Skip to content

Apply config version

POST
/v1/ns/{nsid}/config/{version}/apply
curl --request POST \
--url https://example.com/v1/ns/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/config/example/apply \
--header 'Authorization: Bearer <token>'

Promotes the given version to the namespace’s running config — the version the call path uses. Returns the new running version and the one it replaced.

By default the target must be a descendant of the current running version and must match the running config schema version; otherwise the call fails with not-descendant or schema-version-mismatch (both 409). Add ?force=true (or the X-Force: true header) to bypass the descendancy check.

nsid
required
string format: uuid

Namespace UUID

version
required
string

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

force
boolean

Bypass the descendancy check when promoting.

Applied

Media typeapplication/json
object
success
required
boolean
running_version
required
string
previous_version
required
string
Examplegenerated
{
"success": true,
"running_version": "example",
"previous_version": "example"
}

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"
}