PRprimitive
Functions

Suspend a function

Stop the function from running by suspending its key. Its code, bindings and secrets stay stored; reaffirmFunctionRuntimeKey brings it back as it was. A stop an owner or admin places (suspended_by owner_or_admin) records their role, is lifted only in a dashboard session by someone whose role is at least that one (an owner's stop, only an owner), and replaces any stop but an owner's or admin's of at least that role, an access decision's included: keeping that decision on the waiting list then leaves the function stopped.

post/functions/{id}/runtime-key/suspend

Request

  • Base URL
    https://api.primitive.dev/v1
  • URL
    https://api.primitive.dev/v1/functions/{id}/runtime-key/suspend
  • Auth
    HTTP bearer

Path parameters

idstring uuid required

The function id.

Headers

Idempotency-Keystring

Optional client-supplied idempotency key. Retrying a request with the same key returns the original result instead of performing the action a second time; if omitted the server derives one from the canonical payload hash. Safe to retry network failures without duplicating side effects.

Request body

reason'owner_action' | 'emergency_revoke'

Response

Suspend a function

successtrue required

Changes

No operation changes recorded.