post/provisioning-requests/{requestId}/cancel

Request

  • Base URL: https://api.useanima.sh/v1
  • URL: https://api.useanima.sh/v1/provisioning-requests/{requestId}/cancel
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-Key

Path parameters

requestIdstring required

Provisioning request identifier

Request body

object required

Input for identifying a specific provisioning request

Response

OK

requestIdstring required

Unique provisioning request identifier

agentIdstring required

Agent the resource would belong to

agentNamestring required

Agent display name, so the owner knows who is asking

resource'VAULT' | 'PHONE_NUMBER' | 'GENERIC' required

Resource being requested: VAULT (encrypted secret storage for this agent), PHONE_NUMBER (a provisioned number, Starter+ only), or GENERIC (a master-gated operation the agent tried to perform; approving grants permission rather than provisioning anything).

reasonstring required

The agent's stated justification

status'PENDING' | 'APPROVED' | 'DECLINED' | 'EXPIRED' | 'CANCELLED' required

Lifecycle status: PENDING (awaiting the owner), APPROVED (resource provisioned), DECLINED (owner refused — soft, the agent may ask again), EXPIRED (7-day TTL elapsed unanswered), CANCELLED (withdrawn by the agent).

expiresAtstring date-time required

When an unanswered request stops being actionable

decidedAtstring date-time nullable required

When the owner decided; null while PENDING

decidedNotestring nullable required

The owner's note, typically the reason for a decline — surfaced so a second attempt can address the objection instead of repeating the first

provisionedIdstring nullable required

Id of what approval created (vault identity or phone identity); null unless APPROVED

createdAtstring date-time required

When the agent asked

Changes

No recorded changes to this operation across all 1 revision of this API.