API Reference

R2

Super Slurper

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Jobs

List jobs

GET/accounts/{account_id}/slurper/jobs

Get job details

GET/accounts/{account_id}/slurper/jobs/{job_id}

Create a job

POST/accounts/{account_id}/slurper/jobs

Abort all jobs

PUT/accounts/{account_id}/slurper/jobs/abortAll

Abort a job

PUT/accounts/{account_id}/slurper/jobs/{job_id}/abort

Pause a job

PUT/accounts/{account_id}/slurper/jobs/{job_id}/pause

Get job progress

GET/accounts/{account_id}/slurper/jobs/{job_id}/progress

Resume a job

PUT/accounts/{account_id}/slurper/jobs/{job_id}/resume

ModelsExpand Collapse

JobListResponse { id, createdAt, finishedAt, 4 more }

id: optional string

createdAt: optional string

finishedAt: optional string

overwrite: optional boolean

source: optional { bucket, endpoint, keys, 2 more } or { bucket, keys, pathPrefix, vendor } or { bucket, jurisdiction, keys, 2 more }

One of the following:

S3SourceResponseSchema { bucket, endpoint, keys, 2 more }

bucket: optional string

endpoint: optional string

keys: optional array of string

pathPrefix: optional string

vendor: optional "s3"

GcsSourceResponseSchema { bucket, keys, pathPrefix, vendor }

bucket: optional string

keys: optional array of string

pathPrefix: optional string

vendor: optional "gcs"

R2SourceResponseSchema { bucket, jurisdiction, keys, 2 more }

bucket: optional string

jurisdiction: optional "default" or "eu" or "fedramp"

One of the following:

"default"

"eu"

"fedramp"

keys: optional array of string

pathPrefix: optional string

vendor: optional Provider

status: optional "running" or "paused" or "aborted" or "completed"

One of the following:

"running"

"paused"

"aborted"

"completed"

target: optional { bucket, jurisdiction, vendor }

bucket: optional string

jurisdiction: optional "default" or "eu" or "fedramp"

One of the following:

"default"

"eu"

"fedramp"

vendor: optional Provider

JobGetResponse { id, createdAt, finishedAt, 4 more }

id: optional string

createdAt: optional string

finishedAt: optional string

overwrite: optional boolean

source: optional { bucket, endpoint, keys, 2 more } or { bucket, keys, pathPrefix, vendor } or { bucket, jurisdiction, keys, 2 more }

One of the following:

S3SourceResponseSchema { bucket, endpoint, keys, 2 more }

bucket: optional string

endpoint: optional string

keys: optional array of string

pathPrefix: optional string

vendor: optional "s3"

GcsSourceResponseSchema { bucket, keys, pathPrefix, vendor }

bucket: optional string

keys: optional array of string

pathPrefix: optional string

vendor: optional "gcs"

R2SourceResponseSchema { bucket, jurisdiction, keys, 2 more }

bucket: optional string

jurisdiction: optional "default" or "eu" or "fedramp"

One of the following:

"default"

"eu"

"fedramp"

keys: optional array of string

pathPrefix: optional string

vendor: optional Provider

status: optional "running" or "paused" or "aborted" or "completed"

One of the following:

"running"

"paused"

"aborted"

"completed"

target: optional { bucket, jurisdiction, vendor }

bucket: optional string

jurisdiction: optional "default" or "eu" or "fedramp"

One of the following:

"default"

"eu"

"fedramp"

vendor: optional Provider

JobCreateResponse { id }

id: optional string

JobAbortAllResponse = string

JobAbortResponse = string

JobPauseResponse = string

JobProgressResponse { id, createdAt, failedObjects, 4 more }

id: optional string

createdAt: optional string

failedObjects: optional number

objects: optional number

skippedObjects: optional number

status: optional "running" or "paused" or "aborted" or "completed"

One of the following:

"running"

"paused"

"aborted"

"completed"

transferredObjects: optional number

JobResumeResponse = string

JobsLogs

Get job logs

GET/accounts/{account_id}/slurper/jobs/{job_id}/logs

ModelsExpand Collapse

LogListResponse { createdAt, job, logType, 2 more }

createdAt: optional string

job: optional string

logType: optional "migrationStart" or "migrationComplete" or "migrationAbort" or 12 more

One of the following:

"migrationStart"

"migrationComplete"

"migrationAbort"

"migrationError"

"migrationPause"

"migrationResume"

"migrationErrorFailedContinuation"

"importErrorRetryExhaustion"

"importSkippedStorageClass"

"importSkippedOversized"

"importSkippedEmptyObject"

"importSkippedUnsupportedContentType"

"importSkippedExcludedContentType"

"importSkippedInvalidMedia"

"importSkippedRequiresRetrieval"

message: optional string

objectKey: optional string