Skip to content

Live effective configuration with secret-bearing values redacted

GET
/v1/console/config/effective
curl --request GET \
--url https://example.com/v1/console/config/effective \
--header 'Authorization: Bearer <token>'

Returns the live effective configuration of the deployment with every secret-bearing value redacted.

OK

Media type application/json
object
entries
required
Array<object>
object
key
required
string
redacted
required
boolean
source
required
string
Allowed values: env activation
value
required
string
strict_violations
required
Array<string>
Example
{
"entries": [
{
"source": "env"
}
]
}

Bad request

Media type application/json
object
error
required
object
code
required
string
message
required
string
Example generated
{
"error": {
"code": "example",
"message": "example"
}
}

Unauthenticated

Media type application/json
object
error
required
object
code
required
string
message
required
string
Example generated
{
"error": {
"code": "example",
"message": "example"
}
}

Forbidden

Media type application/json
object
error
required
object
code
required
string
message
required
string
Example generated
{
"error": {
"code": "example",
"message": "example"
}
}

Not found

Media type application/json
object
error
required
object
code
required
string
message
required
string
Example generated
{
"error": {
"code": "example",
"message": "example"
}
}

Conflict / setup required

Media type application/json
object
error
required
object
code
required
string
message
required
string
Example generated
{
"error": {
"code": "example",
"message": "example"
}
}

Rate limited

Media type application/json
object
error
required
object
code
required
string
message
required
string
Example generated
{
"error": {
"code": "example",
"message": "example"
}
}