v1

latestOpenAPI 3.0.3Apache 2.02026-07-142201861.5 MB
Releases

Create a Deploy

Create a deploy for a given release.

post/api/0/organizations/{organization_id_or_slug}/releases/{version}/deploys/

Path parameters

organization_id_or_slugstring required

The ID or slug of the organization the resource belongs to.

versionstring required

The version identifier of the release

Request body

environmentstring required

The environment you're deploying to

namestring nullable

The optional name of the deploy

urlstring uri nullable

The optional URL that points to the deploy

dateStartedstring date-time nullable

An optional date that indicates when the deploy started

dateFinishedstring date-time nullable

An optional date that indicates when the deploy ended. If not provided, the current time is used.

projectsstring[]

The optional list of project slugs to create a deploy within. If not provided, deploys are created for all of the release's projects.

Response

idstring required

The ID of the deploy

environmentstring required

The environment name

dateStartedstring date-time nullable required

An optional date that indicates when the deploy started

dateFinishedstring date-time required

An optional date that indicates when the deploy ended

namestring nullable required

The optional name of the deploy

urlstring uri nullable required

The optional URL that points to the deploy