Skip to content

Amazon DocumentDB with MongoDB compatibility API

by amazonaws.com

API keyHTTPSCloud Platforms
Open documentation ↗

Overview

Amazon DocumentDB API documentation

Amazon DocumentDB with MongoDB compatibility is a cloud platforms API from amazonaws.com. Requests are authenticated with an API key. It is served over HTTPS. Its OpenAPI description documents 106 endpoints.

At a glance

Authentication
API key
HTTPS
Yes
CORS
Unknown
Base URL
http://rds.amazonaws.com
Version
2014-10-31
Endpoints
106
Spec updated
2020-03-29

Make a first request

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

cURL
curl -X GET "http://rds.amazonaws.com/#Action=AddSourceIdentifierToSubscription" \
  -H "Accept: application/json" \
  -H "X-API-Key: YOUR_API_KEY"
JavaScript
const response = await fetch("http://rds.amazonaws.com/#Action=AddSourceIdentifierToSubscription", {
  method: "GET",
  headers: {
    "Accept": "application/json",
    "X-API-Key": "YOUR_API_KEY",
  },
});
const data = await response.json();
console.log(data);
Python
import requests

response = requests.request(
    "GET",
    "http://rds.amazonaws.com/#Action=AddSourceIdentifierToSubscription",
    headers={
    "Accept": "application/json",
    "X-API-Key": "YOUR_API_KEY",
    },
    timeout=30,
)
print(response.json())

Endpoints

