cancel_log_export
Cancel a pending or running log export job to stop it permanently. Takes effect immediately without rolling back already-processed rows.
Instructions
Cancel a pending or running log export job, unlike start_log_export which queues one or delete_integration which removes the source. This permanently stops that export, takes effect immediately, and does not roll back already-processed rows; call create_log_export and start_log_export again to retry.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| export_id | Yes | The unique ID of the log export to cancel |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| ok | Yes | Whether the tool call succeeded and returned structured data | |
| data | No | Structured success payload when ok is true | |
| error | No | Structured error payload when ok is false |
Implementation Reference
- src/services/logging.service.ts:194-198 (handler)Canonical handler for cancel_log_export. Sends a POST request to /logs/exports/{exportId}/cancel via BaseService.post() to cancel a pending or running log export job.
async cancelLogExport(exportId: string): Promise<LogExportActionResponse> { return this.post<LogExportActionResponse>( `/logs/exports/${this.encodePathSegment(exportId)}/cancel`, ); } - src/tools/logging.tools.ts:367-392 (registration)Registration of the 'cancel_log_export' tool on the MCP server. Calls service.logging.cancelLogExport(params.export_id) and returns a JSON result with message, export_id, and status.
// Cancel log export tool server.tool( "cancel_log_export", "Cancel a pending or running log export job, unlike start_log_export which queues one or delete_integration which removes the source. This permanently stops that export, takes effect immediately, and does not roll back already-processed rows; call create_log_export and start_log_export again to retry.", LOGGING_TOOL_SCHEMAS.cancelLogExport, async (params) => { const result = await service.logging.cancelLogExport(params.export_id); return { content: [ { type: "text", text: JSON.stringify( { message: result.message, export_id: params.export_id, status: "cancelled", }, null, 2, ), }, ], }; }, ); - src/tools/logging.tools.ts:145-147 (schema)Input schema definition for cancel_log_export. Defines a single required parameter 'export_id' (string) describing the unique ID of the log export to cancel.
cancelLogExport: { export_id: z.string().describe("The unique ID of the log export to cancel"), }, - Response type LogExportActionResponse returned by cancelLogExport handler. Contains 'message' (string) and 'object' ("export") fields.
export interface LogExportActionResponse { message: string; object: "export"; }