Operation details
POST /v1/probe-dnspup/plugin/requests
Start one probe with the platform's dnspup key pair and quota
- operationId
createProbeDNSPupPluginRequest- Auth
- API key: header Authorization: CdncaKey <key_id>.<secret>. Effective permissions are the key scopes intersected with the owner’s current permissions.
- Required permissions
All of：probes.dnspup.request
Parameters
createProbeDNSPupPluginRequest Parameters| Name | In | Type | Required | Description |
|---|
Idempotency-Key | header | string | Yes | — |
|---|
Request body
application/json · Required：Yes
createProbeDNSPupPluginRequest Request body| Name | Type | Required | Description |
|---|
type | string: tcping / ping / http / https / dns | Yes | — |
|---|
target | string | Yes | public IP / domain; http(s): URL with that scheme |
|---|
port | integer | No | tcping only |
|---|
method | string: GET / HEAD | No | — |
|---|
record | string: A / AAAA / CNAME / MX / NS / TXT | No | — |
|---|
expect | array<string> | No | dns: at least one answer must match |
|---|
ip_version | string: 4 / 6 | No | — |
|---|
selection | Selection | No | — |
|---|
Responses
createProbeDNSPupPluginRequest Responses| Status | Description |
|---|
202 | Started Fields：id: string(uuid) status: string: pending / completed / failed type: string target: string error_code?: string created_at: string(date-time) traces?: any results: array<object> |
|---|
400 | Error envelope |
|---|
401 | Error envelope |
|---|
403 | Error envelope |
|---|
409 | Error envelope |
|---|
422 | Error envelope |
|---|
429 | Error envelope |
|---|
503 | Error envelope |
|---|
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.429 Rate limited: wait, then retry with lower concurrency.503 A dependency is unavailable: retry later with the original Idempotency-Key.
↑ Back to list
GET /v1/probe-dnspup/plugin/requests/{id}
Read a probe this installation started (Retry-After while pending)
- operationId
getProbeDNSPupPluginRequest- Auth
- API key: header Authorization: CdncaKey <key_id>.<secret>. Effective permissions are the key scopes intersected with the owner’s current permissions.
- Required permissions
All of：probes.dnspup.request
Parameters
getProbeDNSPupPluginRequest Parameters| Name | In | Type | Required | Description |
|---|
id | path | string(uuid) | Yes | — |
|---|
Responses
getProbeDNSPupPluginRequest Responses| Status | Description |
|---|
200 | Probe Fields：id: string(uuid) status: string: pending / completed / failed type: string target: string error_code?: string created_at: string(date-time) traces?: any results: array<object> |
|---|
401 | Error envelope |
|---|
403 | Error envelope |
|---|
404 | Error envelope |
|---|
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.404 The resource does not exist or belongs to another tenant.
↑ Back to list
GET /v1/probe-dnspup/plugin/status
Whether the plugin can probe now (not metered)
- operationId
getProbeDNSPupPluginStatus- Auth
- API key: header Authorization: CdncaKey <key_id>.<secret>. Effective permissions are the key scopes intersected with the owner’s current permissions.
- Required permissions
All of：probes.dnspup.request
Responses
getProbeDNSPupPluginStatus Responses| Status | Description |
|---|
200 | Status Fields：available: boolean reason?: string: probe_dnspup_not_installed / probe_dnspup_not_configured / probe_dnspup_paused / probe_dnspup_quota_exceeded paused_until?: string(date-time) per_minute: integer tenant_monthly: integer used_this_month: integer |
|---|
401 | Error envelope |
|---|
403 | Error envelope |
|---|
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.
↑ Back to list