---
title: "HTTP endpoints"
description: "Guide to Aerospike Graph Service (AGS) HTTP endpoints for monitoring, indexing, cache, and metadata management."
---

# HTTP endpoints

> For the complete documentation index see: [llms.txt](https://aerospike.com/docs/llms.txt)
> 
> All documentation pages available in markdown.

## Overview

This page lists HTTP endpoints available to Aerospike Graph Service (AGS).

For all HTTP endpoints, prefix the URL with `/0` if the AGS server does not use [multi-tenant graphs](https://aerospike.com/docs/graph/manage/multi-tenant). For example, to call the `usage` endpoint on an AGS server that does not use multi-tenant graphs, use the following URL:

```plaintext
<IP ADDRESS>:9090/0/admin/metadata/usage
```

For the default graph with name `graph`, use the following URL:

```plaintext
<IP ADDRESS>:9090/0/admin/metadata/usage
```

On AGS servers that use multi-tenant graphs, prefix the URL with the name of the desired graph. For a graph named `myGraph`, use the following URL:

```plaintext
<IP ADDRESS>:9090/myGraph/admin/metadata/usage
```

## Monitoring services

AGS provides HTTP endpoints for monitoring services. Use the [`aerospike.graph.http.port`](https://aerospike.com/docs/graph/reference/config#aerospikegraphhttpport) configuration option to specify an HTTP port for the [Prometheus Exporter](https://aerospike.com/docs/graph/observe/metrics) 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](https://aerospike.com/docs/graph/load/overview) steps.

The prototype format of a call step HTTP endpoint is as follows:

```plaintext
<IP ADDRESS>:9090/0/admin/<call step type>/<call step>
```

If key-value arguments are required, they follow the standard mechanism:

```plaintext
<IP ADDRESS>:9090/0/admin/<call step type>/<call step>?<key1>=<value1>&<key2>=<value2>
```

### Metadata

AGS metadata is available:

```plaintext
http://localhost:9090/0/admin/metadata/summary

http://localhost:9090/0/admin/metadata/config

http://localhost:9090/0/admin/metadata/version
```

### Index management

You can perform [index management](https://aerospike.com/docs/graph/develop/query/indexing) using HTTP endpoints. In the following example, the HTTP request creates a secondary index called on the user-defined vertex `location` property:

```plaintext
http://localhost:9090/0/admin/index/create?property_key=location&element_type=vertex
```

In the following example, the HTTP request drops an index:

```plaintext
http://localhost:9090/0/admin/index/drop?property_key=location&element_type=vertex
```

Other index operations are also available. See [Indexing](https://aerospike.com/docs/graph/develop/query/indexing) for more information about index management.

### Cache management

You can manage AGS [caching](https://aerospike.com/docs/graph/manage/cache) using HTTP endpoints.

Get cache status:

```plaintext
http://localhost:9090/0/admin/cache/status
```

Set cache mode:

```plaintext
http://localhost:9090/0/admin/cache/set-mode?mode=GLOBAL
```

Set cache mode with a custom cache weight:

```plaintext
http://localhost:9090/0/admin/cache/set-mode?mode=GLOBAL&cache_weight=50000000
```

Reset all caches:

```plaintext
http://localhost:9090/0/admin/cache/reset
```

See [Cache management](https://aerospike.com/docs/graph/manage/cache) for more information about cache modes and admin services.