Open documentation ↗Overview
<fullname>Global Accelerator</fullname> <p>This is the <i>Global Accelerator API Reference</i>. This guide is for developers who need detailed information about Global Accelerator API actions, data types, and errors. For more information about Global Accelerator features, see the <a href="https://docs.aws.amazon.com/global-accelerator/latest/dg/what-is-global-accelerator.html">Global Accelerator Developer Guide</a>.</p> <p>Global Accelerator is a service in which you create <i>accelerators</i> to improve the performance of your applications for local and global users. Depending on the type of accelerator you choose, you can gain additional benefits. </p> <ul> <li> <p>By using a standard accelerator, you can improve availability of your internet applications that are used by a global audience. With a standard accelerator, Global Accelerator directs traffic to optimal endpoints over the Amazon Web Services global network. </p> </li> <li> <p>For other scenarios, you might choose a custom routing accelerator. With a custom routing accelerator, you can use application logic to directly map one or more users to a specific endpoint among many endpoints.</p> </li> </ul> <important> <p>Global Accelerator is a global service that supports endpoints in multiple Amazon Web Services Regions but you must specify the US West (Oregon) Region to create, update, or otherwise work with accelerators. That is, for example, specify <code>--region us-west-2</code> on AWS CLI commands.</p> </important> <p>By default, Global Accelerator provides you with static IP addresses that you associate with your accelerator. The static IP addresses are anycast from the Amazon Web Services edge network. For IPv4, Global Accelerator provides two static IPv4 addresses. For dual-stack, Global Accelerator provides a total of four addresses: two static IPv4 addresses and two static IPv6 addresses. With a standard accelerator for IPv4, instead of using the addresses that Global Accelerator provides, you can configure these entry points to be IPv4 addresses from your own IP address ranges that you bring toGlobal Accelerator (BYOIP). </p> <p>For a standard accelerator, they distribute incoming application traffic across multiple endpoint resources in multiple Amazon Web Services Regions , which increases the availability of your applications. Endpoints for standard accelerators can be Network Load Balancers, Application Load Balancers, Amazon EC2 instances, or Elastic IP addresses that are located in one Amazon Web Services Region or multiple Amazon Web Services Regions. For custom routing accelerators, you map traffic that arrives to the static IP addresses to specific Amazon EC2 servers in endpoints that are virtual private cloud (VPC) subnets.</p> <important> <p>The static IP addresses remain assigned to your accelerator for as long as it exists, even if you disable the accelerator and it no longer accepts or routes traffic. However, when you <i>delete</i> an accelerator, you lose the static IP addresses that are assigned to it, so you can no longer route traffic by using them. You can use IAM policies like tag-based permissions with Global Accelerator to limit the users who have permissions to delete an accelerator. For more information, see <a href="https://docs.aws.amazon.com/global-accelerator/latest/dg/access-control-manage-access-tag-policies.html">Tag-based policies</a>.</p> </important> <p>For standard accelerators, Global Accelerator uses the Amazon Web Services global network to route traffic to the optimal regional endpoint based on health, client location, and policies that you configure. The service reacts instantly to changes in health or configuration to ensure that internet traffic from clients is always directed to healthy endpoints.</p> <p>For more information about understanding and using Global Accelerator, see the <a href="https://docs.aws.amazon.com/global-accelerator/latest/dg/what-is-global-accelerator.html">Global Accelerator Developer Guide<
AWS Global Accelerator is a cloud platforms API from amazonaws.com. Requests are authenticated with an API key. It is served over HTTPS. Its OpenAPI description documents 49 endpoints.
At a glance
- Authentication
- API key
- HTTPS
- Yes
- CORS
- Unknown
- Category
- Cloud Platforms
- Version
- 2018-08-08
- Endpoints
- 49
- OpenAPI
- Specification ↗
- Spec updated
- 2020-03-28
Endpoints
| Method | Path | What it does |
|---|---|---|
| POST | /#X-Amz-Target=GlobalAccelerator_V20180706.AddCustomRoutingEndpoints | <p>Associate a virtual private cloud (VPC) subnet endpoint with your custom routing accelerator.</p> <p>The listener port range must be large enough to support |
| POST | /#X-Amz-Target=GlobalAccelerator_V20180706.AddEndpoints | <p>Add endpoints to an endpoint group. The <code>AddEndpoints</code> API operation is the recommended option for adding endpoints. The alternative options are t |
| POST | /#X-Amz-Target=GlobalAccelerator_V20180706.AdvertiseByoipCidr | <p>Advertises an IPv4 address range that is provisioned for use with your Amazon Web Services resources through bring your own IP addresses (BYOIP). It can take |
| POST | /#X-Amz-Target=GlobalAccelerator_V20180706.AllowCustomRoutingTraffic | <p>Specify the Amazon EC2 instance (destination) IP addresses and ports for a VPC subnet endpoint that can receive traffic for a custom routing accelerator. You |
| POST | /#X-Amz-Target=GlobalAccelerator_V20180706.CreateAccelerator | <p>Create an accelerator. An accelerator includes one or more listeners that process inbound connections and direct traffic to one or more endpoint groups, each |
| POST | /#X-Amz-Target=GlobalAccelerator_V20180706.CreateCustomRoutingAccelerator | <p>Create a custom routing accelerator. A custom routing accelerator directs traffic to one of possibly thousands of Amazon EC2 instance destinations running in |
| POST | /#X-Amz-Target=GlobalAccelerator_V20180706.CreateCustomRoutingEndpointGroup | Create an endpoint group for the specified listener for a custom routing accelerator. An endpoint group is a collection of endpoints in one Amazon Web Services |
| POST | /#X-Amz-Target=GlobalAccelerator_V20180706.CreateCustomRoutingListener | Create a listener to process inbound connections from clients to a custom routing accelerator. Connections arrive to assigned static IP addresses on the port ra |
| POST | /#X-Amz-Target=GlobalAccelerator_V20180706.CreateEndpointGroup | Create an endpoint group for the specified listener. An endpoint group is a collection of endpoints in one Amazon Web Services Region. A resource must be valid |
| POST | /#X-Amz-Target=GlobalAccelerator_V20180706.CreateListener | Create a listener to process inbound connections from clients to an accelerator. Connections arrive to assigned static IP addresses on a port, port range, or li |
| POST | /#X-Amz-Target=GlobalAccelerator_V20180706.DeleteAccelerator | <p>Delete an accelerator. Before you can delete an accelerator, you must disable it and remove all dependent resources (listeners and endpoint groups). To disab |
| POST | /#X-Amz-Target=GlobalAccelerator_V20180706.DeleteCustomRoutingAccelerator | <p>Delete a custom routing accelerator. Before you can delete an accelerator, you must disable it and remove all dependent resources (listeners and endpoint gro |
| POST | /#X-Amz-Target=GlobalAccelerator_V20180706.DeleteCustomRoutingEndpointGroup | Delete an endpoint group from a listener for a custom routing accelerator. |
| POST | /#X-Amz-Target=GlobalAccelerator_V20180706.DeleteCustomRoutingListener | Delete a listener for a custom routing accelerator. |
| POST | /#X-Amz-Target=GlobalAccelerator_V20180706.DeleteEndpointGroup | Delete an endpoint group from a listener. |
| POST | /#X-Amz-Target=GlobalAccelerator_V20180706.DeleteListener | Delete a listener from an accelerator. |
| POST | /#X-Amz-Target=GlobalAccelerator_V20180706.DenyCustomRoutingTraffic | <p>Specify the Amazon EC2 instance (destination) IP addresses and ports for a VPC subnet endpoint that cannot receive traffic for a custom routing accelerator. |
| POST | /#X-Amz-Target=GlobalAccelerator_V20180706.DeprovisionByoipCidr | <p>Releases the specified address range that you provisioned to use with your Amazon Web Services resources through bring your own IP addresses (BYOIP) and dele |
| POST | /#X-Amz-Target=GlobalAccelerator_V20180706.DescribeAccelerator | Describe an accelerator. |
| POST | /#X-Amz-Target=GlobalAccelerator_V20180706.DescribeAcceleratorAttributes | Describe the attributes of an accelerator. |
| POST | /#X-Amz-Target=GlobalAccelerator_V20180706.DescribeCustomRoutingAccelerator | Describe a custom routing accelerator. |
| POST | /#X-Amz-Target=GlobalAccelerator_V20180706.DescribeCustomRoutingAcceleratorAttributes | Describe the attributes of a custom routing accelerator. |
| POST | /#X-Amz-Target=GlobalAccelerator_V20180706.DescribeCustomRoutingEndpointGroup | Describe an endpoint group for a custom routing accelerator. |
| POST | /#X-Amz-Target=GlobalAccelerator_V20180706.DescribeCustomRoutingListener | The description of a listener for a custom routing accelerator. |
| POST | /#X-Amz-Target=GlobalAccelerator_V20180706.DescribeEndpointGroup | Describe an endpoint group. |
| POST | /#X-Amz-Target=GlobalAccelerator_V20180706.DescribeListener | Describe a listener. |
| POST | /#X-Amz-Target=GlobalAccelerator_V20180706.ListAccelerators | List the accelerators for an Amazon Web Services account. |
| POST | /#X-Amz-Target=GlobalAccelerator_V20180706.ListByoipCidrs | Lists the IP address ranges that were specified in calls to <a href="https://docs.aws.amazon.com/global-accelerator/latest/api/ProvisionByoipCidr.html">Provisio |
| POST | /#X-Amz-Target=GlobalAccelerator_V20180706.ListCustomRoutingAccelerators | List the custom routing accelerators for an Amazon Web Services account. |
| POST | /#X-Amz-Target=GlobalAccelerator_V20180706.ListCustomRoutingEndpointGroups | List the endpoint groups that are associated with a listener for a custom routing accelerator. |
| POST | /#X-Amz-Target=GlobalAccelerator_V20180706.ListCustomRoutingListeners | List the listeners for a custom routing accelerator. |
| POST | /#X-Amz-Target=GlobalAccelerator_V20180706.ListCustomRoutingPortMappings | <p>Provides a complete mapping from the public accelerator IP address and port to destination EC2 instance IP addresses and ports in the virtual public cloud (V |
| POST | /#X-Amz-Target=GlobalAccelerator_V20180706.ListCustomRoutingPortMappingsByDestination | List the port mappings for a specific EC2 instance (destination) in a VPC subnet endpoint. The response is the mappings for one destination IP address. This is |
| POST | /#X-Amz-Target=GlobalAccelerator_V20180706.ListEndpointGroups | List the endpoint groups that are associated with a listener. |
| POST | /#X-Amz-Target=GlobalAccelerator_V20180706.ListListeners | List the listeners for an accelerator. |
| POST | /#X-Amz-Target=GlobalAccelerator_V20180706.ListTagsForResource | <p>List all tags for an accelerator. </p> <p>For more information, see <a href="https://docs.aws.amazon.com/global-accelerator/latest/dg/tagging-in-global-accel |
| POST | /#X-Amz-Target=GlobalAccelerator_V20180706.ProvisionByoipCidr | <p>Provisions an IP address range to use with your Amazon Web Services resources through bring your own IP addresses (BYOIP) and creates a corresponding address |
| POST | /#X-Amz-Target=GlobalAccelerator_V20180706.RemoveCustomRoutingEndpoints | Remove endpoints from a custom routing accelerator. |
| POST | /#X-Amz-Target=GlobalAccelerator_V20180706.RemoveEndpoints | <p>Remove endpoints from an endpoint group. </p> <p>The <code>RemoveEndpoints</code> API operation is the recommended option for removing endpoints. The alterna |
| POST | /#X-Amz-Target=GlobalAccelerator_V20180706.TagResource | <p>Add tags to an accelerator resource. </p> <p>For more information, see <a href="https://docs.aws.amazon.com/global-accelerator/latest/dg/tagging-in-global-ac |
| POST | /#X-Amz-Target=GlobalAccelerator_V20180706.UntagResource | <p>Remove tags from a Global Accelerator resource. When you specify a tag key, the action removes both that key and its associated value. The operation succeeds |
| POST | /#X-Amz-Target=GlobalAccelerator_V20180706.UpdateAccelerator | <p>Update an accelerator. </p> <important> <p>Global Accelerator is a global service that supports endpoints in multiple Amazon Web Services Regions but you mus |
| POST | /#X-Amz-Target=GlobalAccelerator_V20180706.UpdateAcceleratorAttributes | Update the attributes for an accelerator. |
| POST | /#X-Amz-Target=GlobalAccelerator_V20180706.UpdateCustomRoutingAccelerator | Update a custom routing accelerator. |
| POST | /#X-Amz-Target=GlobalAccelerator_V20180706.UpdateCustomRoutingAcceleratorAttributes | Update the attributes for a custom routing accelerator. |
| POST | /#X-Amz-Target=GlobalAccelerator_V20180706.UpdateCustomRoutingListener | Update a listener for a custom routing accelerator. |
| POST | /#X-Amz-Target=GlobalAccelerator_V20180706.UpdateEndpointGroup | Update an endpoint group. A resource must be valid and active when you add it as an endpoint. |
| POST | /#X-Amz-Target=GlobalAccelerator_V20180706.UpdateListener | Update a listener. |
| POST | /#X-Amz-Target=GlobalAccelerator_V20180706.WithdrawByoipCidr | <p>Stops advertising an address range that is provisioned as an address pool. You can perform this operation at most once every 10 seconds, even if you specify |
Questions
Does the AWS Global Accelerator API need an API key?
Yes. The AWS Global Accelerator API uses API key authentication; the documentation explains how to get credentials.
Does the AWS Global Accelerator API support HTTPS?
Yes, the AWS Global Accelerator API is served over HTTPS.
How many endpoints does the AWS Global Accelerator API have?
Its OpenAPI description lists 49 endpoints in version 2018-08-08. All of them are shown on this page.
What are alternatives to the AWS Global Accelerator 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).