Skip to main content
POST
Request repository review of a procedure version
This opens a pull request in the procedure repository, an effect outside Forge, for people to review.
Submits a provisional version’s draft source files for repository review, as Console does. A version that already has a pull request is not submitted again: scheduled is false. While repository execution is off for the deployment the answer is 409 conflict; for a version that is not provisional or has no draft source files it is 409 invalid_state.

Who may request review

You need procedures:approve at the version’s home; a missing version and one out of reach are the same 404 resource_missing. It is an approve permission: a Personal key carries it only when its owner opts in, an External App only by an explicit grant, and a Forge agent never.

Idempotency

With an Idempotency-Key, a same-key repeat within 24 hours returns the recorded result only while you still hold procedures:approve 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

Response

Success

data
object
required

scheduled: false when the version already has a pull request; otherwise a repository pull request is opened for review.

meta
object
required