---
title: "Deploy API"
slug: "deploy-api"
abstract: "Describes the Deploy API and authentication."
---
# Deploy API

Deploy uses a [Deploy REST API](https://xmclouddeploy-api.sitecorecloud.io/swagger/index.html) to manage projects, environments, and deployments. You can use this API or the [Sitecore CLI](https://doc.sitecore.com/sai/en/developers/sitecoreai/sitecore-command-line-interface/plugins/xm-cloud-plugin.html "XM Cloud plugin") 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/`.

> [!note]
> **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](https://doc.sitecore.com/sai/en/developers/sitecoreai/deploying-sitecoreai/deploy-app/managing-sitecoreai-client-credentials/manage-client-credentials-for-a-sitecoreai-organization-or-environment.html "Create an automation client for a SitecoreAI organization").
2. Use the client ID and client secret to [request a JWT](https://doc.sitecore.com/sai/en/developers/sitecoreai/deploying-sitecoreai/deploy-app/managing-sitecoreai-client-credentials/create-a-json-web-token-for-the-authoring-and-management-api-or-the-deploy-api.html "Create a JSON web token for the Authoring and Management API or the Deploy API"). The `access_token` value is your access token.