Function DeployApiFp

Returns {
    adminConfigureDeployment(groupId, appId, deploymentConfig?, options?) => Promise<((axios?, basePath?) => AxiosPromise<void>)>;
    adminCreateDeploymentDraft(groupId, appId, options?) => Promise<((axios?, basePath?) => AxiosPromise<DeploymentDraft>)>;
    adminCreateDeploymentMigration(groupId, appId, appDeploymentSettings, options?) => Promise<((axios?, basePath?) => AxiosPromise<void>)>;
    adminDeployDraft(groupId, appId, draftId, adminDeployDraftRequest?, options?) => Promise<((axios?, basePath?) => AxiosPromise<Deployment>)>;
    adminDeployDraftDiff(groupId, appId, draftId, options?) => Promise<((axios?, basePath?) => AxiosPromise<Diff>)>;
    adminDiscardDraft(groupId, appId, draftId, options?) => Promise<((axios?, basePath?) => AxiosPromise<void>)>;
    adminGetDeployment(groupId, appId, deploymentId, options?) => Promise<((axios?, basePath?) => AxiosPromise<Deployment>)>;
    adminGetDeploymentConfig(groupId, appId, options?) => Promise<((axios?, basePath?) => AxiosPromise<DeploymentConfig>)>;
    adminGetDeploymentMigration(groupId, appId, options?) => Promise<((axios?, basePath?) => AxiosPromise<DeploymentMigration>)>;
    adminListAppRegions(options?) => Promise<((axios?, basePath?) => AxiosPromise<any>)>;
    adminListDeploymentDrafts(groupId, appId, options?) => Promise<((axios?, basePath?) => AxiosPromise<DeploymentDraft>)>;
    adminListDeployments(groupId, appId, options?) => Promise<((axios?, basePath?) => AxiosPromise<any>)>;
    adminRedeployDeployment(groupId, appId, deploymentId, options?) => Promise<((axios?, basePath?) => AxiosPromise<void>)>;
}

• adminConfigureDeployment:function

  • adminConfigureDeployment(groupId, appId, deploymentConfig?, options?): Promise<((axios?, basePath?) => AxiosPromise<void>)>

  • Modify an App's deployment configuration to customize how the App deploys changes.

    Parameters

    • groupId: any

      An Atlas Project/Group ID.

    • appId: any

      The ObjectID of your application. The App Services API Project and Application IDs section demonstrates how to find this value.

    • Optional deploymentConfig: DeploymentConfig

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<((axios?, basePath?) => AxiosPromise<void>)>

    Summary

    Configure Deployment

    Throws

• adminCreateDeploymentDraft:function

  • adminCreateDeploymentDraft(groupId, appId, options?): Promise<((axios?, basePath?) => AxiosPromise<DeploymentDraft>)>

  • Create a new application deployment draft, if none exists.

    Parameters

    • groupId: any

      An Atlas Project/Group ID.

    • appId: any

      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.

    Returns Promise<((axios?, basePath?) => AxiosPromise<DeploymentDraft>)>

    Summary

    Create a Deployment Draft

    Throws

• adminCreateDeploymentMigration:function

  • adminCreateDeploymentMigration(groupId, appId, appDeploymentSettings, options?): Promise<((axios?, basePath?) => AxiosPromise<void>)>

  • Start a new deployment migration.

    Parameters

    • groupId: any

      An Atlas Project/Group ID.

    • appId: any

      The ObjectID of your application. The App Services API Project and Application IDs section demonstrates how to find this value.

    • appDeploymentSettings: AppDeploymentSettings

      The deployment model and cloud provider region that the App should migrate to.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<((axios?, basePath?) => AxiosPromise<void>)>

    Summary

    Create a Deployment Migration

    Throws

• adminDeployDraft:function

  • adminDeployDraft(groupId, appId, draftId, adminDeployDraftRequest?, options?): Promise<((axios?, basePath?) => AxiosPromise<Deployment>)>

  • Deploy the specified application deployment draft.

    Parameters

    • groupId: any

      An Atlas Project/Group ID.

    • appId: any

      The ObjectID of your application. The App Services API Project and Application IDs section demonstrates how to find this value.

    • draftId: any

      The unique `_id` value of a draft.

    • Optional adminDeployDraftRequest: AdminDeployDraftRequest

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<((axios?, basePath?) => AxiosPromise<Deployment>)>

    Summary

    Deploy a deployment draft

    Throws

