HTTP endpoints
Overview
This page lists HTTP endpoints available to Aerospike Graph Service (AGS).
Monitoring services
AGS provides HTTP endpoints for
monitoring services. Use the
aerospike.graph.http.port
configuration option to specify an HTTP port for the
Prometheus Exporter
and health check services.
| Service | Default path |
|---|---|
| Prometheus Exporter | /metrics |
| Health check | /healthcheck |
Gremlin call steps
All AGS Gremlin call steps are available as HTTP endpoints,
with the exception of the bulk loader
steps which are prefixed with graphloader.admin.bulk-load.
The prototype format of a call step HTTP endpoint is as follows:
<IP ADDRESS>:9090/admin/<call step type>/<call step>
If key-value arguments are required, they follow the standard mechanism:
<IP ADDRESS>:9090/admin/<call step type>/<call step>?<key1>=<value1>&<key2>=<value2>
Metadata
AGS metadata is available:
http://localhost:9090/admin/metadata/summary
http://localhost:9090/admin/metadata/config
http://localhost:9090/admin/metadata/version
Index management
You can perform index management using HTTP endpoints.
In the following example, the HTTP request creates a secondary index
called on the user-defined vertex location property:
http://localhost:9090/admin/index/create?property_key=location&element_type=vertex
In the following example, the HTTP request drops an index:
http://localhost:9090/admin/index/drop?property_key=location&element_type=vertex
Other index operations are also available. See Indexing for more information about index management.