Skip to content

Set version description

PUT
/v1/ns/{nsid}/config/{version}/description
curl --request PUT \
--url https://example.com/v1/ns/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/config/example/description \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "description": "example" }'
nsid
required
string format: uuid

Namespace UUID

version
required
string

Config version: ULID, ‘latest’, ‘running’, or a tag name

Media typeapplication/json
object
description
required
string
<= 4096 characters
Examplegenerated
{
"description": "example"
}

Description set

Error response

Media typeapplication/problem+json

RFC 7807 Problem Details

object
type

Problem type slug URI

string
title
string
status
integer
detail
string
key
additional properties
any
Examplegenerated
{
"type": "example",
"title": "example",
"status": 1,
"detail": "example"
}