Sign in
Durable Functions

Approve a durable approval

Changed on

Approves a pending approval. The workflow resumes with the decision.

Only a person can decide: use the dashboard or a platform token from volcano login. Project access tokens are refused with 403.

Approving an approval that is already approved returns it unchanged. If the workflow cannot be reached right away, the decision still stands and Volcano keeps delivering it.

post/projects/{id}/durable-approvals/{approvalId}/approve

Request

  • Base URL: https://api.volcano.dev
  • URL: https://api.volcano.dev/projects/{id}/durable-approvals/{approvalId}/approve
  • Auth: HTTP bearer

Path parameters

idstring uuid required

Project ID

approvalIdstring uuid required

Durable approval ID

Request body

commentstring

A note for the workflow and the approval's history.

Response

Approved

idstring uuid required
status'pending' | 'approved' | 'denied' | 'expired' | 'cancelled' required

pending means the workflow is waiting for a decision. approved and denied are decisions a person made. expired means the workflow's approval timeout passed first, and cancelled means the execution ended while the approval was still pending. Every status but pending is final.

namestring required

The name the workflow gave the approval in ctx.waitForApproval.

titlestring required
descriptionstring required
detailsunknown
requested_atstring date-time required
expires_atstring date-time nullable required

When the approval expires if nobody decides. Null when the workflow set no timeout; the approval then lasts as long as its execution.

Changes