> ## Documentation Index
> Fetch the complete documentation index at: https://mintlify.com/cloudflare/cloudflare-typescript/llms.txt
> Use this file to discover all available pages before exploring further.
# Logpush
> API reference for Cloudflare Logpush (log export service)
## Overview
Cloudflare Logpush sends logs of HTTP requests, Spectrum events, firewall events, and more to cloud storage destinations. Use the Logpush API to manage jobs, validate destinations, and configure log fields.
## Initialize the client
```typescript theme={null}
import Cloudflare from 'cloudflare';
const client = new Cloudflare({
apiToken: 'your-api-token',
});
```
## Jobs
Manage Logpush jobs.
### Create a job
Create a new Logpush job.
```typescript theme={null}
const job = await client.logpush.jobs.create({
account_id: '023e105f4ecef8ad9ca31a8372d0c353',
destination_conf: 's3://bucket/path?region=us-west-2',
dataset: 'http_requests',
logpull_options: 'fields=ClientIP,EdgeStartTimestamp',
});
```
Account identifier (use `zone_id` for zone-scoped jobs)
Destination configuration string (e.g., S3 bucket URL with credentials)
Dataset to push (e.g., `http_requests`, `firewall_events`, `spectrum_events`)
Configuration string specifying fields to include and other options
Whether the job is enabled (default: true)
How often logs are pushed (e.g., `high`, `low`)
Job name
Job identifier
Whether the job is active
Destination configuration
### Update a job
Update an existing Logpush job.
```typescript theme={null}
const job = await client.logpush.jobs.update(
jobId,
{
account_id: '023e105f4ecef8ad9ca31a8372d0c353',
enabled: false,
}
);
```
### List jobs
List all Logpush jobs.
```typescript theme={null}
const jobs = await client.logpush.jobs.list({
account_id: '023e105f4ecef8ad9ca31a8372d0c353',
});
```
### Get a job
Get details of a specific Logpush job.
```typescript theme={null}
const job = await client.logpush.jobs.get(
jobId,
{ account_id: '023e105f4ecef8ad9ca31a8372d0c353' }
);
```
### Delete a job
Delete a Logpush job.
```typescript theme={null}
await client.logpush.jobs.delete(
jobId,
{ account_id: '023e105f4ecef8ad9ca31a8372d0c353' }
);
```
## Ownership
Manage ownership validation for Logpush destinations.
### Create ownership challenge
Generate an ownership challenge for a destination.
```typescript theme={null}
const challenge = await client.logpush.ownership.create({
account_id: '023e105f4ecef8ad9ca31a8372d0c353',
destination_conf: 's3://bucket/path?region=us-west-2',
});
```
Destination configuration to validate
Name of the file to upload for validation
Contents to include in the validation file
Whether the ownership is already validated
### Validate ownership
Validate ownership of a destination.
```typescript theme={null}
const result = await client.logpush.ownership.validate({
account_id: '023e105f4ecef8ad9ca31a8372d0c353',
destination_conf: 's3://bucket/path?region=us-west-2',
ownership_challenge: 'challenge-token',
});
```
Destination configuration
Ownership challenge token
## Validate
Validate Logpush destinations and origin configurations.
### Validate destination
Check if a destination configuration is valid.
```typescript theme={null}
const result = await client.logpush.validate.destination({
account_id: '023e105f4ecef8ad9ca31a8372d0c353',
destination_conf: 's3://bucket/path?region=us-west-2',
logpull_options: 'fields=ClientIP,EdgeStartTimestamp',
});
```
### Check if destination exists
Check if a destination exists and is accessible.
```typescript theme={null}
const result = await client.logpush.validate.destinationExists({
account_id: '023e105f4ecef8ad9ca31a8372d0c353',
destination_conf: 's3://bucket/path?region=us-west-2',
});
```
### Validate origin
Validate origin configuration for Logpush.
```typescript theme={null}
const result = await client.logpush.validate.origin(params);
```
## Datasets
Get information about available datasets.
```typescript theme={null}
const datasets = client.logpush.datasets;
```
The datasets resource provides methods to retrieve information about available log datasets and their fields.
## Edge
Manage instant Logpush jobs for edge locations.
```typescript theme={null}
const edge = client.logpush.edge;
```
Instant Logpush jobs provide on-demand access to logs from specific edge locations.
### Create instant job
```typescript theme={null}
const job = await client.logpush.edge.create({
zone_id: '023e105f4ecef8ad9ca31a8372d0c353',
// configuration
});
```
### Get instant job
```typescript theme={null}
const job = await client.logpush.edge.get(
jobId,
{ zone_id: '023e105f4ecef8ad9ca31a8372d0c353' }
);
```
## Types
### LogpushJob
Job identifier
Whether the job is active
Job name
Dataset being pushed
Destination configuration
Log field and option configuration
Push frequency
Timestamp of last successful push
Timestamp of last error
### OutputOptions
Output formatting options for logs.
Delimiter between fields
Delimiter between records
Format for timestamps