Skip to content

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

Name
Type
Required
Description
mode
string
•
No description in the catalog.
domainId
string
•
No description in the catalog.
productId
string
•
No description in the catalog.
providerConnectorId
string
—
No description in the catalog.

Response

Field
Type
Always
Description
id
string
•
mode
string
•
domain
string
•
createdAt
string
•
createdBy
string
•
productId
string
•
providerConnectorId
string
•

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.

↑↓navigate↵select