Skip to content
StratumStratum Docs

List a project's DNS health checks.

GET
/v1/projects/{projectId}/dns/health-checks
Code sample: Shell / cURL
curl --request GET \
  --url https://stratum.example.com/v1/projects/example/dns/health-checks \
  --header 'Authorization: Bearer <token>'

Health checks (Slice D) drive the failover and health-filtered weighted routing policies. The list omits the prober result snapshot; GET a single check to see it.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
projectId
required
string
/^p-[a-z0-9-]+$/

Responses

Section titled “Responses”

200

Section titled “200”

The project’s health checks.

Media typeapplication/json
object
items
required
Array<object>
object
id
required
integer format: int64
projectId
required
string
region
string
name
required
string
protocol
required
string
Allowed values: tcp http https
address
required

IPv4/IPv6 literal or hostname to probe.

string
port
required
integer
path

HTTP/HTTPS request path.

string
expectedStatus

HTTP status to treat as healthy; 0 = any 2xx.

integer
intervalSeconds
integer
timeoutSeconds
integer
failureThreshold
integer
successThreshold
integer
enabled
required
boolean
createdAt
string format: date-time
updatedAt
string format: date-time
result

Latest prober snapshot; absent until the check has been probed.

object
healthy
required
boolean
lastProbeAt
required
string format: date-time
lastChangeAt
required
string format: date-time
consecutiveSuccesses
required
integer
consecutiveFailures
required
integer
lastError
string
nullable

Example 

{
  "items": [
    {
      "protocol": "tcp"
    }
  ]
}