Skip to content

Amazon Neptune API

by amazonaws.com

API keyHTTPSCloud Platforms
Open documentation ↗

Overview

<fullname>Amazon Neptune</fullname> <p>Amazon Neptune is a fast, reliable, fully-managed graph database service that makes it easy to build and run applications that work with highly connected datasets. The core of Amazon Neptune is a purpose-built, high-performance graph database engine optimized for storing billions of relationships and querying the graph with milliseconds latency. Amazon Neptune supports popular graph models Property Graph and W3C's RDF, and their respective query languages Apache TinkerPop Gremlin and SPARQL, allowing you to easily build queries that efficiently navigate highly connected datasets. Neptune powers graph use cases such as recommendation engines, fraud detection, knowledge graphs, drug discovery, and network security.</p> <p>This interface reference for Amazon Neptune contains documentation for a programming or command line interface you can use to manage Amazon Neptune. Note that Amazon Neptune is asynchronous, which means that some interfaces might require techniques such as polling or callback functions to determine when a command has been applied. In this reference, the parameter descriptions indicate whether a command is applied immediately, on the next instance reboot, or during the maintenance window. The reference structure is as follows, and we list following some related topics from the user guide.</p>

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

At a glance

Authentication
API key
HTTPS
Yes
CORS
Unknown
Base URL
http://rds.amazonaws.com
Version
2014-10-31
Endpoints
138
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=AddRoleToDBCluster" \
  -H "Accept: application/json" \
  -H "X-API-Key: YOUR_API_KEY"
