Objects

Objects stored in an R2 bucket, over Cloudflare's REST API.

List

List objects in a bucket.

$response = $client->r2()->objects()->list('ACCOUNT_ID', 'BUCKET_NAME', [], 'JURISDICTION');

Get

Retrieve an object from a bucket.

The response carries the object itself, not a JSON envelope, so read it with body() rather than json(). Object metadata comes back as response headers, reachable through toPsrResponse().

$object = $client->r2()->objects()->get('ACCOUNT_ID', 'my-bucket', 'path/to/file.txt');

file_put_contents('file.txt', $object->body());

$response = $client->r2()->objects()->get('ACCOUNT_ID', 'BUCKET_NAME', 'OBJECT_KEY', 'JURISDICTION');

Upload

Upload an object to a bucket.

The object is sent as the raw request body, up to 300 MB. Anything larger needs R2's S3-compatible API and its multipart upload.

$client->r2()->objects()->upload(
    'ACCOUNT_ID',
    'my-bucket',
    'path/to/file.txt',
    file_get_contents('file.txt'),
    'text/plain'
);

$response = $client->r2()->objects()->upload('ACCOUNT_ID', 'BUCKET_NAME', 'OBJECT_KEY', 'CONTENTS', 'CONTENT_TYPE', 'STORAGE_CLASS', 'JURISDICTION');

Delete

Delete a single object from a bucket.

$response = $client->r2()->objects()->delete('ACCOUNT_ID', 'BUCKET_NAME', 'OBJECT_KEY', 'JURISDICTION');

Delete Many

Delete a list of objects from a bucket.

Every key given is deleted, and Cloudflare reports failures per key in the response rather than failing the whole request.

$response = $client->r2()->objects()->deleteMany('ACCOUNT_ID', 'BUCKET_NAME', [], 'JURISDICTION');

Delete By Prefix

Delete every object whose key begins with a prefix.

Cloudflare answers with a job descriptor rather than doing the work inline: small jobs may come back already COMPLETED, larger ones keep running in the background, so poll the id you get back with $client->r2()->jobs()->get(). Objects written after the job starts are not included in it.

$response = $client->r2()->objects()->deleteByPrefix('ACCOUNT_ID', 'BUCKET_NAME', 'PREFIX', true, 'JURISDICTION');

Empty Bucket

Delete every object in a bucket.

The same operation as deleteByPrefix() with an empty prefix, and it behaves the same way: you get a job descriptor back to poll with $client->r2()->jobs()->get().

Cloudflare refuses to empty a bucket that has event notifications configured, answering 409 with error code 10034 — remove the notification rules first. Abort any active multipart uploads before submitting, and avoid writing to the bucket while the job runs.

$response = $client->r2()->objects()->emptyBucket('ACCOUNT_ID', 'BUCKET_NAME', true, 'JURISDICTION');