Operation details
Read the DoH service settings
- operationId
getPlatformDoHSettings- 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
getPlatformDoHSettings Responses| Status | Description |
|---|
200 | Current settings Fields：schema: string revision: integer(int64) value: Settings host_site_id: string(uuid) | null(uuid) token_set: boolean token_created_at: string(date-time) | null(date-time) token?: string nodes_in_range: integer nodes_declaring: integer updated_at: string(date-time) |
|---|
401 | Unauthenticated |
|---|
403 | Permission denied |
|---|
500 | Unexpected internal failure |
|---|
503 | Settings storage 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 the DoH service settings
- operationId
updatePlatformDoHSettings- 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
updatePlatformDoHSettings Parameters| Name | In | Type | Required | Description |
|---|
If-Match | header | string | Yes | — |
|---|
X-Request-ID | header | string | No | — |
|---|
Request body
application/json · Required：Yes
updatePlatformDoHSettings Request body| Name | Type | Required | Description |
|---|
value | Settings | Yes | — |
|---|
rotate_token | boolean | No | Generate a new access token; required when an auth mode is chosen and none exists. |
|---|
Responses
updatePlatformDoHSettings Responses| Status | Description |
|---|
200 | Saved settings Fields：schema: string revision: integer(int64) value: Settings host_site_id: string(uuid) | null(uuid) token_set: boolean token_created_at: string(date-time) | null(date-time) token?: string nodes_in_range: integer nodes_declaring: integer updated_at: string(date-time) |
|---|
400 | Validation error or invalid If-Match |
|---|
401 | Unauthenticated |
|---|
403 | Permission denied |
|---|
409 | Revision conflict |
|---|
500 | Unexpected internal failure |
|---|
503 | Settings storage 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