95 lines
2.5 KiB
Markdown
95 lines
2.5 KiB
Markdown
---
|
|
name: automations-routes
|
|
description: Handle 8 OpenAPI operation(s) under /automations for the automations route group.
|
|
---
|
|
|
|
# automations API Routes
|
|
|
|
Handle 8 OpenAPI operation(s) under /automations for the automations 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_automations
|
|
|
|
- Operation ID: `post_automations`
|
|
- Route: `POST /automations`
|
|
- Mode: WRITE
|
|
- Summary: Create an automation
|
|
- Body: JSON request body accepted.
|
|
|
|
### get_automations
|
|
|
|
- Operation ID: `get_automations`
|
|
- Route: `GET /automations`
|
|
- Mode: READ
|
|
- Summary: Retrieve a list of automations
|
|
- Parameters:
|
|
- `status` in `query`
|
|
- `limit` in `query`
|
|
- `after` in `query`
|
|
- `before` in `query`
|
|
|
|
### get_automations_automation_id
|
|
|
|
- Operation ID: `get_automations_automation_id`
|
|
- Route: `GET /automations/{automation_id}`
|
|
- Mode: READ
|
|
- Summary: Retrieve a single automation
|
|
- Parameters:
|
|
- `automation_id` in `path` required
|
|
|
|
### patch_automations_automation_id
|
|
|
|
- Operation ID: `patch_automations_automation_id`
|
|
- Route: `PATCH /automations/{automation_id}`
|
|
- Mode: WRITE
|
|
- Summary: Update an automation
|
|
- Parameters:
|
|
- `automation_id` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### delete_automations_automation_id
|
|
|
|
- Operation ID: `delete_automations_automation_id`
|
|
- Route: `DELETE /automations/{automation_id}`
|
|
- Mode: WRITE
|
|
- Summary: Delete an automation
|
|
- Parameters:
|
|
- `automation_id` in `path` required
|
|
|
|
### post_automations_automation_id_stop
|
|
|
|
- Operation ID: `post_automations_automation_id_stop`
|
|
- Route: `POST /automations/{automation_id}/stop`
|
|
- Mode: WRITE
|
|
- Summary: Stop an automation
|
|
- Parameters:
|
|
- `automation_id` in `path` required
|
|
|
|
### get_automations_automation_id_runs
|
|
|
|
- Operation ID: `get_automations_automation_id_runs`
|
|
- Route: `GET /automations/{automation_id}/runs`
|
|
- Mode: READ
|
|
- Summary: Retrieve a list of automation runs
|
|
- Parameters:
|
|
- `automation_id` in `path` required
|
|
- `status` in `query`
|
|
- `limit` in `query`
|
|
- `after` in `query`
|
|
- `before` in `query`
|
|
|
|
### get_automations_automation_id_runs_run_id
|
|
|
|
- Operation ID: `get_automations_automation_id_runs_run_id`
|
|
- Route: `GET /automations/{automation_id}/runs/{run_id}`
|
|
- Mode: READ
|
|
- Summary: Retrieve a single automation run
|
|
- Parameters:
|
|
- `automation_id` in `path` required
|
|
- `run_id` in `path` required
|