Optional configuration: ConfigurationProtected axiosProtected baseProtected configurationModify an App's deployment configuration to customize how the App deploys changes.
An Atlas Project/Group ID.
The ObjectID of your application. The App Services API Project and Application IDs section demonstrates how to find this value.
Optional deploymentConfig: DeploymentConfigOptional options: AxiosRequestConfig<any>Override http request option.
Configure Deployment
DeployApi
Create a new application deployment draft, if none exists.
An Atlas Project/Group ID.
The ObjectID of your application. The App Services API Project and Application IDs section demonstrates how to find this value.
Optional options: AxiosRequestConfig<any>Override http request option.
Create a Deployment Draft
DeployApi
Start a new deployment migration.
An Atlas Project/Group ID.
The ObjectID of your application. The App Services API Project and Application IDs section demonstrates how to find this value.
The deployment model and cloud provider region that the App should migrate to.
Optional options: AxiosRequestConfig<any>Override http request option.
Create a Deployment Migration
DeployApi
Deploy the specified application deployment draft.
An Atlas Project/Group ID.
The ObjectID of your application. The App Services API Project and Application IDs section demonstrates how to find this value.
The unique `_id` value of a draft.
Optional adminDeployDraftRequest: AdminDeployDraftRequestOptional options: AxiosRequestConfig<any>Override http request option.
Deploy a deployment draft
DeployApi
Return a diff between the currently deployed application and the specified draft.
An Atlas Project/Group ID.
The ObjectID of your application. The App Services API Project and Application IDs section demonstrates how to find this value.
The unique `_id` value of a draft.
Optional options: AxiosRequestConfig<any>Override http request option.
Diff a draft with the current deployment
DeployApi
Discard the specified application deployment draft.
An Atlas Project/Group ID.
The ObjectID of your application. The App Services API Project and Application IDs section demonstrates how to find this value.
The unique `_id` value of a draft.
Optional options: AxiosRequestConfig<any>Override http request option.
Discard the specified deployment draft
DeployApi
Get information about a recent deployment of the application.
An Atlas Project/Group ID.
The ObjectID of your application. The App Services API Project and Application IDs section demonstrates how to find this value.
The `_id` value of an application deployment.
Optional options: AxiosRequestConfig<any>Override http request option.
Get a deployment
DeployApi
See information about how your App deploys changes.
An Atlas Project/Group ID.
The ObjectID of your application. The App Services API Project and Application IDs section demonstrates how to find this value.
Optional options: AxiosRequestConfig<any>Override http request option.
Get the Deployment Configuration
DeployApi
Get metadata and status for the current deployment migration, if one exists.
An Atlas Project/Group ID.
The ObjectID of your application. The App Services API Project and Application IDs section demonstrates how to find this value.
Optional options: AxiosRequestConfig<any>Override http request option.
Get a Deployment Migration
DeployApi
Return a list of all supported cloud regions in which you can deploy an Atlas App.
Optional options: AxiosRequestConfig<any>Override http request option.
List all available Atlas App cloud regions
DeployApi
Return the current application deployment draft, if applicable.
An Atlas Project/Group ID.
The ObjectID of your application. The App Services API Project and Application IDs section demonstrates how to find this value.
Optional options: AxiosRequestConfig<any>Override http request option.
Get Current Deployment Draft
DeployApi
Return the 25 most recent application deployments.
An Atlas Project/Group ID.
The ObjectID of your application. The App Services API Project and Application IDs section demonstrates how to find this value.
Optional options: AxiosRequestConfig<any>Override http request option.
List recent deployments
DeployApi
Redeploy a previously-deployed version of an App.
An Atlas Project/Group ID.
The ObjectID of your application. The App Services API Project and Application IDs section demonstrates how to find this value.
The `_id` value of an application deployment.
Optional options: AxiosRequestConfig<any>Override http request option.
Redeploy a Deployment
DeployApi
Generated using TypeDoc
DeployApi - object-oriented interface
Export