# Add site domain

Connect a custom hostname to a published website and begin certificate setup. The domain owner must add the required DNS records.

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

## Access & visibility

Allow `domains.AddSiteDomain` 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. |
| `hostname` | string | Yes | A hostname the customer controls the DNS of (www.acme.no). At least 1 character. At most 253 characters. |

## Response

Returns **200 OK** with a JSON body.
| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `item` | null or [object](#addsitedomainitem-response-item) | Yes | The custom hostname as listed on the bundle, or null when the row could not be read back after the insert. |

### AddSiteDomainItem · response.item

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `host` | string | Yes | Custom hostname connected to the website. |
| `cert_status` | string | Yes | Current certificate provisioning state. |
| `validation_name` | null or string | Yes | DNS name required to validate certificate ownership, when validation is pending. |
| `validation_value` | null or string | Yes | DNS value required to validate certificate ownership, when validation is pending. |
| `last_error` | null or string | Yes | Most recent setup failure, or null when none is recorded. |
| `created_at` | number | Yes | Time this domain configuration was created, in Unix milliseconds. |
| `issued_at` | null or number | Yes | Time the certificate was issued, in Unix milliseconds. |

## Errors & retries

Set `BRIGG_REQUEST_ID` once for each logical action. The samples send it as `Idempotency-Key`. Reuse the same value and body on retries, including after a timeout; a missing response does not prove the action failed.

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. Supply a stable Idempotency-Key containing 1–200 characters. |
| 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. Reuse the original Idempotency-Key. |

## 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.AddSiteDomain' \
  -H "Authorization: Bearer $BRIGG_API_KEY" \
  -H 'Content-Type: application/json' \
  -H "Brigg-Act-As: $BRIGG_ACT_AS" \
  -H "Idempotency-Key: $BRIGG_REQUEST_ID" \
  --data-raw '{
  "bundle_id": "e_example",
  "hostname": "www.example.com"
}'
```

#### 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 requestId = process.env.BRIGG_REQUEST_ID;
if (!requestId) throw new Error("Set BRIGG_REQUEST_ID once per action and reuse it on retries.");

const response = await fetch("https://api.brigg.app/v1/operations/domains.AddSiteDomain", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.BRIGG_API_KEY}`,
    "Content-Type": "application/json",
    "Brigg-Act-As": actAs,
    "Idempotency-Key": requestId, // Create once per action; reuse on retries.
  },
  body: JSON.stringify({
    "bundle_id": "e_example",
    "hostname": "www.example.com"
  }),
});
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

request_id = os.environ["BRIGG_REQUEST_ID"]  # Reuse for retries of this action.
payload = {
  "bundle_id": "e_example",
  "hostname": "www.example.com"
}
request = Request(
    "https://api.brigg.app/v1/operations/domains.AddSiteDomain",
    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"],
        "Idempotency-Key": request_id,  # Create once per action; reuse on retries.
    },
    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
{
  "item": null
}
```

## 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)."
    },
    "hostname": {
      "type": "string",
      "minLength": 1,
      "maxLength": 253,
      "description": "A hostname the customer controls the DNS of (www.acme.no)."
    }
  },
  "required": [
    "bundle_id",
    "hostname"
  ],
  "additionalProperties": false,
  "examples": [
    {
      "bundle_id": "e_example",
      "hostname": "www.example.com"
    }
  ]
}
```


```json-schema-response
{
  "type": "object",
  "properties": {
    "item": {
      "description": "The custom hostname as listed on the bundle, or null when the row could not be read back after the insert.",
      "title": "AddSiteDomainItem",
      "anyOf": [
        {
          "type": "null"
        },
        {
          "type": "object",
          "properties": {
            "host": {
              "type": "string",
              "description": "Custom hostname connected to the website."
            },
            "cert_status": {
              "type": "string",
              "description": "Current certificate provisioning state."
            },
            "validation_name": {
              "anyOf": [
                {
                  "type": "null"
                },
                {
                  "type": "string"
                }
              ],
              "description": "DNS name required to validate certificate ownership, when validation is pending."
            },
            "validation_value": {
              "anyOf": [
                {
                  "type": "null"
                },
                {
                  "type": "string"
                }
              ],
              "description": "DNS value required to validate certificate ownership, when validation is pending."
            },
            "last_error": {
              "anyOf": [
                {
                  "type": "null"
                },
                {
                  "type": "string"
                }
              ],
              "description": "Most recent setup failure, or null when none is recorded."
            },
            "created_at": {
              "type": "number",
              "description": "Time this domain configuration was created, in Unix milliseconds."
            },
            "issued_at": {
              "anyOf": [
                {
                  "type": "null"
                },
                {
                  "type": "number"
                }
              ],
              "description": "Time the certificate was issued, in Unix milliseconds."
            }
          },
          "required": [
            "host",
            "cert_status",
            "validation_name",
            "validation_value",
            "last_error",
            "created_at",
            "issued_at"
          ],
          "additionalProperties": false
        }
      ]
    }
  },
  "required": [
    "item"
  ],
  "additionalProperties": false,
  "examples": [
    {
      "item": null
    }
  ]
}
```