Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

APIs.io Engineering Platform R2 Event Notification API

The R2 Event Notification API from APIs.io Engineering Platform — 2 operation(s) for r2 event notification.

This API exposes 3 operations across 2 paths, and defines 9 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.

3 operations 2 paths 9 schemas 1 DELETE1 GET1 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
Terms of Service
Resource Areas
1

Authentication & Security 1

APIs.io Engineering Platform R2 Event Notification 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 3

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

R2 Event Notification 3
GET
/accounts/{account_id}/event_notifications/r2/{bucket_name}/configuration
APIs.io Engineering Platform Read Configuration
event-notification-get-r2-bucket-configs 2 params → 4XX200404
DELETE
/accounts/{account_id}/event_notifications/r2/{bucket_name}/configuration/queues/{queue_id}
APIs.io Engineering Platform Delete Configuration
event-notification-delete-queue-config 3 params → 4XX200
PUT
/accounts/{account_id}/event_notifications/r2/{bucket_name}/configuration/queues/{queue_id}
APIs.io Engineering Platform Create Configuration
event-notification-create-queue-config 3 params body → 4XX200409

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are mq_api-response-common (4 properties), mq_api-response-common-failure (4 properties), mq_rule (3 properties), mq_detail (2 properties). Each schema is shown below with its type and property counts.

mq_rule
object
3 properties 1 required
mq_api-response-common
object
4 properties 4 required
mq_r2-action
string
mq_config-detail
object
mq_detail
object
2 properties 2 required
mq_bucket-config
object
mq_api-response-common-failure
object
4 properties 4 required
mq_identifier
string
Identifier.
mq_messages
array

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

engineering-platform-r2-event-notification-api-openapi.yml Raw ↑