Sitecore API catalog
Welcome to the Sitecore catalog of REST APIs. The REST API documentation in this catalog follows the OpenAPI specification and features an interface that enables authenticated users to send requests directly to their tenant. You can use this interactive console to authenticate, enter custom parameter values, send requests, and inspect responses. You can also download OpenAPI definition files straight from the documentation.
SitecoreAI Content
3
Cache API
Use the XM Cloud Content Cache API to clear parts of the cache for GraphQL requests. This REST API lets you clean up a cache for a specific tenant. It is rate limited to 10 requests per second per tenant. Clearing the cache can have a negative effect on the performance of the tenant application because all GraphQL requests must be executed fully. We recommend that you do not clear the caches or call this API as part of a build process. Authentication To use this API, you need: The URL of your XM Cloud Content server. You can get this from your XM Cloud Administer. A JWT bearer token requested using the OAuth Client Credentials flow . It is sent with every request. The token must include the cs:all:admin scope.
Content Management API
Use the XM Cloud Content Management API to build a content model that structures and organizes your data. Content types make up the content model while the content items contain the data itself. The API definitions are written in JSON. A name field can be alphanumeric, and can contain periods, underscores, and hyphens, but not spaces or other special characters. It cannot start with an underscore. The dateTime format is ISO 8601. Authentication To use this REST API, you must authorize your API requests. To do this, you need the following information: The URL of your XM Cloud Content server (for example, cs-cmapi.sitecorecloud.io or a custom hostname ). The environment ID (for example, main ). To use the Try it feature, enter this information on the Environments tab, by hovering your mouse over the variable and then clicking Edit. Tokens are used for API security. You need to generate an OAuth client bearer token and use it to authenticate. A successful authentication request requires the following credential properties: oauth2_client_id , the oauth2_client_secret , or an oauth2_token . Create an OAuth client bearer token The Settings menu is only visible if you have the Admin role. To create an OAuth client bearer token: In XM Cloud Content, on the menu bar, click Settings. In the left pane, click Content management API. On the Content management API page, in the Grant type section, click Client credentials. Copy the following credentials and paste them into your development tool, and then execute the Generate token method: Client ID - The client ID for XM Cloud Content. Client secret - The client secret for the XM Cloud Content. Audience - The audience for your tenant. This will be in the form https://api.sitecorecloud.io . Authority - The authority for your tenant. This is the POST URL, in the form https://auth.sitecorecloud.io/oauth/token .
Token API
Use the XM Cloud Content Token API to manage query tokens for the GraphQL Query API. By setting an expiration date and applying restrictions, such as making the token valid only for a particular IP address or publish state, you can control how content is queried. The Try it functionality available from the API documentation lets you explore API endpoints and make calls directly from the documentation. Authentication To use this API, you need: The URL of your XM Cloud Content server. A JWT bearer token requested using the OAuth Client Credentials flow . This is sent with every request. The token must include a scope. Which scope to use depends on the endpoint being called. For mutation operations, such as create , update , and delete , include the cs:all:admin scope. To read existing tokens, include the cs.all:editor scope.