Ctrlk
Sign UpGet a DemoContact Us
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Approvals

Approval service handles the approval API to approve or reject pipeline executions

List approvals

get

List all the approvals

Path parameters
orgstring · min: 1 · max: 128Required

Org is the organisation identifier.

Example: 7l
projectstring · min: 1 · max: 128Required

Project is the project identifier.

Example: 4
Query parameters
limitinteger · int64 · min: 1 · max: 1000Optional

Limit is the number of records to return for a page.

Default: 30Example: 30
pageinteger · int64 · min: 1Optional

Page is the page number to return relative to the page 'limit'.

Default: 1Example: 1
workspacestringOptional

Workspace identifier

Example: Et libero quia qui dolorum ut.
pipeline_execution_idstringOptional

Pipeline identifier

Example: Sed dolor exercitationem perspiciatis quaerat.
pipeline_stage_idstringOptional

Pipeline stage identifier

Example: Saepe provident omnis necessitatibus ut.
status_typestring · enumOptional

Status of the approval step

Example: pendingPossible values:
Header parameters
Harness-Accountstring · min: 1 · max: 128Required

Account is the internal customer account ID.

Example: 8xu
Responses
200

OK response.

application/json
get/api/orgs/{org}/projects/{project}/approvals
GET /api/orgs/{org}/projects/{project}/approvals HTTP/1.1
Host: localhost:80
Harness-Account: 8xu
Accept: */*

[
  {
    "account": "kn8",
    "actioned_by": "John Doe",
    "actioned_by_email": "john.doe@example.com",
    "created": 8923043851235030000,
    "id": "Aliquid quia dignissimos aut accusamus voluptates rerum.",
    "org": "1",
    "pipeline_execution_id": "A tempora asperiores consectetur.",
    "pipeline_stage_id": "Id consequatur atque.",
    "project": "bcz",
    "status": "Quam saepe sit magnam tenetur.",
    "updated": 4501857522395362000,
    "workspace_id": "Itaque sed eum."
  },
  {
    "account": "kn8",
    "actioned_by": "John Doe",
    "actioned_by_email": "john.doe@example.com",
    "created": 8923043851235030000,
    "id": "Aliquid quia dignissimos aut accusamus voluptates rerum.",
    "org": "1",
    "pipeline_execution_id": "A tempora asperiores consectetur.",
    "pipeline_stage_id": "Id consequatur atque.",
    "project": "bcz",
    "status": "Quam saepe sit magnam tenetur.",
    "updated": 4501857522395362000,
    "workspace_id": "Itaque sed eum."
  },
  {
    "account": "kn8",
    "actioned_by": "John Doe",
    "actioned_by_email": "john.doe@example.com",
    "created": 8923043851235030000,
    "id": "Aliquid quia dignissimos aut accusamus voluptates rerum.",
    "org": "1",
    "pipeline_execution_id": "A tempora asperiores consectetur.",
    "pipeline_stage_id": "Id consequatur atque.",
    "project": "bcz",
    "status": "Quam saepe sit magnam tenetur.",
    "updated": 4501857522395362000,
    "workspace_id": "Itaque sed eum."
  }
]

Create approval

post

Create an approval resource

Path parameters
orgstring · min: 1 · max: 128Required

Org is the organisation identifier.

Example: 8
projectstring · min: 1 · max: 128Required

Project is the project identifier.

Example: kzt
Header parameters
Harness-Accountstring · min: 1 · max: 128Required

Account is the internal customer account ID.

Example: ee
Body
pipeline_execution_idstringRequired

The unique identifier for the associated pipeline execution

Example: Consequatur aperiam aut ea qui perspiciatis.
pipeline_stage_idstringRequired

The unique identifier for the associated pipeline execution stage

Example: Explicabo iste quaerat cupiditate exercitationem.
statusstring · enumOptional

Status of the approval resource

Default: pendingExample: approvedPossible values:
workspace_idstringRequired

The unique identifier for the workspace_id

Example: Nobis odit animi optio.
Responses
200

OK response.

application/json

Create-ApprovalResponseBody result type (creation view)

idstringRequiredExample: Eos rem omnis est.
post/api/orgs/{org}/projects/{project}/approvals
POST /api/orgs/{org}/projects/{project}/approvals HTTP/1.1
Host: localhost:80
Harness-Account: ee
Content-Type: application/json
Accept: */*
Content-Length: 135

{
  "pipeline_execution_id": "In placeat voluptatum.",
  "pipeline_stage_id": "Voluptatem sed.",
  "status": "approved",
  "workspace_id": "Ut totam."
}
{
  "id": "Illo consequatur."
}

Show approval

get

Retrieve a single approval

Path parameters
orgstring · min: 1 · max: 128Required

Org is the organisation identifier.

Example: r
projectstring · min: 1 · max: 128Required

Project is the project identifier.

Example: 2u
idstring · uuidRequiredExample: ca0289a9-0b58-4604-975a-35ab3edffe90
Header parameters
Harness-Accountstring · min: 1 · max: 128Required

Account is the internal customer account ID.

Example: wp
Responses
200

OK response.

application/json

Show-ApprovalResponseBody result type (statusInfo view)

actioned_bystringOptional

User that approved/rejected the step

Example: John Doe
actioned_by_emailstringOptional

Email of the user that approved/rejected the step

Example: john.doe@example.com
createdinteger · int64Required

Created is the unix timestamp at which the resource was originally created in milliseconds.

Example: 8422866544782249000
statusstringRequired

Status of the approval resource

Default: pendingExample: Illo non dicta qui ut sit adipisci.
updatedinteger · int64Required

Modified is the unix timestamp at which the resource was last modified in milliseconds.

Example: 5096406529158260000
get/api/orgs/{org}/projects/{project}/approvals/{id}
GET /api/orgs/{org}/projects/{project}/approvals/{id} HTTP/1.1
Host: localhost:80
Harness-Account: wp
Accept: */*

{
  "actioned_by": "John Doe",
  "actioned_by_email": "john.doe@example.com",
  "created": 7972994791850198000,
  "status": "Ut eveniet id aperiam.",
  "updated": 8636171398764903000
}

Update approval

put

Update a single approval

Path parameters
orgstring · min: 1 · max: 128Required

Org is the organisation identifier.

Example: i6y
projectstring · min: 1 · max: 128Required

Project is the project identifier.

Example: kr
idstring · uuidRequiredExample: fa47a692-322d-47f8-9aba-414749c5fb03
Header parameters
Harness-Accountstring · min: 1 · max: 128Required

Account is the internal customer account ID.

Example: f
Body
actioned_bystringOptional

User that approved/rejected the step

Example: John Doe
actioned_by_emailstringOptional

Email of the user that approved/rejected the step

Example: john.doe@example.com
statusstring · enumRequired

Status update to be performed upon the Approval step

Default: pendingExample: pendingPossible values:
Responses
200

OK response.

No content
put/api/orgs/{org}/projects/{project}/approvals/{id}
PUT /api/orgs/{org}/projects/{project}/approvals/{id} HTTP/1.1
Host: localhost:80
Harness-Account: f
Content-Type: application/json
Accept: */*
Content-Length: 89

{
  "actioned_by": "John Doe",
  "actioned_by_email": "john.doe@example.com",
  "status": "approved"
}
No content
NextCcm Costs

Last updated

Was this helpful?