Sign in

v1

latestOpenAPI 3.1.02026-07-26289714404.6 KB
Environments

List Deployments

get/environments/{id}/deployments

Path parameters

idstring required

Query parameters

limitstring

Number of deployments per page. The maximum is 100, with the default value is set to maximum

offsetstring

The offset of the first deployment returned. Defaults to 0

fromDatestring

The start date of the first deployment log in the response. Must be provided with toDate and in the following format YYYY-MM-DDTHH:mm:ss.sssZ

toDatestring

The start date of the last deployment log in the response. Must be provided with fromDate and in the following format YYYY-MM-DDTHH:mm:ss.sssZ

deploymentTypesstring

The types of the deployment logs in the response. The types should be in Camel case and separated by commas. For example: deploymentTypes=deploy,prPlan,driftDetection

statusesstring

The statuses of the deployment logs in the response. The statuses should be separated by commas.

deployerUserIdsstring

The ids of the users who started the deployments. The ids should be separated by commas.

Response

idstring
createdAtstring date-time
updatedAtstring date-time
type'deploy' | 'destroy' | 'prPlan' | 'driftDetection' | 'task' | 'remotePlan' | 'dryRun' | 'moduleTest' | 'deploy' | 'destroy' | 'prPlan' | 'driftDetection' | 'task' | 'remotePlan' | 'dryRun' | 'moduleTest' required
startedBystring required
queuedAtstring date-time required
startedAtstring date-time required
finishedAtstring date-time required
errorobject required
failedCommandstring
stoppedByTimeoutReason'DEPLOYMENT_TIME_LIMIT_EXCEEDED' | 'AGENT_UNRESPONSIVE' | 'DEPLOYMENT_NOT_STARTED' | 'DEPLOYMENT_TIME_LIMIT_EXCEEDED' | 'AGENT_UNRESPONSIVE' | 'DEPLOYMENT_NOT_STARTED'
status'IN_PROGRESS' | 'WAITING_FOR_USER' | 'TIMEOUT' | 'FAILURE' | 'SUCCESS' | 'CANCELLED' | 'INTERNAL_FAILURE' | 'ABORTING' | 'ABORTED' | 'QUEUED' | 'SKIPPED' | 'NEVER_DEPLOYED' | 'IN_PROGRESS' | 'WAITING_FOR_USER' | 'TIMEOUT' | 'FAILURE' | 'SUCCESS' | 'CANCELLED' | 'INTERNAL_FAILURE' | 'ABORTING' | 'ABORTED' | 'QUEUED' | 'SKIPPED' | 'NEVER_DEPLOYED' | 'IN_PROGRESS' | 'WAITING_FOR_USER' | 'TIMEOUT' | 'FAILURE' | 'SUCCESS' | 'CANCELLED' | 'INTERNAL_FAILURE' | 'ABORTING' | 'ABORTED' | 'QUEUED' | 'SKIPPED' | 'NEVER_DEPLOYED' required
blueprintIdstring required
blueprintNamestring required
blueprintRepositorystring required
blueprintRevisionstring required
blueprintPathstring required
commentstring
environmentIdstring required
resourceCountnumber required
isScheduledRunboolean required
abortedBystring required
gitUserstring
gitAvatarUrlstring
prNumberstring
driftDetectedboolean
isSkippedApplyboolean
workflowDeploymentIdstring
stateVersionIdstring
reviewedBystring
targetsstring[]