Get domain diagnostics

Returns what public DNS currently answers for the hostname, the records still to set, and certificate state. diagnostics is absent when no check reported a problem.

GET /v1/domains/{domainId}/diagnostics

Authorization

Authorization Bearer token · header required

Authorization: Bearer <token>

with an API key (sfa_ prefix), an OAuth access token, a session token, or a Space machine credential (sfm_ prefix).

or

Authorization OAuth2 access token · header required

OAuth 2.0 with Spacefast scopes. People use the authorization code flow; machines use client credentials.

Scopes: domains:read

Path parameters

• domainId string required

Responses

200 Response for status 200

{
  "$schema": "string",
  "data": {
    "domainId": "string",
    "hostname": "string",
    "diagnostics": [
      {
        "code": "string",
        "severity": "info",
        "message": "string",
        "path": "string",
        "provider": "string",
        "details": {
          "property1": null,
          "property2": null
        },
        "fix": "string",
        "retryable": true
      }
    ],
    "hostnameDiagnostics": [
      {
        "hostname": "string",
        "purpose": "apex",
        "isConfiguredHostname": true,
        "providerIps": [],
        "verificationCode": "string",
        "dnsInstructions": [],
        "dns": {
          "observedAt": "2019-08-24T14:15:22Z",
          "expectedTxtValue": "string",
          "pointsToProvider": true,
          "proxyDetected": true,
          "txtVerified": true,
          "hasAaaaRecords": true,
          "hasCaaRecords": true,
          "records": {
            "a": [],
            "aaaa": [],
            "caa": [],
            "cname": [],
            "mx": [],
            "txt": []
          },
          "byResolver": []
        },
        "ssl": {
          "status": "missing",
          "canRetry": true,
          "certificateId": "string",
          "validationExpiration": "string",
          "authzUri": "string",
          "brokenRecord": {
            "reason": "string",
            "lastError": "string",
            "retryDate": "string",
            "failCount": -9007199254740991
          }
        }
      }
    ]
  }
}

Error response

{
  "$schema": "string",
  "type": "string",
  "title": "string",
  "status": -9007199254740991,
  "detail": "string",
  "code": "string",
  "pointer": "string",
  "details": {
    "property1": null,
    "property2": null
  },
  "suggestions": [
    "string"
  ],
  "next": [
    "string"
  ],
  "requestId": "string"
}