Skip to content

List all service config sections

GET
/api/v1/service-config
curl --request GET \
--url https://example.com/api/v1/service-config \
--header 'Authorization: <Authorization>'

Returns all service configuration sections across all services.

OK

Media typeapplication/json
Array<object>
object
createdAt
string
deletedAt
object
time
string
valid

Valid is true if Time is not NULL

boolean
editable
boolean
environmentID
integer
id
integer
info
string
name
string
overrides

Overrides is a JSON array of the top-level fields an operator pinned in this section. Only pinned fields beat flags, environment variables and YAML at startup; every other field follows the process.

Empty is meaningful and depends on Source:

  • source=yaml: nothing is pinned.
  • source=db: a row written before pins existed (or replaced wholesale through the API), so EVERY field is pinned. That is the only reading that cannot silently drop an operator’s edit, since the original YAML is gone once a row is overwritten.
string
service
string
source

“yaml” or “db”

string
type

Always “json” for now

string
updatedAt
string
value
string
Examplegenerated
[
{
"createdAt": "example",
"deletedAt": {
"time": "example",
"valid": true
},
"editable": true,
"environmentID": 1,
"id": 1,
"info": "example",
"name": "example",
"overrides": "example",
"service": "example",
"source": "example",
"type": "example",
"updatedAt": "example",
"value": "example"
}
]

Unauthorized

Media typeapplication/json
object
code
string
error
string
Examplegenerated
{
"code": "example",
"error": "example"
}

Forbidden

Media typeapplication/json
object
code
string
error
string
Examplegenerated
{
"code": "example",
"error": "example"
}

Internal server error

Media typeapplication/json
object
code
string
error
string
Examplegenerated
{
"code": "example",
"error": "example"
}