62 lines
1.4 KiB
Markdown
62 lines
1.4 KiB
Markdown
---
|
|
name: checks-routes
|
|
description: Handle 4 OpenAPI operation(s) under /checks for the checks route group.
|
|
---
|
|
|
|
# checks API Routes
|
|
|
|
Handle 4 OpenAPI operation(s) under /checks for the checks 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
|
|
|
|
### checks_list
|
|
|
|
- Operation ID: `checks_list`
|
|
- Route: `GET /checks`
|
|
- Mode: READ
|
|
- Summary: List
|
|
- Parameters:
|
|
- `limit` in `query`
|
|
- `before/after` in `query`
|
|
- `include` in `query`
|
|
- `date_created` in `query`
|
|
- `metadata` in `query`
|
|
- `scheduled` in `query`
|
|
- `send_date` in `query`
|
|
- `mail_type` in `query`
|
|
- `sort_by` in `query`
|
|
- `status` in `query`
|
|
|
|
### check_create
|
|
|
|
- Operation ID: `check_create`
|
|
- Route: `POST /checks`
|
|
- Mode: WRITE
|
|
- Summary: Create
|
|
- Parameters:
|
|
- `Idempotency-Key` in `header`
|
|
- `idempotency_key` in `query`
|
|
- Body: JSON request body accepted.
|
|
|
|
### check_retrieve
|
|
|
|
- Operation ID: `check_retrieve`
|
|
- Route: `GET /checks/{chk_id}`
|
|
- Mode: READ
|
|
- Summary: Retrieve
|
|
- Parameters:
|
|
- `chk_id` in `path` required
|
|
|
|
### check_cancel
|
|
|
|
- Operation ID: `check_cancel`
|
|
- Route: `DELETE /checks/{chk_id}`
|
|
- Mode: WRITE
|
|
- Summary: Cancel
|
|
- Parameters:
|
|
- `chk_id` in `path` required
|