Required permission
Project > Pipelines > General > Update
Path parameters
projectId
string requiredID of the projectpipelineId
string requiredID of the pipelinestage
string requiredStage of the pipelinerunId
string requiredID of the release flow run
Response body
- {object}Response object.
data
{object} requiredResult data.name
stringOptional name of the run.description
stringOptional description of the run.apiVersion
stringTemplate API version.spec
(multiple options: anyOf)project
{object}ref
stringskipNodeExecution
(multiple options: anyOf)- boolean
- stringone oftrue, false
detailsHidden
boolean requiredkind
string requiredspec
{object} requiredresponse
{object}status
stringstartTime
numberendTime
numberduration
numberattempts
numberdata
{object}id
stringname
string_id
string_id
stringid
stringinternalId
stringtype
stringname
stringpipelineId
stringtemplateId
stringIdentifier of the template, when available.environmentId
stringIdentifier of the preview environment, when available.status
string requiredStatus of the template runone ofpending, running, success, failure, aborted, aborting, queued, unknown, skipped, waiting, retrying, async_wait, approval_waitconcluded
boolean requiredWhether execution has concluded.startedAt
stringWhen execution started.concludedAt
stringWhen execution concluded.createdAt
string requiredWhen the run was created.updatedAt
string requiredWhen the run was last updated.detailsHidden
boolean requiredRun details include available public results. Sensitive inputs and results are omitted._id
stringinternalId
stringentityId
stringentityType
stringprojectId
stringpipelineId
stringuserId
stringenvironmentName
stringexpiresAt
stringdeleted
booleanphase
stringtemplateVersionSha
stringcommitSHA
stringhasDiff
booleancontent
{object}name
stringdescription
stringapiVersion
stringspec
(multiple options: anyOf)project
{object}ref
stringskipNodeExecution
(multiple options: anyOf)- boolean
- stringone oftrue, false
detailsHidden
boolean requiredkind
string requiredspec
{object} requiredresponse
{object}status
stringstartTime
numberendTime
numberduration
numberattempts
numberdata
{object}id
stringname
string_id
string_id
stringid
stringinternalId
stringtype
stringname
stringpipelineId
stringtemplate
{object}_id
stringid
string requiredinternalId
stringtype
stringname
stringpipelineId
stringpipeline
{object}_id
stringid
string requiredinternalId
stringtype
stringname
stringpipelineId
stringstage
stringrun
{object}_id
stringid
string requiredinternalId
stringtype
stringname
stringpipelineId
stringauditLog
{object}_id
stringrunContext
{object}origin
stringuserId
stringuser
{object}_id
stringsha
stringbranch
stringpullRequestId
(multiple options: anyOf)- string
- integer
matchedFile
stringtrigger
{object}globalSecretInternalId
stringpendingApprovals
[array]- {object}
nodePath
string requireduser
string requiredid
string requiredIdentifier of the run.
OR
OR
OR
POST /v1/projects/{projectId}/pipelines/{pipelineId}/release-flows/{stage}/runs/{runId}/abort
POST /v1/teams/{teamId}/projects/{projectId}/pipelines/{pipelineId}/release-flows/{stage}/runs/{runId}/abort
Example response
200 OK
JSON
{
"data": {
"name": "Production deployment",
"description": "Deploy the latest release.",
"status": "success",
"concluded": true,
"startedAt": "2026-01-01T12:00:00.000Z",
"concludedAt": "2026-01-01T12:01:00.000Z",
"createdAt": "2026-01-01T12:00:00.000Z",
"updatedAt": "2026-01-01T12:01:00.000Z",
"id": "110ddb52-bdcd-482d-8ac2-05ba580afe2f"
}
}