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

ArangoDB Administration API

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

ArangoDB Administration API is one of 24 APIs that ArangoDB publishes on the 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.

This API exposes 26 operations across 22 paths. It is described by OpenAPI 3.2.0, at version 3.12.10 (API v0).

Requests are made against the base URL https://{deployment-id}.arangodb.cloud:8529.

26 operations 22 paths 0 schemas 2 DELETE18 GET3 POST3 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
3.12.10 (API v0)
Base URL
https://{deployment-id}.arangodb.cloud:8529
Resource Areas
1

Paths & Operations 26

Across 22 paths, the API surfaces 26 operations — 2 DELETE, 18 GET, 3 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.

Administration 26

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

PUT
/_admin/compact
Compact all databases
compactAllDatabases body → 200401
GET
/_admin/database/target-versiondeprecated
Get the required database version (deprecated)
getDatabaseVersion → 200
GET
/_admin/server/availability
Return whether or not a server is available
getServerAvailability → 200503
GET
/_db/_system/_admin/options
Get the startup option configuration
getEffectiveStartupOptions → 200401403405
GET
/_db/_system/_admin/options-description
Get the available startup options
getAvailableStartupOptions → 200401403405
GET
/_db/_system/_admin/support-info
Get information about the deployment
getSupportInfo → 200404
GET
/_db/_system/_api/endpointdeprecated
List the endpoints of a single server (deprecated)
listEndpoints → 200400405
GET
/_db/{database-name}/_admin/crashes
List crash dumps
listCrashDumps 1 param → 200401403503
DELETE
/_db/{database-name}/_admin/crashes/{crashId}
Delete a crash dump
deleteCrashDump 2 params → 200401403404503
GET
/_db/{database-name}/_admin/crashes/{crashId}
Get a crash dump
getCrashDump 2 params → 200401403404503
GET
/_db/{database-name}/_admin/deployment/id
Get the deployment ID
getDeploymentId 1 param → 200401
POST
/_db/{database-name}/_admin/echodeprecated
Echo a request
echoRequest 1 param body → 200
POST
/_db/{database-name}/_admin/executedeprecated
Execute a script
executeCode 1 param body → 200403404
GET
/_db/{database-name}/_admin/license
Get information about the current license
getLicense 1 param → 200
PUT
/_db/{database-name}/_admin/license
Set a new license
setLicense 2 params body → 201400501
GET
/_db/{database-name}/_admin/options-public
Get the public startup option configuration
getPublicStartupOptions 1 param → 200401405
POST
/_db/{database-name}/_admin/routing/reloaddeprecated
Reload the routing table
reloadRouting 1 param → 200
GET
/_db/{database-name}/_admin/server/mode
Return whether or not a server is in read-only mode
getServerMode 1 param → 200
PUT
/_db/{database-name}/_admin/server/mode
Set the server mode to read-only or default
setServerMode 1 param body → 200401
DELETE
/_db/{database-name}/_admin/shutdown
Start the shutdown sequence
startShutdown 2 params → 200
GET
/_db/{database-name}/_admin/shutdown
Query the soft shutdown progress
getShutdownProgress 1 param → 200
GET
/_db/{database-name}/_admin/status
Get server status information
getStatus 1 param → 200
GET
/_db/{database-name}/_admin/time
Get the system time
getTime 1 param → 200
GET
/_db/{database-name}/_api/engine
Get the storage engine type
getEngine 1 param → 200401
GET
/_db/{database-name}/_api/engine/stats
Get the storage engine statistics
getEngineStats 1 param → 200401403
GET
/_db/{database-name}/_api/version
Get the server version
getVersion 2 params → 200

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

arangodb-administration-api-openapi.yml Raw ↑

Other APIs ArangoDB publishes across the network.

Arango Managed Platform (AMP) API
Arango Managed Platform SCIM API
ArangoDB Analyzers API
ArangoDB Authentication API
ArangoDB Batch Requests API
ArangoDB Cluster API
ArangoDB Collections API
ArangoDB Databases API
ArangoDB Documents API
ArangoDB Foxx API
ArangoDB Graphs API
ArangoDB Hot Backups API
Where this information came from

This is an independent, third-party profile of ArangoDB Administration 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.