Operation details
Read platform system settings
- operationId
getPlatformSystemSettings- Auth
- Session: the Bearer session of a signed-in control plane user, used by the customer in their own control plane; a plugin must never ask for it.
- Required permissions
All of：system_configuration.read
Responses
getPlatformSystemSettings Responses| Status | Description |
|---|
200 | Current settings Fields：schema: const cdnca.platform-system-settings/v1 revision: integer updated_at?: string(date-time) value: Settings |
|---|
401 | Unauthenticated |
|---|
403 | Permission denied |
|---|
500 | Unexpected internal failure |
|---|
503 | Settings storage or policy is unavailable |
|---|
What to do on failure
401 Check the credential format and whether it expired or was rotated.403 Check the key scopes, the owner’s current permissions and the tenant scope; never switch to a more privileged account.500 Outcome unknown: read back by ID or list first, then decide whether to retry with the original Idempotency-Key.503 A dependency is unavailable: retry later with the original Idempotency-Key.
↑ Back to list
Update platform system settings
- operationId
updatePlatformSystemSettings- Auth
- Session: the Bearer session of a signed-in control plane user, used by the customer in their own control plane; a plugin must never ask for it.
- Required permissions
All of：system_configuration.manage
Parameters
updatePlatformSystemSettings Parameters| Name | In | Type | Required | Description |
|---|
If-Match | header | string | Yes | — |
|---|
Idempotency-Key | header | string | Yes | — |
|---|
X-Request-ID | header | string | Yes | — |
|---|
Request body
application/json · Required：Yes
updatePlatformSystemSettings Request body| Name | Type | Required | Description |
|---|
value | Settings | Yes | — |
|---|
Responses
updatePlatformSystemSettings Responses| Status | Description |
|---|
200 | Saved document Fields：schema: const cdnca.platform-system-settings/v1 revision: integer updated_at?: string(date-time) value: Settings |
|---|
400 | Validation error |
|---|
401 | Unauthenticated |
|---|
403 | Permission denied |
|---|
409 | Revision or idempotency conflict |
|---|
500 | Unexpected internal failure |
|---|
503 | Settings storage or policy is unavailable |
|---|
What to do on failure
400 Fix the parameters or body per the field list; do not retry unchanged.401 Check the credential format and whether it expired or was rotated.403 Check the key scopes, the owner’s current permissions and the tenant scope; never switch to a more privileged account.409 Read the current state first; a retry of the same operation keeps the original Idempotency-Key and body.500 Outcome unknown: read back by ID or list first, then decide whether to retry with the original Idempotency-Key.503 A dependency is unavailable: retry later with the original Idempotency-Key.
↑ Back to list