Sign in
latestOpenAPI 3.0.02026-08-10221235717.8 KB

e21ad140ec3c

public
PipelineApprovals

List of the approval requests

List of the approval requests with in an app.

get/orgs/{orgId}/apps/{appId}/approvals

Path parameters

orgIdstring required

The Organization ID

appIdstring required

The Application ID

Query parameters

per_pageinteger

The maximum number of items to return in a page of results

pagestring

The page token to request from

pipelinestring[]

An optional list of Pipeline IDs.

[
  "sample-pipeline"
]
runstring[]

An optional Pipeline Run ID.

[
  "sample-run"
]
statusstring

Optional filter by status.

Response

Successful list response.

idstring required

The id of the approval object.

org_idstring required

The id of the Organization.

app_idstring required

The id of the Application.

pipeline_idstring required

The id of the Pipeline.

run_idstring required

The id of the Pipeline's Run.

job_idstring required

The id of the Run's Job.

env_idstring required

The environment for which the approver needs to have deploy permission to approve the job.

messagestring required

A human-readable message indicating the reason for approval.

created_atstring date-time required

The date and time when the approval request was created.

status'waiting' | 'approved' | 'denied' | 'cancelled' required

The current status of the approval request.

approved_bystring

The user who approved or denied the request.

approved_atstring date-time

The date and time when the request was approved or denied.

Example response

[
  {
    "org_id": "sample-org",
    "app_id": "sample-app",
    "pipeline_id": "sample-pipeline",
    "run_id": "01234567-89ab-cdef-0123-456789abcdef",
    "job_id": "deploy",
    "env_id": "production",
    "message": "Promoting app to production",
    "created_at": "2023-01-01T00:00:00Z",
    "status": "waiting",
    "approved_by": "0123456789ab-cdef-0123-456789abcdef",
    "approved_at": "2023-01-01T00:00:00Z"
  }
]