APIs

List an API's revisions

Changed on

List every revision imported for an API, newest first.

Each revision gives its state (draft, published, imported or archived), whether it is_current (the one served), its source, spec digest, operation count and lifecycle timestamps, plus links to the actions valid in its state. Repeat state to filter by several states. Results are cursor-paginated: pass next_cursor as cursor while has_more is true. Fetch one revision with GET /apis/{vendor}/{name}/{version}/revisions/{revision_id}.

get/apis/{vendor}/{name}/{version}/revisions

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
  • 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

Query parameters

statestring[] nullable

Only return revisions in these states; repeat to match several.

[
  "published"
]
cursorstring nullable

Opaque cursor from a previous page's next_cursor; omit for the first page.

Example:eyJ0IjogIjIwMjYtMDEtMTVUMDk6MzA6MDArMDA6MDAiLCAiaWQiOiAiM2YyYjhjMWUtN2Q0YS00ZTliLWE2YzUtMWQyZTNmNGE1YjZjIn0=
limitinteger

Maximum number of revisions to return (1-200).

Example:25

Response

Successful Response

unknown required

Changes