API Reference

R2

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Super Slurper

Super SlurperJobs

List jobs

client.r2.superSlurper.jobs.list(JobListParams { account_id, limit, offset } params, RequestOptionsoptions?): SinglePage<JobListResponse { id, createdAt, finishedAt, 4 more } >

GET/accounts/{account_id}/slurper/jobs

Get job details

client.r2.superSlurper.jobs.get(stringjobId, JobGetParams { account_id } params, RequestOptionsoptions?): JobGetResponse { id, createdAt, finishedAt, 4 more }

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

Create a job

client.r2.superSlurper.jobs.create(JobCreateParams { account_id, overwrite, source, target } params, RequestOptionsoptions?): JobCreateResponse { id }

POST/accounts/{account_id}/slurper/jobs

Abort all jobs

client.r2.superSlurper.jobs.abortAll(JobAbortAllParams { account_id } params, RequestOptionsoptions?): JobAbortAllResponse

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

Abort a job

client.r2.superSlurper.jobs.abort(stringjobId, JobAbortParams { account_id } params, RequestOptionsoptions?): JobAbortResponse

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

Pause a job

client.r2.superSlurper.jobs.pause(stringjobId, JobPauseParams { account_id } params, RequestOptionsoptions?): JobPauseResponse

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

Get job progress

client.r2.superSlurper.jobs.progress(stringjobId, JobProgressParams { account_id } params, RequestOptionsoptions?): JobProgressResponse { id, createdAt, failedObjects, 4 more }

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

Resume a job

client.r2.superSlurper.jobs.resume(stringjobId, JobResumeParams { account_id } params, RequestOptionsoptions?): JobResumeResponse

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

ModelsExpand Collapse

JobListResponse { id, createdAt, finishedAt, 4 more }

id?: string

createdAt?: string

finishedAt?: string | null

overwrite?: boolean

source?: S3SourceResponseSchema { bucket, endpoint, keys, 2 more } | GcsSourceResponseSchema { bucket, keys, pathPrefix, vendor } | R2SourceResponseSchema { bucket, jurisdiction, keys, 2 more }

One of the following:

S3SourceResponseSchema { bucket, endpoint, keys, 2 more }

bucket?: string

endpoint?: string | null

keys?: Array<string> | null

pathPrefix?: string | null

vendor?: "s3"

GcsSourceResponseSchema { bucket, keys, pathPrefix, vendor }

bucket?: string

keys?: Array<string> | null

pathPrefix?: string | null

vendor?: "gcs"

R2SourceResponseSchema { bucket, jurisdiction, keys, 2 more }

bucket?: string

jurisdiction?: "default" | "eu" | "fedramp"

One of the following:

"default"

"eu"

"fedramp"

keys?: Array<string> | null

pathPrefix?: string | null

vendor?: Provider { }

status?: "running" | "paused" | "aborted" | "completed"

One of the following:

"running"

"paused"

"aborted"

"completed"

target?: Target { bucket, jurisdiction, vendor }

bucket?: string

jurisdiction?: "default" | "eu" | "fedramp"

One of the following:

"default"

"eu"

"fedramp"

vendor?: Provider { }

JobGetResponse { id, createdAt, finishedAt, 4 more }

id?: string

createdAt?: string

finishedAt?: string | null

overwrite?: boolean

source?: S3SourceResponseSchema { bucket, endpoint, keys, 2 more } | GcsSourceResponseSchema { bucket, keys, pathPrefix, vendor } | R2SourceResponseSchema { bucket, jurisdiction, keys, 2 more }

One of the following:

S3SourceResponseSchema { bucket, endpoint, keys, 2 more }

bucket?: string

endpoint?: string | null

keys?: Array<string> | null

pathPrefix?: string | null

vendor?: "s3"

GcsSourceResponseSchema { bucket, keys, pathPrefix, vendor }

bucket?: string

keys?: Array<string> | null

pathPrefix?: string | null

vendor?: "gcs"

R2SourceResponseSchema { bucket, jurisdiction, keys, 2 more }

bucket?: string

jurisdiction?: "default" | "eu" | "fedramp"

One of the following:

"default"

"eu"

"fedramp"

keys?: Array<string> | null

pathPrefix?: string | null

vendor?: Provider { }

status?: "running" | "paused" | "aborted" | "completed"

One of the following:

"running"

"paused"

"aborted"

"completed"

target?: Target { bucket, jurisdiction, vendor }

bucket?: string

jurisdiction?: "default" | "eu" | "fedramp"

One of the following:

"default"

"eu"

"fedramp"

vendor?: Provider { }

JobCreateResponse { id }

id?: string

JobAbortAllResponse = string

JobAbortResponse = string

JobPauseResponse = string

JobProgressResponse { id, createdAt, failedObjects, 4 more }

id?: string

createdAt?: string

failedObjects?: number

objects?: number

skippedObjects?: number

status?: "running" | "paused" | "aborted" | "completed"

One of the following:

"running"

"paused"

"aborted"

"completed"

transferredObjects?: number

JobResumeResponse = string

Super SlurperJobsLogs

Get job logs

client.r2.superSlurper.jobs.logs.list(stringjobId, LogListParams { account_id, limit, offset } params, RequestOptionsoptions?): SinglePage<LogListResponse { createdAt, job, logType, 2 more } >

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

ModelsExpand Collapse

LogListResponse { createdAt, job, logType, 2 more }

createdAt?: string

job?: string

logType?: "migrationStart" | "migrationComplete" | "migrationAbort" | 12 more

One of the following:

"migrationStart"

"migrationComplete"

"migrationAbort"

"migrationError"

"migrationPause"

"migrationResume"

"migrationErrorFailedContinuation"

"importErrorRetryExhaustion"

"importSkippedStorageClass"

"importSkippedOversized"

"importSkippedEmptyObject"

"importSkippedUnsupportedContentType"

"importSkippedExcludedContentType"

"importSkippedInvalidMedia"

"importSkippedRequiresRetrieval"

message?: string | null

objectKey?: string | null

Super SlurperConnectivity Precheck

Check source connectivity

client.r2.superSlurper.connectivityPrecheck.source(ConnectivityPrecheckSourceParamsparams, RequestOptionsoptions?): ConnectivityPrecheckSourceResponse { connectivityStatus }

PUT/accounts/{account_id}/slurper/source/connectivity-precheck

Check target connectivity

client.r2.superSlurper.connectivityPrecheck.target(ConnectivityPrecheckTargetParams { account_id, bucket, secret, 2 more } params, RequestOptionsoptions?): ConnectivityPrecheckTargetResponse { connectivityStatus }

PUT/accounts/{account_id}/slurper/target/connectivity-precheck

ModelsExpand Collapse

ConnectivityPrecheckSourceResponse { connectivityStatus }

connectivityStatus?: "success" | "error"

One of the following:

"success"

"error"

ConnectivityPrecheckTargetResponse { connectivityStatus }

connectivityStatus?: "success" | "error"

One of the following:

"success"

"error"