List domains - Spacefast Docs

List domains

Returns the domains the caller can access, newest first. Page with cursor. Pass teamId to limit the result to one team.

GET /v1/domains

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

Query parameters

Responses

200 Response for status 200

{
  "$schema": "string<uri>",
  "data": [
    {
      "id": "string",
      "name": "string",
      "unicodeName": "string",
      "kind": "hostname",
      "wildcardEnabled": true,
      "spaceId": "string",
      "primary": true,
      "redirect": {
        "to": {
          "url": "http://example.com"
        },
        "status": 301
      },
      "derivedGroup": "string",
      "registrar": {
        "provider": "string",
        "status": "active",
        "expiresAt": "string<date-time>",
        "redemptionEndsAt": "string<date-time>",
        "autoRenew": true,
        "transferLock": true
      },
      "dns": {
        "managementKind": "unmanaged_external",
        "dnsMode": "authoritative",
        "provider": "string",
        "assignedNameservers": [
          "string"
        ],
        "observedNameservers": [
          "string"
        ],
        "snapshot": {
          "freshness": "fresh",
          "lastFetchedAt": "string<date-time>",
          "version": "string"
        },
        "lastOperation": {
          "id": "string",
          "kind": "string",
          "status": "queued",
          "updatedAt": "string<date-time>"
        }
      },
      "verification": {
        "status": "not_required",
        "requiredRecords": [
          {
            "type": "A",
            "name": "string",
            "value": "string",
            "ttl": -9007199254740991,
            "purpose": "verification"
          }
        ],
        "lastCheckedAt": "string<date-time>",
        "lastVerifiedAt": "string<date-time>",
        "diagnostics": [
          {
            "code": "string",
            "severity": "info",
            "message": "string",
            "path": "string",
            "provider": "infra",
            "details": {
              "property1": null,
              "property2": null
            },
            "fix": "string",
            "retryable": true
          }
        ]
      },
      "hints": [
        {
          "id": "string",
          "code": "string",
          "severity": "info",
          "painLevel": "info",
          "subjectFacet": "dns_zone",
          "subjectRef": {
            "domainId": "string",
            "zoneId": "string",
            "bindingId": "string",
            "connectionId": "string"
          },
          "owner": "stattic",
          "status": "active",
          "summary": "string",
          "description": "string",
          "impact": "string",
          "evidence": [
            {
              "label": "string",
              "value": "string",
              "observedAt": "string<date-time>",
              "source": "provider_api"
            }
          ],
          "suggestions": [
            {
              "label": "string",
              "description": "string",
              "action": {
                "type": "open_pending_action",
                "actionId": "string"
              },
              "primary": true,
              "destructive": true
            }
          ],
          "docsUrl": "http://example.com",
          "operationId": "string",
          "requestId": "string",
          "providerRequestId": "string",
          "expiresAt": "string<date-time>"
        }
      ],
      "createdAt": "string<date-time>",
      "updatedAt": "string<date-time>"
    }
  ],
  "pagination": {
    "nextCursor": "string",
    "hasMore": true
  }
}