# Connect a domain

URL: https://heaven.dev/docs/reference/domains/connect
Updated: 2026-11-21

Connect a domain to your organization so it can assign website names under that domain. The response includes the wildcard DNS record to set at your DNS provider.

`POST /v1/organization/domain/create`

## Parameters

- `domain` (string, required): The parent domain to connect to your organization, such as example.com.
- `who` (string): Who can assign names under this domain. Use `admins`, `owners` for people who own a Computer, or a team name or ID. Defaults to `admins` for a new domain.
- `organization` (string): Organization name or ID. A credential, named resource or sole membership can select the organization for you.

## Returns

- `data` (object, always present): An organization's domain connection and setup or disconnection effects.
  - `disconnected` (boolean): Whether the domain connection was removed. May be omitted.
  - `name` (string, always present): Domain whose connection changed.
  - `removed` (string[]): Names removed from Computers by disconnecting the domain. May be omitted.
  - `setup` (object): Required DNS records and the current check. May be omitted.
    - `certificate` (object): Certificate check for a configured name whose DNS is correct. May be omitted.
      - `message` (string, always present): An explanation of the certificate check.
      - `state` (string, always present): Whether the certificate is ready or still needs attention.
    - `code` (string): First problem that needs correction. May be omitted.
    - `computer` (string): Organization's Computer currently using this name. May be omitted.
    - `domain` (string, always present): Registrable domain containing the name.
    - `kind` (string, always present): Whether the check concerns an ordinary name, root domain or wildcard.
    - `message` (string): What to change to make the name work. May be omitted.
    - `name` (string, always present): Full name being checked.
    - `one_click_url` (string): A provider page that can add the required records, when supported. May be omitted.
    - `optional` (object[]): Suggested additional records, such as a root domain's www name. May be omitted.
      - `items` (object): One DNS record needed for routing or ownership proof.
        - `found` (string): What DNS returned when it differed from the expected value. May be omitted.
        - `name` (string, always present): DNS name where the record belongs.
        - `one_click_url` (string): DNS provider's page for adding this record, when available. May be omitted.
        - `purpose` (string, always present): Whether the record establishes routing or proves ownership.
        - `state` (string, always present): DNS-check result. `proxied` requires turning off Cloudflare's proxy for this record.
        - `type` (string, always present): DNS record type to create.
        - `value` (string, always present): Value the record should contain.
    - `proof` (string): How ownership was proved, such as a CNAME or TXT record. May be omitted.
    - `provider` (object): Detected DNS provider and where to edit its records. May be omitted.
      - `id` (string, always present): Provider identifier.
      - `name` (string, always present): Provider's display name.
      - `records_url` (string): Provider page for editing DNS records. May be omitted.
      - `root_record` (string): Provider's supported record form for a root domain. May be omitted.
    - `proxied` (boolean): Whether Cloudflare's proxy is in front of the name. May be omitted.
    - `records` (object[] | null, always present): Required DNS records and what the check found.
      - `items` (object): One DNS record needed for routing or ownership proof.
        - `found` (string): What DNS returned when it differed from the expected value. May be omitted.
        - `name` (string, always present): DNS name where the record belongs.
        - `one_click_url` (string): DNS provider's page for adding this record, when available. May be omitted.
        - `purpose` (string, always present): Whether the record establishes routing or proves ownership.
        - `state` (string, always present): DNS-check result. `proxied` requires turning off Cloudflare's proxy for this record.
        - `type` (string, always present): DNS record type to create.
        - `value` (string, always present): Value the record should contain.
    - `state` (string, always present): Overall DNS-check result.
    - `target` (string, always present): Organization's DNS destination.
    - `whole` (boolean): Whether the parent domain's DNS already routes this name. May be omitted.
  - `team` (string): Permitted team, when limited to a team. May be omitted.
  - `who` (string): Who is permitted to assign names under the domain. May be omitted.
  - `whole` (boolean, always present): Whether DNS directs all names under the domain to the organization.

## Errors

Each code is explained in full at https://heaven.dev/docs/reference/errors.

| Code | Status | What happened |
|---|---:|---|
| `invalid` | 400 | An input is missing or invalid. |
| `unauthenticated` | 401 | The credential is missing, invalid, expired or revoked. |
| `denied` | 403 | The caller lacks permission for this action. |
| `not_found` | 404 | The resource is absent or inaccessible to this caller. |
| `conflict` | 409 | The request conflicts with the current resource state or an earlier request. |
| `over_capacity` | 409 | The request exceeds a resource or credential allowance. |
| `access_list_full` | 409 | The change would exceed the access-list allowance. |
| `payment_required` | 402 | Payment or credit is required. |
| `rate_limited` | 429 | The caller's request rate exceeds its limit. |
| `busy` | 429 | Too much work is in progress to accept this request. |
| `unknown` | 503 | The outcome is unconfirmed; a change may have happened. |
| `unavailable` | 503 | The service or requested feature is unavailable. |

## Notes

- API key permission: `domain connect`.

## Examples

```sh tab="heaven CLI"
heaven domain connect DOMAIN
  [--who owners|admins|TEAM]
  [--organization ORGANIZATION]
```

```sh tab="SSH"
ssh cli@heaven.dev domain connect DOMAIN
  [--who owners|admins|TEAM]
  [--organization ORGANIZATION]
```

```sh tab="cURL"
curl https://heaven.dev/v1/organization/domain/create \
  -H "Authorization: Bearer $HEAVEN_API_KEY" \
  --json '{"domain": "example.com", "who": "admins"}'
```

```json tab="MCP"
{ "tool": "domain_connect",
  "arguments": { "domain": "example.com", "who": "admins" } }
```

Response:

```json title="Response excerpt"
{
  "version": 1,
  "data": {
    "name": "example.com",
    "setup": {
      "code": "no_records",
      "domain": "example.com",
      "kind": "wildcard",
      "message": "*.example.com has no record yet. Add a CNAME for *.example.com to b5c0a80b9864.domains.heaven.dev. DNS changes can take a few minutes to appear.",
      "name": "*.example.com",
      "provider": {
        "id": "cloudflare",
        "name": "Cloudflare",
        "records_url": "https://dash.cloudflare.com/?to=/:account/example.com/dns/records",
        "root_record": "CNAME"
      },
      "records": [
        {
          "name": "*.example.com",
          "purpose": "route",
          "state": "missing",
          "type": "CNAME",
          "value": "b5c0a80b9864.domains.heaven.dev"
        }
      ],
      "state": "waiting",
      "target": "b5c0a80b9864.domains.heaven.dev"
    },
    "who": "admins",
    "whole": false
  }
}
```
