71 lines
1.7 KiB
Markdown
71 lines
1.7 KiB
Markdown
---
|
|
name: domains-routes
|
|
description: Handle 6 OpenAPI operation(s) under /domains for the domains route group.
|
|
---
|
|
|
|
# domains API Routes
|
|
|
|
Handle 6 OpenAPI operation(s) under /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
|
|
|
|
### post_domains
|
|
|
|
- Operation ID: `post_domains`
|
|
- Route: `POST /domains`
|
|
- Mode: WRITE
|
|
- Summary: Create a new domain
|
|
- Body: JSON request body accepted.
|
|
|
|
### get_domains
|
|
|
|
- Operation ID: `get_domains`
|
|
- Route: `GET /domains`
|
|
- Mode: READ
|
|
- Summary: Retrieve a list of domains
|
|
- Parameters:
|
|
- `limit` in `query`
|
|
- `after` in `query`
|
|
- `before` in `query`
|
|
|
|
### get_domains_domain_id
|
|
|
|
- Operation ID: `get_domains_domain_id`
|
|
- Route: `GET /domains/{domain_id}`
|
|
- Mode: READ
|
|
- Summary: Retrieve a single domain
|
|
- Parameters:
|
|
- `domain_id` in `path` required
|
|
|
|
### patch_domains_domain_id
|
|
|
|
- Operation ID: `patch_domains_domain_id`
|
|
- Route: `PATCH /domains/{domain_id}`
|
|
- Mode: WRITE
|
|
- Summary: Update an existing domain
|
|
- Parameters:
|
|
- `domain_id` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### delete_domains_domain_id
|
|
|
|
- Operation ID: `delete_domains_domain_id`
|
|
- Route: `DELETE /domains/{domain_id}`
|
|
- Mode: WRITE
|
|
- Summary: Remove an existing domain
|
|
- Parameters:
|
|
- `domain_id` in `path` required
|
|
|
|
### post_domains_domain_id_verify
|
|
|
|
- Operation ID: `post_domains_domain_id_verify`
|
|
- Route: `POST /domains/{domain_id}/verify`
|
|
- Mode: WRITE
|
|
- Summary: Verify an existing domain
|
|
- Parameters:
|
|
- `domain_id` in `path` required
|