# List site domains

List a website's custom hostnames, certificate status and required DNS configuration.

POST https://api.brigg.app/v1/operations/domains.ListSiteDomains

## Access & visibility

Allow `domains.ListSiteDomains` on your API key.

**Acting member required.** Send `Brigg-Act-As` with an [approved member account ID](https://developer.brigg.app/authentication#member-delegation). The key supplies permissions; the member selects whose data is used.

The selected member must be active and approved by the credential. This selects whose private data is used; the credential supplies permissions. Private ownership and project boundaries still apply.

[Set up authentication](https://developer.brigg.app/authentication) · [Choose permissions](https://developer.brigg.app/permissions)

## Request fields

Send a JSON object with the following fields. Required fields must be included; omit optional fields you do not need.
| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `bundle_id` | string | Yes | Select a website and use its content_id. This is the website identity, not a domain hostname or workspace ID. [workspace.ListBundles](https://developer.brigg.app/reference/workspace/ListBundles). At least 1 character. |

## Response

Returns **200 OK** with a JSON body.

This operation has no continuation cursor. An empty `items` array means no matching visible results were returned.
| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `items` | array of [Website domain](#website-domain-response-items) | Yes | Custom domains attached to the selected website. This operation has no cursor pagination. |
| `target` | string or null | Yes | DNS target hostname for this alias. |

### Website domain · response.items[]

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `host` | string | Yes | Custom hostname attached to this website. |
| `cert_status` | string | Yes | TLS certificate provisioning state. It does not independently verify the site's current reachability. |
| `validation_name` | null or string | Yes | DNS validation record name to create, or null when no validation record is needed. |
| `validation_value` | null or string | Yes | DNS value for validation_name, or null when no validation record is needed. |
| `last_error` | null or string | Yes | Latest recorded domain provisioning error, or null when none is recorded. |
| `created_at` | number | Yes | Time the hostname was attached, in Unix milliseconds. |
| `issued_at` | null or number | Yes | Time its certificate was issued, in Unix milliseconds; null before issuance. |

## Errors & retries

This operation reads data. It needs no idempotency key and can be retried after a transient failure.

For rate limits, follow the server’s retry guidance and back off. See [HTTP errors](https://developer.brigg.app/http#errors) and [safe retries and limits](https://developer.brigg.app/reliability).

| HTTP status | Code | What to do |
| --- | --- | --- |
| 400 | `invalid_json` | Send a JSON object with Content-Type: application/json. |
| 400 | `invalid_input` | Check the request fields and types. |
| 401 | `invalid_key` | The workspace API key is missing, invalid or revoked. |
| 403 | `forbidden` | Check the key’s operation and resource grants. Supply Brigg-Act-As with a member authorized by the key’s delegation grant. The selected member must be active and approved by the credential. This selects whose private data is used; the credential supplies permissions. Private ownership and project boundaries still apply. |
| 404 | `not_found` | The requested operation or resource is not available to this credential. |
| 429 | `rate_limited` | Wait for Retry-After before retrying. |

## Next steps

- [List bundles](https://developer.brigg.app/reference/workspace/ListBundles)

[Download OpenAPI](https://developer.brigg.app/openapi.json) · [Versioning & retirement](https://developer.brigg.app/versioning)

## Examples

### Example request

Fictional values. Replace IDs and business details with values from your workspace.
#### cURL


```sh
curl 'https://api.brigg.app/v1/operations/domains.ListSiteDomains' \
  -H "Authorization: Bearer $BRIGG_API_KEY" \
  -H 'Content-Type: application/json' \
  -H "Brigg-Act-As: $BRIGG_ACT_AS" \
  --data-raw '{
  "bundle_id": "e_example"
}'
```

#### TypeScript


```typescript
const actAs = process.env.BRIGG_ACT_AS;
if (!actAs) throw new Error("Set BRIGG_ACT_AS to an approved member account ID.");

const response = await fetch("https://api.brigg.app/v1/operations/domains.ListSiteDomains", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.BRIGG_API_KEY}`,
    "Content-Type": "application/json",
    "Brigg-Act-As": actAs,
  },
  body: JSON.stringify({
    "bundle_id": "e_example"
  }),
});
const result = await response.json();
if (!response.ok) throw new Error(`${response.status}: ${result.error} — ${result.message}`);
console.log(result);
```

#### Python


```python
import json
import os
from urllib.request import Request, urlopen
from urllib.error import HTTPError

payload = {
  "bundle_id": "e_example"
}
request = Request(
    "https://api.brigg.app/v1/operations/domains.ListSiteDomains",
    data=json.dumps(payload).encode("utf-8"),
    headers={
        "Authorization": f"Bearer {os.environ['BRIGG_API_KEY']}",
        "Content-Type": "application/json",
        "Brigg-Act-As": os.environ["BRIGG_ACT_AS"],
    },
    method="POST",
)
try:
    with urlopen(request) as response:
        print(json.load(response))
except HTTPError as error:
    print(error.code, json.load(error))
    raise
```

#### Response example


```json
{
  "items": [
    {
      "host": "www.example.com",
      "cert_status": "issued",
      "validation_name": null,
      "validation_value": null,
      "last_error": null,
      "created_at": 1,
      "issued_at": null
    }
  ],
  "target": "sites.example.net"
}
```

## JSON schemas


```json-schema-request
{
  "type": "object",
  "properties": {
    "bundle_id": {
      "type": "string",
      "minLength": 1,
      "description": "Select a website and use its content_id. This is the website identity, not a domain hostname or workspace ID. [workspace.ListBundles](https://developer.brigg.app/reference/workspace/ListBundles)."
    }
  },
  "required": [
    "bundle_id"
  ],
  "additionalProperties": false,
  "examples": [
    {
      "bundle_id": "e_example"
    }
  ]
}
```


```json-schema-response
{
  "type": "object",
  "properties": {
    "items": {
      "type": "array",
      "items": {
        "title": "Website domain",
        "type": "object",
        "properties": {
          "host": {
            "type": "string",
            "description": "Custom hostname attached to this website.",
            "examples": [
              "www.example.com"
            ]
          },
          "cert_status": {
            "type": "string",
            "description": "TLS certificate provisioning state. It does not independently verify the site's current reachability.",
            "examples": [
              "issued"
            ]
          },
          "validation_name": {
            "anyOf": [
              {
                "type": "null"
              },
              {
                "type": "string"
              }
            ],
            "description": "DNS validation record name to create, or null when no validation record is needed.",
            "examples": [
              null
            ]
          },
          "validation_value": {
            "anyOf": [
              {
                "type": "null"
              },
              {
                "type": "string"
              }
            ],
            "description": "DNS value for validation_name, or null when no validation record is needed.",
            "examples": [
              null
            ]
          },
          "last_error": {
            "anyOf": [
              {
                "type": "null"
              },
              {
                "type": "string"
              }
            ],
            "description": "Latest recorded domain provisioning error, or null when none is recorded.",
            "examples": [
              null
            ]
          },
          "created_at": {
            "type": "number",
            "description": "Time the hostname was attached, in Unix milliseconds."
          },
          "issued_at": {
            "anyOf": [
              {
                "type": "null"
              },
              {
                "type": "number"
              }
            ],
            "description": "Time its certificate was issued, in Unix milliseconds; null before issuance."
          }
        },
        "required": [
          "host",
          "cert_status",
          "validation_name",
          "validation_value",
          "last_error",
          "created_at",
          "issued_at"
        ],
        "additionalProperties": false
      },
      "description": "Custom domains attached to the selected website. This operation has no cursor pagination."
    },
    "target": {
      "type": [
        "string",
        "null"
      ],
      "description": "DNS target hostname for this alias."
    }
  },
  "required": [
    "items",
    "target"
  ],
  "additionalProperties": false,
  "examples": [
    {
      "items": [
        {
          "host": "www.example.com",
          "cert_status": "issued",
          "validation_name": null,
          "validation_value": null,
          "last_error": null,
          "created_at": 1,
          "issued_at": null
        }
      ],
      "target": "sites.example.net"
    }
  ]
}
```