HTTP Interface for Endpoints

The API /_api/endpoint is deprecated. For cluster mode there is /_api/cluster/endpoints to find all current coordinator endpoints (see below).

The ArangoDB server can listen for incoming requests on multiple endpoints.

The endpoints are normally specified either in ArangoDB’s configuration file or on the command-line, using the “--server.endpoint” option. The default endpoint for ArangoDB is tcp://127.0.0.1:8529 or tcp://localhost:8529.

Please note that all endpoint management operations can only be accessed via the default database (_system) and none of the other databases.

Asking about Endpoints via HTTP

Get information about all coordinator endpoints

This API call returns information about all coordinator endpoints (cluster only).

GET /_api/cluster/endpoints

Returns an object with an attribute endpoints, which contains an array of objects, which each have the attribute endpoint, whose value is a string with the endpoint description. There is an entry for each coordinator in the cluster. This method only works on coordinators in cluster mode. In case of an error the error attribute is set to true.

HTTP 200

  • error: boolean flag to indicate whether an error occurred (true in this case)

  • code: the HTTP status code - 200

  • endpoints: A list of active cluster endpoints.

    • endpoint: The bind of the coordinator, like tcp://[::1]:8530
  • 403:

Return list of all endpoints

This API call returns the list of all endpoints (single server).

GET /_api/endpoint

This route should no longer be used. It is considered as deprecated from version 3.4.0 on.

Returns an array of all configured endpoints the server is listening on.

The result is a JSON array of JSON objects, each with `“entrypoint”’ as the only attribute, and with the value being a string describing the endpoint.

Note: retrieving the array of all endpoints is allowed in the system database only. Calling this action in any other database will make the server return an error.

Return codes

  • 200: is returned when the array of endpoints can be determined successfully.

  • 400: is returned if the action is not carried out in the system database.

  • 405: The server will respond with HTTP 405 if an unsupported HTTP method is used.

Examples

shell> curl --header 'accept: application/json' --dump - http://localhost:8529/_api/endpoint

HTTP/1.1 OK
content-type: application/json; charset=utf-8
x-content-type-options: nosniff

[ 
  { 
    "endpoint" : "http://127.0.0.1:58481" 
  } 
]