ArangoDB v3.8 reached End of Life (EOL) and is no longer supported.
This documentation is outdated. Please see the most recent version at docs.arangodb.com
Return the role of a server in a cluster
Return the role of a server in a cluster
GET /_admin/server/role
Returns the role of a server in a cluster. The role is returned in the role attribute of the result. Possible return values for role are:
- SINGLE: the server is a standalone server without clustering
- COORDINATOR: the server is a Coordinator in a cluster
- PRIMARY: the server is a DB-Server in a cluster
- SECONDARY: this role is not used anymore
- AGENT: the server is an Agency node in a cluster
- UNDEFINED: in a cluster, UNDEFINED is returned if the server role cannot be determined.
Responses
HTTP 200: Is returned in all cases.
-
error (boolean): always false
-
code (integer): the HTTP status code, always 200
-
errorNum (integer): the server error number
-
role (string): one of [ SINGLE, COORDINATOR, PRIMARY, SECONDARY, AGENT, UNDEFINED]