Skip to main content
POST
Deprecate a procedure version
Deprecates an active version, with a reason of at least 8 characters for the audit trail, as Console’s deprecate action does. Workflows that pin it keep running, and authors are warned to upgrade. The change goes through the procedure lifecycle, which records the deprecated event and the procedure_deprecated audit. A version that is not active is 409 invalid_state.

Who may deprecate

You need procedures:manage at the version’s home org unit; a missing version and one out of reach are the same 404 resource_missing. A Personal key acts as its owner; an External App or platform key acts as itself.

Idempotency

With an Idempotency-Key, a same-key repeat within 24 hours returns the recorded result only while you still hold procedures:manage at the version’s home; otherwise 409 idempotency_result_unavailable.

Authorizations

Authorization
string
header
required

An External App: the JWT it obtains from POST /oauth/token with OAuth2 client_credentials. Pass as Authorization: Bearer <jwt>. An app's static companion key also authenticates as the app, but is deprecated and is not protected by Idempotency-Key.

Headers

Idempotency-Key
string

Optional logical intent key. A same-key retry within 24 hours returns the recorded result without writing again.

Required string length: 1 - 255

Path Parameters

procedureId
string
required

The procedure family's id (its slug).

Minimum string length: 1

Body

application/json
version
string
required

The semver version.

Minimum string length: 1
reason
string
required

Why, for the audit trail: at least 8 characters.

Response

Success

data
object
required
meta
object
required