Skip to content

putNamespaceVariable

PUT
/api/v1/namespaces/{namespace}/variables/{key}
curl --request PUT \
--url https://example.com/api/v1/namespaces/example/variables/example \
--header 'Content-Type: application/json' \
--data '{ "value": "example" }'
namespace
required
string
<= 128 characters /^[a-z0-9]([a-z0-9-]*[a-z0-9])?(\.[a-z0-9]([a-z0-9-]*[a-z0-9])?)*$/
key
required
string
/^[A-Za-z_][A-Za-z0-9_]{0,127}$/
Media typeapplication/json
object
value
required
string
<= 65536 characters
key
additional properties
any
Examplegenerated
{
"value": "example"
}

OK

Media typeapplication/json
object
inherited
required

True when a parent namespace or the global scope defines the variable.

boolean
key
required
string
scope
required

Global or the namespace name that defines the variable.

string
updated_at
required
string format: date-time
updated_by
required
string
value
required
string
key
additional properties
any
Examplegenerated
{
"inherited": true,
"key": "example",
"scope": "example",
"updated_at": "2026-04-15T12:00:00Z",
"updated_by": "example",
"value": "example"
}

Error

Media typeapplication/json
object
error
required
object
code
required
string
details
message
required
string
key
additional properties
any
key
additional properties
any
Examplegenerated
{
"error": {
"code": "example",
"details": "example",
"message": "example"
}
}