Open documentation ↗Overview
<fullname>Amazon ElastiCache</fullname> <p>Amazon ElastiCache is a web service that makes it easier to set up, operate, and scale a distributed cache in the cloud.</p> <p>With ElastiCache, customers get all of the benefits of a high-performance, in-memory cache with less of the administrative burden involved in launching and managing a distributed cache. The service makes setup, scaling, and cluster failure handling much simpler than in a self-managed cache deployment.</p> <p>In addition, through integration with Amazon CloudWatch, customers get enhanced visibility into the key performance statistics associated with their cache and can receive alarms if a part of their cache runs hot.</p>
Amazon ElastiCache is a cloud platforms API from amazonaws.com. Requests are authenticated with an API key. It is served over HTTPS. Its OpenAPI description documents 130 endpoints.
At a glance
- Authentication
- API key
- HTTPS
- Yes
- CORS
- Unknown
- Category
- Cloud Platforms
- Version
- 2015-02-02
- Endpoints
- 130
- OpenAPI
- Specification ↗
- Spec updated
- 2020-03-29
Endpoints
| Method | Path | What it does |
|---|---|---|
| GET | /#Action=AddTagsToResource | <p>A tag is a key-value pair where the key and value are case-sensitive. You can use tags to categorize and track all your ElastiCache resources, with the excep |
| POST | /#Action=AddTagsToResource | <p>A tag is a key-value pair where the key and value are case-sensitive. You can use tags to categorize and track all your ElastiCache resources, with the excep |
| GET | /#Action=AuthorizeCacheSecurityGroupIngress | <p>Allows network ingress to a cache security group. Applications using ElastiCache must be running on Amazon EC2, and Amazon EC2 security groups are used as th |
| POST | /#Action=AuthorizeCacheSecurityGroupIngress | <p>Allows network ingress to a cache security group. Applications using ElastiCache must be running on Amazon EC2, and Amazon EC2 security groups are used as th |
| GET | /#Action=BatchApplyUpdateAction | Apply the service update. For more information on service updates and applying them, see <a href="https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/ap |
| POST | /#Action=BatchApplyUpdateAction | Apply the service update. For more information on service updates and applying them, see <a href="https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/ap |
| GET | /#Action=BatchStopUpdateAction | Stop the service update. For more information on service updates and stopping them, see <a href="https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/sto |
| POST | /#Action=BatchStopUpdateAction | Stop the service update. For more information on service updates and stopping them, see <a href="https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/sto |
| GET | /#Action=CompleteMigration | Complete the migration of data. |
| POST | /#Action=CompleteMigration | Complete the migration of data. |
| GET | /#Action=CopySnapshot | <p>Makes a copy of an existing snapshot.</p> <note> <p>This operation is valid for Redis only.</p> </note> <important> <p>Users or groups that have permissions |
| POST | /#Action=CopySnapshot | <p>Makes a copy of an existing snapshot.</p> <note> <p>This operation is valid for Redis only.</p> </note> <important> <p>Users or groups that have permissions |
| GET | /#Action=CreateCacheCluster | <p>Creates a cluster. All nodes in the cluster run the same protocol-compliant cache engine software, either Memcached or Redis.</p> <p>This operation is not su |
| POST | /#Action=CreateCacheCluster | <p>Creates a cluster. All nodes in the cluster run the same protocol-compliant cache engine software, either Memcached or Redis.</p> <p>This operation is not su |
| GET | /#Action=CreateCacheParameterGroup | <p>Creates a new Amazon ElastiCache cache parameter group. An ElastiCache cache parameter group is a collection of parameters and their values that are applied |
| POST | /#Action=CreateCacheParameterGroup | <p>Creates a new Amazon ElastiCache cache parameter group. An ElastiCache cache parameter group is a collection of parameters and their values that are applied |
| GET | /#Action=CreateCacheSecurityGroup | <p>Creates a new cache security group. Use a cache security group to control access to one or more clusters.</p> <p>Cache security groups are only used when you |
| POST | /#Action=CreateCacheSecurityGroup | <p>Creates a new cache security group. Use a cache security group to control access to one or more clusters.</p> <p>Cache security groups are only used when you |
| GET | /#Action=CreateCacheSubnetGroup | <p>Creates a new cache subnet group.</p> <p>Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (Amazon VPC).</p> |
| POST | /#Action=CreateCacheSubnetGroup | <p>Creates a new cache subnet group.</p> <p>Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (Amazon VPC).</p> |
| GET | /#Action=CreateGlobalReplicationGroup | <p>Global Datastore for Redis offers fully managed, fast, reliable and secure cross-region replication. Using Global Datastore for Redis, you can create cross-r |
| POST | /#Action=CreateGlobalReplicationGroup | <p>Global Datastore for Redis offers fully managed, fast, reliable and secure cross-region replication. Using Global Datastore for Redis, you can create cross-r |
| GET | /#Action=CreateReplicationGroup | <p>Creates a Redis (cluster mode disabled) or a Redis (cluster mode enabled) replication group.</p> <p>This API can be used to create a standalone regional repl |
| POST | /#Action=CreateReplicationGroup | <p>Creates a Redis (cluster mode disabled) or a Redis (cluster mode enabled) replication group.</p> <p>This API can be used to create a standalone regional repl |
| GET | /#Action=CreateSnapshot | <p>Creates a copy of an entire cluster or replication group at a specific moment in time.</p> <note> <p>This operation is valid for Redis only.</p> </note> |
| POST | /#Action=CreateSnapshot | <p>Creates a copy of an entire cluster or replication group at a specific moment in time.</p> <note> <p>This operation is valid for Redis only.</p> </note> |
| GET | /#Action=CreateUser | For Redis engine version 6.0 onwards: Creates a Redis user. For more information, see <a href="http://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Cluste |
| POST | /#Action=CreateUser | For Redis engine version 6.0 onwards: Creates a Redis user. For more information, see <a href="http://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Cluste |
| GET | /#Action=CreateUserGroup | For Redis engine version 6.0 onwards: Creates a Redis user group. For more information, see <a href="http://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/ |
| POST | /#Action=CreateUserGroup | For Redis engine version 6.0 onwards: Creates a Redis user group. For more information, see <a href="http://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/ |
| GET | /#Action=DecreaseNodeGroupsInGlobalReplicationGroup | Decreases the number of node groups in a Global datastore |
| POST | /#Action=DecreaseNodeGroupsInGlobalReplicationGroup | Decreases the number of node groups in a Global datastore |
| GET | /#Action=DecreaseReplicaCount | Dynamically decreases the number of replicas in a Redis (cluster mode disabled) replication group or the number of replica nodes in one or more node groups (sha |
| POST | /#Action=DecreaseReplicaCount | Dynamically decreases the number of replicas in a Redis (cluster mode disabled) replication group or the number of replica nodes in one or more node groups (sha |
| GET | /#Action=DeleteCacheCluster | <p>Deletes a previously provisioned cluster. <code>DeleteCacheCluster</code> deletes all associated cache nodes, node endpoints and the cluster itself. When you |
| POST | /#Action=DeleteCacheCluster | <p>Deletes a previously provisioned cluster. <code>DeleteCacheCluster</code> deletes all associated cache nodes, node endpoints and the cluster itself. When you |
| GET | /#Action=DeleteCacheParameterGroup | Deletes the specified cache parameter group. You cannot delete a cache parameter group if it is associated with any cache clusters. You cannot delete the defaul |
| POST | /#Action=DeleteCacheParameterGroup | Deletes the specified cache parameter group. You cannot delete a cache parameter group if it is associated with any cache clusters. You cannot delete the defaul |
| GET | /#Action=DeleteCacheSecurityGroup | <p>Deletes a cache security group.</p> <note> <p>You cannot delete a cache security group if it is associated with any clusters.</p> </note> |
| POST | /#Action=DeleteCacheSecurityGroup | <p>Deletes a cache security group.</p> <note> <p>You cannot delete a cache security group if it is associated with any clusters.</p> </note> |
| GET | /#Action=DeleteCacheSubnetGroup | <p>Deletes a cache subnet group.</p> <note> <p>You cannot delete a default cache subnet group or one that is associated with any clusters.</p> </note> |
| POST | /#Action=DeleteCacheSubnetGroup | <p>Deletes a cache subnet group.</p> <note> <p>You cannot delete a default cache subnet group or one that is associated with any clusters.</p> </note> |
| GET | /#Action=DeleteGlobalReplicationGroup | <p>Deleting a Global datastore is a two-step process: </p> <ul> <li> <p>First, you must <a>DisassociateGlobalReplicationGroup</a> to remove the secondary cluste |
| POST | /#Action=DeleteGlobalReplicationGroup | <p>Deleting a Global datastore is a two-step process: </p> <ul> <li> <p>First, you must <a>DisassociateGlobalReplicationGroup</a> to remove the secondary cluste |
| GET | /#Action=DeleteReplicationGroup | <p>Deletes an existing replication group. By default, this operation deletes the entire replication group, including the primary/primaries and all of the read r |
| POST | /#Action=DeleteReplicationGroup | <p>Deletes an existing replication group. By default, this operation deletes the entire replication group, including the primary/primaries and all of the read r |
| GET | /#Action=DeleteSnapshot | <p>Deletes an existing snapshot. When you receive a successful response from this operation, ElastiCache immediately begins deleting the snapshot; you cannot ca |
| POST | /#Action=DeleteSnapshot | <p>Deletes an existing snapshot. When you receive a successful response from this operation, ElastiCache immediately begins deleting the snapshot; you cannot ca |
| GET | /#Action=DeleteUser | For Redis engine version 6.0 onwards: Deletes a user. The user will be removed from all user groups and in turn removed from all replication groups. For more in |
| POST | /#Action=DeleteUser | For Redis engine version 6.0 onwards: Deletes a user. The user will be removed from all user groups and in turn removed from all replication groups. For more in |
| GET | /#Action=DeleteUserGroup | For Redis engine version 6.0 onwards: Deletes a user group. The user group must first be disassociated from the replication group before it can be deleted. For |
| POST | /#Action=DeleteUserGroup | For Redis engine version 6.0 onwards: Deletes a user group. The user group must first be disassociated from the replication group before it can be deleted. For |
| GET | /#Action=DescribeCacheClusters | <p>Returns information about all provisioned clusters if no cluster identifier is specified, or about a specific cache cluster if a cluster identifier is suppli |
| POST | /#Action=DescribeCacheClusters | <p>Returns information about all provisioned clusters if no cluster identifier is specified, or about a specific cache cluster if a cluster identifier is suppli |
| GET | /#Action=DescribeCacheEngineVersions | Returns a list of the available cache engines and their versions. |
| POST | /#Action=DescribeCacheEngineVersions | Returns a list of the available cache engines and their versions. |
| GET | /#Action=DescribeCacheParameterGroups | Returns a list of cache parameter group descriptions. If a cache parameter group name is specified, the list contains only the descriptions for that group. |
| POST | /#Action=DescribeCacheParameterGroups | Returns a list of cache parameter group descriptions. If a cache parameter group name is specified, the list contains only the descriptions for that group. |
| GET | /#Action=DescribeCacheParameters | Returns the detailed parameter list for a particular cache parameter group. |
| POST | /#Action=DescribeCacheParameters | Returns the detailed parameter list for a particular cache parameter group. |
| GET | /#Action=DescribeCacheSecurityGroups | Returns a list of cache security group descriptions. If a cache security group name is specified, the list contains only the description of that group. This app |
| POST | /#Action=DescribeCacheSecurityGroups | Returns a list of cache security group descriptions. If a cache security group name is specified, the list contains only the description of that group. This app |
| GET | /#Action=DescribeCacheSubnetGroups | Returns a list of cache subnet group descriptions. If a subnet group name is specified, the list contains only the description of that group. This is applicable |
| POST | /#Action=DescribeCacheSubnetGroups | Returns a list of cache subnet group descriptions. If a subnet group name is specified, the list contains only the description of that group. This is applicable |
| GET | /#Action=DescribeEngineDefaultParameters | Returns the default engine and system parameter information for the specified cache engine. |
| POST | /#Action=DescribeEngineDefaultParameters | Returns the default engine and system parameter information for the specified cache engine. |
| GET | /#Action=DescribeEvents | <p>Returns events related to clusters, cache security groups, and cache parameter groups. You can obtain events specific to a particular cluster, cache security |
| POST | /#Action=DescribeEvents | <p>Returns events related to clusters, cache security groups, and cache parameter groups. You can obtain events specific to a particular cluster, cache security |
| GET | /#Action=DescribeGlobalReplicationGroups | Returns information about a particular global replication group. If no identifier is specified, returns information about all Global datastores. |
| POST | /#Action=DescribeGlobalReplicationGroups | Returns information about a particular global replication group. If no identifier is specified, returns information about all Global datastores. |
| GET | /#Action=DescribeReplicationGroups | <p>Returns information about a particular replication group. If no identifier is specified, <code>DescribeReplicationGroups</code> returns information about all |
| POST | /#Action=DescribeReplicationGroups | <p>Returns information about a particular replication group. If no identifier is specified, <code>DescribeReplicationGroups</code> returns information about all |
| GET | /#Action=DescribeReservedCacheNodes | Returns information about reserved cache nodes for this account, or about a specified reserved cache node. |
| POST | /#Action=DescribeReservedCacheNodes | Returns information about reserved cache nodes for this account, or about a specified reserved cache node. |
| GET | /#Action=DescribeReservedCacheNodesOfferings | Lists available reserved cache node offerings. |
| POST | /#Action=DescribeReservedCacheNodesOfferings | Lists available reserved cache node offerings. |
| GET | /#Action=DescribeServiceUpdates | Returns details of the service updates |
| POST | /#Action=DescribeServiceUpdates | Returns details of the service updates |
| GET | /#Action=DescribeSnapshots | <p>Returns information about cluster or replication group snapshots. By default, <code>DescribeSnapshots</code> lists all of your snapshots; it can optionally d |
| POST | /#Action=DescribeSnapshots | <p>Returns information about cluster or replication group snapshots. By default, <code>DescribeSnapshots</code> lists all of your snapshots; it can optionally d |
| GET | /#Action=DescribeUpdateActions | Returns details of the update actions |
| POST | /#Action=DescribeUpdateActions | Returns details of the update actions |
| GET | /#Action=DescribeUserGroups | Returns a list of user groups. |
| POST | /#Action=DescribeUserGroups | Returns a list of user groups. |
| GET | /#Action=DescribeUsers | Returns a list of users. |
| POST | /#Action=DescribeUsers | Returns a list of users. |
| GET | /#Action=DisassociateGlobalReplicationGroup | Remove a secondary cluster from the Global datastore using the Global datastore name. The secondary cluster will no longer receive updates from the primary clus |
| POST | /#Action=DisassociateGlobalReplicationGroup | Remove a secondary cluster from the Global datastore using the Global datastore name. The secondary cluster will no longer receive updates from the primary clus |
| GET | /#Action=FailoverGlobalReplicationGroup | Used to failover the primary region to a secondary region. The secondary region will become primary, and all other clusters will become secondary. |
| POST | /#Action=FailoverGlobalReplicationGroup | Used to failover the primary region to a secondary region. The secondary region will become primary, and all other clusters will become secondary. |
| GET | /#Action=IncreaseNodeGroupsInGlobalReplicationGroup | Increase the number of node groups in the Global datastore |
| POST | /#Action=IncreaseNodeGroupsInGlobalReplicationGroup | Increase the number of node groups in the Global datastore |
| GET | /#Action=IncreaseReplicaCount | Dynamically increases the number of replicas in a Redis (cluster mode disabled) replication group or the number of replica nodes in one or more node groups (sha |
| POST | /#Action=IncreaseReplicaCount | Dynamically increases the number of replicas in a Redis (cluster mode disabled) replication group or the number of replica nodes in one or more node groups (sha |
| GET | /#Action=ListAllowedNodeTypeModifications | <p>Lists all available node types that you can scale your Redis cluster's or replication group's current node type.</p> <p>When you use the <code>ModifyCacheClu |
| POST | /#Action=ListAllowedNodeTypeModifications | <p>Lists all available node types that you can scale your Redis cluster's or replication group's current node type.</p> <p>When you use the <code>ModifyCacheClu |
| GET | /#Action=ListTagsForResource | <p>Lists all tags currently on a named resource.</p> <p> A tag is a key-value pair where the key and value are case-sensitive. You can use tags to categorize an |
| POST | /#Action=ListTagsForResource | <p>Lists all tags currently on a named resource.</p> <p> A tag is a key-value pair where the key and value are case-sensitive. You can use tags to categorize an |
| GET | /#Action=ModifyCacheCluster | Modifies the settings for a cluster. You can use this operation to change one or more cluster configuration parameters by specifying the parameters and the new |
| POST | /#Action=ModifyCacheCluster | Modifies the settings for a cluster. You can use this operation to change one or more cluster configuration parameters by specifying the parameters and the new |
Showing the first 100 of 130 endpoints; the full list is in the documentation.
Questions
Does the Amazon ElastiCache API need an API key?
Yes. The Amazon ElastiCache API uses API key authentication; the documentation explains how to get credentials.
Does the Amazon ElastiCache API support HTTPS?
Yes, the Amazon ElastiCache API is served over HTTPS.
How many endpoints does the Amazon ElastiCache API have?
Its OpenAPI description lists 130 endpoints in version 2015-02-02. The first 100 are shown on this page.
What are alternatives to the Amazon ElastiCache 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).