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 Cluster API

Get information, monitor, and administrate cluster deployments

ArangoDB Cluster API is one of 24 APIs that ArangoDB publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Cluster. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 13 operations across 10 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.

13 operations 10 paths 0 schemas 7 GET2 POST4 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 13

Across 10 paths, the API surfaces 13 operations — 7 GET, 2 POST, 4 PUT. Each is listed below with its method, path, parameters, and response codes.

Cluster 13

Get information, monitor, and administrate cluster deployments

GET
/_admin/cluster/health
Get the cluster health
getClusterHealth → 200
PUT
/_admin/cluster/maintenance
Set the cluster maintenance mode
setClusterMaintenance body → 200400501504
GET
/_admin/cluster/maintenance/{DB-Server-ID}
Get the maintenance status of a DB-Server
getDbserverMaintenance 1 param → 200400412504
PUT
/_admin/cluster/maintenance/{DB-Server-ID}
Set the maintenance status of a DB-Server
setDbserverMaintenance 1 param body → 200400412504
GET
/_admin/cluster/rebalance
Get the current cluster imbalance
getClusterImbalance → 200
POST
/_admin/cluster/rebalance
Compute a set of move shard operations to improve balance
computeClusterRebalancePlan body → 200
PUT
/_admin/cluster/rebalance
Compute and execute a set of move shard operations to improve balance
startClusterRebalance body → 200
POST
/_admin/cluster/rebalance/execute
Execute a set of move shard operations
executeClusterRebalancePlan body → 200202
GET
/_admin/cluster/statisticsdeprecated
Get the statistics of a DB-Server
getClusterStatistics 1 param → 200400403
PUT
/_admin/cluster/uniqId
Reserve globally unique IDs
reserveUniqueIDs 2 params → 200400
GET
/_admin/server/id
Get the server ID
getServerId → 200500
GET
/_admin/server/role
Get the server role
getServerRole → 200
GET
/_api/cluster/endpoints
List all Coordinator endpoints
listClusterEndpoints → 200501

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

arangodb-cluster-api-openapi.yml Raw ↑

Other APIs ArangoDB publishes across the network.

Arango Managed Platform (AMP) API
Arango Managed Platform SCIM API
ArangoDB Administration API
ArangoDB Analyzers API
ArangoDB Authentication API
ArangoDB Batch Requests 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 Cluster 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.