POST/v1/delivery?squid={squid_hash}

Configure Amazon S3 Delivery

Export squid run results directly to an AWS S3 bucket

Configure Amazon S3 delivery to export run results directly to an AWS S3 bucket. Results will be automatically uploaded to your specified bucket and path when runs complete.

Authentication Options

You can authenticate with S3 in two ways:

AWS Credentials: Provide aws_access_key and aws_secret_key in the request
Bucket Policy: If you don't provide credentials, ensure your bucket policy allows public WRITE permissions

Headers

Key	Value	Required
Authorization	Token YOUR_API_KEY	Yes
Content-Type	application/json	Yes

Request Body

s3_fields.bucketstring

Required

Name of the S3 bucket where data will be stored

Example: my-bucket

s3_fields.is_activeboolean

Required

Set to true to enable S3 delivery, false to disable

Example: true

s3_fields.target_pathstring

Required

Folder path inside the bucket where results will be saved

Example: exports

s3_fields.aws_access_keystring

Optional

(Optional) AWS Access Key for authentication. If not provided, bucket must have public WRITE permissions

Example: AKIAIOSFODNN7EXAMPLE

s3_fields.aws_secret_keystring

Optional

(Optional) AWS Secret Key for authentication. If not provided, bucket must have public WRITE permissions

Example: wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY

Response Field Explanations

s3_fields.bucket

string

S3 bucket name

Example: my-bucket

s3_fields.is_active

boolean

Whether S3 delivery is active

Example: true

s3_fields.target_path

string

Target folder path in bucket

Example: exports

s3_fields.aws_access_key

string

AWS Access Key (returned if provided)

Example: AKIAIOSFODNN7EXAMPLE

s3_fields.aws_secret_key

string

AWS Secret Key (returned if provided)

Example: wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY

Parameters

squidstring

Required

The unique identifier (hash) of the squid for which to configure S3 delivery

Example: c106a44a98044ef18acc59986ae10967

Warning

If you don't provide AWS credentials, your bucket policy MUST allow public WRITE permissions for Lobstr to upload files.

Pro Tip

For better security, provide AWS credentials instead of making your bucket publicly writable. Use IAM users with limited permissions.

Note

The target_path creates a folder structure in your bucket. Results will be uploaded to s3://bucket/target_path/filename.csv

Pro Tip

Use the Test S3 endpoint to verify your bucket permissions and credentials before activating automatic delivery.

Warning

AWS credentials are stored and returned in API responses. Ensure you're using HTTPS and handle responses securely.