52 lines
1.2 KiB
Markdown
52 lines
1.2 KiB
Markdown
---
|
|
name: domains-routes
|
|
description: Handle 4 OpenAPI operation(s) under /domains for the domains route group.
|
|
---
|
|
|
|
# domains API Routes
|
|
|
|
Handle 4 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
|
|
|
|
### domain_get
|
|
|
|
- Operation ID: `domain_get`
|
|
- Route: `GET /domains/{domain_id}`
|
|
- Mode: READ
|
|
- Summary: Retrieve a domain
|
|
- Parameters:
|
|
- `domain_id` in `path` required
|
|
|
|
### domain_delete
|
|
|
|
- Operation ID: `domain_delete`
|
|
- Route: `DELETE /domains/{domain_id}`
|
|
- Mode: WRITE
|
|
- Summary: Delete a Domain
|
|
- Parameters:
|
|
- `domain_id` in `path` required
|
|
|
|
### domain_create
|
|
|
|
- Operation ID: `domain_create`
|
|
- Route: `POST /domains`
|
|
- Mode: WRITE
|
|
- Summary: Create Domain
|
|
- Body: JSON request body accepted.
|
|
|
|
### domain_list
|
|
|
|
- Operation ID: `domain_list`
|
|
- Route: `GET /domains`
|
|
- Mode: READ
|
|
- Summary: List all domains
|
|
- Parameters:
|
|
- `limit` in `query`
|
|
- `before/after` in `query`
|
|
- `status` in `query`
|