Deployment

Operations related to project deployments.

Get organizations project deployments

get
/organizations/{organizationId}/projects/{projectId}/deployments

Get organizations project deployments by organization user

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
organizationIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$
projectIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$
Query parameters
limitintegerOptional

The limit of per page

Default: 10
pageintegerOptional

Current page number

Default: 1
sortstringOptional

Sort

Example: {"value":"createdAt"}
deploymentTypestring · enumOptional

Deployment type

Possible values:
isLivebooleanOptional

The is live to filter

isOnStorestring · enumOptional

The is on store to filter

Possible values:
statusstringOptional

Status

osstring · enumOptional

Os

Possible values:
buildTargetstring · enumOptional

Build target

Possible values:
forceUpdatebooleanOptional

The force update to filter

envVersionstringOptional

Env version

storeVersionstringOptional

Store version

parentstringOptional

Parent

createdBystringOptional

Entity ID

Pattern: ^[0-9a-fA-F]{24}$
createdAtstringOptional

Created at date

Responses
chevron-right
200

OK

application/json
get
/organizations/{organizationId}/projects/{projectId}/deployments

Get a organization project deployment

get
/organizations/{organizationId}/projects/{projectId}/deployments/{deploymentId}

Get a organization project deployment by organization user

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
organizationIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$
projectIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$
deploymentIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$
Responses
chevron-right
200

OK

application/json
Responseone of
or
get
/organizations/{organizationId}/projects/{projectId}/deployments/{deploymentId}

Cancel a organization project deployment

patch
/organizations/{organizationId}/projects/{projectId}/deployments/{deploymentId}/cancel

Cancel a organization project deployment by organization user

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
organizationIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$
projectIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$
deploymentIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$
Responses
chevron-right
200

OK

application/json
Responseone of
or
patch
/organizations/{organizationId}/projects/{projectId}/deployments/{deploymentId}/cancel

Update deployment store state

patch
/organizations/{organizationId}/projects/{projectId}/deployments/{deploymentId}/storestate

Update deployment store state by organization user

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
organizationIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$
projectIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$
deploymentIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$
Body
isOnStorestring · enumRequiredPossible values:
Responses
chevron-right
200

OK

application/json
Responseone of
or
patch
/organizations/{organizationId}/projects/{projectId}/deployments/{deploymentId}/storestate

Get a organization project deployment metrics

get
/organizations/{organizationId}/projects/{projectId}/deployments/{deploymentId}/metrics

Get a organization project deployment metrics by organization user

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
organizationIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$
projectIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$
deploymentIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$
Responses
chevron-right
200

OK

application/json
get
/organizations/{organizationId}/projects/{projectId}/deployments/{deploymentId}/metrics

Update a organization project deployment release

patch
/organizations/{organizationId}/projects/{projectId}/deployments/{deploymentId}/code-push-release

Update a organization project deployment release by organization user

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
organizationIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$
projectIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$
deploymentIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$
Body
Responses
chevron-right
200

OK

application/json
Responseone of
or
patch
/organizations/{organizationId}/projects/{projectId}/deployments/{deploymentId}/code-push-release

Rollback a organization project deployment code push

post
/organizations/{organizationId}/projects/{projectId}/deployments/{deploymentId}/rollback-release

Rollback a organization project deployment code push by organization user

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
organizationIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$
projectIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$
deploymentIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$
Body
releaseLabelstringRequired

Code push label

Example: <releaseLabel>
Responses
chevron-right
200

OK

application/json
post
/organizations/{organizationId}/projects/{projectId}/deployments/{deploymentId}/rollback-release

Promote a organization project deployment code push

post
/organizations/{organizationId}/projects/{projectId}/deployments/{deploymentId}/promote-release

Promote a organization project deployment code push by organization user

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
organizationIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$
projectIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$
deploymentIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$
Responses
chevron-right
200

OK

application/json
post
/organizations/{organizationId}/projects/{projectId}/deployments/{deploymentId}/promote-release

Get a organization project deployment distributions

get
/organizations/{organizationId}/projects/{projectId}/deployments/{deploymentId}/distributions

Get a organization project deployment distributions by organization user

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
organizationIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$
projectIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$
deploymentIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$
Responses
chevron-right
200

OK

application/json
get
/organizations/{organizationId}/projects/{projectId}/deployments/{deploymentId}/distributions

Create a organization project deployment distribution

post
/organizations/{organizationId}/projects/{projectId}/deployments/{deploymentId}/distributions

Create a organization project deployment distribution by organization user

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
organizationIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$
projectIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$
deploymentIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$
Body
releaseNotesstringRequired

Deployment release notes

Example: <releaseNotes>
releaseMethodstring · enumOptional

Deployment release method

Possible values:
trackstring · enumRequired

Deployment track

Possible values:
uploadMetadatabooleanOptional

Deployment upload metadata

Default: falseExample: <uploadMetadata>
uploadScreenshotsbooleanOptional

Deployment upload screenshots

Default: falseExample: <uploadScreenshots>
shouldSubmitForReviewbooleanOptional

Deployment should submit for review

Default: falseExample: <shouldSubmitForReview>
shouldAutoReleasebooleanOptional

Deployment should auto release

Default: falseExample: <shouldAutoRelease>
userFractionnumber · max: 1Optional

Deployment user fraction

Default: 1Example: <userFraction>
updatePrioritynumber · max: 5Optional

Deployment update priority

Default: 0Example: <updatePriority>
Responses
post
/organizations/{organizationId}/projects/{projectId}/deployments/{deploymentId}/distributions

Get a organization project deployment distribution

get
/organizations/{organizationId}/projects/{projectId}/deployments/{deploymentId}/distributions/{distributionId}

Get a organization project deployment distribution by organization user

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
organizationIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$
projectIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$
deploymentIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$
distributionIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$
Responses
chevron-right
200

OK

application/json
get
/organizations/{organizationId}/projects/{projectId}/deployments/{deploymentId}/distributions/{distributionId}

Update a organization project deployment distribution

patch
/organizations/{organizationId}/projects/{projectId}/deployments/{deploymentId}/distributions/{distributionId}

Update a organization project deployment distribution by organization user

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
organizationIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$
projectIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$
deploymentIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$
distributionIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$
Body
statusstring · enumOptional

Deployment status

Possible values:
remoteIdnumberOptional

Deployment remote id

Example: <remoteId>
Responses
chevron-right
200

OK

application/json
patch
/organizations/{organizationId}/projects/{projectId}/deployments/{deploymentId}/distributions/{distributionId}

Last updated

Was this helpful?