AWS Health APIs and Notifications API

by amazonaws.com

Overview

<fullname>Health</fullname> The Health API provides programmatic access to the Health information that appears in the <a href="https://phd.aws.amazon.com/phd/home#/">Personal Health Dashboard</a>. You can use the API operations to get information about events that might affect your Amazon Web Services services and resources. <note> <ul> <li> You must have a Business, Enterprise On-Ramp, or Enterprise Support plan from <a href="http://aws.amazon.com/premiumsupport/">Amazon Web Services Support</a> to use the Health API. If you call the Health API from an Amazon Web Services account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, you receive a <code>SubscriptionRequiredException</code> error. </li> <li> You can use the Health endpoint health.us-east-1.amazonaws.com (HTTPS) to call the Health API operations. Health supports a multi-Region application architecture and has two regional endpoints in an active-passive configuration. You can use the high availability endpoint example to determine which Amazon Web Services Region is active, so that you can get the latest information from the API. For more information, see <a href="https://docs.aws.amazon.com/health/latest/ug/health-api.html">Accessing the Health API</a> in the Health User Guide. </li> </ul> </note> For authentication of requests, Health uses the <a href="https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html">Signature Version 4 Signing Process</a>. If your Amazon Web Services account is part of Organizations, you can use the Health organizational view feature. This feature provides a centralized view of Health events across all accounts in your organization. You can aggregate Health events in real time to identify accounts in your organization that are affected by an operational event or get notified of security vulnerabilities. Use the organizational view API operations to enable this feature and return event information. For more information, see <a href="https://docs.aws.amazon.com/health/latest/ug/aggregate-events.html">Aggregating Health events</a> in the Health User Guide. <note> When you use the Health API operations to return Health events, see the following recommendations: <ul> <li> Use the <a href="https://docs.aws.amazon.com/health/latest/APIReference/API_Event.html#AWSHealth-Type-Event-eventScopeCode">eventScopeCode</a> parameter to specify whether to return Health events that are public or account-specific. </li> <li> Use pagination to view all events from the response. For example, if you call the <code>DescribeEventsForOrganization</code> operation to get all events in your organization, you might receive several page results. Specify the <code>nextToken</code> in the next request to return more results. </li> </ul> </note>

AWS Health APIs and Notifications is a cloud platforms API from amazonaws.com. Requests are authenticated with an API key. It is served over HTTPS. Its OpenAPI description documents 13 endpoints.

At a glance

Authentication: API key
HTTPS: Yes
CORS: Unknown
Category: Cloud Platforms
Base URL: https://health.us-east-1.amazonaws.com
Version: 2016-08-04
Endpoints: 13
OpenAPI: Specification ↗
Spec updated: 2020-03-11

Make a first request

Replace the placeholders; the documentation says exactly where credentials go.

cURL

curl -X POST "https://health.us-east-1.amazonaws.com/#X-Amz-Target=AWSHealth_20160804.DescribeAffectedAccountsForOrganization" \
  -H "Accept: application/json" \
  -H "X-API-Key: YOUR_API_KEY"

JavaScript

const response = await fetch("https://health.us-east-1.amazonaws.com/#X-Amz-Target=AWSHealth_20160804.DescribeAffectedAccountsForOrganization", {
  method: "POST",
  headers: {
    "Accept": "application/json",
    "X-API-Key": "YOUR_API_KEY",
  },
});
const data = await response.json();
console.log(data);

Python

import requests

response = requests.request(
    "POST",
    "https://health.us-east-1.amazonaws.com/#X-Amz-Target=AWSHealth_20160804.DescribeAffectedAccountsForOrganization",
    headers={
    "Accept": "application/json",
    "X-API-Key": "YOUR_API_KEY",
    },
    timeout=30,
)
print(response.json())

Endpoints

Method	Path	What it does
POST	`/#X-Amz-Target=AWSHealth_20160804.DescribeAffectedAccountsForOrganization`	<p>Returns a list of accounts in the organization from Organizations that are affected by the provided event. For more information about the different types of
POST	`/#X-Amz-Target=AWSHealth_20160804.DescribeAffectedEntities`	<p>Returns a list of entities that have been affected by the specified events, based on the specified filter criteria. Entities can refer to individual customer
POST	`/#X-Amz-Target=AWSHealth_20160804.DescribeAffectedEntitiesForOrganization`	<p>Returns a list of entities that have been affected by one or more events for one or more accounts in your organization in Organizations, based on the filter
POST	`/#X-Amz-Target=AWSHealth_20160804.DescribeEntityAggregates`	Returns the number of entities that are affected by each of the specified events.
POST	`/#X-Amz-Target=AWSHealth_20160804.DescribeEventAggregates`	<p>Returns the number of events of each event type (issue, scheduled change, and account notification). If no filter is specified, the counts of all events in e
POST	`/#X-Amz-Target=AWSHealth_20160804.DescribeEventDetails`	<p>Returns detailed information about one or more specified events. Information includes standard event data (Amazon Web Services Region, service, and so on, as
POST	`/#X-Amz-Target=AWSHealth_20160804.DescribeEventDetailsForOrganization`	<p>Returns detailed information about one or more specified events for one or more Amazon Web Services accounts in your organization. This information includes
POST	`/#X-Amz-Target=AWSHealth_20160804.DescribeEventTypes`	<p>Returns the event types that meet the specified filter criteria. You can use this API operation to find information about the Health event, such as the categ
POST	`/#X-Amz-Target=AWSHealth_20160804.DescribeEvents`	<p> Returns information about events that meet the specified filter criteria. Events are returned in a summary form and do not include the detailed description,
POST	`/#X-Amz-Target=AWSHealth_20160804.DescribeEventsForOrganization`	<p>Returns information about events across your organization in Organizations. You can use the<code>filters</code> parameter to specify the events that you want
POST	`/#X-Amz-Target=AWSHealth_20160804.DescribeHealthServiceStatusForOrganization`	This operation provides status information on enabling or disabling Health to work with your organization. To call this operation, you must sign in as an IAM us
POST	`/#X-Amz-Target=AWSHealth_20160804.DisableHealthServiceAccessForOrganization`	<p>Disables Health from working with Organizations. To call this operation, you must sign in as an Identity and Access Management (IAM) user, assume an IAM role
POST	`/#X-Amz-Target=AWSHealth_20160804.EnableHealthServiceAccessForOrganization`	<p>Enables Health to work with Organizations. You can use the organizational view feature to aggregate events from all Amazon Web Services accounts in your orga

Questions

Does the AWS Health APIs and Notifications API need an API key?

Yes. The AWS Health APIs and Notifications API uses API key authentication; the documentation explains how to get credentials.

Does the AWS Health APIs and Notifications API support HTTPS?

Yes, the AWS Health APIs and Notifications API is served over HTTPS.

How many endpoints does the AWS Health APIs and Notifications API have?

Its OpenAPI description lists 13 endpoints in version 2016-08-04. All of them are shown on this page.

What are alternatives to the AWS Health APIs and Notifications API?

Other Cloud Platforms APIs include Remote Settings PROD, Linode API, DigitalOcean API, Vercel API, Platform API.

Compare alternatives →

Remote Settings PROD

Cloud Platforms

Firefox is a free web browser backed by Mozilla, a non-profit dedicated to internet health and privacy.

No auth19 endpoints

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

Bearer token350 endpoints

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

Bearer token290 endpoints

Vercel API

Cloud Platforms

Vercel combines the best developer experience with an obsessive focus on end-user performance. Our platform enables frontend teams to do their best work.

Bearer token112 endpoints