Scale API

Application Deployments

application_deployments

Methods

Create Application Deployment ->
ApplicationDeployment
post/v4/application-deployments

Description

Creates a application deployment

Details

This API can be used to create a application deployment. To use this API, review the request schema and pass in all fields that are required to create a application deployment.

List Application Deployments -> PageResponse<
ApplicationDeployment
>
get/v4/application-deployments

Description

Lists all application deployments accessible to the user.

Details

This API can be used to list application deployments. If a user has access to multiple accounts, all application deployments from all accounts the user is associated with will be returned.

Get Application Deployment ->
ApplicationDeployment
get/v4/application-deployments/{application_deployment_id}

Description

Gets the details of a application deployment

Details

This API can be used to get information about a single application deployment by ID. To use this API, pass in the id that was returned from your Create Application Deployment API call as a path parameter.

Review the response schema to see the fields that will be returned.

Update Application Deployment ->
ApplicationDeployment
patch/v4/application-deployments/{application_deployment_id}

Description

Updates a application deployment

Details

This API can be used to update the application deployment that matches the ID that was passed in as a path parameter. To use this API, pass in the id that was returned from your Create Application Deployment API call as a path parameter.

Review the request schema to see the fields that can be updated.

Domain types

ApplicationDeployment = { id, account_id, application_variant_id, 6 more... }
PaginatedApplicationDeployments = { current_page, items, items_per_page, 1 more... }