Skip to main content
GET
Read a pipeline authority request

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string<uuid>
required

Response

The request.

id
string<uuid>
required
organisation_id
string<uuid>
required
repository_id
string<uuid>
required
application_id
string<uuid> | null
required
definition_id
string<uuid>
required

The definition to approve: POST /api/v1/org/pipelines/definitions/{definition_id}/approve resolves this request.

protected_hash
string
required

Identity of the protected settings an approval grants.

approved_hash
string | null
required

Identity of the settings the raising run executed under instead; null when nothing was ever approved.

run_id
string<uuid>
required

The newest pipeline run that raised or joined this request.

head_sha
string
required
ref
string
required
pull_request_number
integer | null
required
requested_by
string
required

The principal behind the run, as <lane>:<identity> (github:, user:).

status
enum<string>
required
Available options:
pending,
approved,
dismissed,
superseded
resolved_by
string | null
required

Ankra user id of the person who approved or dismissed it.

resolved_at
string<date-time> | null
required
resolved_via
enum<string> | null
required
Available options:
portal,
github_check,
cli,
api,
null
reason
string | null
required

The dismissal's reason; null unless dismissed.

diff
object
required
last_refusal
null | object
required

The last approval press from a source-control host that was refused; null when none was.

created_at
string<date-time>
required
updated_at
string<date-time>
required