Skip to content

Organization

organization_domains_set-mode

Switches a custom domain between external (self-managed DNS) and managed mode.

Tool

organization_domains_set-mode

Switches a custom domain between external (self-managed DNS) and managed mode.

Switches a custom domain between external (self-managed DNS) and managed mode. Managed mode requires providerConnectorId — the id of an active Cloudflare connector attached to the product — and hands the domain's records to the platform reconciler.

Behavior

HTTP
PUT /governance/api/v1/products/:productId/domains/:domainId/mode

Arguments

NameTypeRequiredDescription
modestringNo description in the catalog.
domainIdstringNo description in the catalog.
productIdstringNo description in the catalog.
providerConnectorIdstringNo description in the catalog.

Response

FieldTypeAlwaysDescription
idstring
modestring
domainstring
createdAtstring
createdBystring
productIdstring
providerConnectorIdstring

Try it

Switches a custom domain between external (self-managed DNS) and managed mode.

When to use

Switches a custom domain between external (self-managed DNS) and managed mode. Managed mode requires providerConnectorId — the id of an active Cloudflare connector attached to the product — and hands the domain's records to the platform reconciler.

Example

Ask your agent something like this:

Switches a custom domain between external (self-managed DNS) and managed mode.

The agent will invoke organization_domains_set-mode with these arguments:

{
  "mode": "<mode>",
  "domainId": "<domainId>",
  "productId": "<productId>"
}

Esc

Start typing to search the docs.

navigateselect