MethodPathWhat it does
GET/#Action=AddSourceIdentifierToSubscriptionAdds a source identifier to an existing event notification subscription.
POST/#Action=AddSourceIdentifierToSubscriptionAdds a source identifier to an existing event notification subscription.
GET/#Action=AddTagsToResourceAdds metadata tags to an Amazon DocumentDB resource. You can use these tags with cost allocation reporting to track costs that are associated with Amazon Docume
POST/#Action=AddTagsToResourceAdds metadata tags to an Amazon DocumentDB resource. You can use these tags with cost allocation reporting to track costs that are associated with Amazon Docume
GET/#Action=ApplyPendingMaintenanceActionApplies a pending maintenance action to a resource (for example, to an Amazon DocumentDB instance).
POST/#Action=ApplyPendingMaintenanceActionApplies a pending maintenance action to a resource (for example, to an Amazon DocumentDB instance).
GET/#Action=CopyDBClusterParameterGroupCopies the specified cluster parameter group.
POST/#Action=CopyDBClusterParameterGroupCopies the specified cluster parameter group.
GET/#Action=CopyDBClusterSnapshot<p>Copies a snapshot of a cluster.</p> <p>To copy a cluster snapshot from a shared manual cluster snapshot, <code>SourceDBClusterSnapshotIdentifier</code> must
POST/#Action=CopyDBClusterSnapshot<p>Copies a snapshot of a cluster.</p> <p>To copy a cluster snapshot from a shared manual cluster snapshot, <code>SourceDBClusterSnapshotIdentifier</code> must
GET/#Action=CreateDBClusterCreates a new Amazon DocumentDB cluster.
POST/#Action=CreateDBClusterCreates a new Amazon DocumentDB cluster.
GET/#Action=CreateDBClusterParameterGroup<p>Creates a new cluster parameter group.</p> <p>Parameters in a cluster parameter group apply to all of the instances in a cluster.</p> <p>A cluster parameter
POST/#Action=CreateDBClusterParameterGroup<p>Creates a new cluster parameter group.</p> <p>Parameters in a cluster parameter group apply to all of the instances in a cluster.</p> <p>A cluster parameter
GET/#Action=CreateDBClusterSnapshotCreates a snapshot of a cluster.
POST/#Action=CreateDBClusterSnapshotCreates a snapshot of a cluster.
GET/#Action=CreateDBInstanceCreates a new instance.
POST/#Action=CreateDBInstanceCreates a new instance.
GET/#Action=CreateDBSubnetGroupCreates a new subnet group. subnet groups must contain at least one subnet in at least two Availability Zones in the Amazon Web Services Region.
POST/#Action=CreateDBSubnetGroupCreates a new subnet group. subnet groups must contain at least one subnet in at least two Availability Zones in the Amazon Web Services Region.
GET/#Action=CreateEventSubscription<p>Creates an Amazon DocumentDB event notification subscription. This action requires a topic Amazon Resource Name (ARN) created by using the Amazon DocumentDB
POST/#Action=CreateEventSubscription<p>Creates an Amazon DocumentDB event notification subscription. This action requires a topic Amazon Resource Name (ARN) created by using the Amazon DocumentDB
GET/#Action=CreateGlobalCluster<p>Creates an Amazon DocumentDB global cluster that can span multiple multiple Amazon Web Services Regions. The global cluster contains one primary cluster with
POST/#Action=CreateGlobalCluster<p>Creates an Amazon DocumentDB global cluster that can span multiple multiple Amazon Web Services Regions. The global cluster contains one primary cluster with
GET/#Action=DeleteDBCluster<p>Deletes a previously provisioned cluster. When you delete a cluster, all automated backups for that cluster are deleted and can't be recovered. Manual DB clu
POST/#Action=DeleteDBCluster<p>Deletes a previously provisioned cluster. When you delete a cluster, all automated backups for that cluster are deleted and can't be recovered. Manual DB clu
GET/#Action=DeleteDBClusterParameterGroupDeletes a specified cluster parameter group. The cluster parameter group to be deleted can't be associated with any clusters.
POST/#Action=DeleteDBClusterParameterGroupDeletes a specified cluster parameter group. The cluster parameter group to be deleted can't be associated with any clusters.
GET/#Action=DeleteDBClusterSnapshot<p>Deletes a cluster snapshot. If the snapshot is being copied, the copy operation is terminated.</p> <note> <p>The cluster snapshot must be in the <code>availa
POST/#Action=DeleteDBClusterSnapshot<p>Deletes a cluster snapshot. If the snapshot is being copied, the copy operation is terminated.</p> <note> <p>The cluster snapshot must be in the <code>availa
GET/#Action=DeleteDBInstanceDeletes a previously provisioned instance.
POST/#Action=DeleteDBInstanceDeletes a previously provisioned instance.
GET/#Action=DeleteDBSubnetGroup<p>Deletes a subnet group.</p> <note> <p>The specified database subnet group must not be associated with any DB instances.</p> </note>
POST/#Action=DeleteDBSubnetGroup<p>Deletes a subnet group.</p> <note> <p>The specified database subnet group must not be associated with any DB instances.</p> </note>
GET/#Action=DeleteEventSubscriptionDeletes an Amazon DocumentDB event notification subscription.
POST/#Action=DeleteEventSubscriptionDeletes an Amazon DocumentDB event notification subscription.
GET/#Action=DeleteGlobalCluster<p>Deletes a global cluster. The primary and secondary clusters must already be detached or deleted before attempting to delete a global cluster.</p> <note> <p>
POST/#Action=DeleteGlobalCluster<p>Deletes a global cluster. The primary and secondary clusters must already be detached or deleted before attempting to delete a global cluster.</p> <note> <p>
GET/#Action=DescribeCertificatesReturns a list of certificate authority (CA) certificates provided by Amazon DocumentDB for this Amazon Web Services account.
POST/#Action=DescribeCertificatesReturns a list of certificate authority (CA) certificates provided by Amazon DocumentDB for this Amazon Web Services account.
GET/#Action=DescribeDBClusterParameterGroupsReturns a list of <code>DBClusterParameterGroup</code> descriptions. If a <code>DBClusterParameterGroupName</code> parameter is specified, the list contains onl
POST/#Action=DescribeDBClusterParameterGroupsReturns a list of <code>DBClusterParameterGroup</code> descriptions. If a <code>DBClusterParameterGroupName</code> parameter is specified, the list contains onl
GET/#Action=DescribeDBClusterParametersReturns the detailed parameter list for a particular cluster parameter group.
POST/#Action=DescribeDBClusterParametersReturns the detailed parameter list for a particular cluster parameter group.
GET/#Action=DescribeDBClusterSnapshotAttributes<p>Returns a list of cluster snapshot attribute names and values for a manual DB cluster snapshot.</p> <p>When you share snapshots with other Amazon Web Service
POST/#Action=DescribeDBClusterSnapshotAttributes<p>Returns a list of cluster snapshot attribute names and values for a manual DB cluster snapshot.</p> <p>When you share snapshots with other Amazon Web Service
GET/#Action=DescribeDBClusterSnapshotsReturns information about cluster snapshots. This API operation supports pagination.
POST/#Action=DescribeDBClusterSnapshotsReturns information about cluster snapshots. This API operation supports pagination.
GET/#Action=DescribeDBClustersReturns information about provisioned Amazon DocumentDB clusters. This API operation supports pagination. For certain management features such as cluster and in
POST/#Action=DescribeDBClustersReturns information about provisioned Amazon DocumentDB clusters. This API operation supports pagination. For certain management features such as cluster and in
GET/#Action=DescribeDBEngineVersionsReturns a list of the available engines.
POST/#Action=DescribeDBEngineVersionsReturns a list of the available engines.
GET/#Action=DescribeDBInstancesReturns information about provisioned Amazon DocumentDB instances. This API supports pagination.
POST/#Action=DescribeDBInstancesReturns information about provisioned Amazon DocumentDB instances. This API supports pagination.
GET/#Action=DescribeDBSubnetGroupsReturns a list of <code>DBSubnetGroup</code> descriptions. If a <code>DBSubnetGroupName</code> is specified, the list will contain only the descriptions of the
POST/#Action=DescribeDBSubnetGroupsReturns a list of <code>DBSubnetGroup</code> descriptions. If a <code>DBSubnetGroupName</code> is specified, the list will contain only the descriptions of the
GET/#Action=DescribeEngineDefaultClusterParametersReturns the default engine and system parameter information for the cluster database engine.
POST/#Action=DescribeEngineDefaultClusterParametersReturns the default engine and system parameter information for the cluster database engine.
GET/#Action=DescribeEventCategoriesDisplays a list of categories for all event source types, or, if specified, for a specified source type.
POST/#Action=DescribeEventCategoriesDisplays a list of categories for all event source types, or, if specified, for a specified source type.
GET/#Action=DescribeEventSubscriptions<p>Lists all the subscription descriptions for a customer account. The description for a subscription includes <code>SubscriptionName</code>, <code>SNSTopicARN<
POST/#Action=DescribeEventSubscriptions<p>Lists all the subscription descriptions for a customer account. The description for a subscription includes <code>SubscriptionName</code>, <code>SNSTopicARN<
GET/#Action=DescribeEventsReturns events related to instances, security groups, snapshots, and DB parameter groups for the past 14 days. You can obtain events specific to a particular DB
POST/#Action=DescribeEventsReturns events related to instances, security groups, snapshots, and DB parameter groups for the past 14 days. You can obtain events specific to a particular DB
GET/#Action=DescribeGlobalClusters<p>Returns information about Amazon DocumentDB global clusters. This API supports pagination.</p> <note> <p>This action only applies to Amazon DocumentDB cluste
POST/#Action=DescribeGlobalClusters<p>Returns information about Amazon DocumentDB global clusters. This API supports pagination.</p> <note> <p>This action only applies to Amazon DocumentDB cluste
GET/#Action=DescribeOrderableDBInstanceOptionsReturns a list of orderable instance options for the specified engine.
POST/#Action=DescribeOrderableDBInstanceOptionsReturns a list of orderable instance options for the specified engine.
GET/#Action=DescribePendingMaintenanceActionsReturns a list of resources (for example, instances) that have at least one pending maintenance action.
POST/#Action=DescribePendingMaintenanceActionsReturns a list of resources (for example, instances) that have at least one pending maintenance action.
GET/#Action=FailoverDBCluster<p>Forces a failover for a cluster.</p> <p>A failover for a cluster promotes one of the Amazon DocumentDB replicas (read-only instances) in the cluster to be th
POST/#Action=FailoverDBCluster<p>Forces a failover for a cluster.</p> <p>A failover for a cluster promotes one of the Amazon DocumentDB replicas (read-only instances) in the cluster to be th
GET/#Action=ListTagsForResourceLists all tags on an Amazon DocumentDB resource.
POST/#Action=ListTagsForResourceLists all tags on an Amazon DocumentDB resource.
GET/#Action=ModifyDBClusterModifies a setting for an Amazon DocumentDB cluster. You can change one or more database configuration parameters by specifying these parameters and the new val
POST/#Action=ModifyDBClusterModifies a setting for an Amazon DocumentDB cluster. You can change one or more database configuration parameters by specifying these parameters and the new val
GET/#Action=ModifyDBClusterParameterGroup<p> Modifies the parameters of a cluster parameter group. To modify more than one parameter, submit a list of the following: <code>ParameterName</code>, <code>P
POST/#Action=ModifyDBClusterParameterGroup<p> Modifies the parameters of a cluster parameter group. To modify more than one parameter, submit a list of the following: <code>ParameterName</code>, <code>P
GET/#Action=ModifyDBClusterSnapshotAttribute<p>Adds an attribute and values to, or removes an attribute and values from, a manual cluster snapshot.</p> <p>To share a manual cluster snapshot with other Ama
POST/#Action=ModifyDBClusterSnapshotAttribute<p>Adds an attribute and values to, or removes an attribute and values from, a manual cluster snapshot.</p> <p>To share a manual cluster snapshot with other Ama
GET/#Action=ModifyDBInstanceModifies settings for an instance. You can change one or more database configuration parameters by specifying these parameters and the new values in the request
POST/#Action=ModifyDBInstanceModifies settings for an instance. You can change one or more database configuration parameters by specifying these parameters and the new values in the request
GET/#Action=ModifyDBSubnetGroupModifies an existing subnet group. subnet groups must contain at least one subnet in at least two Availability Zones in the Amazon Web Services Region.
POST/#Action=ModifyDBSubnetGroupModifies an existing subnet group. subnet groups must contain at least one subnet in at least two Availability Zones in the Amazon Web Services Region.
GET/#Action=ModifyEventSubscriptionModifies an existing Amazon DocumentDB event notification subscription.
POST/#Action=ModifyEventSubscriptionModifies an existing Amazon DocumentDB event notification subscription.
GET/#Action=ModifyGlobalCluster<p>Modify a setting for an Amazon DocumentDB global cluster. You can change one or more configuration parameters (for example: deletion protection), or the glob
POST/#Action=ModifyGlobalCluster<p>Modify a setting for an Amazon DocumentDB global cluster. You can change one or more configuration parameters (for example: deletion protection), or the glob
GET/#Action=RebootDBInstance<p>You might need to reboot your instance, usually for maintenance reasons. For example, if you make certain changes, or if you change the cluster parameter gro
POST/#Action=RebootDBInstance<p>You might need to reboot your instance, usually for maintenance reasons. For example, if you make certain changes, or if you change the cluster parameter gro
GET/#Action=RemoveFromGlobalCluster<p>Detaches an Amazon DocumentDB secondary cluster from a global cluster. The cluster becomes a standalone cluster with read-write capability instead of being r
POST/#Action=RemoveFromGlobalCluster<p>Detaches an Amazon DocumentDB secondary cluster from a global cluster. The cluster becomes a standalone cluster with read-write capability instead of being r
GET/#Action=RemoveSourceIdentifierFromSubscriptionRemoves a source identifier from an existing Amazon DocumentDB event notification subscription.
POST/#Action=RemoveSourceIdentifierFromSubscriptionRemoves a source identifier from an existing Amazon DocumentDB event notification subscription.
GET/#Action=RemoveTagsFromResourceRemoves metadata tags from an Amazon DocumentDB resource.
POST/#Action=RemoveTagsFromResourceRemoves metadata tags from an Amazon DocumentDB resource.
GET/#Action=ResetDBClusterParameterGroup<p> Modifies the parameters of a cluster parameter group to the default value. To reset specific parameters, submit a list of the following: <code>ParameterName
POST/#Action=ResetDBClusterParameterGroup<p> Modifies the parameters of a cluster parameter group to the default value. To reset specific parameters, submit a list of the following: <code>ParameterName
GET/#Action=RestoreDBClusterFromSnapshot<p>Creates a new cluster from a snapshot or cluster snapshot.</p> <p>If a snapshot is specified, the target cluster is created from the source DB snapshot with
POST/#Action=RestoreDBClusterFromSnapshot<p>Creates a new cluster from a snapshot or cluster snapshot.</p> <p>If a snapshot is specified, the target cluster is created from the source DB snapshot with

Showing the first 100 of 106 endpoints; the full list is in the documentation.

Questions

Does the Amazon DocumentDB with MongoDB compatibility API need an API key?

Yes. The Amazon DocumentDB with MongoDB compatibility API uses API key authentication; the documentation explains how to get credentials.

Does the Amazon DocumentDB with MongoDB compatibility API support HTTPS?

Yes, the Amazon DocumentDB with MongoDB compatibility API is served over HTTPS.

How many endpoints does the Amazon DocumentDB with MongoDB compatibility API have?

Its OpenAPI description lists 106 endpoints in version 2014-10-31. The first 100 are shown on this page.

What are alternatives to the Amazon DocumentDB with MongoDB compatibility 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

Platform API

Cloud Platforms

The [REST API specification](https://www.ably.io/documentation/rest-api) for Ably.

HTTP Basic22 endpoints

Azure Data Lake Storage

Cloud Platforms

Azure Data Lake Storage provides storage for Hadoop and other big data workloads.

No auth10 endpoints

Listed from APIs.guru (CC0).