Configure Deployment

PATCH /groups/{groupId}/apps/{appId}/deploy/config
Token auth

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

Path parameters

application/json

Body

  • ui_drafts_disabled boolean Required

    If true, every change made in the Admin UI deploys automatically on save. If false, changes are grouped into a deployment draft that you deploy separately.

  • automatic_deployment object Required

    Configuration for automatic deployment methods

    Hide automatic_deployment attributes Show automatic_deployment attributes object
    • enabled boolean

      If true, the app automatically deploys using the method defined for provider.

    • provider string

      The type of automatic deployment.

      Value is github.

    • installation_ids array[string]

      The unique ID values of automatic deployment provider installations. For example, the id value of a GitHub app installation.

  • last_modified number

    The time this configuration was last modified represented by the number of seconds since the UNIX epoch.

Responses

  • 204

    Success

PATCH /groups/{groupId}/apps/{appId}/deploy/config 
curl \ --request PATCH 'https://services.cloud.mongodb.com/api/admin/v3.0/groups/{groupId}/apps/{appId}/deploy/config' \ --header "Authorization: Bearer $ACCESS_TOKEN" \ --header "Content-Type: application/json" \ --data '{"ui_drafts_disabled":true,"automatic_deployment":{"enabled":true,"provider":"github","installation_ids":["string"]},"last_modified":42.0}'
Request examples 
{ "ui_drafts_disabled": true, "automatic_deployment": { "enabled": true, "provider": "github", "installation_ids": [ "string" ] }, "last_modified": 42.0 }