Open documentation ↗Overview
<fullname>Amazon Elasticsearch Configuration Service</fullname> <p>Use the Amazon Elasticsearch Configuration API to create, configure, and manage Elasticsearch domains.</p> <p>For sample code that uses the Configuration API, see the <a href="https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-configuration-samples.html">Amazon Elasticsearch Service Developer Guide</a>. The guide also contains <a href="https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-request-signing.html">sample code for sending signed HTTP requests to the Elasticsearch APIs</a>.</p> <p>The endpoint for configuration service requests is region-specific: es.<i>region</i>.amazonaws.com. For example, es.us-east-1.amazonaws.com. For a current list of supported regions and endpoints, see <a href="http://docs.aws.amazon.com/general/latest/gr/rande.html#elasticsearch-service-regions" target="_blank">Regions and Endpoints</a>.</p>
Amazon Elasticsearch Service is a cloud platforms API from amazonaws.com. Requests are authenticated with an API key. It is served over HTTPS. Its OpenAPI description documents 50 endpoints.
At a glance
- Authentication
- API key
- HTTPS
- Yes
- CORS
- Unknown
- Category
- Cloud Platforms
- Version
- 2015-01-01
- Endpoints
- 50
- OpenAPI
- Specification ↗
- Spec updated
- 2020-04-22
Endpoints
| Method | Path | What it does |
|---|---|---|
| PUT | /2015-01-01/es/ccs/inboundConnection/{ConnectionId}/accept | Allows the destination domain owner to accept an inbound cross-cluster search connection request. |
| POST | /2015-01-01/tags | Attaches tags to an existing Elasticsearch domain. Tags are a set of case-sensitive key value pairs. An Elasticsearch domain may have up to 10 tags. See <a href |
| POST | /2015-01-01/packages/associate/{PackageID}/{DomainName} | Associates a package with an Amazon ES domain. |
| POST | /2015-01-01/es/domain/{DomainName}/authorizeVpcEndpointAccess | Provides access to an Amazon OpenSearch Service domain through the use of an interface VPC endpoint. |
| POST | /2015-01-01/es/serviceSoftwareUpdate/cancel | Cancels a scheduled service software update for an Amazon ES domain. You can only perform this operation before the <code>AutomatedUpdateDate</code> and when th |
| POST | /2015-01-01/es/domain | Creates a new Elasticsearch domain. For more information, see <a href="http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedom |
| POST | /2015-01-01/es/ccs/outboundConnection | Creates a new cross-cluster search connection from a source domain to a destination domain. |
| POST | /2015-01-01/packages | Create a package for use with Amazon ES domains. |
| GET | /2015-01-01/es/vpcEndpoints | Retrieves all Amazon OpenSearch Service-managed VPC endpoints in the current account and Region. |
| POST | /2015-01-01/es/vpcEndpoints | Creates an Amazon OpenSearch Service-managed VPC endpoint. |
| GET | /2015-01-01/es/domain/{DomainName} | Returns domain configuration information about the specified Elasticsearch domain, including the domain ID, domain endpoint, and domain ARN. |
| DELETE | /2015-01-01/es/domain/{DomainName} | Permanently deletes the specified Elasticsearch domain and all of its data. Once a domain is deleted, it cannot be recovered. |
| DELETE | /2015-01-01/es/role | Deletes the service-linked role that Elasticsearch Service uses to manage and maintain VPC domains. Role deletion will fail if any existing VPC domains use the |
| DELETE | /2015-01-01/es/ccs/inboundConnection/{ConnectionId} | Allows the destination domain owner to delete an existing inbound cross-cluster search connection. |
| DELETE | /2015-01-01/es/ccs/outboundConnection/{ConnectionId} | Allows the source domain owner to delete an existing outbound cross-cluster search connection. |
| DELETE | /2015-01-01/packages/{PackageID} | Delete the package. |
| DELETE | /2015-01-01/es/vpcEndpoints/{VpcEndpointId} | Deletes an Amazon OpenSearch Service-managed interface VPC endpoint. |
| GET | /2015-01-01/es/domain/{DomainName}/autoTunes | Provides scheduled Auto-Tune action details for the Elasticsearch domain, such as Auto-Tune action type, description, severity, and scheduled date. |
| GET | /2015-01-01/es/domain/{DomainName}/progress | Returns information about the current blue/green deployment happening on a domain, including a change ID, status, and progress stages. |
| GET | /2015-01-01/es/domain/{DomainName}/config | Provides cluster configuration information about the specified Elasticsearch domain, such as the state, creation date, update version, and update date for clust |
| POST | /2015-01-01/es/domain/{DomainName}/config | Modifies the cluster configuration of the specified Elasticsearch domain, setting as setting the instance type and the number of instances. |
| POST | /2015-01-01/es/domain-info | Returns domain configuration information about the specified Elasticsearch domains, including the domain ID, domain endpoint, and domain ARN. |
| GET | /2015-01-01/es/instanceTypeLimits/{ElasticsearchVersion}/{InstanceType} | Describe Elasticsearch Limits for a given InstanceType and ElasticsearchVersion. When modifying existing Domain, specify the <code> <a>DomainName</a> </code> to |
| POST | /2015-01-01/es/ccs/inboundConnection/search | Lists all the inbound cross-cluster search connections for a destination domain. |
| POST | /2015-01-01/es/ccs/outboundConnection/search | Lists all the outbound cross-cluster search connections for a source domain. |
| POST | /2015-01-01/packages/describe | Describes all packages available to Amazon ES. Includes options for filtering, limiting the number of results, and pagination. |
| GET | /2015-01-01/es/reservedInstanceOfferings | Lists available reserved Elasticsearch instance offerings. |
| GET | /2015-01-01/es/reservedInstances | Returns information about reserved Elasticsearch instances for this account. |
| POST | /2015-01-01/es/vpcEndpoints/describe | Describes one or more Amazon OpenSearch Service-managed VPC endpoints. |
| POST | /2015-01-01/packages/dissociate/{PackageID}/{DomainName} | Dissociates a package from the Amazon ES domain. |
| GET | /2015-01-01/es/compatibleVersions | Returns a list of upgrade compatible Elastisearch versions. You can optionally pass a <code> <a>DomainName</a> </code> to get all upgrade compatible Elasticsear |
| GET | /2015-01-01/packages/{PackageID}/history | Returns a list of versions of the package, along with their creation time and commit message. |
| GET | /2015-01-01/es/upgradeDomain/{DomainName}/history | Retrieves the complete history of the last 10 upgrades that were performed on the domain. |
| GET | /2015-01-01/es/upgradeDomain/{DomainName}/status | Retrieves the latest status of the last upgrade or upgrade eligibility check that was performed on the domain. |
| GET | /2015-01-01/domain | Returns the name of all Elasticsearch domains owned by the current user's account. |
| GET | /2015-01-01/packages/{PackageID}/domains | Lists all Amazon ES domains associated with the package. |
| GET | /2015-01-01/es/instanceTypes/{ElasticsearchVersion} | List all Elasticsearch instance types that are supported for given ElasticsearchVersion |
| GET | /2015-01-01/es/versions | List all supported Elasticsearch versions |
| GET | /2015-01-01/domain/{DomainName}/packages | Lists all packages associated with the Amazon ES domain. |
| GET | /2015-01-01/tags/#arn | Returns all tags for the given Elasticsearch domain. |
| GET | /2015-01-01/es/domain/{DomainName}/listVpcEndpointAccess | Retrieves information about each principal that is allowed to access a given Amazon OpenSearch Service domain through the use of an interface VPC endpoint. |
| GET | /2015-01-01/es/domain/{DomainName}/vpcEndpoints | Retrieves all Amazon OpenSearch Service-managed VPC endpoints associated with a particular domain. |
| POST | /2015-01-01/es/purchaseReservedInstanceOffering | Allows you to purchase reserved Elasticsearch instances. |
| PUT | /2015-01-01/es/ccs/inboundConnection/{ConnectionId}/reject | Allows the destination domain owner to reject an inbound cross-cluster search connection request. |
| POST | /2015-01-01/tags-removal | Removes the specified set of tags from the specified Elasticsearch domain. |
| POST | /2015-01-01/es/domain/{DomainName}/revokeVpcEndpointAccess | Revokes access to an Amazon OpenSearch Service domain that was provided through an interface VPC endpoint. |
| POST | /2015-01-01/es/serviceSoftwareUpdate/start | Schedules a service software update for an Amazon ES domain. |
| POST | /2015-01-01/packages/update | Updates a package for use with Amazon ES domains. |
| POST | /2015-01-01/es/vpcEndpoints/update | Modifies an Amazon OpenSearch Service-managed interface VPC endpoint. |
| POST | /2015-01-01/es/upgradeDomain | Allows you to either upgrade your domain or perform an Upgrade eligibility check to a compatible Elasticsearch version. |
Questions
Does the Amazon Elasticsearch Service API need an API key?
Yes. The Amazon Elasticsearch Service API uses API key authentication; the documentation explains how to get credentials.
Does the Amazon Elasticsearch Service API support HTTPS?
Yes, the Amazon Elasticsearch Service API is served over HTTPS.
How many endpoints does the Amazon Elasticsearch Service API have?
Its OpenAPI description lists 50 endpoints in version 2015-01-01. All of them are shown on this page.
What are alternatives to the Amazon Elasticsearch Service 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).