Operation Approvals

3 operations.

Method	Endpoint	Description
GET	/api/v1/operation-approvals	List operation approvals
GET	/api/v1/operation-approvals/{approvalId}	Get an operation approval
PATCH	/api/v1/operation-approvals/{approvalId}	Decide an operation approval

List operation approvals

GET/api/v1/operation-approvals

List operation approvals awaiting or recording a decision.

Parameters

query

Name	Type	Required	Description
projectId	string	optional	Filters results to the specified Project. Applies to List operation approvals.
environmentId	string	optional	Selects the active Project environment coordinate. Applies to List operation approvals.
agentId	string	optional	Selects the Project Agent by its stable identifier. Applies to List operation approvals.
status	"pending" \| "approved" \| "rejected" \| "consumed"	optional	Filters results to the requested status. Applies to List operation approvals.
limit	integer	optional	Sets the maximum number of resources returned in this page. Applies to List operation approvals.
cursor	string	optional	Opaque cursor returned by the previous page; omit it to read the first page. Applies to List operation approvals.

Responses

Status	Description	Body
200	Response for status 200	application/json object `operationApprovals` (required): array<object> `pagination` (required): object
400	Bad Request	application/json PublicApiError `error` (required): object
401	Authentication failed. Possible reasons: - Authorization header is not provided - Invalid API key - Session expired	application/json PublicApiError `error` (required): object
403	Access denied. The authenticated user does not have permission to perform this action.	application/json PublicApiError `error` (required): object
404	Resource not found.	application/json PublicApiError `error` (required): object
422	Request validation failed. Check the request body, query parameters, or path parameters.	application/json PublicApiError `error` (required): object
500	The server could not complete the request.	application/json PublicApiError `error` (required): object

Get an operation approval

GET/api/v1/operation-approvals/{approvalId}

Get one operation approval in the caller's authorized Agent scope.

Parameters

path

Name	Type	Required	Description
approvalId	string	required	Identifies the operation approval being decided. Applies to Get an operation approval.

Responses

Status	Description	Body
200	Response for status 200	application/json object `type` (required): "operationApproval" `id` (required): string `invocationId` (required): string `agentRunId` (required): one of 2 types `organizationId` (required): string `projectId` (required): string `environmentId` (required): string `agentId` (required): string `definitionId` (required): string `definitionRevisionId` (optional): string `operationName` (required): string `renderedSummary` (optional): one of 2 types `requestedByUserId` (required): one of 2 types `status` (required): "pending" \| "approved" \| "rejected" \| "consumed" `decidedByUserId` (required): one of 2 types `decidedAt` (required): one of 2 types `consumedAt` (required): one of 2 types `requestedAt` (required): string `createdAt` (required): string `statusVersion` (required): integer
400	Bad Request	application/json PublicApiError `error` (required): object
401	Authentication failed. Possible reasons: - Authorization header is not provided - Invalid API key - Session expired	application/json PublicApiError `error` (required): object
403	Access denied. The authenticated user does not have permission to perform this action.	application/json PublicApiError `error` (required): object
404	Resource not found.	application/json PublicApiError `error` (required): object
422	Request validation failed. Check the request body, query parameters, or path parameters.	application/json PublicApiError `error` (required): object
500	The server could not complete the request.	application/json PublicApiError `error` (required): object

Decide an operation approval

PATCH/api/v1/operation-approvals/{approvalId}

Approve or reject a pending operation approval exactly once. For AgentRun approvals, either decision durably schedules the server-owned resume; clients cannot submit a privileged resume signal.

Parameters

path

Name	Type	Required	Description
approvalId	string	required	Identifies the operation approval being decided. Applies to Decide an operation approval.

Request body

required — Request body for: Decide an operation approval.

application/json

Alternative 1

Name	Type	Required	Description
status	"approved"	required

Alternative 2

Name	Type	Required	Description
status	"rejected"	required

Responses

Status	Description	Body
200	Response for status 200	application/json object `type` (required): "operationApproval" `id` (required): string `invocationId` (required): string `agentRunId` (required): one of 2 types `organizationId` (required): string `projectId` (required): string `environmentId` (required): string `agentId` (required): string `definitionId` (required): string `definitionRevisionId` (optional): string `operationName` (required): string `renderedSummary` (optional): one of 2 types `requestedByUserId` (required): one of 2 types `status` (required): "pending" \| "approved" \| "rejected" \| "consumed" `decidedByUserId` (required): one of 2 types `decidedAt` (required): one of 2 types `consumedAt` (required): one of 2 types `requestedAt` (required): string `createdAt` (required): string `statusVersion` (required): integer
400	Bad Request	application/json PublicApiError `error` (required): object
401	Authentication failed. Possible reasons: - Authorization header is not provided - Invalid API key - Session expired	application/json PublicApiError `error` (required): object
403	Access denied. The authenticated user does not have permission to perform this action.	application/json PublicApiError `error` (required): object
404	Resource not found.	application/json PublicApiError `error` (required): object
409	Request conflicts with current state of the resource, including safe deployment conflict classifications.	application/json PublicApiError `error` (required): object
422	Request validation failed. Check the request body, query parameters, or path parameters.	application/json PublicApiError `error` (required): object
500	The server could not complete the request.	application/json PublicApiError `error` (required): object