REST APIs
The REST API is a Hypermedia API built on top of HTTP. All objects in Sitecore Content Hub are modeled as resources that represent the state of objects at the time of a request. Standard HTTP requests and responses are used to query and manipulate object states and standard HTTP headers are used to augment the request and response. Furthermore, to provide consistent performance across all services, backend services apply throttling mechanisms.
The REST architectural pattern models the state of the system as resources. Each resource is identified by a unique URL. By performing HTTP requests, the representation of the resource can be transferred and manipulated. What makes the REST API different is that it is also a Hypermedia API. In essence, hyperlinks are used to navigate between resources instead requiring knowledge of how the URLs to specific resources are constructed. In fact, URLs specified in this REST API documentation (other than the service endpoint) are for documentation purposes only and should not be used by the client directly. Instead, the client should adopt the navigational model and discover the URLs by navigating between the resources.
To ensure optimal performance, the following default timeout values define how long connections and requests can remain open. They apply to all REST APIs:
-
API keep-alive timeout - 60 seconds
-
API timeout - 140 seconds
API access is over HTTPS and accessed from
All data is sent and received as JSON.
You can use the following REST APIs to perform CRUD operations on Content Hub resources:
-
Audit API - retrieve and query audit log entries.
-
Cache API - to clear your caches.
-
Download orders API - to create and retrieve download orders.
-
Entities API - to work with entities.
-
Entity definitions API - to manage entity definitions.
-
Jobs API - to retrieve, create, update, and delete job targets or descriptions.
-
Querying API - to fetch entities that match a specific criteria.
-
Search API - to execute a search query, retrieve facet values, remove search filters or retrieve a facet query.
-
Selection API - to manage entity selections across selection pools.
-
Status API - to monitor system health.
-
Upload API - to upload assets to Content Hub.
Guidelines for throttling are available in the Best practices section of the documentation. The REST API does not handle throttling internally and developers need to handle it in their code. In the best practices, you can also find details on when you should use Scripts and when you should use Microsoft Azure functionality (in particular, see How to choose the integration tool).