Domain operations
4 operations named domain.*. Every one runs in a batch through apply_ops, dry_run_ops, the CLI or the admin.
Updated
| Operation | What it does | Permission | Confirmation |
|---|---|---|---|
| domain.add | domain.add with domain ownership and provider gates. | site.admin | none |
| domain.primary | domain.primary with domain ownership and provider gates. | site.admin | none |
| domain.verify | domain.verify with domain ownership and provider gates. | site.admin | none |
| domain.delete | domain.delete with domain ownership and provider gates. | site.admin | destructive |
domain.add
domain.add with domain ownership and provider gates.
permission: site.adminwrites: siteclass: externalundo: explicit recovery
Example input
{
"hostname": "www.example.com"
}Input
| Field | Type | Required | Notes |
|---|---|---|---|
| hostname | string | yes | At least 1 character. At most 255 characters. |
Output
| Field | Type | Required | Notes |
|---|---|---|---|
| domain | object | yes | |
| domain.id | string | yes | |
| domain.siteId | string | yes | |
| domain.hostname | string | yes | |
| domain.kind | string | yes | One of "platform", "custom". |
| domain.isPrimary | boolean | yes | |
| domain.redirectToPrimary | boolean | yes | |
| domain.status | string | yes | One of "pending", "active", "error". |
| domain.dnsStatus | string | yes | |
| domain.provider | string | null | yes | |
| domain.providerId | string | null | yes | |
| domain.providerStatus | string | null | yes | |
| domain.sslStatus | string | null | yes | |
| domain.dnsTarget | string | null | yes | |
| domain.ownershipVerification | object | null | yes | |
| domain.sslValidationRecords | array of object | null | yes | |
| domain.lastError | string | null | yes | |
| domain.lastCheckedAt | string | null | yes | |
| domain.verifiedAt | string | null | yes | |
| domain.createdAt | string | yes | |
| domain.updatedAt | string | yes |
A dry run refuses an external operation, so it has no dry-run line: run it alone in a batch.
domain.primary
domain.primary with domain ownership and provider gates.
permission: site.adminwrites: siteclass: transactionundo: yes
Example input
{
"domainId": "9c0d1e2f-3a4b-4c5d-9e6f-7a8b9c0d1e2f"
}Input
| Field | Type | Required | Notes |
|---|---|---|---|
| domainId | string (uuid) | yes |
Output
| Field | Type | Required | Notes |
|---|---|---|---|
| domain | object | yes | |
| domain.id | string | yes | |
| domain.siteId | string | yes | |
| domain.hostname | string | yes | |
| domain.kind | string | yes | One of "platform", "custom". |
| domain.isPrimary | boolean | yes | |
| domain.redirectToPrimary | boolean | yes | |
| domain.status | string | yes | One of "pending", "active", "error". |
| domain.dnsStatus | string | yes | |
| domain.provider | string | null | yes | |
| domain.providerId | string | null | yes | |
| domain.providerStatus | string | null | yes | |
| domain.sslStatus | string | null | yes | |
| domain.dnsTarget | string | null | yes | |
| domain.ownershipVerification | object | null | yes | |
| domain.sslValidationRecords | array of object | null | yes | |
| domain.lastError | string | null | yes | |
| domain.lastCheckedAt | string | null | yes | |
| domain.verifiedAt | string | null | yes | |
| domain.createdAt | string | yes | |
| domain.updatedAt | string | yes |
Try it
yarn splash domain.primary '{"domainId":"9c0d1e2f-3a4b-4c5d-9e6f-7a8b9c0d1e2f"}' --dry-rundomain.verify
domain.verify with domain ownership and provider gates.
permission: site.adminwrites: siteclass: externalundo: explicit recovery
Example input
{
"domainId": "9c0d1e2f-3a4b-4c5d-9e6f-7a8b9c0d1e2f"
}Input
| Field | Type | Required | Notes |
|---|---|---|---|
| domainId | string (uuid) | yes |
Output
| Field | Type | Required | Notes |
|---|---|---|---|
| domain | object | yes | |
| domain.id | string | yes | |
| domain.siteId | string | yes | |
| domain.hostname | string | yes | |
| domain.kind | string | yes | One of "platform", "custom". |
| domain.isPrimary | boolean | yes | |
| domain.redirectToPrimary | boolean | yes | |
| domain.status | string | yes | One of "pending", "active", "error". |
| domain.dnsStatus | string | yes | |
| domain.provider | string | null | yes | |
| domain.providerId | string | null | yes | |
| domain.providerStatus | string | null | yes | |
| domain.sslStatus | string | null | yes | |
| domain.dnsTarget | string | null | yes | |
| domain.ownershipVerification | object | null | yes | |
| domain.sslValidationRecords | array of object | null | yes | |
| domain.lastError | string | null | yes | |
| domain.lastCheckedAt | string | null | yes | |
| domain.verifiedAt | string | null | yes | |
| domain.createdAt | string | yes | |
| domain.updatedAt | string | yes |
A dry run refuses an external operation, so it has no dry-run line: run it alone in a batch.
domain.delete
domain.delete with domain ownership and provider gates.
permission: site.adminwrites: siteclass: externalconfirm: destructiveundo: explicit recovery
Example input
{
"domainId": "9c0d1e2f-3a4b-4c5d-9e6f-7a8b9c0d1e2f"
}Input
| Field | Type | Required | Notes |
|---|---|---|---|
| domainId | string (uuid) | yes |
Output
| Field | Type | Required | Notes |
|---|---|---|---|
| success | true | yes |
A dry run refuses an external operation, so it has no dry-run line: run it alone in a batch.
Generated from the operation registry and the MCP tool catalogue (source ada45690b9ef1968).
Something wrong on this page? Write to docs@librettocms.com.