77 lines
1.9 KiB
Markdown
77 lines
1.9 KiB
Markdown
---
|
|
name: domains-routes
|
|
description: Handle 7 OpenAPI operation(s) under /api/v1/domains for the domains route group.
|
|
---
|
|
|
|
# domains API Routes
|
|
|
|
Handle 7 OpenAPI operation(s) under /api/v1/domains for the domains route group.
|
|
|
|
Use the generated operation tools to make real API calls. Do not invent API responses.
|
|
If a tool reports missing setup, return the exact setup field name to the caller.
|
|
For write, update, or delete operations, state the intended action before calling the tool.
|
|
|
|
## Operations
|
|
|
|
### list_custom_domains
|
|
|
|
- Operation ID: `list_custom_domains`
|
|
- Route: `GET /api/v1/domains`
|
|
- Mode: READ
|
|
- Summary: List all custom domains
|
|
|
|
### create_custom_domain
|
|
|
|
- Operation ID: `create_custom_domain`
|
|
- Route: `POST /api/v1/domains`
|
|
- Mode: WRITE
|
|
- Summary: Create a custom domain
|
|
- Body: JSON request body accepted.
|
|
|
|
### get_custom_domain
|
|
|
|
- Operation ID: `get_custom_domain`
|
|
- Route: `GET /api/v1/domains/{domainId}`
|
|
- Mode: READ
|
|
- Summary: Retrieve a custom domain
|
|
- Parameters:
|
|
- `domainId` in `path` required
|
|
|
|
### replace_custom_domain
|
|
|
|
- Operation ID: `replace_custom_domain`
|
|
- Route: `PUT /api/v1/domains/{domainId}`
|
|
- Mode: WRITE
|
|
- Summary: Replace a custom domain's brand
|
|
- Parameters:
|
|
- `domainId` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### delete_custom_domain
|
|
|
|
- Operation ID: `delete_custom_domain`
|
|
- Route: `DELETE /api/v1/domains/{domainId}`
|
|
- Mode: WRITE
|
|
- Summary: Delete a custom domain
|
|
- Parameters:
|
|
- `domainId` in `path` required
|
|
|
|
### upsert_certificate
|
|
|
|
- Operation ID: `upsert_certificate`
|
|
- Route: `PUT /api/v1/domains/{domainId}/certificate`
|
|
- Mode: WRITE
|
|
- Summary: Upsert the custom domain's certificate
|
|
- Parameters:
|
|
- `domainId` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### verify_domain
|
|
|
|
- Operation ID: `verify_domain`
|
|
- Route: `POST /api/v1/domains/{domainId}/verify`
|
|
- Mode: WRITE
|
|
- Summary: Verify a custom domain
|
|
- Parameters:
|
|
- `domainId` in `path` required
|