49 lines
1.3 KiB
Markdown
49 lines
1.3 KiB
Markdown
---
|
|
name: connections-routes
|
|
description: Handle 3 OpenAPI operation(s) under /connections for the connections route group.
|
|
---
|
|
|
|
# connections API Routes
|
|
|
|
Handle 3 OpenAPI operation(s) under /connections for the connections 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
|
|
|
|
### connections_controller_list
|
|
|
|
- Operation ID: `connections_controller_list`
|
|
- Route: `GET /connections`
|
|
- Mode: READ
|
|
- Summary: List Connections
|
|
- Parameters:
|
|
- `before` in `query`
|
|
- `after` in `query`
|
|
- `limit` in `query`
|
|
- `order` in `query`
|
|
- `connection_type` in `query`
|
|
- `domain` in `query`
|
|
- `organization_id` in `query`
|
|
- `search` in `query`
|
|
|
|
### connections_controller_find
|
|
|
|
- Operation ID: `connections_controller_find`
|
|
- Route: `GET /connections/{id}`
|
|
- Mode: READ
|
|
- Summary: Get a Connection
|
|
- Parameters:
|
|
- `id` in `path` required
|
|
|
|
### connections_controller_delete
|
|
|
|
- Operation ID: `connections_controller_delete`
|
|
- Route: `DELETE /connections/{id}`
|
|
- Mode: WRITE
|
|
- Summary: Delete a Connection
|
|
- Parameters:
|
|
- `id` in `path` required
|