Deploy API

Deploy uses a REST API to manage projects, environments, and deployments. You can use this API or the Sitecore CLI to automate Deploy operations.

Important

The maximum supported repository size for deployments is 500MB. If your repository exceeds this limit, you won't be able to deploy your source code to SitecoreAI.

The base URL of the Deploy API is https://xmclouddeploy-api.sitecorecloud.io/.

XM Cloud is now SitecoreAI

Some code examples, images, and UI labels may still use XM Cloud while engineering assets are being updated.

The Deploy API documentation is generated using Swagger UI.

Generate an access token for the Deploy API

The Deploy API uses JSON Web Token (JWT) access tokens for authentication. You can use the access token for API call authentication and to authorize when testing in the Swagger UI.

To generate an access token for the Deploy API:

  1. Generate an organization automation client.

  2. Use the client ID and client secret to request a JWT. The access_token value is your access token.

Do you have some feedback for us?

If you have suggestions for improving this article,