# ArangoDB Administration API

**Canonical:** https://apis.io/apis/arangodb/arangodb-administration-api/  
**Provider:** ArangoDB — https://apis.io/providers/arangodb/  
**Base URL:** https://{deployment-id}.arangodb.cloud:8529  
**Documentation:** https://docs.arango.ai/arangodb/stable/develop/http-api/

ArangoDB Administration API is one of 24 APIs that [ArangoDB](https://apis.io/providers/arangodb/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include Administration. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

Get server information, manage licenses, shut down nodes, and more

## Operations (26)

| Method | Path | Summary |
|---|---|---|
| PUT | `/_admin/compact` | Compact all databases |
| GET | `/_admin/database/target-version` | Get the required database version (deprecated) |
| GET | `/_admin/server/availability` | Return whether or not a server is available |
| GET | `/_db/_system/_admin/options` | Get the startup option configuration |
| GET | `/_db/_system/_admin/options-description` | Get the available startup options |
| GET | `/_db/_system/_admin/support-info` | Get information about the deployment |
| GET | `/_db/_system/_api/endpoint` | List the endpoints of a single server (deprecated) |
| GET | `/_db/{database-name}/_admin/crashes` | List crash dumps |
| DELETE | `/_db/{database-name}/_admin/crashes/{crashId}` | Delete a crash dump |
| GET | `/_db/{database-name}/_admin/crashes/{crashId}` | Get a crash dump |
| GET | `/_db/{database-name}/_admin/deployment/id` | Get the deployment ID |
| POST | `/_db/{database-name}/_admin/echo` | Echo a request |
| POST | `/_db/{database-name}/_admin/execute` | Execute a script |
| GET | `/_db/{database-name}/_admin/license` | Get information about the current license |
| PUT | `/_db/{database-name}/_admin/license` | Set a new license |
| GET | `/_db/{database-name}/_admin/options-public` | Get the public startup option configuration |
| POST | `/_db/{database-name}/_admin/routing/reload` | Reload the routing table |
| GET | `/_db/{database-name}/_admin/server/mode` | Return whether or not a server is in read-only mode |
| PUT | `/_db/{database-name}/_admin/server/mode` | Set the server mode to read-only or default |
| DELETE | `/_db/{database-name}/_admin/shutdown` | Start the shutdown sequence |
| GET | `/_db/{database-name}/_admin/shutdown` | Query the soft shutdown progress |
| GET | `/_db/{database-name}/_admin/status` | Get server status information |
| GET | `/_db/{database-name}/_admin/time` | Get the system time |
| GET | `/_db/{database-name}/_api/engine` | Get the storage engine type |
| GET | `/_db/{database-name}/_api/engine/stats` | Get the storage engine statistics |
| GET | `/_db/{database-name}/_api/version` | Get the server version |

## Machine-readable artifacts (2)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/arangodb/refs/heads/main/openapi/arangodb-administration-api-openapi.yml
- **Documentation** — https://docs.arango.ai/arangodb/stable/develop/http-api/

## Other ArangoDB APIs (12)

- [Arango Managed Platform (AMP) API](https://apis.io/apis/arangodb/amp-api/)
- [Arango Managed Platform SCIM API](https://apis.io/apis/arangodb/amp-scim-api/)
- [ArangoDB Analyzers API](https://apis.io/apis/arangodb/arangodb-analyzers-api/)
- [ArangoDB Authentication API](https://apis.io/apis/arangodb/arangodb-authentication-api/)
- [ArangoDB Batch Requests API](https://apis.io/apis/arangodb/arangodb-batch-requests-api/)
- [ArangoDB Cluster API](https://apis.io/apis/arangodb/arangodb-cluster-api/)
- [ArangoDB Collections API](https://apis.io/apis/arangodb/arangodb-collections-api/)
- [ArangoDB Databases API](https://apis.io/apis/arangodb/arangodb-databases-api/)
- [ArangoDB Documents API](https://apis.io/apis/arangodb/arangodb-documents-api/)
- [ArangoDB Foxx API](https://apis.io/apis/arangodb/arangodb-foxx-api/)
- [ArangoDB Graphs API](https://apis.io/apis/arangodb/arangodb-graphs-api/)
- [ArangoDB Hot Backups API](https://apis.io/apis/arangodb/arangodb-hot-backups-api/)

## Tags

Administration

---

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