Skip to main content
POST
Deprecate stack profile version

Authorizations

ankra_session
string
cookie
required

Browser session. Mutations also require X-Ankra-CSRF.

Headers

X-Ankra-CSRF
string
required

Path Parameters

profile_id
string<uuid>
required
version
integer
required

Body

application/json
reason
enum<string>
required

Why the version must not be deployed any more.

Available options:
incompatibility,
critical_bug,
cve
note
string | null

Free text shown to anyone who tries to deploy the version, for example which version fixes the problem.

Maximum string length: 2000
references
string[]

CVE identifiers or advisory URLs the deprecation relates to.

Maximum array length: 20
Maximum string length: 200

Response

Profile version deprecated

id
string<uuid>
required
version
integer
required
channel
string
required
changelog
string | null
required
created_by_user_id
string | null
required
created_at
string<date-time>
required
deprecation
StackProfileVersionDeprecation · object | null
required

The withdrawal notice; null while the version is deployable.