• adminDeployDraftDiff:function

  • adminDeployDraftDiff(groupId, appId, draftId, options?): Promise<((axios?, basePath?) => AxiosPromise<Diff>)>

  • Return a diff between the currently deployed application and the specified draft.

    Parameters

    • groupId: any

      An Atlas Project/Group ID.

    • appId: any

      The ObjectID of your application. The App Services API Project and Application IDs section demonstrates how to find this value.

    • draftId: any

      The unique `_id` value of a draft.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<((axios?, basePath?) => AxiosPromise<Diff>)>

    Summary

    Diff a draft with the current deployment

    Throws

• adminDiscardDraft:function

  • adminDiscardDraft(groupId, appId, draftId, options?): Promise<((axios?, basePath?) => AxiosPromise<void>)>

  • Discard the specified application deployment draft.

    Parameters

    • groupId: any

      An Atlas Project/Group ID.

    • appId: any

      The ObjectID of your application. The App Services API Project and Application IDs section demonstrates how to find this value.

    • draftId: any

      The unique `_id` value of a draft.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<((axios?, basePath?) => AxiosPromise<void>)>

    Summary

    Discard the specified deployment draft

    Throws

• adminGetDeployment:function

  • adminGetDeployment(groupId, appId, deploymentId, options?): Promise<((axios?, basePath?) => AxiosPromise<Deployment>)>

  • Get information about a recent deployment of the application.

    Parameters

    • groupId: any

      An Atlas Project/Group ID.

    • appId: any

      The ObjectID of your application. The App Services API Project and Application IDs section demonstrates how to find this value.

    • deploymentId: any

      The `_id` value of an application deployment.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<((axios?, basePath?) => AxiosPromise<Deployment>)>

    Summary

    Get a deployment

    Throws

• adminGetDeploymentConfig:function

  • adminGetDeploymentConfig(groupId, appId, options?): Promise<((axios?, basePath?) => AxiosPromise<DeploymentConfig>)>

  • See information about how your App deploys changes.

    Parameters

    • groupId: any

      An Atlas Project/Group ID.

    • appId: any

      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.

    Returns Promise<((axios?, basePath?) => AxiosPromise<DeploymentConfig>)>

    Summary

    Get the Deployment Configuration

    Throws

• adminGetDeploymentMigration:function

  • adminGetDeploymentMigration(groupId, appId, options?): Promise<((axios?, basePath?) => AxiosPromise<DeploymentMigration>)>

  • Get metadata and status for the current deployment migration, if one exists.

    Parameters

    • groupId: any

      An Atlas Project/Group ID.

    • appId: any

      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.

    Returns Promise<((axios?, basePath?) => AxiosPromise<DeploymentMigration>)>

    Summary

    Get a Deployment Migration

    Throws

• adminListAppRegions:function

  • adminListAppRegions(options?): Promise<((axios?, basePath?) => AxiosPromise<any>)>

  • Return a list of all supported cloud regions in which you can deploy an Atlas App.

    Parameters

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<((axios?, basePath?) => AxiosPromise<any>)>

    Summary

    List all available Atlas App cloud regions

    Throws

• adminListDeploymentDrafts:function

  • adminListDeploymentDrafts(groupId, appId, options?): Promise<((axios?, basePath?) => AxiosPromise<DeploymentDraft>)>

  • Return the current application deployment draft, if applicable.

    Parameters

    • groupId: any

      An Atlas Project/Group ID.

    • appId: any

      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.

    Returns Promise<((axios?, basePath?) => AxiosPromise<DeploymentDraft>)>

    Summary

    Get Current Deployment Draft

    Throws

• adminListDeployments:function

  • adminListDeployments(groupId, appId, options?): Promise<((axios?, basePath?) => AxiosPromise<any>)>

  • Return the 25 most recent application deployments.

    Parameters

    • groupId: any

      An Atlas Project/Group ID.

    • appId: any

      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.

    Returns Promise<((axios?, basePath?) => AxiosPromise<any>)>

    Summary

    List recent deployments

    Throws

• adminRedeployDeployment:function

  • adminRedeployDeployment(groupId, appId, deploymentId, options?): Promise<((axios?, basePath?) => AxiosPromise<void>)>

  • Redeploy a previously-deployed version of an App.

    Parameters

    • groupId: any

      An Atlas Project/Group ID.

    • appId: any

      The ObjectID of your application. The App Services API Project and Application IDs section demonstrates how to find this value.

    • deploymentId: any

      The `_id` value of an application deployment.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<((axios?, basePath?) => AxiosPromise<void>)>

    Summary

    Redeploy a Deployment

    Throws