How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Amazon Neptune Gremlin API

Execute Gremlin graph traversal queries

Amazon Neptune Gremlin API is one of 29 APIs that Amazon Neptune publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Gremlin. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, pricing, a getting-started guide, and best-practice docs.

This API exposes 6 operations across 5 paths, and defines 6 schemas. It is described by OpenAPI 3.2.0, at version 2023-08-01.

Requests are made against a single base URL, https://neptune-db.{region}.amazonaws.com.

6 operations 5 paths 6 schemas 1 DELETE2 GET3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2023-08-01
Server
https://neptune-db.{region}.amazonaws.com
Authentication
API Key
License
Resource Areas
1

Authentication & Security 1

Amazon Neptune Gremlin API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (aws_sigv4). By default, every request must be authenticated.

  • aws_sigv4 — AWS Signature Version 4 authentication

Paths & Operations 6

Across 5 paths, the API surfaces 6 operations — 1 DELETE, 2 GET, 3 POST. Each is listed below with its method, path, parameters, and response codes.

Gremlin 6

Execute Gremlin graph traversal queries

POST
/gremlin
Amazon Neptune Execute a Gremlin Query via the Data API
executeGremlinQuery body → 200400408500
POST
/gremlin/explain
Amazon Neptune Get the Execution Plan for a Gremlin Query
executeGremlinExplainQuery body → 200400
POST
/gremlin/profile
Amazon Neptune Profile a Gremlin Query Execution
executeGremlinProfileQuery body → 200400
GET
/gremlin/status
Amazon Neptune Get the Status of Gremlin Queries
getGremlinQueryStatus → 200
GET
/gremlin/status/{queryId}
Amazon Neptune Get the Status of a Specific Gremlin Query
getGremlinQueryStatusById 1 param → 200404
DELETE
/gremlin/status/{queryId}
Amazon Neptune Cancel a Running Gremlin Query
cancelGremlinQuery 1 param → 200404

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are ExecuteGremlinProfileInput (5 properties), GremlinQueryStatus (3 properties), ExecuteGremlinQueryOutput (3 properties), GremlinQueryStatusOutput (3 properties). Each schema is shown below with its type and property counts.

ErrorResponse
object
3 properties
ExecuteGremlinProfileInput
object
5 properties 1 required
GremlinQueryStatusOutput
object
3 properties
ExecuteGremlinQueryInput
object
1 property 1 required
ExecuteGremlinQueryOutput
object
3 properties
GremlinQueryStatus
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

amazon-neptune-gremlin-api-openapi.yml Raw ↑

Other APIs Amazon Neptune publishes across the network.

Amazon Neptune ?Action=AddTagsToResource API
Amazon Neptune ?Action=ListTagsForResource API
Amazon Neptune Data Processing API
Amazon Neptune DB Clusters API
Amazon Neptune DB Instances API
Amazon Neptune Engine API
Amazon Neptune Events API
Amazon Neptune Global Clusters API
Amazon Neptune Graph Snapshots API
Amazon Neptune Graphs API
Amazon Neptune Import Tasks API
Amazon Neptune Inference Endpoints API
Where this information came from

This is an independent, third-party profile of Amazon Neptune Gremlin API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.