Open documentation ↗Overview
<p>Amazon EventBridge helps you to respond to state changes in your Amazon Web Services resources. When your resources change state, they automatically send events to an event stream. You can create rules that match selected events in the stream and route them to targets to take action. You can also use rules to take action on a predetermined schedule. For example, you can configure rules to:</p> <ul> <li> <p>Automatically invoke an Lambda function to update DNS entries when an event notifies you that Amazon EC2 instance enters the running state.</p> </li> <li> <p>Direct specific API records from CloudTrail to an Amazon Kinesis data stream for detailed analysis of potential security or availability risks.</p> </li> <li> <p>Periodically invoke a built-in target to create a snapshot of an Amazon EBS volume.</p> </li> </ul> <p>For more information about the features of Amazon EventBridge, see the <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide">Amazon EventBridge User Guide</a>.</p>
Amazon EventBridge is a cloud platforms API from amazonaws.com. Requests are authenticated with an API key. It is served over HTTPS. Its OpenAPI description documents 56 endpoints.
At a glance
- Authentication
- API key
- HTTPS
- Yes
- CORS
- Unknown
- Category
- Cloud Platforms
- Version
- 2015-10-07
- Endpoints
- 56
- OpenAPI
- Specification ↗
- Spec updated
- 2020-03-11
Endpoints
| Method | Path | What it does |
|---|---|---|
| POST | /#X-Amz-Target=AWSEvents.ActivateEventSource | Activates a partner event source that has been deactivated. Once activated, your matching event bus will start receiving events from the event source. |
| POST | /#X-Amz-Target=AWSEvents.CancelReplay | Cancels the specified replay. |
| POST | /#X-Amz-Target=AWSEvents.CreateApiDestination | Creates an API destination, which is an HTTP invocation endpoint configured as a target for events. |
| POST | /#X-Amz-Target=AWSEvents.CreateArchive | Creates an archive of events with the specified settings. When you create an archive, incoming events might not immediately start being sent to the archive. All |
| POST | /#X-Amz-Target=AWSEvents.CreateConnection | Creates a connection. A connection defines the authorization type and credentials to use for authorization with an API destination HTTP endpoint. |
| POST | /#X-Amz-Target=AWSEvents.CreateEndpoint | 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 s |
| POST | /#X-Amz-Target=AWSEvents.CreateEventBus | Creates a new event bus within your account. This can be a custom event bus which you can use to receive events from your custom applications and services, or i |
| POST | /#X-Amz-Target=AWSEvents.CreatePartnerEventSource | <p>Called by an SaaS partner to create a partner event source. This operation is not used by Amazon Web Services customers.</p> <p>Each partner event source can |
| POST | /#X-Amz-Target=AWSEvents.DeactivateEventSource | <p>You can use this operation to temporarily stop receiving events from the specified partner event source. The matching event bus is not deleted. </p> <p>When |
| POST | /#X-Amz-Target=AWSEvents.DeauthorizeConnection | Removes all authorization parameters from the connection. This lets you remove the secret from the connection so you can reuse it without having to create a new |
| POST | /#X-Amz-Target=AWSEvents.DeleteApiDestination | Deletes the specified API destination. |
| POST | /#X-Amz-Target=AWSEvents.DeleteArchive | Deletes the specified archive. |
| POST | /#X-Amz-Target=AWSEvents.DeleteConnection | Deletes a connection. |
| POST | /#X-Amz-Target=AWSEvents.DeleteEndpoint | Delete an existing global endpoint. For more information about global endpoints, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-global |
| POST | /#X-Amz-Target=AWSEvents.DeleteEventBus | Deletes the specified custom event bus or partner event bus. All rules associated with this event bus need to be deleted. You can't delete your account's defaul |
| POST | /#X-Amz-Target=AWSEvents.DeletePartnerEventSource | <p>This operation is used by SaaS partners to delete a partner event source. This operation is not used by Amazon Web Services customers.</p> <p>When you delete |
| POST | /#X-Amz-Target=AWSEvents.DeleteRule | <p>Deletes the specified rule.</p> <p>Before you can delete the rule, you must remove all targets, using <a href="https://docs.aws.amazon.com/eventbridge/latest |
| POST | /#X-Amz-Target=AWSEvents.DescribeApiDestination | Retrieves details about an API destination. |
| POST | /#X-Amz-Target=AWSEvents.DescribeArchive | Retrieves details about an archive. |
| POST | /#X-Amz-Target=AWSEvents.DescribeConnection | Retrieves details about a connection. |
| POST | /#X-Amz-Target=AWSEvents.DescribeEndpoint | Get the information about an existing global endpoint. For more information about global endpoints, see <a href="https://docs.aws.amazon.com/eventbridge/latest/ |
| POST | /#X-Amz-Target=AWSEvents.DescribeEventBus | <p>Displays details about an event bus in your account. This can include the external Amazon Web Services accounts that are permitted to write events to your de |
| POST | /#X-Amz-Target=AWSEvents.DescribeEventSource | This operation lists details about a partner event source that is shared with your account. |
| POST | /#X-Amz-Target=AWSEvents.DescribePartnerEventSource | An SaaS partner can use this operation to list details about a partner event source that they have created. Amazon Web Services customers do not use this operat |
| POST | /#X-Amz-Target=AWSEvents.DescribeReplay | Retrieves details about a replay. Use <code>DescribeReplay</code> to determine the progress of a running replay. A replay processes events to replay based on th |
| POST | /#X-Amz-Target=AWSEvents.DescribeRule | <p>Describes the specified rule.</p> <p>DescribeRule does not list the targets of a rule. To see the targets associated with a rule, use <a href="https://docs.a |
| POST | /#X-Amz-Target=AWSEvents.DisableRule | <p>Disables the specified rule. A disabled rule won't match any events, and won't self-trigger if it has a schedule expression.</p> <p>When you disable a rule, |
| POST | /#X-Amz-Target=AWSEvents.EnableRule | <p>Enables the specified rule. If the rule does not exist, the operation fails.</p> <p>When you enable a rule, incoming events might not immediately start match |
| POST | /#X-Amz-Target=AWSEvents.ListApiDestinations | Retrieves a list of API destination in the account in the current Region. |
| POST | /#X-Amz-Target=AWSEvents.ListArchives | Lists your archives. You can either list all the archives or you can provide a prefix to match to the archive names. Filter parameters are exclusive. |
| POST | /#X-Amz-Target=AWSEvents.ListConnections | Retrieves a list of connections from the account. |
| POST | /#X-Amz-Target=AWSEvents.ListEndpoints | List the global endpoints associated with this account. For more information about global endpoints, see <a href="https://docs.aws.amazon.com/eventbridge/latest |
| POST | /#X-Amz-Target=AWSEvents.ListEventBuses | Lists all the event buses in your account, including the default event bus, custom event buses, and partner event buses. |
| POST | /#X-Amz-Target=AWSEvents.ListEventSources | You can use this to see all the partner event sources that have been shared with your Amazon Web Services account. For more information about partner event sour |
| POST | /#X-Amz-Target=AWSEvents.ListPartnerEventSourceAccounts | An SaaS partner can use this operation to display the Amazon Web Services account ID that a particular partner event source name is associated with. This operat |
| POST | /#X-Amz-Target=AWSEvents.ListPartnerEventSources | An SaaS partner can use this operation to list all the partner event source names that they have created. This operation is not used by Amazon Web Services cust |
| POST | /#X-Amz-Target=AWSEvents.ListReplays | Lists your replays. You can either list all the replays or you can provide a prefix to match to the replay names. Filter parameters are exclusive. |
| POST | /#X-Amz-Target=AWSEvents.ListRuleNamesByTarget | Lists the rules for the specified target. You can see which of the rules in Amazon EventBridge can invoke a specific target in your account. |
| POST | /#X-Amz-Target=AWSEvents.ListRules | <p>Lists your Amazon EventBridge rules. You can either list all the rules or you can provide a prefix to match to the rule names.</p> <p>ListRules does not list |
| POST | /#X-Amz-Target=AWSEvents.ListTagsForResource | Displays the tags associated with an EventBridge resource. In EventBridge, rules and event buses can be tagged. |
| POST | /#X-Amz-Target=AWSEvents.ListTargetsByRule | Lists the targets assigned to the specified rule. |
| POST | /#X-Amz-Target=AWSEvents.PutEvents | <p>Sends custom events to Amazon EventBridge so that they can be matched to rules.</p> <note> <p>PutEvents will only process nested JSON up to 1100 levels deep. |
| POST | /#X-Amz-Target=AWSEvents.PutPartnerEvents | This is used by SaaS partners to write events to a customer's partner event bus. Amazon Web Services customers do not use this operation. |
| POST | /#X-Amz-Target=AWSEvents.PutPermission | <p>Running <code>PutPermission</code> permits the specified Amazon Web Services account or Amazon Web Services organization to put events to the specified <i>ev |
| POST | /#X-Amz-Target=AWSEvents.PutRule | <p>Creates or updates the specified rule. Rules are enabled by default, or based on value of the state. You can disable a rule using <a href="https://docs.aws.a |
| POST | /#X-Amz-Target=AWSEvents.PutTargets | <p>Adds the specified targets to the specified rule, or updates the targets if they are already associated with the rule.</p> <p>Targets are the resources that |
| POST | /#X-Amz-Target=AWSEvents.RemovePermission | Revokes the permission of another Amazon Web Services account to be able to put events to the specified event bus. Specify the account to revoke by the <code>St |
| POST | /#X-Amz-Target=AWSEvents.RemoveTargets | <p>Removes the specified targets from the specified rule. When the rule is triggered, those targets are no longer be invoked.</p> <note> <p>A successful executi |
| POST | /#X-Amz-Target=AWSEvents.StartReplay | Starts the specified replay. Events are not necessarily replayed in the exact same order that they were added to the archive. A replay processes events to repla |
| POST | /#X-Amz-Target=AWSEvents.TagResource | <p>Assigns one or more tags (key-value pairs) to the specified EventBridge resource. Tags can help you organize and categorize your resources. You can also use |
| POST | /#X-Amz-Target=AWSEvents.TestEventPattern | <p>Tests whether the specified event pattern matches the provided event.</p> <p>Most services in Amazon Web Services treat : or / as the same character in Amazo |
| POST | /#X-Amz-Target=AWSEvents.UntagResource | Removes one or more tags from the specified EventBridge resource. In Amazon EventBridge (CloudWatch Events), rules and event buses can be tagged. |
| POST | /#X-Amz-Target=AWSEvents.UpdateApiDestination | Updates an API destination. |
| POST | /#X-Amz-Target=AWSEvents.UpdateArchive | Updates the specified archive. |
| POST | /#X-Amz-Target=AWSEvents.UpdateConnection | Updates settings for a connection. |
| POST | /#X-Amz-Target=AWSEvents.UpdateEndpoint | Update an existing endpoint. For more information about global endpoints, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-global-endpoi |
Questions
Does the Amazon EventBridge API need an API key?
Yes. The Amazon EventBridge API uses API key authentication; the documentation explains how to get credentials.
Does the Amazon EventBridge API support HTTPS?
Yes, the Amazon EventBridge API is served over HTTPS.
How many endpoints does the Amazon EventBridge API have?
Its OpenAPI description lists 56 endpoints in version 2015-10-07. All of them are shown on this page.
What are alternatives to the Amazon EventBridge API?
Other Cloud Platforms APIs include Remote Settings PROD, Linode API, DigitalOcean API, Vercel API, Platform API.
Similar cloud platforms APIs
Compare alternatives →Remote Settings PROD
Cloud PlatformsFirefox is a free web browser backed by Mozilla, a non-profit dedicated to internet health and privacy.
Linode API
Cloud Platforms## Introduction The Linode API provides the ability to programmatically manage the full range of Linode products and services. This reference is designed to assist application developers and system administrators. Each endpoint includes descriptions, request syntax, and examples using standard HTTP requests. Response data is returned in JSON format. This document was generated from our OpenAPI Specification. See the <a target="_top" href="https://www.openapis.org">OpenAPI website</a> for more information. <a target="_top" href="/docs/api/openapi.yaml">Download the Linode OpenAPI Specification</a>. ## Changelog <a target="_top" href="/docs/products/tools/api/release-notes/">View our Changelog</a> to see release notes on all changes made to our API. ## Access and Authentication Some endpoints are publicly accessible without requiring authentication. All endpoints affecting your Account, however, require either a Personal Access Token or OAuth authentication (when using third-party applications). ### Personal Access Token The easiest way to access the API is with a Personal Access Token (PAT) generated from the <a target="_top" href="https://cloud.linode.com/profile/tokens">Linode Cloud Manager</a> or the [Create Personal Access Token](/docs/api/profile/#personal-access-token-create) endpoint. All scopes for the OAuth security model ([defined below](/docs/api/profile/#oauth)) apply to this security model as well. #### Authentication | Security Scheme Type: | HTTP | |-----------------------|------| | **HTTP Authorization Scheme** | bearer | ### OAuth If you only need to access the Linode API for personal use, we recommend that you create a [personal access token](/docs/api/#personal-access-token). If you're designing an application that can authenticate with an arbitrary Linode user, then you should use the OAuth 2.0 workflows presented in this section. For a more detailed example of an OAuth 2.0 implementation, see our guide on [How to Create an OAuth App with the Linode Python API Library](/docs/products/tools/api/guides/create-an-oauth-app-with-the-python-api-library/#oauth-2-authentication-exchange). Before you implement OAuth in your application, you first need to create an OAuth client. You can do this [with the Linode API](/docs/api/account/#oauth-client-create) or [via the Cloud Manager](https://cloud.linode.com/profile/clients): - When creating the client, you'll supply a `label` and a `redirect_uri` (referred to as the Callback URL in the Cloud Manager). - The response from this endpoint will give you a `client_id` and a `secret`. - Clients can be public or private, and are private by default. You can choose to make the client public when it is created. - A private client is used with applications which can securely store the client secret (that is, the secret returned to you when you first created the client). For example, an application running on a secured server that only the developer has access to would use a private OAuth client. This is also called a confidential client in some OAuth documentation. - A public client is used with applications where the client secret is not guaranteed to be secure. For example, a native app running on a user's computer may not be able to keep the client secret safe, as a user could potentially inspect the source of the application. So, native apps or apps that run in a user's browser should use a public client. - Public and private clients follow different workflows, as described below. #### OAuth Workflow The OAuth workflow is a series of exchanges between your third-party app and Linode. The workflow is used to authenticate a user before an application can start making API calls on the user's behalf. Notes: - With respect to the diagram in [section 1.2 of RFC 6749](https://tools.ietf.org/html/rfc6749#section-1.2), login.linode.com (referred to in this section as the *login server*) is the Resource Owner and the Authorization Server; api.linode.com (referred to here as the *api se
DigitalOcean API
Cloud Platforms# Introduction The DigitalOcean API allows you to manage Droplets and resources within the DigitalOcean cloud in a simple, programmatic way using conventional HTTP requests. All of the functionality that you are familiar with in the DigitalOcean control panel is also available through the API, allowing you to script the complex actions that your situation requires. The API documentation will start with a general overview about the design and technology that has been implemented, followed by reference information about specific endpoints. ## Requests Any tool that is fluent in HTTP can communicate with the API simply by requesting the correct URI. Requests should be made using the HTTPS protocol so that traffic is encrypted. The interface responds to different methods depending on the action required. |Method|Usage| |--- |--- | |GET|For simple retrieval of information about your account, Droplets, or environment, you should use the GET method. The information you request will be returned to you as a JSON object. The attributes defined by the JSON object can be used to form additional requests. Any request using the GET method is read-only and will not affect any of the objects you are querying.| |DELETE|To destroy a resource and remove it from your account and environment, the DELETE method should be used. This will remove the specified object if it is found. If it is not found, the operation will return a response indicating that the object was not found. This idempotency means that you do not have to check for a resource's availability prior to issuing a delete command, the final state will be the same regardless of its existence.| |PUT|To update the information about a resource in your account, the PUT method is available. Like the DELETE Method, the PUT method is idempotent. It sets the state of the target using the provided values, regardless of their current values. Requests using the PUT method do not need to check the current attributes of the object.| |PATCH|Some resources support partial modification. In these cases, the PATCH method is available. Unlike PUT which generally requires a complete representation of a resource, a PATCH request is is a set of instructions on how to modify a resource updating only specific attributes.| |POST|To create a new object, your request should specify the POST method. The POST request includes all of the attributes necessary to create a new object. When you wish to create a new object, send a POST request to the target endpoint.| |HEAD|Finally, to retrieve metadata information, you should use the HEAD method to get the headers. This returns only the header of what would be returned with an associated GET request. Response headers contain some useful information about your API access and the results that are available for your request. For instance, the headers contain your current rate-limit value and the amount of time available until the limit resets. It also contains metrics about the total number of objects found, pagination information, and the total content length.| ## HTTP Statuses Along with the HTTP methods that the API responds to, it will also return standard HTTP statuses, including error codes. In the event of a problem, the status will contain the error code, while the body of the response will usually contain additional information about the problem that was encountered. In general, if the status returned is in the 200 range, it indicates that the request was fulfilled successfully and that no error was encountered. Return codes in the 400 range typically indicate that there was an issue with the request that was sent. Among other things, this could mean that you did not authenticate correctly, that you are requesting an action that you do not have authorization for, that the object you are requesting does not exist, or that your request is malformed. If you receive a status in the 500 range, this generally indicates a server-side problem. This means that we are having
Vercel API
Cloud PlatformsVercel combines the best developer experience with an obsessive focus on end-user performance. Our platform enables frontend teams to do their best work.
Platform API
Cloud PlatformsThe [REST API specification](https://www.ably.io/documentation/rest-api) for Ably.
Azure Data Lake Storage
Cloud PlatformsAzure Data Lake Storage provides storage for Hadoop and other big data workloads.
Listed from APIs.guru (CC0).