# Amazon Neptune Gremlin API

**Canonical:** https://apis.io/apis/amazon-neptune/amazon-neptune-gremlin/  
**Provider:** Amazon Neptune — https://apis.io/providers/amazon-neptune/  
**Base URL:** https://{cluster-endpoint}:8182

Amazon Neptune Gremlin API is one of 9 APIs that [Amazon Neptune](https://apis.io/providers/amazon-neptune/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include DB Clusters, DB Instances, Data Processing, Engine, and Event. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, best-practice docs, API documentation, a getting-started guide, and pricing.

Apache TinkerPop Gremlin graph traversal language API for querying property graphs in Neptune. It supports both WebSocket and HTTP REST endpoints for submitting Gremlin traversals. This spec covers the HTTP REST endpoint. Neptune supports Gremlin as defined in Apache TinkerPop and uses HTTP/1.1 with

## Operations (5)

| Method | Path | Summary |
|---|---|---|
| POST | `/gremlin` | Amazon Neptune Execute a Gremlin Traversal via HTTP POST |
| GET | `/gremlin` | Amazon Neptune Execute a Gremlin Traversal via HTTP GET |
| GET | `/gremlin/status` | Amazon Neptune Get the Status of All Running Gremlin Queries |
| GET | `/gremlin/status/{queryId}` | Amazon Neptune Get the Status of a Specific Gremlin Query |
| DELETE | `/gremlin/status/{queryId}` | Amazon Neptune Cancel a Running Gremlin Query |

## Machine-readable artifacts (41)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/amazon-neptune/refs/heads/main/openapi/_original/amazon-neptune-gremlin-openapi.yml
- **APIReference** — https://docs.aws.amazon.com/neptune-analytics/latest/apiref/Welcome.html
- **APIReference** — https://docs.aws.amazon.com/neptune/latest/data-api/Welcome.html
- **APIReference** — https://docs.aws.amazon.com/neptune/latest/userguide/api.html
- **APIReference** — https://docs.aws.amazon.com/neptune/latest/userguide/load-api-reference.html
- **APIReference** — https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-api-reference.html
- **APIReference** — https://docs.aws.amazon.com/neptune/latest/userguide/streams-using-api-call.html
- **Best Practices** — https://docs.aws.amazon.com/neptune/latest/userguide/best-practices-gremlin.html
- **Best Practices** — https://docs.aws.amazon.com/neptune/latest/userguide/best-practices-opencypher.html
- **Best Practices** — https://docs.aws.amazon.com/neptune/latest/userguide/best-practices-sparql.html
- **CLI Reference** — https://docs.aws.amazon.com/cli/latest/reference/neptunedata/
- **Data API Reference** — https://docs.aws.amazon.com/neptune/latest/userguide/data-api-dp-loader.html
- **Data API Reference** — https://docs.aws.amazon.com/neptune/latest/userguide/data-api-dp-streams.html
- **Data Formats** — https://docs.aws.amazon.com/neptune/latest/userguide/bulk-load-tutorial-format.html
- **Documentation** — https://docs.aws.amazon.com/neptune-analytics/latest/userguide/what-is-neptune-analytics.html
- **Documentation** — https://docs.aws.amazon.com/neptune/latest/userguide/access-graph-gremlin.html
- **Documentation** — https://docs.aws.amazon.com/neptune/latest/userguide/access-graph-opencypher.html
- **Documentation** — https://docs.aws.amazon.com/neptune/latest/userguide/access-graph-sparql.html
- **Documentation** — https://docs.aws.amazon.com/neptune/latest/userguide/bulk-load.html
- **Documentation** — https://docs.aws.amazon.com/neptune/latest/userguide/data-api.html
- **Documentation** — https://docs.aws.amazon.com/neptune/latest/userguide/intro.html
- **Documentation** — https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning.html
- **Documentation** — https://docs.aws.amazon.com/neptune/latest/userguide/streams.html
- **GettingStarted** — https://docs.aws.amazon.com/neptune-analytics/latest/userguide/gettingStarted-accessing.html
- **GettingStarted** — https://docs.aws.amazon.com/neptune/latest/userguide/get-started.html
- **GettingStarted** — https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-overview.html
- **Go SDK** — https://docs.aws.amazon.com/sdk-for-go/api/service/neptunedata/
- **Gremlin Reference** — https://tinkerpop.apache.org/docs/current/reference/
- **JavaScript SDK** — https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/neptunedata/
- **Loader Command** — https://docs.aws.amazon.com/neptune/latest/userguide/load-api-reference-load.html
- **Model Training** — https://docs.aws.amazon.com/neptune/latest/userguide/data-api-dp-ml-training.html
- **Pricing** — https://aws.amazon.com/neptune/pricing/
- **REST Endpoint** — https://docs.aws.amazon.com/neptune/latest/userguide/access-graph-gremlin-rest.html
- **REST Endpoint** — https://docs.aws.amazon.com/neptune/latest/userguide/access-graph-sparql-http-rest.html
- **Reference** — https://docs.aws.amazon.com/neptune/latest/userguide/gremlin-api-reference.html
- **Response Format** — https://docs.aws.amazon.com/neptune/latest/userguide/streams-using-api-reponse.html
- **SDKs** — https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/neptune-graph.html
- **SDKs** — https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/neptune.html
- **SDKs** — https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/neptunedata.html
- **SPARQL Reference** — https://www.w3.org/TR/sparql11-query/
- …and 1 more, listed in full on the page.

## Other Amazon Neptune APIs (8)

- [Amazon Neptune Analytics API](https://apis.io/apis/amazon-neptune/amazon-neptune-analytics/)
- [Amazon Neptune Data API](https://apis.io/apis/amazon-neptune/amazon-neptune-data/)
- [Amazon Neptune Loader API](https://apis.io/apis/amazon-neptune/amazon-neptune-loader/)
- [Amazon Neptune Management API](https://apis.io/apis/amazon-neptune/amazon-neptune-management/)
- [Amazon Neptune ML API](https://apis.io/apis/amazon-neptune/amazon-neptune-ml/)
- [Amazon Neptune openCypher API](https://apis.io/apis/amazon-neptune/amazon-neptune-opencypher/)
- [Amazon Neptune SPARQL API](https://apis.io/apis/amazon-neptune/amazon-neptune-sparql/)
- [Amazon Neptune Streams API](https://apis.io/apis/amazon-neptune/amazon-neptune-streams/)

## Tags

DB Clusters, DB Instances, Data Processing, Engine, Event

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/amazon-neptune/amazon-neptune-gremlin/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/amazon-neptune/.
