API reference

Operator - Approvals

One tag: method, path, summary, auth, and scopes. Request and response fields ship in this page — expand a row to read the contract.

Browse docs

Endpoints

GET

/api/v1/operator/approval_requests Web Session

List approval requests

Description

Returns pending approval requests for the current workspace.

Auth

Web Session

Responses

200

List of approval requests

Returns: ApprovalRequestList

Example

{
  "approval_requests": [
    {
      "id": "a2b3c4d5-e6f7-4890-abcd-ef1234567890",
      "inserted_at": "2026-03-25T10:00:00Z",
      "payload": {
        "action": "deploy",
        "target": "production"
      },
      "request_type": "gateway_execute",
      "service_agent_id": "f4d49601-3477-4c9d-b896-ac08a26a3147",
      "status": "pending",
      "updated_at": "2026-03-25T10:00:00Z",
      "workspace_id": "4ce4d170-e6d5-4118-8f4d-fac69dc099ea"
    }
  ]
}

GET

/api/v1/operator/approval_requests/:id Web Session

Get approval request details

Description

Returns details of a specific approval request.

Auth

Web Session

Parameters

Name	In	Type	Required	Description
id	path	string	Yes	Approval request UUID

Responses

200

Approval request details

Returns: ApprovalRequest

Example

{
  "id": "a2b3c4d5-e6f7-4890-abcd-ef1234567890",
  "inserted_at": "2026-03-25T10:00:00Z",
  "payload": {
    "action": "deploy",
    "target": "production"
  },
  "request_type": "gateway_execute",
  "service_agent_id": "f4d49601-3477-4c9d-b896-ac08a26a3147",
  "status": "pending",
  "updated_at": "2026-03-25T10:00:00Z",
  "workspace_id": "4ce4d170-e6d5-4118-8f4d-fac69dc099ea"
}

404

Approval request not found

POST

/api/v1/operator/approval_requests/:id/decide Web Session

Approve or deny request

Description

Makes a decision on an approval request.

Auth

Web Session

Request Body

Field	Type	Required	Description
notes	string	No	Optional notes for the decision
decision	string (approved, rejected)	Yes	Decision

Parameters

Name	In	Type	Required	Description
id	path	string	Yes	Approval request UUID

Responses

200

Decision recorded

Returns: ApprovalRequest

Example

{
  "id": "a2b3c4d5-e6f7-4890-abcd-ef1234567890",
  "inserted_at": "2026-03-25T10:00:00Z",
  "payload": {
    "action": "deploy",
    "target": "production"
  },
  "request_type": "gateway_execute",
  "service_agent_id": "f4d49601-3477-4c9d-b896-ac08a26a3147",
  "status": "approved",
  "updated_at": "2026-03-25T10:00:00Z",
  "workspace_id": "4ce4d170-e6d5-4118-8f4d-fac69dc099ea"
}

404

Approval request not found