Add resource custom domain
POST
/v1/servers/{serverId}/custom-domainHow to call this endpoint
Every ACP API request uses bearer authentication. The examples here show the actual request path, auth header, and body shape that the platform expects.
Path, query, and header parameters
These parameters control which ACP object the endpoint acts on and how the request is processed.
Path parameters
| Name | Location | Type | Required | Description |
|---|---|---|---|---|
| serverId | path | string | Yes | Resource ID |
Query parameters
None.
Body schema
Content type: application/json · Optional
| Field | Type | Required | Description |
|---|---|---|---|
| domain | string | Yes | Domain name to map to the deployed resource. |
| forceOverride | boolean | No | Reserved for provider-specific override behavior. |
What the API returns
Each response code below includes the documented payload shape for the ACP API.
200Custom domain mapping createdapplication/json
| Field | Type | Required | Description |
|---|---|---|---|
| server | object | No | — |
| server.id | string | No | Unique identifier. |
| server.userId | string | No | User ID. |
| server.organizationId | string | No | — |
| server.createdByUserId | string | No | — |
| server.projectId | string | No | Project ID. |
| server.name | string | No | Human-readable name. |
| server.description | string | No | Human-readable description. |
| server.kind | website | web_app | api | function | auth | agent_runtime | secrets | payments | No | — |
| server.sourceType | string | No | — |
| server.sourceEnvironmentId | string | No | — |
| server.sourcePath | string | No | Workspace-relative file path. |
| server.region | string | No | — |
| server.runtime | string | No | — |
| server.authMode | public | private | No | — |
| server.serviceUrl | string | No | — |
| server.customDomain | string | No | — |
| server.cloudRunServiceName | string | No | — |
| server.imageUrl | string | No | — |
| server.status | draft | deploying | deployed | failed | inactive | No | Current lifecycle status. |
| server.lastDeployedAt | string | No | — |
| server.metadata | object | No | Free-form metadata object. |
| server.createdAt | string | No | ISO 8601 timestamp. |
| server.updatedAt | string | No | ISO 8601 timestamp. |
| domain | object | No | — |
| domain.domain | string | No | — |
| domain.provider | string | No | — |
| domain.status | connected | needs_setup | pending_dns | pending | verification_required | No | Current lifecycle status. |
| domain.url | string | No | — |
| domain.mappedRouteName | string | No | — |
| domain.records | object[] | No | — |
| domain.records[].action | add | remove | none | No | — |
| domain.records[].type | string | No | — |
| domain.records[].name | string | No | Human-readable name. |
| domain.records[].value | string | No | — |
| domain.records[].source | string | No | — |
| domain.conditions | object[] | No | — |
| domain.conditions[].type | string | No | — |
| domain.conditions[].status | string | No | Current lifecycle status. |
| domain.conditions[].reason | string | No | — |
| domain.conditions[].message | string | No | Message text. |
| domain.lastCheckedAt | string | No | — |
| domain.verification | object | No | — |
| domain.verification.required | boolean | No | — |
| domain.verification.message | string | No | Message text. |
| domain.verification.searchConsoleUrl | string | No | — |
| domain.siteId | string | No | — |
| domain.hostState | string | No | — |
| domain.ownershipState | string | No | — |
| domain.certState | string | No | — |
| domain.dnsCheckTime | string | No | — |
| domains | object[] | No | — |
| domains[].domain | string | No | — |
| domains[].provider | string | No | — |
| domains[].status | connected | needs_setup | pending_dns | pending | verification_required | No | Current lifecycle status. |
| domains[].url | string | No | — |
| domains[].mappedRouteName | string | No | — |
| domains[].records | object[] | No | — |
| domains[].records[].action | add | remove | none | No | — |
| domains[].records[].type | string | No | — |
| domains[].records[].name | string | No | Human-readable name. |
| domains[].records[].value | string | No | — |
| domains[].records[].source | string | No | — |
| domains[].conditions | object[] | No | — |
| domains[].conditions[].type | string | No | — |
| domains[].conditions[].status | string | No | Current lifecycle status. |
| domains[].conditions[].reason | string | No | — |
| domains[].conditions[].message | string | No | Message text. |
| domains[].lastCheckedAt | string | No | — |
| domains[].verification | object | No | — |
| domains[].verification.required | boolean | No | — |
| domains[].verification.message | string | No | Message text. |
| domains[].verification.searchConsoleUrl | string | No | — |
| domains[].siteId | string | No | — |
| domains[].hostState | string | No | — |
| domains[].ownershipState | string | No | — |
| domains[].certState | string | No | — |
| domains[].dnsCheckTime | string | No | — |