Skip to content
Cloudflare API
Start here
API Reference
R2

Super Slurper

Super SlurperJobs

List jobs
r2.super_slurper.jobs.list(JobListParams**kwargs) -> SyncSinglePage[JobListResponse]
GET/accounts/{account_id}/slurper/jobs
Get job details
r2.super_slurper.jobs.get(strjob_id, JobGetParams**kwargs) -> JobGetResponse
GET/accounts/{account_id}/slurper/jobs/{job_id}
Create a job
r2.super_slurper.jobs.create(JobCreateParams**kwargs) -> JobCreateResponse
POST/accounts/{account_id}/slurper/jobs
Abort all jobs
r2.super_slurper.jobs.abort_all(JobAbortAllParams**kwargs) -> JobAbortAllResponse
PUT/accounts/{account_id}/slurper/jobs/abortAll
Abort a job
r2.super_slurper.jobs.abort(strjob_id, JobAbortParams**kwargs) -> JobAbortResponse
PUT/accounts/{account_id}/slurper/jobs/{job_id}/abort
Pause a job
r2.super_slurper.jobs.pause(strjob_id, JobPauseParams**kwargs) -> JobPauseResponse
PUT/accounts/{account_id}/slurper/jobs/{job_id}/pause
Get job progress
r2.super_slurper.jobs.progress(strjob_id, JobProgressParams**kwargs) -> JobProgressResponse
GET/accounts/{account_id}/slurper/jobs/{job_id}/progress
Resume a job
r2.super_slurper.jobs.resume(strjob_id, JobResumeParams**kwargs) -> JobResumeResponse
PUT/accounts/{account_id}/slurper/jobs/{job_id}/resume
ModelsExpand Collapse
class JobListResponse: …
id: Optional[str]
created_at: Optional[str]
finished_at: Optional[str]
overwrite: Optional[bool]
source: Optional[Source]
One of the following:
class SourceS3SourceResponseSchema: …
bucket: Optional[str]
endpoint: Optional[str]
keys: Optional[List[str]]
path_prefix: Optional[str]
vendor: Optional[Literal["s3"]]
class SourceGcsSourceResponseSchema: …
bucket: Optional[str]
keys: Optional[List[str]]
path_prefix: Optional[str]
vendor: Optional[Literal["gcs"]]
class SourceR2SourceResponseSchema: …
bucket: Optional[str]
jurisdiction: Optional[Literal["default", "eu", "fedramp"]]
One of the following:
"default"
"eu"
"fedramp"
keys: Optional[List[str]]
path_prefix: Optional[str]
vendor: Optional[Provider]
status: Optional[Literal["running", "paused", "aborted", "completed"]]
One of the following:
"running"
"paused"
"aborted"
"completed"
target: Optional[Target]
bucket: Optional[str]
jurisdiction: Optional[Literal["default", "eu", "fedramp"]]
One of the following:
"default"
"eu"
"fedramp"
vendor: Optional[Provider]
class JobGetResponse: …
id: Optional[str]
created_at: Optional[str]
finished_at: Optional[str]
overwrite: Optional[bool]
source: Optional[Source]
One of the following:
class SourceS3SourceResponseSchema: …
bucket: Optional[str]
endpoint: Optional[str]
keys: Optional[List[str]]
path_prefix: Optional[str]
vendor: Optional[Literal["s3"]]
class SourceGcsSourceResponseSchema: …
bucket: Optional[str]
keys: Optional[List[str]]
path_prefix: Optional[str]
vendor: Optional[Literal["gcs"]]
class SourceR2SourceResponseSchema: …
bucket: Optional[str]
jurisdiction: Optional[Literal["default", "eu", "fedramp"]]
One of the following:
"default"
"eu"
"fedramp"
keys: Optional[List[str]]
path_prefix: Optional[str]
vendor: Optional[Provider]
status: Optional[Literal["running", "paused", "aborted", "completed"]]
One of the following:
"running"
"paused"
"aborted"
"completed"
target: Optional[Target]
bucket: Optional[str]
jurisdiction: Optional[Literal["default", "eu", "fedramp"]]
One of the following:
"default"
"eu"
"fedramp"
vendor: Optional[Provider]
class JobCreateResponse: …
id: Optional[str]
str
str
str
class JobProgressResponse: …
id: Optional[str]
created_at: Optional[str]
failed_objects: Optional[int]
objects: Optional[int]
skipped_objects: Optional[int]
status: Optional[Literal["running", "paused", "aborted", "completed"]]
One of the following:
"running"
"paused"
"aborted"
"completed"
transferred_objects: Optional[int]
str

Super SlurperJobsLogs

Get job logs
r2.super_slurper.jobs.logs.list(strjob_id, LogListParams**kwargs) -> SyncSinglePage[LogListResponse]
GET/accounts/{account_id}/slurper/jobs/{job_id}/logs
ModelsExpand Collapse
class LogListResponse: …
created_at: Optional[str]
job: Optional[str]
log_type: Optional[Literal["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: Optional[str]
object_key: Optional[str]

Super SlurperConnectivity Precheck

Check source connectivity
r2.super_slurper.connectivity_precheck.source(ConnectivityPrecheckSourceParams**kwargs) -> ConnectivityPrecheckSourceResponse
PUT/accounts/{account_id}/slurper/source/connectivity-precheck
Check target connectivity
r2.super_slurper.connectivity_precheck.target(ConnectivityPrecheckTargetParams**kwargs) -> ConnectivityPrecheckTargetResponse
PUT/accounts/{account_id}/slurper/target/connectivity-precheck
ModelsExpand Collapse
class ConnectivityPrecheckSourceResponse: …
connectivity_status: Optional[Literal["success", "error"]]
One of the following:
"success"
"error"
class ConnectivityPrecheckTargetResponse: …
connectivity_status: Optional[Literal["success", "error"]]
One of the following:
"success"
"error"