{
  "opencollection": "1.0.0",
  "info": {
    "name": "Amazon Neptune Neptune Gremlin API",
    "version": "2024-01-01"
  },
  "request": {
    "auth": {
      "type": "apikey",
      "key": "Authorization",
      "value": "{{Authorization}}",
      "placement": "header"
    }
  },
  "items": [
    {
      "info": {
        "name": "Query",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Amazon Neptune Execute a Gremlin Traversal via HTTP GET",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{cluster-endpoint}:8182/gremlin",
            "params": [
              {
                "name": "gremlin",
                "value": "g.V().count()",
                "type": "query",
                "description": "The Gremlin traversal query string (URL-encoded)."
              }
            ]
          },
          "docs": "Submits a Gremlin traversal query via a URL query parameter. This is an alternative to the POST method for simple queries."
        },
        {
          "info": {
            "name": "Amazon Neptune Execute a Gremlin Traversal via HTTP POST",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{cluster-endpoint}:8182/gremlin",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Submits a Gremlin traversal query to the Neptune HTTP REST endpoint. The query is provided as a JSON body with a gremlin property containing the traversal string. All results are returned in a single JSON response by default. For large result sets, chunked responses can be enabled to avoid OutOfMemoryError."
        }
      ]
    },
    {
      "info": {
        "name": "Status",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Amazon Neptune Get the Status of All Running Gremlin Queries",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{cluster-endpoint}:8182/gremlin/status"
          },
          "docs": "Returns the status of all running and waiting Gremlin queries, including query IDs, query strings, and execution statistics."
        },
        {
          "info": {
            "name": "Amazon Neptune Get the Status of a Specific Gremlin Query",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{cluster-endpoint}:8182/gremlin/status/:queryId",
            "params": [
              {
                "name": "queryId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the Gremlin query."
              }
            ]
          },
          "docs": "Returns the status of a specific Gremlin query identified by its query ID, including the query string and execution statistics."
        },
        {
          "info": {
            "name": "Amazon Neptune Cancel a Running Gremlin Query",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://{cluster-endpoint}:8182/gremlin/status/:queryId",
            "params": [
              {
                "name": "queryId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the Gremlin query to cancel."
              }
            ]
          },
          "docs": "Cancels a running Gremlin query by its query ID. The query must be currently running or waiting in the queue."
        }
      ]
    }
  ],
  "bundled": true
}