v1

latestSwagger 2.02026-07-13242272.7 KB
Deployments

Create a new deployment.

Required permission: deployments_write

post/v3/deployments

Request body

versionstring required

The version number of this deployment. The value of version can be a SemVer compliant string or any other syntax that you are using as your version numbering scheme.

createdstring date-time

When was this deployment created in UTC. Defaults to current time if not specified.

descriptionstring

Optional description of this deployment. Can be markdown or clear text.

userNamestring

The name of the person responsible for creating this deployment. This can be the name taken from your deployment server (like Azure DevOps or Octopus).

userEmailstring email

The email of the person responsible for creating this deployment. This can be the email taken from your deployment server (like Azure DevOps or Octopus).

logIdstring

As default, deployments are attached all logs of the organization. If you want a deployment to attach to a single log only, set this to the ID of that log.

Response

Deployment was created.

locationstring uri

The location of the created deployment.