Projects
verifyCustomDomain
Verify custom domain DNS
Checks DNS TXT record to verify domain ownership. Updates domain status on success. Requires a Scale or Enterprise plan.
Usage
const result = await api.projects.verifyCustomDomain({
pathParams: { project_id: "prj_xxx", domain_id: "dom_xxx" },
});Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| pathParams.project_id | string | Yes | Unique project identifier (prefixed, e.g. prj_xxx). |
| pathParams.domain_id | string | Yes | Unique custom domain identifier (prefixed, e.g. dom_xxx). |
Response
Promise<VerifyCustomDomainResponse> — verification result.
Example
import { PgBeamClient } from "pgbeam";
const client = new PgBeamClient({
token: "pbk_...",
baseUrl: "https://api.pgbeam.com",
});
const result = await client.api.projects.verifyCustomDomain({
pathParams: { project_id: "prj_xxx", domain_id: "dom_xxx" },
});Errors
| Status | Description |
|---|---|
| 400 | Invalid request parameters. |
| 401 | Missing or invalid authentication. |
| 403 | Custom domains require a Scale or Enterprise plan. |
| 404 | Resource not found. |
| 429 | Rate limited. Try again later. |