APIs.io Engineering Platform R2 Bucket API

The R2 Bucket API from APIs.io Engineering Platform — 7 operation(s) for r2 bucket.

Documentation Provider Profile APIs.io OpenAPI GitHub

This API exposes 14 operations across 7 paths, and defines 25 schemas. It is described by OpenAPI 3.0.0, at version 2015-07-09.

Requests are made against 4 base URLs: http://apigateway.{region}.amazonaws.com, https://apigateway.{region}.amazonaws.com, http://apigateway.{region}.amazonaws.com.cn, https://apigateway.{region}.amazonaws.com.cn.

14 operations 7 paths 25 schemas 3 DELETE5 GET3 POST3 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification

OpenAPI 3.0.0

API Version

2015-07-09

Base URL

https://{bucketname}.s3.amazonaws.com

Authentication

API Key

Contact

Mike Ralphson

License

Apache 2.0 License

View terms

Resource Areas

Authentication & Security 1

APIs.io Engineering Platform R2 Bucket API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (hmac). By default, every request must be authenticated.

hmac — Amazon Signature authorization v4

Paths & Operations 14

Across 7 paths, the API surfaces 14 operations — 3 DELETE, 5 GET, 3 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.

R2 Bucket 14

GET

/accounts/{account_id}/r2/buckets

APIs.io Engineering Platform List Buckets

r2-list-buckets 7 params → 4XX200

POST

/accounts/{account_id}/r2/buckets

APIs.io Engineering Platform Create Bucket

r2-create-bucket 1 param body → 4XX200

DELETE

/accounts/{account_id}/r2/buckets/{bucket_name}

APIs.io Engineering Platform Delete Bucket

r2-delete-bucket 2 params → 4XX200

GET

/accounts/{account_id}/r2/buckets/{bucket_name}

APIs.io Engineering Platform Get Bucket

r2-get-bucket 2 params → 4XX200

GET

/accounts/{account_id}/r2/buckets/{bucket_name}/domains/custom

APIs.io Engineering Platform List Custom Domains of Bucket

r2-list-custom-domains 2 params → 4XX200

POST

/accounts/{account_id}/r2/buckets/{bucket_name}/domains/custom

APIs.io Engineering Platform Attach Custom Domain To Bucket

r2-add-custom-domain 2 params body → 4XX200

DELETE

/accounts/{account_id}/r2/buckets/{bucket_name}/domains/custom/{domain_name}

APIs.io Engineering Platform Remove Custom Domain From Bucket

r2-delete-custom-domain 3 params → 4XX200

PUT

/accounts/{account_id}/r2/buckets/{bucket_name}/domains/custom/{domain_name}

APIs.io Engineering Platform Configure Custom Domain Settings

r2-edit-custom-domain-settings 3 params body → 4XX200

GET

/accounts/{account_id}/r2/buckets/{bucket_name}/domains/managed

APIs.io Engineering Platform Get r2.dev Domain of Bucket

r2-get-bucket-public-policy 2 params → 4XX200

PUT

/accounts/{account_id}/r2/buckets/{bucket_name}/domains/managed

APIs.io Engineering Platform Update r2.dev Domain of Bucket

r2-put-bucket-public-policy 2 params body → 4XX200

DELETE

/accounts/{account_id}/r2/buckets/{bucket_name}/sippy

APIs.io Engineering Platform Disable Sippy

r2-delete-bucket-sippy-config 2 params → 4XX200

GET

/accounts/{account_id}/r2/buckets/{bucket_name}/sippy

APIs.io Engineering Platform Get Sippy Configuration

r2-get-bucket-sippy-config 2 params → 4XX200

PUT

/accounts/{account_id}/r2/buckets/{bucket_name}/sippy

APIs.io Engineering Platform Enable Sippy

r2-put-bucket-sippy-config 2 params body → 4XX200

POST

/accounts/{account_id}/r2/temp-access-credentials

APIs.io Engineering Platform Create Temporary Access Credentials

r2-create-temp-access-credentials 1 param body → 4XX200

Schemas 25

The contract defines 25 schemas that model the data the API accepts and returns. The most detailed are r2_temp_access_creds_request (6 properties), r2_add_custom_domain_request (4 properties), r2_v4_response_failure (4 properties), r2_bucket (4 properties). Each schema is shown below with its type and property counts.

r2_errors

array

r2_v4_response_failure

object

4 properties 4 required

r2_account_identifier

string

Account ID

r2_v4_response

object

4 properties 4 required

r2_bucket_name

string

Name of the bucket

r2_edit_custom_domain_response

object

3 properties 1 required

r2_temp_access_creds_request

object

6 properties 4 required

r2_storage_class

string

Storage class for newly uploaded objects, unless specified otherwise.

r2_edit_managed_domain_request

object

1 property 1 required

r2_enable_sippy_gcs

object

2 properties

r2_bucket

object

A single R2 bucket

4 properties

r2_edit_custom_domain_request

object

2 properties

r2_domain_name

string

Name of the custom domain

r2_list_custom_domains_response

object

1 property 1 required

r2_add_custom_domain_response

object

3 properties 2 required

r2_v4_response_list

r2_temp_access_creds_response

object

3 properties

r2_result_info

object

2 properties

r2_bucket_location

string

Location of the bucket

r2_messages

array

r2_enable_sippy_aws

object

2 properties

r2_sippy

object

3 properties

r2_add_custom_domain_request

object

4 properties 2 required

r2_managed_domain_response

object

3 properties 3 required

r2_remove_custom_domain_response

object

1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

#R2 Bucket

← Back to A APIs

Discovery

Learnings

Guidance

Toolbox

Alignment

API Evangelist LLC

APIs.io Engineering Platform R2 Bucket API

Metadata

Authentication & Security 1

Paths & Operations 14

Schemas 25

Specification

Source

API Details

Provider

Explore more