55 lines
1.7 KiB
Markdown
55 lines
1.7 KiB
Markdown
---
|
|
name: diagnostics-routes
|
|
description: Handle 5 OpenAPI operation(s) under /v2.1/diagnostics for the diagnostics route group.
|
|
---
|
|
|
|
# diagnostics API Routes
|
|
|
|
Handle 5 OpenAPI operation(s) under /v2.1/diagnostics for the diagnostics 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
|
|
|
|
### api_request_log_get_request_logs
|
|
|
|
- Operation ID: `api_request_log_get_request_logs`
|
|
- Route: `GET /v2.1/diagnostics/request_logs`
|
|
- Mode: READ
|
|
- Summary: Gets the API request logging log files.
|
|
- Parameters:
|
|
- `encoding` in `query`
|
|
|
|
### api_request_log_delete_request_logs
|
|
|
|
- Operation ID: `api_request_log_delete_request_logs`
|
|
- Route: `DELETE /v2.1/diagnostics/request_logs`
|
|
- Mode: WRITE
|
|
- Summary: Deletes the request log files.
|
|
|
|
### api_request_log_get_request_log
|
|
|
|
- Operation ID: `api_request_log_get_request_log`
|
|
- Route: `GET /v2.1/diagnostics/request_logs/{requestLogId}`
|
|
- Mode: READ
|
|
- Summary: Gets a request logging log file.
|
|
- Parameters:
|
|
- `requestLogId` in `path` required
|
|
|
|
### api_request_log_get_request_log_settings
|
|
|
|
- Operation ID: `api_request_log_get_request_log_settings`
|
|
- Route: `GET /v2.1/diagnostics/settings`
|
|
- Mode: READ
|
|
- Summary: Gets the API request logging settings.
|
|
|
|
### api_request_log_put_request_log_settings
|
|
|
|
- Operation ID: `api_request_log_put_request_log_settings`
|
|
- Route: `PUT /v2.1/diagnostics/settings`
|
|
- Mode: WRITE
|
|
- Summary: Enables or disables API request logging for troubleshooting.
|
|
- Body: JSON request body accepted.
|