GET /_system/system_key_value/{guid}

Get a system configuration key-value pair (secure values are obscured)

/_system/system_key_value/{guid}GET

Get a system configuration key-value pair (secure values are obscured)

Key	Type	Example	Description
guidrequired	`string`	`"example"`	Unique identifier (GUID)

Key	Type	Example	Description
authorizationrequired	`string`	`"Bearer access_token"`	Access token

{
  "_meta": {
    "cms": 1782166695813,
    "created": 1782166695,
    "entity": 1,
    "expiry": 3600,
    "guid": "a23575f49d0af385314c1f02280163374297e018a692e5e4ab85eb307ebf6ebc",
    "removed": 0,
    "ums": 1782166695813,
    "update_hash": "60e27209fa93063b5605e41605c2722ed428cae0",
    "updated": 1782166695
  },
  "is_secure": true,
  "key": "order_sync",
  "label": "Database host",
  "value": "enabled"
}

{
  "code": 401,
  "error": "INVALID_ACCESS_TOKEN"
}

Status	Error Code	Description
`401`	`INVALID_ACCESS_TOKEN`	Authentication required or invalid token
`404`	`ERROR`	Key-value pair not found

Permission	Description
`Bearer token`	Access token required via Authorization header, x-authtoken, x-token, query param, or cookie
`system_key_value_view`	Required scope: system_key_value_view

Back to System Key-Value Return to the System Key-Value category to view other endpoints All API Categories Browse all available API categories

Cluster

Blocks

Interfaces

Blueprints

Tutorials

Examples

Reference

Architecture

Troubleshooting

Other

GET /_system/system_key_value/{guid}