Operation details
POST /v1/admin/probe-dnspup/diagnoses
Run one mtr diagnosis (at most 2 checkpoints, metered as diagnose)
- operationId
createProbeDNSPupDiagnosis- 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.probe_dnspup.manage
Parameters
createProbeDNSPupDiagnosis Parameters| Name | In | Type | Required | Description |
|---|
Idempotency-Key | header | string | Yes | — |
|---|
Request body
application/json · Required：Yes
createProbeDNSPupDiagnosis Request body| Name | Type | Required | Description |
|---|
target | string | Yes | public IP or domain |
|---|
node_id | string(uuid) | No | — |
|---|
checkpoints | array<string> | Yes | — |
|---|
Responses
createProbeDNSPupDiagnosis 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> |
|---|
401 | Error envelope |
|---|
403 | Error envelope |
|---|
409 | Error envelope |
|---|
422 | Error envelope |
|---|
429 | Error envelope |
|---|
503 | 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.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/admin/probe-dnspup/diagnoses/{id}
Read a diagnosis (Retry-After while pending)
- operationId
getProbeDNSPupDiagnosis- 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.probe_dnspup.manage
Parameters
getProbeDNSPupDiagnosis Parameters| Name | In | Type | Required | Description |
|---|
id | path | string(uuid) | Yes | — |
|---|
Responses
getProbeDNSPupDiagnosis Responses| Status | Description |
|---|
200 | Diagnosis 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/admin/probe-dnspup/edge-subjects
CDN candidate hosts probed in the last day
- operationId
listProbeDNSPupEdgeSubjects- 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.probe_dnspup.manage
Responses
listProbeDNSPupEdgeSubjects Responses| Status | Description |
|---|
200 | Hosts Fields：items: array<string> |
|---|
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
GET /v1/admin/probe-dnspup/matrix
Area × carrier matrix and history of a node or a CDN candidate host
- operationId
getProbeDNSPupMatrix- 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.probe_dnspup.manage
Parameters
getProbeDNSPupMatrix Parameters| Name | In | Type | Required | Description |
|---|
subject | query | string: node / edge | Yes | — |
|---|
id | query | string | Yes | node id, or the candidate host |
|---|
window | query | string: 1h / 6h / 24h / 7d | No | — |
|---|
Responses
getProbeDNSPupMatrix Responses| Status | Description |
|---|
200 | Matrix Fields：subject: string id: string window: string cells: array<object> series: array<object> |
|---|
401 | Error envelope |
|---|
403 | Error envelope |
|---|
422 | 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
GET /v1/admin/probe-dnspup/node-monitoring/overrides
Per node / line group overrides
- operationId
listProbeDNSPupNodeOverrides- 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.probe_dnspup.manage
Responses
listProbeDNSPupNodeOverrides Responses| Status | Description |
|---|
200 | Overrides Fields：items: array<Override> |
|---|
401 | Error envelope |
|---|
403 | Error envelope |
|---|
503 | 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.503 A dependency is unavailable: retry later with the original Idempotency-Key.
↑ Back to list
PUT /v1/admin/probe-dnspup/node-monitoring/overrides
Create or replace the override of a node or a line group
- operationId
putProbeDNSPupNodeOverride- 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.probe_dnspup.manage
Parameters
putProbeDNSPupNodeOverride Parameters| Name | In | Type | Required | Description |
|---|
Idempotency-Key | header | string | Yes | — |
|---|
Request body
application/json · Required：Yes
putProbeDNSPupNodeOverride Request body| Name | Type | Required | Description |
|---|
node_id | string(uuid) | No | — |
|---|
tenant_scope_id | string(uuid) | No | — |
|---|
line_group_id | string(uuid) | No | — |
|---|
probe_type | string: tcping / ping / http | No | — |
|---|
selection | Selection | No | — |
|---|
Responses
putProbeDNSPupNodeOverride Responses| Status | Description |
|---|
200 | Saved Fields：id: string(uuid) subject_kind: string: node / line_group node_id?: string(uuid) tenant_scope_id?: string(uuid) line_group_id?: string(uuid) subject_name: string subject_display_id?: integer probe_type?: string: tcping / ping / http / null | null: tcping / ping / http / null selection?: Selection | null revision: integer |
|---|
400 | Error envelope |
|---|
401 | Error envelope |
|---|
403 | Error envelope |
|---|
409 | Error envelope |
|---|
422 | 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.
↑ Back to list
DELETE /v1/admin/probe-dnspup/node-monitoring/overrides/{id}
Delete an override
- operationId
deleteProbeDNSPupNodeOverride- 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.probe_dnspup.manage
Parameters
deleteProbeDNSPupNodeOverride Parameters| Name | In | Type | Required | Description |
|---|
Idempotency-Key | header | string | Yes | — |
|---|
id | path | string(uuid) | Yes | — |
|---|
Responses
deleteProbeDNSPupNodeOverride Responses| Status | Description |
|---|
204 | Deleted |
|---|
401 | Error envelope |
|---|
403 | Error envelope |
|---|
404 | Error envelope |
|---|
409 | 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.409 Read the current state first; a retry of the same operation keeps the original Idempotency-Key and body.
↑ Back to list
GET /v1/admin/probe-dnspup/purposes
Probe purposes with usage, projection and budget gate
- operationId
getProbeDNSPupPurposes- 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.probe_dnspup.manage
Responses
getProbeDNSPupPurposes Responses| Status | Description |
|---|
200 | Purposes Fields：monthly_limit: integer monthly_used: integer projected_monthly: integer purposes: array<object> |
|---|
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
PUT /v1/admin/probe-dnspup/purposes
Change purposes (availability purposes cannot be disabled)
- operationId
putProbeDNSPupPurposes- 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.probe_dnspup.manage
Parameters
putProbeDNSPupPurposes Parameters| Name | In | Type | Required | Description |
|---|
Idempotency-Key | header | string | Yes | — |
|---|
Request body
application/json · Required：Yes
putProbeDNSPupPurposes Request body| Name | Type | Required | Description |
|---|
purposes | array<object> | Yes | — |
|---|
Responses
putProbeDNSPupPurposes Responses| Status | Description |
|---|
200 | Saved Fields：monthly_limit: integer monthly_used: integer projected_monthly: integer purposes: array<object> |
|---|
400 | Error envelope |
|---|
401 | Error envelope |
|---|
403 | Error envelope |
|---|
409 | Error envelope |
|---|
422 | 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.
↑ Back to list