Sign in
Durable Functions

Get a durable approval

Changed on

Returns one approval: what the workflow asked, the durable function and execution that asked it, its deadline, and the decision once one is made.

Project access tokens can read approvals, including read-only ones.

get/projects/{id}/durable-approvals/{approvalId}

Request

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

Path parameters

idstring uuid required

Project ID

approvalIdstring uuid required

Durable approval ID

Response

Successful response

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