Skip to content
GitHub

The approval state of a deployment run.

GET
/api/v1/projects/{project}/environments/{environment}/apps/{app}/deployments/{run}/approval
curl --request GET \
  --url https://example.com/api/v1/projects/example/environments/example/apps/example/deployments/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/approval

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
project
required
string

Project name

environment
required
string

Environment short name

app
required
string

App name

run
required
string format: uuid

Deployment run id

Responses

Section titled “Responses”

200

Section titled “200”
Media typeapplication/json
object
run
required
string format: uuid
phase
required
string
requestedBy
required

Email of whoever asked for the deployment.

string
required
required

Distinct approvals needed; 0 when the run needs none.

integer format: int32
approved
required
integer format: int32
expiresAt

When the run is cancelled unless approved (Unix milliseconds).

integer | null format: int64
planHash

What an approver confirms: send it back with the decision.

string | null
canDecide
required

Whether the caller may decide on this run now.

boolean
decisions
required
Array<object>
object
approver
required

Email of whoever decided.

string
decision
required

approved or rejected.

string
comment
string | null
decidedAt
required
integer format: int64
Examplegenerated
{
  "run": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "phase": "example",
  "requestedBy": "example",
  "required": 1,
  "approved": 1,
  "expiresAt": 1,
  "planHash": "example",
  "canDecide": true,
  "decisions": [
    {
      "approver": "example",
      "decision": "example",
      "comment": "example",
      "decidedAt": 1
    }
  ]
}

403

Section titled “403”
Media typeapplication/json

Problem Details body.

object
code
required

Stable machine-readable code, e.g. forbidden.

string
title
required

Short human readable title.

string
status
required

HTTP status.

integer format: int32
detail

Details, if safe to expose.

string | null
Example
{
  "code": "forbidden"
}

404

Section titled “404”
Media typeapplication/json

Problem Details body.

object
code
required

Stable machine-readable code, e.g. forbidden.

string
title
required

Short human readable title.

string
status
required

HTTP status.

integer format: int32
detail

Details, if safe to expose.

string | null
Example
{
  "code": "forbidden"
}