provider batch_exportsfile_download_batch_exports POST /api/environments/{environment_id}/file_download_batch_exports/{id}/cancel/
@utdk/posthog /api/environments/{environment_id}/file_download_batch_exports/{id}/cancel/
environments_file_download_batch_exports_cancel_create
Cancel an ongoing file-download batch export.
environment_id path required
Deprecated. Use /api/projects/{project_id}/ instead.
string
id path required
A UUID string identifying this batch export run.
string

Try it

Authentication
Configure credentials for PostHog API
environmentsFileDownloadBatchExportsCancelCreate
POST/api/environments/{environment_id}/file_download_batch_exports/{id}/cancel/
Cancel an ongoing file-download batch export.

Parameters

required

Deprecated. Use /api/projects/{project_id}/ instead.

required

A UUID string identifying this batch export run.

Input

required

Typed configuration for a FileDownload batch-export destination.

required

* `events` - events * `persons` - persons * `sessions` - sessions

required
required

Configure credentials above to enable sending.

Code snippet
Updates live as you fill in the form above.

TypeScript

import posthog from '@utdk/posthog';

await posthog.environmentsFileDownloadBatchExportsCancelCreate()