Amazon EventBridge

Amazon EventBridge Eventbridge Endpoint API

The Eventbridge Endpoint API from Amazon EventBridge — 5 operation(s) for eventbridge endpoint.

GitHub OpenAPI

Operations 5

POST /#CreateEndpoint Create Endpoint #
POST /#DeleteEndpoint Delete Endpoint #
POST /#DescribeEndpoint Describe Endpoint #
POST /#ListEndpoints List Endpoints #
POST /#UpdateEndpoint Update Endpoint #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/amazon-eventbridge/openapi/amazon-eventbridge-endpoint-api-openapi.yml

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.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/amazon-eventbridge:amazon-eventbridge-endpoint-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.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

amazon-eventbridge-endpoint-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Amazon EventBridge Endpoint 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: Endpoint
paths:
  /#CreateEndpoint:
    post:
      operationId: CreateEndpoint
      summary: Create Endpoint
      description: Creates a global endpoint. Global endpoints improve your application's availability by making it regional-fault tolerant. To do this, you define a primary and secondary Region with event buses in each Region. You also create a Amazon Route 53 health check that will tell EventBridge to route events to the secondary Region when an "unhealthy" state is encountered and events will be routed back to the primary Region when the health check reports a "healthy" state.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/CreateEndpointResponse'
        '500':
          description: InternalException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InternalException'
        '400':
          description: LimitExceededException; ResourceAlreadyExistsException
          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.CreateEndpoint
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/CreateEndpointRequest'
      tags:
      - Endpoint
  /#DeleteEndpoint:
    post:
      operationId: DeleteEndpoint
      summary: Delete Endpoint
      description: Delete an existing global endpoint. For more information about global endpoints, see Making applications Regional-fault tolerant with global endpoints and event replication in the Amazon EventBridge User Guide .
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DeleteEndpointResponse'
        '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.DeleteEndpoint
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DeleteEndpointRequest'
      tags:
      - Endpoint
  /#DescribeEndpoint:
    post:
      operationId: DescribeEndpoint
      summary: Describe Endpoint
      description: Get the information about an existing global endpoint. For more information about global endpoints, see Making applications Regional-fault tolerant with global endpoints and event replication in the Amazon EventBridge User Guide .
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DescribeEndpointResponse'
        '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.DescribeEndpoint
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DescribeEndpointRequest'
      tags:
      - Endpoint
  /#ListEndpoints:
    post:
      operationId: ListEndpoints
      summary: List Endpoints
      description: List the global endpoints associated with this account. For more information about global endpoints, see Making applications Regional-fault tolerant with global endpoints and event replication in the Amazon EventBridge User Guide .
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ListEndpointsResponse'
        '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.ListEndpoints
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/ListEndpointsRequest'
      tags:
      - Endpoint
  /#UpdateEndpoint:
    post:
      operationId: UpdateEndpoint
      summary: Update Endpoint
      description: Update an existing endpoint. For more information about global endpoints, see Making applications Regional-fault tolerant with global endpoints and event replication in the Amazon EventBridge User Guide .
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/UpdateEndpointResponse'
        '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.UpdateEndpoint
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/UpdateEndpointRequest'
      tags:
      - Endpoint
