# Domain

> The Domain object in the Guv API.

## Fields

| Field | Type | Description |
| --- | --- | --- |
| `id` * | string |  |
| `hostname` * | string |  |
| `kind` * | `generated`, `custom` |  |
| `environment_id` * | string |  |
| `service_id` * | string |  |
| `status` * | [DomainStatus](/docs/api/objects/domain-status/) |  |
| `status_text` | string |  |
| `apex` | boolean |  |
| `wildcard` | boolean |  |
| `dns_records` | array of [DnsRecord](/docs/api/objects/dns-record/) | Records the customer must create. |
| `registrar` | object or null | Detected registrar (RDAP), with step-by-step instructions. |
| `checks` | object |  |
| `certificate` | object or null |  |
| `caa_warning` | string or null | Set when CAA records exclude the CAs Guv uses. |
| `error` | object or null |  |
| `last_checked_at` | string (date-time) or null |  |
| `next_check_at` | string (date-time) or null |  |
| `orphaned_at` | string (date-time) or null |  |
| `release_at` | string (date-time) or null |  |
| `created_at` * | string (date-time) |  |

\* always present

## Example

```json
{
  "id": "dom_01jbx2m9k7q4r8t5v6w3y0z1dm",
  "hostname": "www.primecarers.co.uk",
  "kind": "custom",
  "environment_id": "env_01jbx2m9k7q4r8t5v6w3y0z1en",
  "service_id": "svc_01jbx2m9k7q4r8t5v6w3y0z1sv",
  "status": "pending",
  "status_text": "Waiting for your DNS records. This usually takes a few minutes.",
  "apex": false,
  "wildcard": false,
  "dns_records": [
    {
      "type": "CNAME",
      "name": "www.primecarers.co.uk",
      "value": "prj-k7q4r8t5.edge.guv.run",
      "purpose": "routing",
      "status": "missing",
      "observed": []
    },
    {
      "type": "TXT",
      "name": "_guv-challenge.www.primecarers.co.uk",
      "value": "guv-verify=8f3a2c1d9e7b6a5f",
      "purpose": "ownership",
      "status": "ok",
      "observed": [
        "guv-verify=8f3a2c1d9e7b6a5f"
      ]
    }
  ],
  "registrar": {
    "name": "123-reg",
    "instructions_url": "https://guv.dev/docs/domains/123-reg"
  },
  "checks": {
    "dns": "pending",
    "ownership": "ok",
    "certificate": "pending",
    "live": "pending"
  },
  "certificate": null,
  "caa_warning": null,
  "error": null,
  "last_checked_at": "2026-10-23T14:10:00Z",
  "next_check_at": "2026-10-23T14:11:00Z",
  "created_at": "2026-10-23T14:00:00Z"
}
```

## Used by

- [Add a custom domain](/docs/api/domains/#add-a-custom-domain)
- [Get a domain](/docs/api/domains/#get-a-domain)
- [Point a domain at a different service](/docs/api/domains/#point-a-domain-at-a-different-service)
- [Check DNS now](/docs/api/domains/#check-dns-now)