JavaScript
const response = await fetch("http://rds.amazonaws.com/#Action=AddRoleToDBCluster", {
  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=AddRoleToDBCluster",
    headers={
    "Accept": "application/json",
    "X-API-Key": "YOUR_API_KEY",
    },
    timeout=30,
)
print(response.json())

Endpoints

MethodPathWhat it does
GET/#Action=AddRoleToDBClusterAssociates an Identity and Access Management (IAM) role with an Neptune DB cluster.
POST/#Action=AddRoleToDBClusterAssociates an Identity and Access Management (IAM) role with an Neptune DB cluster.
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 Neptune resource. These tags can also be used with cost allocation reporting to track cost associated with Amazon Neptune resour
POST/#Action=AddTagsToResourceAdds metadata tags to an Amazon Neptune resource. These tags can also be used with cost allocation reporting to track cost associated with Amazon Neptune resour
GET/#Action=ApplyPendingMaintenanceActionApplies a pending maintenance action to a resource (for example, to a DB instance).
POST/#Action=ApplyPendingMaintenanceActionApplies a pending maintenance action to a resource (for example, to a DB instance).
GET/#Action=CopyDBClusterParameterGroupCopies the specified DB cluster parameter group.
POST/#Action=CopyDBClusterParameterGroupCopies the specified DB cluster parameter group.
GET/#Action=CopyDBClusterSnapshot<p>Copies a snapshot of a DB cluster.</p> <p>To copy a DB cluster snapshot from a shared manual DB cluster snapshot, <code>SourceDBClusterSnapshotIdentifier</co
POST/#Action=CopyDBClusterSnapshot<p>Copies a snapshot of a DB cluster.</p> <p>To copy a DB cluster snapshot from a shared manual DB cluster snapshot, <code>SourceDBClusterSnapshotIdentifier</co
GET/#Action=CopyDBParameterGroupCopies the specified DB parameter group.
POST/#Action=CopyDBParameterGroupCopies the specified DB parameter group.
GET/#Action=CreateDBCluster<p>Creates a new Amazon Neptune DB cluster.</p> <p>You can use the <code>ReplicationSourceIdentifier</code> parameter to create the DB cluster as a Read Replica
POST/#Action=CreateDBCluster<p>Creates a new Amazon Neptune DB cluster.</p> <p>You can use the <code>ReplicationSourceIdentifier</code> parameter to create the DB cluster as a Read Replica
GET/#Action=CreateDBClusterEndpointCreates a new custom endpoint and associates it with an Amazon Neptune DB cluster.
POST/#Action=CreateDBClusterEndpointCreates a new custom endpoint and associates it with an Amazon Neptune DB cluster.
GET/#Action=CreateDBClusterParameterGroup<p>Creates a new DB cluster parameter group.</p> <p>Parameters in a DB cluster parameter group apply to all of the instances in a DB cluster.</p> <p> A DB clust
POST/#Action=CreateDBClusterParameterGroup<p>Creates a new DB cluster parameter group.</p> <p>Parameters in a DB cluster parameter group apply to all of the instances in a DB cluster.</p> <p> A DB clust
GET/#Action=CreateDBClusterSnapshotCreates a snapshot of a DB cluster.
POST/#Action=CreateDBClusterSnapshotCreates a snapshot of a DB cluster.
GET/#Action=CreateDBInstanceCreates a new DB instance.
POST/#Action=CreateDBInstanceCreates a new DB instance.
GET/#Action=CreateDBParameterGroup<p>Creates a new DB parameter group.</p> <p>A DB parameter group is initially created with the default parameters for the database engine used by the DB instanc
POST/#Action=CreateDBParameterGroup<p>Creates a new DB parameter group.</p> <p>A DB parameter group is initially created with the default parameters for the database engine used by the DB instanc
GET/#Action=CreateDBSubnetGroupCreates a new DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the Amazon Region.
POST/#Action=CreateDBSubnetGroupCreates a new DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the Amazon Region.
GET/#Action=CreateEventSubscription<p>Creates an event notification subscription. This action requires a topic ARN (Amazon Resource Name) created by either the Neptune console, the SNS console, o
POST/#Action=CreateEventSubscription<p>Creates an event notification subscription. This action requires a topic ARN (Amazon Resource Name) created by either the Neptune console, the SNS console, o
GET/#Action=CreateGlobalCluster<p>Creates a Neptune global database spread across multiple Amazon Regions. The global database contains a single primary cluster with read-write capability, an
POST/#Action=CreateGlobalCluster<p>Creates a Neptune global database spread across multiple Amazon Regions. The global database contains a single primary cluster with read-write capability, an
GET/#Action=DeleteDBCluster<p>The DeleteDBCluster action deletes a previously provisioned DB cluster. When you delete a DB cluster, all automated backups for that DB cluster are deleted a
POST/#Action=DeleteDBCluster<p>The DeleteDBCluster action deletes a previously provisioned DB cluster. When you delete a DB cluster, all automated backups for that DB cluster are deleted a
GET/#Action=DeleteDBClusterEndpointDeletes a custom endpoint and removes it from an Amazon Neptune DB cluster.
POST/#Action=DeleteDBClusterEndpointDeletes a custom endpoint and removes it from an Amazon Neptune DB cluster.
GET/#Action=DeleteDBClusterParameterGroupDeletes a specified DB cluster parameter group. The DB cluster parameter group to be deleted can't be associated with any DB clusters.
POST/#Action=DeleteDBClusterParameterGroupDeletes a specified DB cluster parameter group. The DB cluster parameter group to be deleted can't be associated with any DB clusters.
GET/#Action=DeleteDBClusterSnapshot<p>Deletes a DB cluster snapshot. If the snapshot is being copied, the copy operation is terminated.</p> <note> <p>The DB cluster snapshot must be in the <code>
POST/#Action=DeleteDBClusterSnapshot<p>Deletes a DB cluster snapshot. If the snapshot is being copied, the copy operation is terminated.</p> <note> <p>The DB cluster snapshot must be in the <code>
GET/#Action=DeleteDBInstance<p>The DeleteDBInstance action deletes a previously provisioned DB instance. When you delete a DB instance, all automated backups for that instance are deleted
POST/#Action=DeleteDBInstance<p>The DeleteDBInstance action deletes a previously provisioned DB instance. When you delete a DB instance, all automated backups for that instance are deleted
GET/#Action=DeleteDBParameterGroupDeletes a specified DBParameterGroup. The DBParameterGroup to be deleted can't be associated with any DB instances.
POST/#Action=DeleteDBParameterGroupDeletes a specified DBParameterGroup. The DBParameterGroup to be deleted can't be associated with any DB instances.
GET/#Action=DeleteDBSubnetGroup<p>Deletes a DB 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 DB subnet group.</p> <note> <p>The specified database subnet group must not be associated with any DB instances.</p> </note>
GET/#Action=DeleteEventSubscriptionDeletes an event notification subscription.
POST/#Action=DeleteEventSubscriptionDeletes an event notification subscription.
GET/#Action=DeleteGlobalClusterDeletes a global database. The primary and all secondary clusters must already be detached or deleted first.
POST/#Action=DeleteGlobalClusterDeletes a global database. The primary and all secondary clusters must already be detached or deleted first.
GET/#Action=DescribeDBClusterEndpoints<p>Returns information about endpoints for an Amazon Neptune DB cluster.</p> <note> <p>This operation can also return information for Amazon RDS clusters and Am
POST/#Action=DescribeDBClusterEndpoints<p>Returns information about endpoints for an Amazon Neptune DB cluster.</p> <note> <p>This operation can also return information for Amazon RDS clusters and Am
GET/#Action=DescribeDBClusterParameterGroupsReturns a list of <code>DBClusterParameterGroup</code> descriptions. If a <code>DBClusterParameterGroupName</code> parameter is specified, the list will contain
POST/#Action=DescribeDBClusterParameterGroupsReturns a list of <code>DBClusterParameterGroup</code> descriptions. If a <code>DBClusterParameterGroupName</code> parameter is specified, the list will contain
GET/#Action=DescribeDBClusterParametersReturns the detailed parameter list for a particular DB cluster parameter group.
POST/#Action=DescribeDBClusterParametersReturns the detailed parameter list for a particular DB cluster parameter group.
GET/#Action=DescribeDBClusterSnapshotAttributes<p>Returns a list of DB cluster snapshot attribute names and values for a manual DB cluster snapshot.</p> <p>When sharing snapshots with other Amazon accounts,
POST/#Action=DescribeDBClusterSnapshotAttributes<p>Returns a list of DB cluster snapshot attribute names and values for a manual DB cluster snapshot.</p> <p>When sharing snapshots with other Amazon accounts,
GET/#Action=DescribeDBClusterSnapshotsReturns information about DB cluster snapshots. This API action supports pagination.
POST/#Action=DescribeDBClusterSnapshotsReturns information about DB cluster snapshots. This API action supports pagination.
GET/#Action=DescribeDBClusters<p>Returns information about provisioned DB clusters, and supports pagination.</p> <note> <p>This operation can also return information for Amazon RDS clusters
POST/#Action=DescribeDBClusters<p>Returns information about provisioned DB clusters, and supports pagination.</p> <note> <p>This operation can also return information for Amazon RDS clusters
GET/#Action=DescribeDBEngineVersionsReturns a list of the available DB engines.
POST/#Action=DescribeDBEngineVersionsReturns a list of the available DB engines.
GET/#Action=DescribeDBInstances<p>Returns information about provisioned instances, and supports pagination.</p> <note> <p>This operation can also return information for Amazon RDS instances a
POST/#Action=DescribeDBInstances<p>Returns information about provisioned instances, and supports pagination.</p> <note> <p>This operation can also return information for Amazon RDS instances a
GET/#Action=DescribeDBParameterGroupsReturns a list of <code>DBParameterGroup</code> descriptions. If a <code>DBParameterGroupName</code> is specified, the list will contain only the description of
POST/#Action=DescribeDBParameterGroupsReturns a list of <code>DBParameterGroup</code> descriptions. If a <code>DBParameterGroupName</code> is specified, the list will contain only the description of
GET/#Action=DescribeDBParametersReturns the detailed parameter list for a particular DB parameter group.
POST/#Action=DescribeDBParametersReturns the detailed parameter list for a particular DB parameter group.
GET/#Action=DescribeDBSubnetGroups<p>Returns a list of DBSubnetGroup descriptions. If a DBSubnetGroupName is specified, the list will contain only the descriptions of the specified DBSubnetGroup
POST/#Action=DescribeDBSubnetGroups<p>Returns a list of DBSubnetGroup descriptions. If a DBSubnetGroupName is specified, the list will contain only the descriptions of the specified DBSubnetGroup
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=DescribeEngineDefaultParametersReturns the default engine and system parameter information for the specified database engine.
POST/#Action=DescribeEngineDefaultParametersReturns the default engine and system parameter information for the specified 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 SubscriptionName, SNSTopicARN, CustomerID, Source
POST/#Action=DescribeEventSubscriptions<p>Lists all the subscription descriptions for a customer account. The description for a subscription includes SubscriptionName, SNSTopicARN, CustomerID, Source
GET/#Action=DescribeEventsReturns events related to DB instances, DB security groups, DB snapshots, and DB parameter groups for the past 14 days. Events specific to a particular DB insta
POST/#Action=DescribeEventsReturns events related to DB instances, DB security groups, DB snapshots, and DB parameter groups for the past 14 days. Events specific to a particular DB insta
GET/#Action=DescribeGlobalClustersReturns information about Neptune global database clusters. This API supports pagination.
POST/#Action=DescribeGlobalClustersReturns information about Neptune global database clusters. This API supports pagination.
GET/#Action=DescribeOrderableDBInstanceOptionsReturns a list of orderable DB instance options for the specified engine.
POST/#Action=DescribeOrderableDBInstanceOptionsReturns a list of orderable DB instance options for the specified engine.
GET/#Action=DescribePendingMaintenanceActionsReturns a list of resources (for example, DB instances) that have at least one pending maintenance action.
POST/#Action=DescribePendingMaintenanceActionsReturns a list of resources (for example, DB instances) that have at least one pending maintenance action.
GET/#Action=DescribeValidDBInstanceModificationsYou can call <a>DescribeValidDBInstanceModifications</a> to learn what modifications you can make to your DB instance. You can use this information when you cal
POST/#Action=DescribeValidDBInstanceModificationsYou can call <a>DescribeValidDBInstanceModifications</a> to learn what modifications you can make to your DB instance. You can use this information when you cal
GET/#Action=FailoverDBCluster<p>Forces a failover for a DB cluster.</p> <p>A failover for a DB cluster promotes one of the Read Replicas (read-only instances) in the DB cluster to be the pr
POST/#Action=FailoverDBCluster<p>Forces a failover for a DB cluster.</p> <p>A failover for a DB cluster promotes one of the Read Replicas (read-only instances) in the DB cluster to be the pr
GET/#Action=FailoverGlobalCluster<p>Initiates the failover process for a Neptune global database.</p> <p>A failover for a Neptune global database promotes one of secondary read-only DB clusters
POST/#Action=FailoverGlobalCluster<p>Initiates the failover process for a Neptune global database.</p> <p>A failover for a Neptune global database promotes one of secondary read-only DB clusters
GET/#Action=ListTagsForResourceLists all tags on an Amazon Neptune resource.
POST/#Action=ListTagsForResourceLists all tags on an Amazon Neptune resource.
GET/#Action=ModifyDBClusterModify a setting for a DB cluster. You can change one or more database configuration parameters by specifying these parameters and the new values in the request
POST/#Action=ModifyDBClusterModify a setting for a DB cluster. You can change one or more database configuration parameters by specifying these parameters and the new values in the request
GET/#Action=ModifyDBClusterEndpointModifies the properties of an endpoint in an Amazon Neptune DB cluster.
POST/#Action=ModifyDBClusterEndpointModifies the properties of an endpoint in an Amazon Neptune DB cluster.

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

Questions

Does the Amazon Neptune API need an API key?

Yes. The Amazon Neptune API uses API key authentication; the documentation explains how to get credentials.

Does the Amazon Neptune API support HTTPS?

Yes, the Amazon Neptune API is served over HTTPS.

How many endpoints does the Amazon Neptune API have?

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

What are alternatives to the Amazon Neptune 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).