RUAL Documentation

GET /_system/system_key_value/{guid}

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

Get a system configuration key-value pair (secure values are obscured)
Key Type Example Description
guid required string
"example-string"
Unique identifier (GUID)
Key Type Example Description
authorization required string
"Bearer access_token"
Access token
{ "_meta": { "guid": "example-string", "entity": 42, "removed": 42, "created": 42, "updated": 42, "ums": 42, "cms": 42, "expiry": 42, "update_hash": "example-string" }, "label": "example-string", "value": "example-string", "key": "example-string", "is_secure": true }
{ "error": "INVALID_ACCESS_TOKEN", "code": 401 }
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