Skip to main content
POST
Retire a published version

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

name
string
required

The API's name.

Pattern: ^[a-z][a-z0-9_]{1,62}$
version
string
required

A version number, or 'draft'.

Pattern: ^(\d{1,6}|draft)$

Response

Successful Response

version
integer
required
status
enum<string>
required

A version's lifecycle. Only draft can be edited.

Available options:
draft,
published,
retired
created_at
string<date-time>
required
context_hash
string | null
created_by
string | null
published_by
string | null
published_at
string<date-time> | null
retired_at
string<date-time> | null