Skip to content

Organization

organization_domains_add

Adds a custom domain to a product.

Tool

organization_domains_add

Adds a custom domain to a product.

Adds a custom domain to a product. The domain always starts in external (self-managed DNS) mode; when the product has an active Cloudflare connector that can write DNS, the response carries a managedDns hint naming the connector and the tool that switches the domain to managed mode.

Behavior

HTTP
POST /governance/api/v1/products/:productId/domains

Arguments

NameTypeRequiredDescription
domainstringNo description in the catalog.
productIdstringNo description in the catalog.

Response

FieldTypeAlwaysDescription
idstring
modestring
domainstring
createdAtstring
createdBystring
productIdstring
managedDnsobject
providerConnectorIdstring

Try it

Adds a custom domain to a product.

When to use

Adds a custom domain to a product. The domain always starts in external (self-managed DNS) mode; when the product has an active Cloudflare connector that can write DNS, the response carries a managedDns hint naming the connector and the tool that switches the domain to managed mode.

Example

Ask your agent something like this:

Adds a custom domain to a product.

The agent will invoke organization_domains_add with these arguments:

{
  "domain": "<domain>",
  "productId": "<productId>"
}

Esc

Start typing to search the docs.

navigateselect