Get App Settings Server

GET 
/config/v1/app_settings/server

deprecated

DEPRECATED Please use /v2/kv instead.

Returns app settings that are configured to be available to the server.

Required Permissions: : config:app_settings:server:read

Request

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

• 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)

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

304

Content still has the same etag and has not changed

403

Error Codes:

• auth_invalid_key_id - Invalid Authorization - Invalid Key ID in Access Token

• auth_invalid_version - Invalid Authorization - version

• auth_malformed_access - Invalid Authorization - malformed access token

• auth_not_jwt - Invalid Authorization

• auth_token_expired - Token is expired

• auth_token_format - Invalid Authorization - {}

• auth_token_invalid_claim - Token contained invalid claim value: {}

• auth_token_invalid_type - Invalid Authorization - Invalid Token Type

• auth_token_sig_invalid - Token Signature is invalid

• auth_token_unknown - Failed to parse token

• insufficient_permissions - Insufficient Permissions

application/json

Schema

Schema

auth_success Auth Success (boolean)

Default value: true

error_code Error Code (string)required
desc Desc (string)required

Example (from schema)

{
  "auth_success": true,
  "error_code": "string",
  "desc": "string"
}

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...