components:
  schemas:
    ListEndpointsRequest:
      type: object
      properties:
        NamePrefix:
          type: string
          description: 'A value that will return a subset of the endpoints associated with this account. For example, "NamePrefix": "ABC" will return all endpoints with "ABC" in the name.'
        HomeRegion:
          type: string
          description: 'The primary Region of the endpoints associated with this account. For example "HomeRegion": "us-east-1".'
        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.
        MaxResults:
          type: integer
          description: The maximum number of results returned by the call.
    UpdateEndpointResponse:
      type: object
      properties:
        Name:
          type: string
          description: The name of the endpoint you updated in this request.
        Arn:
          type: string
          description: The ARN of the endpoint you updated in this request.
        RoutingConfig:
          $ref: '#/components/schemas/RoutingConfig'
        ReplicationConfig:
          $ref: '#/components/schemas/ReplicationConfig'
        EventBuses:
          type: array
          items:
            $ref: '#/components/schemas/EndpointEventBus'
          description: The event buses used for replication for the endpoint you updated in this request.
        RoleArn:
          type: string
          description: The ARN of the role used by event replication for the endpoint you updated in this request.
        EndpointId:
          type: string
          description: The ID of the endpoint you updated in this request.
        EndpointUrl:
          type: string
          description: The URL of the endpoint you updated in this request.
        State:
          type: string
          enum:
          - ACTIVE
          - CREATING
          - UPDATING
          - DELETING
          - CREATE_FAILED
          - UPDATE_FAILED
          - DELETE_FAILED
          description: The state of the endpoint you updated in this request.
    ReplicationConfig:
      type: object
      properties:
        State:
          type: string
          enum:
          - ENABLED
          - DISABLED
          description: The state of event replication.
    EndpointEventBus:
      type: object
      properties:
        EventBusArn:
          type: string
          description: The ARN of the event bus the endpoint is associated with.
      required:
      - EventBusArn
    Endpoint:
      type: object
      properties:
        Name:
          type: string
          description: The name of the endpoint.
        Description:
          type: string
          description: A description for the endpoint.
        Arn:
          type: string
          description: The ARN of the endpoint.
        RoutingConfig:
          $ref: '#/components/schemas/RoutingConfig'
        ReplicationConfig:
          $ref: '#/components/schemas/ReplicationConfig'
        EventBuses:
          type: array
          items:
            $ref: '#/components/schemas/EndpointEventBus'
          description: The event buses being used by the endpoint.
        RoleArn:
          type: string
          description: The ARN of the role used by event replication for the endpoint.
        EndpointId:
          type: string
          description: The URL subdomain of the endpoint. For example, if the URL for Endpoint is https://abcde.veo.endpoints.event.amazonaws.com, then the EndpointId is abcde.veo.
        EndpointUrl:
          type: string
          description: The URL of the endpoint.
        State:
          type: string
          enum:
          - ACTIVE
          - CREATING
          - UPDATING
          - DELETING
          - CREATE_FAILED
          - UPDATE_FAILED
          - DELETE_FAILED
          description: The current state of the endpoint.
        StateReason:
          type: string
          description: The reason the endpoint is in its current state.
        CreationTime:
          type: string
          format: date-time
          description: The time the endpoint was created.
        LastModifiedTime:
          type: string
          format: date-time
          description: The last time the endpoint was modified.
    Secondary:
      type: object
      properties:
        Route:
          type: string
          description: Defines the secondary Region.
      required:
      - Route
    CreateEndpointRequest:
      type: object
      properties:
        Name:
          type: string
          description: The name of the global endpoint. For example, "Name":"us-east-2-custom_bus_A-endpoint".
        Description:
          type: string
          description: A description of the global endpoint.
        RoutingConfig:
          $ref: '#/components/schemas/RoutingConfig'
        ReplicationConfig:
          $ref: '#/components/schemas/ReplicationConfig'
        EventBuses:
          type: array
          items:
            $ref: '#/components/schemas/EndpointEventBus'
          description: Define the event buses used. The names of the event buses must be identical in each Region.
        RoleArn:
          type: string
          description: The ARN of the role used for replication.
      required:
      - Name
      - RoutingConfig
      - EventBuses
    FailoverConfig:
      type: object
      properties:
        Primary:
          $ref: '#/components/schemas/Primary'
        Secondary:
          $ref: '#/components/schemas/Secondary'
      required:
      - Primary
      - Secondary
    UpdateEndpointRequest:
      type: object
      properties:
        Name:
          type: string
          description: The name of the endpoint you want to update.
        Description:
          type: string
          description: A description for the endpoint.
        RoutingConfig:
          $ref: '#/components/schemas/RoutingConfig'
        ReplicationConfig:
          $ref: '#/components/schemas/ReplicationConfig'
        EventBuses:
          type: array
          items:
            $ref: '#/components/schemas/EndpointEventBus'
          description: Define event buses used for replication.
        RoleArn:
          type: string
          description: The ARN of the role used by event replication for this request.
      required:
      - Name
    LimitExceededException:
      type: object
      properties:
        message:
          type: string
    ResourceNotFoundException:
      type: object
      properties:
        message:
          type: string
    ConcurrentModificationException:
      type: object
      properties:
        message:
          type: string
    ListEndpointsResponse:
      type: object
      properties:
        Endpoints:
          type: array
          items:
            $ref: '#/components/schemas/Endpoint'
          description: The endpoints returned by the call.
        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.
    CreateEndpointResponse:
      type: object
      properties:
        Name:
          type: string
          description: The name of the endpoint that was created by this request.
        Arn:
          type: string
          description: The ARN of the endpoint that was created by this request.
        RoutingConfig:
          $ref: '#/components/schemas/RoutingConfig'
        ReplicationConfig:
          $ref: '#/components/schemas/ReplicationConfig'
        EventBuses:
          type: array
          items:
            $ref: '#/components/schemas/EndpointEventBus'
          description: The event buses used by this request.
        RoleArn:
          type: string
          description: The ARN of the role used by event replication for this request.
        State:
          type: string
          enum:
          - ACTIVE
          - CREATING
          - UPDATING
          - DELETING
          - CREATE_FAILED
          - UPDATE_FAILED
          - DELETE_FAILED
          description: The state of the endpoint that was created by this request.
    RoutingConfig:
      type: object
      properties:
        FailoverConfig:
          $ref: '#/components/schemas/FailoverConfig'
      required:
      - FailoverConfig
    DeleteEndpointRequest:
      type: object
      properties:
        Name:
          type: string
          description: The name of the endpoint you want to delete. For example, "Name":"us-east-2-custom_bus_A-endpoint"..
      required:
      - Name
    DeleteEndpointResponse:
      type: object
      properties: {}
    DescribeEndpointRequest:
      type: object
      properties:
        Name:
          type: string
          description: The name of the endpoint you want to get information about. For example, "Name":"us-east-2-custom_bus_A-endpoint".
        HomeRegion:
          type: string
          description: 'The primary Region of the endpoint you want to get information about. For example "HomeRegion": "us-east-1".'
      required:
      - Name
    InternalException:
      type: object
      properties:
        message:
          type: string
    DescribeEndpointResponse:
      type: object
      properties:
        Name:
          type: string
          description: The name of the endpoint you asked for information about.
        Description:
          type: string
          description: The description of the endpoint you asked for information about.
        Arn:
          type: string
          description: The ARN of the endpoint you asked for information about.
        RoutingConfig:
          $ref: '#/components/schemas/RoutingConfig'
        ReplicationConfig:
          $ref: '#/components/schemas/ReplicationConfig'
        EventBuses:
          type: array
          items:
            $ref: '#/components/schemas/EndpointEventBus'
          description: The event buses being used by the endpoint you asked for information about.
        RoleArn:
          type: string
          description: The ARN of the role used by the endpoint you asked for information about.
        EndpointId:
          type: string
          description: The ID of the endpoint you asked for information about.
        EndpointUrl:
          type: string
          description: The URL of the endpoint you asked for information about.
        State:
          type: string
          enum:
          - ACTIVE
          - CREATING
          - UPDATING
          - DELETING
          - CREATE_FAILED
          - UPDATE_FAILED
          - DELETE_FAILED
          description: The current state of the endpoint you asked for information about.
        StateReason:
          type: string
          description: The reason the endpoint you asked for information about is in its current state.
        CreationTime:
          type: string
          format: date-time
          description: The time the endpoint you asked for information about was created.
        LastModifiedTime:
          type: string
          format: date-time
          description: The last time the endpoint you asked for information about was modified.
    Primary:
      type: object
      properties:
        HealthCheck:
          type: string
          description: The ARN of the health check used by the endpoint to determine whether failover is triggered.
      required:
      - HealthCheck
  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)