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 | |
---|---|---|---|
:guid required | string |
"example-guid"
|
Key | Type | Example | |
---|---|---|---|
authorization required | string |
"Bearer your-jwt-token"
|
{
"_meta": {
"guid": "example-string",
"entity": "example-value",
"created": "example-value",
"modified": "example-value",
"updated": "example-value"
},
"label": "database_host",
"value": "example-value",
"is_secure": false,
"description": "example-string",
"category": "database"
}
{
"success": false,
"error": "HTTP_401",
"message": "Error response"
}
Error Code | Description |
---|---|
HTTP_401 | HTTP 401 error |
HTTP_404 | Key-value pair not found |
permission | description |
---|---|
BearerAuth |
JWT access token obtained from login endpoint required |
Back to System Key-Value Return to the System Key-Value category to view other endpoints All API Categories Browse all available API categories