Amazon EventBridge Eventbridge Api Destination API
The Eventbridge Api Destination API from Amazon EventBridge — 5 operation(s) for eventbridge api destination.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/amazon-eventbridge:amazon-eventbridge-api-destination-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: Amazon EventBridge Api Destination API
version: '2015-10-07'
description: Generated from AWS's published Smithy model for Amazon EventBridge. 5 operation(s).
contact:
name: Amazon Web Services
url: https://aws.amazon.com/contact-us/
license:
name: Apache 2.0
identifier: Apache-2.0
url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://events.{region}.amazonaws.com
variables:
region:
default: us-east-1
security:
- sigv4: []
tags:
- name: Api Destination
paths:
/#CreateApiDestination:
post:
operationId: CreateApiDestination
summary: Create Api Destination
description: Creates an API destination, which is an HTTP invocation endpoint configured as a target for events. API destinations do not support private destinations, such as interface VPC endpoints. For more information, see API destinations in the EventBridge User Guide.
responses:
'200':
description: Success
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/CreateApiDestinationResponse'
'500':
description: InternalException
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/InternalException'
'400':
description: LimitExceededException; ResourceAlreadyExistsException; ResourceNotFoundException
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/LimitExceededException'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AWSEvents.CreateApiDestination
requestBody:
required: true
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/CreateApiDestinationRequest'
tags:
- Api Destination
/#DeleteApiDestination:
post:
operationId: DeleteApiDestination
summary: Delete Api Destination
description: Deletes the specified API destination.
responses:
'200':
description: Success
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/DeleteApiDestinationResponse'
'400':
description: ConcurrentModificationException; ResourceNotFoundException
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/ConcurrentModificationException'
'500':
description: InternalException
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/InternalException'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AWSEvents.DeleteApiDestination
requestBody:
required: true
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/DeleteApiDestinationRequest'
tags:
- Api Destination
/#DescribeApiDestination:
post:
operationId: DescribeApiDestination
summary: Describe Api Destination
description: Retrieves details about an API destination.
responses:
'200':
description: Success
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/DescribeApiDestinationResponse'
'500':
description: InternalException
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/InternalException'
'400':
description: ResourceNotFoundException
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AWSEvents.DescribeApiDestination
requestBody:
required: true
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/DescribeApiDestinationRequest'
tags:
- Api Destination
/#ListApiDestinations:
post:
operationId: ListApiDestinations
summary: List Api Destinations
description: Retrieves a list of API destination in the account in the current Region.
responses:
'200':
description: Success
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/ListApiDestinationsResponse'
'500':
description: InternalException
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/InternalException'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AWSEvents.ListApiDestinations
requestBody:
required: true
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/ListApiDestinationsRequest'
tags:
- Api Destination
/#UpdateApiDestination:
post:
operationId: UpdateApiDestination
summary: Update Api Destination
description: Updates an API destination.
responses:
'200':
description: Success
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/UpdateApiDestinationResponse'
'400':
description: ConcurrentModificationException; LimitExceededException; ResourceNotFoundException
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/ConcurrentModificationException'
'500':
description: InternalException
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/InternalException'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AWSEvents.UpdateApiDestination
requestBody:
required: true
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/UpdateApiDestinationRequest'
tags:
- Api Destination
components:
schemas:
CreateApiDestinationRequest:
type: object
properties:
Name:
type: string
description: The name for the API destination to create.
Description:
type: string
description: A description for the API destination to create.
ConnectionArn:
type: string
description: The ARN of the connection to use for the API destination. The destination endpoint must support the authorization type specified for the connection.
InvocationEndpoint:
type: string
description: The URL to the HTTP invocation endpoint for the API destination.
HttpMethod:
type: string
enum:
- POST
- GET
- HEAD
- OPTIONS
- PUT
- PATCH
- DELETE
description: The method to use for the request to the HTTP invocation endpoint.
InvocationRateLimitPerSecond:
type: integer
description: The maximum number of requests per second to send to the HTTP invocation endpoint.
required:
- Name
- ConnectionArn
- InvocationEndpoint
- HttpMethod
CreateApiDestinationResponse:
type: object
properties:
ApiDestinationArn:
type: string
description: The ARN of the API destination that was created by the request.
ApiDestinationState:
type: string
enum:
- ACTIVE
- INACTIVE
description: The state of the API destination that was created by the request.
CreationTime:
type: string
format: date-time
description: A time stamp indicating the time that the API destination was created.
LastModifiedTime:
type: string
format: date-time
description: A time stamp indicating the time that the API destination was last modified.
LimitExceededException:
type: object
properties:
message:
type: string
ResourceNotFoundException:
type: object
properties:
message:
type: string
InternalException:
type: object
properties:
message:
type: string
ApiDestination:
type: object
properties:
ApiDestinationArn:
type: string
description: The ARN of the API destination.
Name:
type: string
description: The name of the API destination.
ApiDestinationState:
type: string
enum:
- ACTIVE
- INACTIVE
description: The state of the API destination.
ConnectionArn:
type: string
description: The ARN of the connection specified for the API destination.
InvocationEndpoint:
type: string
description: The URL to the endpoint for the API destination.
HttpMethod:
type: string
enum:
- POST
- GET
- HEAD
- OPTIONS
- PUT
- PATCH
- DELETE
description: The method to use to connect to the HTTP endpoint.
InvocationRateLimitPerSecond:
type: integer
description: The maximum number of invocations per second to send to the HTTP endpoint.
CreationTime:
type: string
format: date-time
description: A time stamp for the time that the API destination was created.
LastModifiedTime:
type: string
format: date-time
description: A time stamp for the time that the API destination was last modified.
UpdateApiDestinationResponse:
type: object
properties:
ApiDestinationArn:
type: string
description: The ARN of the API destination that was updated.
ApiDestinationState:
type: string
enum:
- ACTIVE
- INACTIVE
description: The state of the API destination that was updated.
CreationTime:
type: string
format: date-time
description: A time stamp for the time that the API destination was created.
LastModifiedTime:
type: string
format: date-time
description: A time stamp for the time that the API destination was last modified.
DescribeApiDestinationRequest:
type: object
properties:
Name:
type: string
description: The name of the API destination to retrieve.
required:
- Name
DescribeApiDestinationResponse:
type: object
properties:
ApiDestinationArn:
type: string
description: The ARN of the API destination retrieved.
Name:
type: string
description: The name of the API destination retrieved.
Description:
type: string
description: The description for the API destination retrieved.
ApiDestinationState:
type: string
enum:
- ACTIVE
- INACTIVE
description: The state of the API destination retrieved.
ConnectionArn:
type: string
description: The ARN of the connection specified for the API destination retrieved.
InvocationEndpoint:
type: string
description: The URL to use to connect to the HTTP endpoint.
HttpMethod:
type: string
enum:
- POST
- GET
- HEAD
- OPTIONS
- PUT
- PATCH
- DELETE
description: The method to use to connect to the HTTP endpoint.
InvocationRateLimitPerSecond:
type: integer
description: The maximum number of invocations per second to specified for the API destination. Note that if you set the invocation rate maximum to a value lower the rate necessary to send all events received on to the destination HTTP endpoint, some events may not be delivered within the 24-hour retry window. If you plan to set the rate lower than the rate necessary to deliver all events, consider using a dead-letter queue to catch events that are not delivered within 24 hours.
CreationTime:
type: string
format: date-time
description: A time stamp for the time that the API destination was created.
LastModifiedTime:
type: string
format: date-time
description: A time stamp for the time that the API destination was last modified.
ConcurrentModificationException:
type: object
properties:
message:
type: string
ListApiDestinationsRequest:
type: object
properties:
NamePrefix:
type: string
description: A name prefix to filter results returned. Only API destinations with a name that starts with the prefix are returned.
ConnectionArn:
type: string
description: The ARN of the connection specified for the API destination.
NextToken:
type: string
description: The token returned by a previous call, which you can use to retrieve the next set of results. The value of nextToken is a unique pagination token for each page. To retrieve the next page of results, make the call again using the returned token. Keep all other arguments unchanged. Using an expired pagination token results in an HTTP 400 InvalidToken error.
Limit:
type: integer
description: The maximum number of API destinations to include in the response.
DeleteApiDestinationRequest:
type: object
properties:
Name:
type: string
description: The name of the destination to delete.
required:
- Name
UpdateApiDestinationRequest:
type: object
properties:
Name:
type: string
description: The name of the API destination to update.
Description:
type: string
description: The name of the API destination to update.
ConnectionArn:
type: string
description: The ARN of the connection to use for the API destination.
InvocationEndpoint:
type: string
description: The URL to the endpoint to use for the API destination.
HttpMethod:
type: string
enum:
- POST
- GET
- HEAD
- OPTIONS
- PUT
- PATCH
- DELETE
description: The method to use for the API destination.
InvocationRateLimitPerSecond:
type: integer
description: The maximum number of invocations per second to send to the API destination.
required:
- Name
ListApiDestinationsResponse:
type: object
properties:
ApiDestinations:
type: array
items:
$ref: '#/components/schemas/ApiDestination'
description: An array that includes information about each API destination.
NextToken:
type: string
description: A token indicating there are more results available. If there are no more results, no token is included in the response. The value of nextToken is a unique pagination token for each page. To retrieve the next page of results, make the call again using the returned token. Keep all other arguments unchanged. Using an expired pagination token results in an HTTP 400 InvalidToken error.
DeleteApiDestinationResponse:
type: object
properties: {}
securitySchemes:
sigv4:
type: apiKey
in: header
name: Authorization
description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
x-aws-sigv4:
signingName: events
x-provenance:
method: harvested
publisher: Amazon Web Services
source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/eventbridge/service/2015-10-07/eventbridge-2015-10-07.json
note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)