Coelevate Documentation
API ReferenceContext Repository

Retire a kit

Retires the kit.

DELETE /context/v1/kits/{kit_id}

Retires the kit. Every version stays readable and the retirement is one more entry in the kit's journal. A kit that has moved since base_version is a 409 kit_moved.

Requires the context:kits scope.

Parameters

ParameterLocationRequiredDescription
kit_idpathyesThe kit's id.
base_versionqueryyesThe kit version you read.

Responses

StatusMeaning
204The request succeeded.
401The token is missing, expired or invalid.
403The token does not carry the scope this operation requires.
404No such project, or the token belongs to a different project.
422The request was not valid: a parameter or the body failed validation.

Example

curl -sS -X DELETE "$API_URL/context/v1/kits/$KIT_ID?base_version=$BASE_VERSION" \
  -H "Authorization: Bearer $TOKEN"