# Add a custom domain to an app

- **OpenAPI Version:** `3.2.0`
- **API Version:** `3.1.0`
- **Contact:** Syndai <https://syndai.ai>

## Contents

**Operations**

- [POST /api/v1/external/coding/customers/{customer\_id}/apps/{publication\_id}/domain](#scalar-operation-post-apiv1externalcodingcustomerscustomer-idappspublication-iddomain)

**Schemas**

- [DomainAddRequest](#scalar-schema-domainaddrequest)
- [DomainRead](#scalar-schema-domainread)
- [DnsRecordRead](#scalar-schema-dnsrecordread)
- [ProblemDetail](#scalar-schema-problemdetail)
- [ExternalErrorCode](#scalar-schema-externalerrorcode)

<a id="scalar-context-global-servers"></a>

## Servers

- **URL:** `https://api.syndai.ai`

<a id="scalar-context-global-authentication"></a>

## Authentication

- **CustomerApiKey**: HTTP bearer (`API Key`)

  Customer API key sent as a bearer token

## Tags

### Apps

Beta: may change without notice. Publishing a repository as a hosted app: publish, unpublish, read and update a publication, its deployments, custom domain, runtime and monthly AI limit, and export its data or waitlist.

## Operations

<a id="scalar-operation-post-apiv1externalcodingcustomerscustomer-idappspublication-iddomain"></a>

### Add a custom domain to an app

- **Method:** `POST`
- **Path:** `/api/v1/external/coding/customers/{customer_id}/apps/{publication_id}/domain`
- **Operation ID:** `addAppDomain`
- **Tags:** Apps

Attach `hostname` (pasted URLs and bare domains are accepted: `bakery.com` becomes `www.bakery.com`). One address per site; the same address again is a no-op and a failed one is retried. Refusals: `invalid_hostname`, `reserved_hostname`, `domain_exists` (remove the current one first), `hostname_taken` (another site in this workspace), `hostname_in_use` (a site in this workspace's SEO tab), `hostname_contested` (another workspace has the address or removed it in the last 30 days: the problem's `records` name the TXT `_syndai.<address>` that proves it is this workspace's, to add at the DNS host (`dns_provider` / `dns_url` say where); once DNS answers it, adding again takes the address over). Refusals are 409 or 422 with that `code`; 503 `domains_not_configured`, 502 `cloudflare_unavailable`. Needs `coding:apps:publish`.

**Servers:** [Inherited servers](#scalar-context-global-servers)

**Authentication:** [Global authentication](#scalar-context-global-authentication)

#### Path parameters

- **`customer_id` (required)**: `string`, format: `uuid`
- **`publication_id` (required)**: `string`, format: `uuid`

#### Request body

**Required:** `true`

**Content type:** `application/json`

[DomainAddRequest](#scalar-schema-domainaddrequest)

<a id="scalar-example-1"></a>

**Generated example:**

```json
{
  "hostname": ""
}
```

#### Responses

##### 200 Request fulfilled, document follows

**Content type:** `application/json`

[DomainRead](#scalar-schema-domainread)

<a id="scalar-example-2"></a>

**Generated example:**

```json
{
  "delete_records": [
    {
      "name": "",
      "type": "",
      "value": ""
    }
  ],
  "dns_provider": "",
  "dns_url": "",
  "domain_connect_url": "",
  "hostname": "",
  "records": [
    {
      "name": "",
      "type": "",
      "value": ""
    }
  ],
  "status": ""
}
```

##### 400, 401, 403, 404

- `400` Bad request syntax or unsupported method
- `401` Invalid or missing customer API key
- `403` Insufficient scope or forbidden customer access
- `404` Resource not found

**Content type:** `application/problem+json`

[ProblemDetail](#scalar-schema-problemdetail)

RFC 7807 problem detail returned for public CaaS errors.

<a id="scalar-example-3"></a>

**Generated example:**

```json
{
  "code": "BUDGET_EXHAUSTED",
  "detail": null,
  "existing_run_id": null,
  "instance": null,
  "status": 1,
  "title": "",
  "type": "about:blank",
  "additionalProperty": "anything"
}
```

##### 429 Rate limit exceeded

**Headers:**

- **`Retry-After`**

  Seconds to wait before retrying the request

  `integer`

**Content type:** `application/problem+json`

[ProblemDetail](#scalar-schema-problemdetail)

RFC 7807 problem detail returned for public CaaS errors.

[Generated example](#scalar-example-3)

##### default Unexpected error

**Content type:** `application/problem+json`

[ProblemDetail](#scalar-schema-problemdetail)

<a id="scalar-example-4"></a>

**Generated example:**

```json
null
```

## Schemas

<a id="scalar-schema-domainaddrequest"></a>

### DomainAddRequest

**Type:** `object`

- **`hostname` (required)**: `string`

<a id="scalar-example-5"></a>

**Generated example:**

```json
{
  "hostname": ""
}
```

<a id="scalar-schema-domainread"></a>

### DomainRead

**Type:** `object`

- **`records` (required)**: array of [DnsRecordRead](#scalar-schema-dnsrecordread)
- **`status` (required)**: `string`
- **`delete_records`**: array of [DnsRecordRead](#scalar-schema-dnsrecordread)
- **`dns_provider`**: `string | null`
- **`dns_url`**: `string | null`
- **`domain_connect_url`**: `string | null`
- **`hostname`**: `string | null`

<a id="scalar-example-6"></a>

**Generated example:**

```json
{
  "delete_records": [
    {
      "name": "",
      "type": "",
      "value": ""
    }
  ],
  "dns_provider": "",
  "dns_url": "",
  "domain_connect_url": "",
  "hostname": "",
  "records": [
    {
      "name": "",
      "type": "",
      "value": ""
    }
  ],
  "status": ""
}
```

<a id="scalar-schema-dnsrecordread"></a>

### DnsRecordRead

**Type:** `object`

- **`name` (required)**: `string`
- **`type` (required)**: `string`
- **`value` (required)**: `string`

<a id="scalar-example-7"></a>

**Generated example:**

```json
{
  "name": "",
  "type": "",
  "value": ""
}
```

<a id="scalar-schema-problemdetail"></a>

### ProblemDetail

**Type:** `object`

RFC 7807 problem detail returned for public CaaS errors.

- **`code` (required)**: `string`, possible values: `"BUDGET_EXHAUSTED", "QUOTA_EXCEEDED", "RUN_CONCURRENCY_LIMIT", "CUSTOMER_DISABLED", "REPO_NOT_BOUND", "IDEMPOTENCY_REPLAY", "CONFLICT", "MISSION_BUSY_RETRY", "HITL_REQUEST_CONFLICT", "HITL_REQUEST_SETTLED", "RUN_TERMINATED_BEFORE_RESPONSE", "INVALID_POLICY", "INVALID_SCOPE", "RATE_LIMITED", "INSTALLATION_INCOMPLETE", "SUBSCRIPTION_USAGE_UNAVAILABLE", "INVALID_TOKEN", "ROLE_REQUIRED", "PLAN_UPGRADE_REQUIRED", "EMAIL_MISMATCH", "EXPIRED_TOKEN", "NOT_FOUND", "OVERSCOPE_ACK_REQUIRED", "VERIFY_FAILED", "PUBLISH_IN_FLIGHT", "PUBLISH_UNSUPPORTED_REPO", "PUBLICATION_NOT_LIVE", "NO_APP_DATA", "FEATURE_REQUESTS_NEEDS_MEMBERS", "EMPTY_UPDATE", "BAD_CURSOR", "HUMAN_APPROVAL_REQUIRED", "PROTECTED_PATHS_MANAGED_ONLY", "RUN_IN_FLIGHT", "TEXT_EDIT_REFUSED", "CLI_UPGRADE_REQUIRED", "PRODUCTION_STEP_UP_REQUIRED", "PRICES_UPDATING", "GITHUB_UNAVAILABLE", "PUBLISH_NOT_SET_UP", "VERSION_NOT_DEPLOYED", "INTERNAL_ERROR"`

  Stable error codes surfaced to public CaaS clients.
- **`status` (required)**: `integer`
- **`title` (required)**: `string`
- **`detail`**: `string | null`, default: `null`
- **`existing_run_id`**: `string | null`, default: `null`
- **`instance`**: `string | null`, default: `null`
- **`type`**: `string`, default: `"about:blank"`

<a id="scalar-example-8"></a>

**Generated example:**

```json
{
  "code": "BUDGET_EXHAUSTED",
  "detail": null,
  "existing_run_id": null,
  "instance": null,
  "status": 1,
  "title": "",
  "type": "about:blank",
  "additionalProperty": "anything"
}
```

<a id="scalar-schema-externalerrorcode"></a>

### ExternalErrorCode

**Type:** `string`, possible values: `"BUDGET_EXHAUSTED", "QUOTA_EXCEEDED", "RUN_CONCURRENCY_LIMIT", "CUSTOMER_DISABLED", "REPO_NOT_BOUND", "IDEMPOTENCY_REPLAY", "CONFLICT", "MISSION_BUSY_RETRY", "HITL_REQUEST_CONFLICT", "HITL_REQUEST_SETTLED", "RUN_TERMINATED_BEFORE_RESPONSE", "INVALID_POLICY", "INVALID_SCOPE", "RATE_LIMITED", "INSTALLATION_INCOMPLETE", "SUBSCRIPTION_USAGE_UNAVAILABLE", "INVALID_TOKEN", "ROLE_REQUIRED", "PLAN_UPGRADE_REQUIRED", "EMAIL_MISMATCH", "EXPIRED_TOKEN", "NOT_FOUND", "OVERSCOPE_ACK_REQUIRED", "VERIFY_FAILED", "PUBLISH_IN_FLIGHT", "PUBLISH_UNSUPPORTED_REPO", "PUBLICATION_NOT_LIVE", "NO_APP_DATA", "FEATURE_REQUESTS_NEEDS_MEMBERS", "EMPTY_UPDATE", "BAD_CURSOR", "HUMAN_APPROVAL_REQUIRED", "PROTECTED_PATHS_MANAGED_ONLY", "RUN_IN_FLIGHT", "TEXT_EDIT_REFUSED", "CLI_UPGRADE_REQUIRED", "PRODUCTION_STEP_UP_REQUIRED", "PRICES_UPDATING", "GITHUB_UNAVAILABLE", "PUBLISH_NOT_SET_UP", "VERSION_NOT_DEPLOYED", "INTERNAL_ERROR"`

Stable error codes surfaced to public CaaS clients.