APIs

Promote Revision

Changed on

Promote a draft revision to published, archiving the current one.

If the draft declares different server hosts than the API's current (or last live) revision, or serves a host over plaintext http that was https-only, and the API has credentials bound to agents, the caller also needs credentials:write; otherwise the promote is refused with 403 host_change_requires_operator.

post/apis/{vendor}/{name}/{version}/revisions/{revision_id}:promote

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /apis/{vendor}/{name}/{version}/revisions/{revision_id}:promote
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL /authorize, token URL /oauth/token)

Path parameters

vendorstring required

Vendor of the API.

Example:stripe.com
namestring required

Name of the API.

Example:stripe
versionstring required

Version of the API.

Example:2024-04-10
revision_idstring required

ID of the API revision.

Example:3f2b8c1e-7d4a-4e9b-a6c5-1d2e3f4a5b6c

Response

Successful Response

unknown required

Changes