Get App Settings All

GET 
/config/v1/kv

deprecated

DEPRECATED Please use /v2/kv instead.

If authenticated and with correct permissions, will return all KVs. Otherwise it will only return non secret KVs.

Request

Query Parameters

keys_to_include any

If specified, will only return the KVs with the specified keys

Header Parameters

if-none-match any

If you provide the ETag that matches the current ETag for this content, will return a 304 response - indicating that the content has not changed.

if-match any

If you provide the ETag that matches the current ETag for this content, will return a 412 response - indicating that the content has changed.

Responses

200

Successful Response

Response Headers

• ETag

  string

  Used to identify this version of the content. Provide with a get request to avoid downloading the same data multiple times.

application/json

Schema

Schema

kvs

object[]

The list of key/value pairs

Array [

key Key (string)required

The key for the setting

value Value (string)required

The value for the setting

notes

object

Notes to describe the key value pair

anyOf

MOD1

string

]

secret_kvs

object[]

The list of secret key/value pairs

Array [

key Key (string)required

The key for the setting

value Value (string)required

The value for the setting

notes

object

Notes to describe the key value pair

anyOf

MOD1

string

]

Example (from schema)

{
  "kvs": [
    {
      "key": "string",
      "value": "string",
      "notes": "string"
    }
  ],
  "secret_kvs": [
    {
      "key": "string",
      "value": "string",
      "notes": "string"
    }
  ]
}

304

Content still has the same etag and has not changed

412

Content has changed since the ETag was provided

422

Validation Error

application/json

Schema

Schema

detail

object[]

Array [

loc

object[]

required

Array [

anyOf

MOD1

string

MOD2

integer

]

msg Message (string)required

type Error Type (string)required

]

Example (from schema)

{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Loading...