ArangoDB 3.11 reached End of Life (EOL) and is no longer supported.

This documentation is outdated. Please see the most recent stable version.

Administration HTTP API

You can get information about ArangoDB servers, toggle the maintenance mode, shut down server nodes, and start actions like compaction

Information

Get the server version

GET http://<EXTERNAL_ENDPOINT>:8529/_db/:database-name/_api/version

Returns the server name and version number.

Path Parameters

database-name string
The name of a database. Which database you use doesn’t matter as long as the user account you authenticate with has at least read access to this database.
Example: _system

Query Parameters

details boolean (default: false)
If set to true and if the user account you authenticate with has administrate access to the _system database, the response contains a details attribute with additional information about included components and their versions. The attribute names and internals of the details object may vary depending on platform and ArangoDB version.

HTTP Headers

Responses

200 OK
is returned in all cases.
- details object, optional
  An object with additional details like compile flags, dependency versions, and so on.
  Only returned if the details query parameter is set to true in the request.
  architecture string
  The value is always: "64bit"
  The CPU architecture in terms of bitness.
  arm string
  Possible values: "true", "false"
  Whether the server binary has been compiled for an ARM CPU.
  asan string
  Possible values: "true", "false"
  Whether the server has been compiled with the ASAN address sanitizer enabled.
  assertions string
  Possible values: "true", "false"
  Whether the server has assertions compiled in (only in development builds).
  avx string
  Possible values: "true", "false"
  Whether the server binary has been compiled with AVX instruction support.
  avx2 string
  Possible values: "true", "false"
  Whether the server binary has been compiled with AVX2 instruction support.
  boost-version string
  Which version of the Boost library is used.
  build-date string
  The date when this binary was created.
  build-repository string, optional
  Reference to the Git ID this was compiled from.
  compiler string
  The compiler that has been used.
  coverage string
  Possible values: "true", "false"
  Whether this build has code coverage instrumentation.
  cplusplus string
  The C++ standards version.
  curl-version string
  The linked cURL version, or "none" if not linked.
  debug string
  Possible values: "true", "false"
  Whether this is a debug build, "false" for production binaries.
  endianness string
  The value is always: "little"
  The byte order of the system, detected at runtime.
  enterprise-build-repository string, optional
  Reference to the enterprise Git ID this was compiled from.
  enterprise-version string, optional
  The value is always: "enterprise"
  Only present if this is a build that includes the non-public enterprise code.
  failure-tests string
  Possible values: "true", "false"
  Whether the facility to invoke fatal errors is compiled in, "false" for production binaries.
  fd-client-event-handler string
  Which method is used to handle fd-sets, typically poll on Linux.
  fd-setsize string
  If not poll, the fd setsize is valid for the maximum number of file descriptors.
  full-version-string string
  The full version string including the build ID and the versions of major dependencies.
  host string
  The host ID.
  icu-version string
  The version of the bundled ICU library.
  ipo string
  Possible values: "true", "false"
  Whether interprocedural optimization was enabled.
  iresearch-version string
  The ArangoSearch/IResearch library version.
  jemalloc string
  Possible values: "true", "false"
  Whether the jemalloc memory allocator is used, typically "true"
  libunwind string
  Whether libunwind is linked for stack unwinding.
  license string
  Possible values: "community", "enterprise"
  Whether this build of ArangoDB includes the non-public enterprise code. Reports "community" for the Community Edition and "enterprise" for the Enterprise Edition.
  maintainer-mode string
  Possible values: "true", "false"
  Whether the server has been compiled in maintainer mode, "false" for production binaries.
  memory-profiler string
  Possible values: "true", "false"
  Whether the memory profiler is enabled.
  mode string
  Possible values: "server", "console", "script"
  The mode the server runs in.
  ndebug string
  Possible values: "true", "false"
  Whether NDEBUG was defined for the build.
  openssl-version-compile-time string
  The OpenSSL version at compile time.
  openssl-version-run-time string
  The OpenSSL version at run time.
  optimization-flags string, optional
  The compiler optimization flags used for this build.
  oskar-build-repository string, optional
  Reference to the Git ID of the build environment this was compiled with.
  pic string
  The position-independent code setting.
  pie string
  The position-independent executable setting.
  platform string
  Possible values: "linux", "windows", "darwin"
  The operating system the server has been compiled for.
  reactor-type string
  The value is always: "epoll"
  replication2-enabled string
  Possible values: "true", "false"
  Whether replication2 is enabled.
  rocksdb-version string
  The rocksdb version this release bundles.
  role string
  Possible values: "SINGLE", "PRIMARY", "COORDINATOR", "AGENT"
  The server role.
  "SINGLE": Standalone single server
  "PRIMARY": DB-Server of a cluster
  "COORDINATOR": Coordinator of a cluster
  "AGENT": Part of the cluster’s Agency
  server-version string
  The ArangoDB release version.
  sizeof int string
  Number of bytes for integers.
  sizeof long string
  Number of bytes for long integers.
  sizeof void* string
  Number of bytes for void pointers.
  sse42 string
  Whether the server binary has been compiled with SSE 4.2 instruction support.
  tsan string
  Possible values: "true", "false"
  Whether this was compiled with the thread sanitizer.
  unaligned-access string
  Possible values: "true", "false"
  Whether this system supports unaligned memory accesses.
  v8-version string
  The bundled V8 JavaScript engine version.
  vpack-version string
  The version of the used VelocyPack implementation.
  zlib-version string
  The version of the bundled zlib compression library.
- server string
  The value is always: "arango"
- version string
  The server version string in the format major.minor.sub (e.g. 3.12.11). The major and minor parts are numeric, and sub is a number that may have a version suffix starting with a hyphen minus (e.g. 3.11.14-5 or 4.0.0-devel).

Examples

Return the version information

curl --header 'accept: application/json' --dump - 'http://localhost:8529/_api/version'

Show output

HTTP/1.1 200 OK
content-type: application/json
cache-control: no-cache, no-store, must-revalidate, pre-check=0, post-check=0, max-age=0, s-maxage=0
connection: Keep-Alive
content-length: 62
content-security-policy: frame-ancestors 'self'; form-action 'self';
expires: 0
pragma: no-cache
server: ArangoDB
strict-transport-security: max-age=31536000 ; includeSubDomains
x-arango-queue-time-seconds: 0.000000
x-content-type-options: nosniff

{ 
  "server" : "arango", 
  "license" : "enterprise", 
  "version" : "3.11.14" 
}

Return the version information with details

curl --header 'accept: application/json' --dump - 'http://localhost:8529/_api/version?details=true'

Show output

HTTP/1.1 200 OK
content-type: application/json
cache-control: no-cache, no-store, must-revalidate, pre-check=0, post-check=0, max-age=0, s-maxage=0
connection: Keep-Alive
content-length: 1594
content-security-policy: frame-ancestors 'self'; form-action 'self';
expires: 0
pragma: no-cache
server: ArangoDB
strict-transport-security: max-age=31536000 ; includeSubDomains
x-arango-queue-time-seconds: 0.000000
x-content-type-options: nosniff

{ 
  "server" : "arango", 
  "license" : "enterprise", 
  "version" : "3.11.14", 
  "details" : { 
    "architecture" : "64bit", 
    "arm" : "false", 
    "asan" : "false", 
    "assertions" : "false", 
    "avx" : "true", 
    "avx2" : "false", 
    "boost-version" : "1.78.0", 
    "build-date" : "2025-05-23 17:41:20", 
    "build-repository" : "refs/3.11.14 46e2b3087", 
    "compiler" : "clang [Ubuntu Clang 16.0.6 (23ubuntu4)]", 
    "coverage" : "false", 
    "cplusplus" : "202002", 
    "curl-version" : "none", 
    "debug" : "false", 
    "endianness" : "little", 
    "enterprise-build-repository" : "refs/3.11.14 633a631", 
    "enterprise-version" : "enterprise", 
    "failure-tests" : "false", 
    "fd-client-event-handler" : "poll", 
    "fd-setsize" : "1024", 
    "full-version-string" : "ArangoDB 3.11.14 enterprise [linux] 64bit, using jemalloc, build refs/3.11.14 46e2b3087, VPack 0.2.1, RocksDB 7.2.0, ICU 64.2, V8 7.9.317, OpenSSL 3.5.0 8 Apr 2025", 
    "icu-version" : "64.2", 
    "ipo" : "false", 
    "iresearch-version" : "1.3.0.0", 
    "jemalloc" : "true", 
    "libunwind" : "true", 
    "license" : "enterprise", 
    "maintainer-mode" : "false", 
    "memory-profiler" : "true", 
    "ndebug" : "true", 
    "openssl-version-compile-time" : "OpenSSL 3.5.0 8 Apr 2025", 
    "openssl-version-run-time" : "OpenSSL 3.5.0 8 Apr 2025", 
    "optimization-flags" : "-mfxsr -mmmx -msse -msse2 -mcx16 -msahf -mpopcnt -msse3 -msse4.1 -msse4.2 -mssse3 -mpclmul -mavx -mxsave", 
    "pic" : "2", 
    "pie" : "2", 
    "platform" : "linux", 
    "reactor-type" : "epoll", 
    "replication2-enabled" : "false", 
    "rocksdb-version" : "7.2.0", 
    "server-version" : "3.11.14", 
    "sizeof int" : "4", 
    "sizeof long" : "8", 
    "sizeof void*" : "8", 
    "sse42" : "true", 
    "tsan" : "false", 
    "unaligned-access" : "true", 
    "v8-version" : "7.9.317", 
    "vpack-version" : "0.2.1", 
    "zlib-version" : "1.2.13", 
    "mode" : "server", 
    "role" : "SINGLE", 
    "host" : "localhost" 
  } 
}

Get the storage engine type

GET http://<EXTERNAL_ENDPOINT>:8529/_db/:database-name/_api/engine

Returns the name of the storage engine the server is configured to use and the index types it supports.

Path Parameters

database-name string
The name of a database. Which database you use doesn’t matter as long as the user account you authenticate with has at least read access to this database.
Example: _system

Query Parameters

HTTP Headers

Responses

200 OK
Successfully retrieved the storage engine information.
- name string
  The value is always: "rocksdb"
  The name of the storage engine.
- supports object
  An object describing what the storage engine supports.
  aliases object
  An object describing the alternative names you can use for certain index types.
  indexes object
  The keys are the alternative index type names and the values are the index types they refer to.
  hash string
  The value is always: "persistent"
  The hash index type is an alias for persistent.
  skiplist string
  The value is always: "persistent"
  The skiplist index type is an alias for persistent.
  dfdb boolean
  The value is always: false
  Whether the active storage engine support being inspected/repaired with the MMFiles datafile debugger.
  indexes array of strings
  Possible values in the array: "primary", "edge", "ttl", "persistent", "geo", "zkd", "inverted", "hash", "skiplist", "fulltext"
  A list of the index types you can use. vector is only included if the --vector-index startup option is enabled.
401 Unauthorized
Missing read access to the given database.
- code integer
  The HTTP response status code.
  Example: 401
- error boolean
  A flag indicating that an error occurred.
  Example: true
- errorMessage string
  A descriptive error message.
- errorNum integer
  The ArangoDB error number for the error that occurred.

Examples

Return the active storage engine:

curl --header 'accept: application/json' --dump - 'http://localhost:8529/_api/engine'

Show output

HTTP/1.1 200 OK
content-type: application/json
cache-control: no-cache, no-store, must-revalidate, pre-check=0, post-check=0, max-age=0, s-maxage=0
connection: Keep-Alive
content-length: 212
content-security-policy: frame-ancestors 'self'; form-action 'self';
expires: 0
pragma: no-cache
server: ArangoDB
strict-transport-security: max-age=31536000 ; includeSubDomains
x-arango-queue-time-seconds: 0.000000
x-content-type-options: nosniff

{ 
  "name" : "rocksdb", 
  "supports" : { 
    "dfdb" : false, 
    "indexes" : [ 
      "primary", 
      "edge", 
      "hash", 
      "skiplist", 
      "ttl", 
      "persistent", 
      "geo", 
      "fulltext", 
      "zkd", 
      "inverted" 
    ], 
    "aliases" : { 
      "indexes" : { 
        "hash" : "persistent", 
        "skiplist" : "persistent" 
      } 
    } 
  } 
}

Get the storage engine statistics

GET http://<EXTERNAL_ENDPOINT>:8529/_db/:database-name/_api/engine/stats

Returns detailed statistics related to the RocksDB storage engine activity, including figures about data size, cache usage, individual column families, etc.

Path Parameters

database-name string
The name of a database. Which database you use doesn’t matter as long as the user account you authenticate with has at least read access to this database. If the --server.harden startup option is enabled, administrate access to the _system database is required.
Example: _system

Query Parameters

HTTP Headers

Responses

200 OK
Successfully retrieved the storage engine statistics.
401 Unauthorized
The user account you authenticated with lacks read access to the specified database, the credentials are wrong, or the user account is inactive.
- code integer
  The HTTP response status code.
  Example: 401
- error boolean
  A flag indicating that an error occurred.
  Example: true
- errorMessage string
  A descriptive error message.
- errorNum integer
  The ArangoDB error number for the error that occurred.
403 Forbidden
The --server.harden startup option is enabled but the user account you authenticated with lacks write access to the _system database.
- code integer
  The HTTP response status code.
  Example: 403
- error boolean
  A flag indicating that an error occurred.
  Example: true
- errorMessage string
  A descriptive error message.
- errorNum integer
  The ArangoDB error number for the error that occurred.

Get the system time

GET http://<EXTERNAL_ENDPOINT>:8529/_db/:database-name/_admin/time

The call returns an object with the time attribute. This contains the current system time as a Unix timestamp with microsecond precision.

Path Parameters

database-name string
The name of a database. Which database you use doesn’t matter as long as the user account you authenticate with has at least read access to this database.
Example: _system

Query Parameters

HTTP Headers

Responses

200 OK
Time was returned successfully.
- code integer
  The HTTP response status code.
  Example: 200
- error boolean
  A flag indicating that no error occurred.
  Example: false
- time number
  The current system time as a Unix timestamp with microsecond precision of the server

Get server status information

GET http://<EXTERNAL_ENDPOINT>:8529/_db/:database-name/_admin/status

Returns status information about the server.

Path Parameters

database-name string
The name of a database. Which database you use doesn’t matter as long as the user account you authenticate with has at least read access to this database. If the --server.harden startup option is enabled, administrate access to the _system database is required.
Example: _system

Query Parameters

HTTP Headers

Responses

200 OK
Status information was returned successfully.
- agency object, optional
  Information about the Agency. Cluster only (Coordinators and DB-Servers).
  agencyComm object
  Information about the communication with the Agency. Cluster only (Coordinators and DB-Servers).
  endpoints array of strings
  A list of possible Agency endpoints.
- agent object, optional
  Information about the Agents. Cluster only (Agents)
  endpoint string
  The endpoint of the queried Agent.
  id string
  Server ID of the queried Agent.
  leaderId string
  Server ID of the leading Agent.
  leading boolean
  Whether the queried Agent is the leader.
  term number
  The current term number.
- coordinator object, optional
  Information about the Coordinators. Cluster only (Coordinators)
  foxxmaster string, optional
  The server ID of the Coordinator that is the Foxx master.
  isFoxxmaster boolean, optional
  Whether the queried Coordinator is the Foxx master.
- foxxApi boolean
  Whether the Foxx API is enabled.
- host string
  A host identifier defined by the HOST or NODE_NAME environment variable, or a fallback value using a machine identifier or the cluster/Agency address.
- hostname string, optional
  A hostname defined by the HOSTNAME environment variable.
- license string
  ArangoDB Edition, either "community" or "enterprise".
- mode string
  Either "server" or "console". Deprecated, use operationMode instead.
- operationMode string
  Either "server" or "console".
- pid number
  The process ID of arangod.
- server string
  The value is always: "arango"
- serverInfo object
  Information about the server status.
  address string, optional
  The address of the server, e.g. tcp://[::1]:8530. Cluster only (Coordinators and DB-Servers).
  maintenance boolean
  Whether the maintenance mode is enabled.
  persistedId string, optional
  The persisted ID, e. g. "CRDN-e427b441-5087-4a9a-9983-2fb1682f3e2a". Cluster only (Agents, Coordinators, and DB-Servers).
  progress object
  Startup and recovery information.
  You can check for changes to determine whether progress was made between two calls, but you should not rely on specific values as they may change between ArangoDB versions. The values are only expected to change during the startup and shutdown, i.e. while maintenance is true.
  You need to start arangod with the --server.early-connections startup option enabled to be able to query the endpoint during the startup process. If authentication is enabled, then you need to use the super-user JWT for the request because the user management is not available during the startup.
  feature string
  Internal name of the feature that is currently being prepared, started, stopped or unprepared.
  phase string
  Name of the lifecycle phase the instance is currently in. Normally one of "in prepare", "in start", "in wait", "in shutdown", "in stop", or "in unprepare".
  recoveryTick number
  Current recovery sequence number value, if the instance is currently recovering. If the instance is already past the recovery, this attribute will contain the last handled recovery sequence number.
  readOnly boolean
  Whether writes are disabled.
  rebootId number, optional
  The reboot ID. Changes on every restart. Cluster only (Agents, Coordinators, and DB-Servers).
  role string
  Either "SINGLE", "COORDINATOR", "PRIMARY" (DB-Server), or "AGENT".
  serverId string, optional
  The server ID, e.g. "CRDN-e427b441-5087-4a9a-9983-2fb1682f3e2a". Cluster only (Coordinators and DB-Servers).
  state string, optional
  Either "STARTUP", "SERVING", or "SHUTDOWN". Cluster only (Coordinators and DB-Servers).
  writeOpsEnabled boolean
  Whether writes are enabled. Deprecated, use readOnly instead.
- version string
  The server version as a string.

Examples

curl --header 'accept: application/json' --dump - 'http://localhost:8529/_admin/status'

Show output

HTTP/1.1 200 OK
content-type: application/json
cache-control: no-cache, no-store, must-revalidate, pre-check=0, post-check=0, max-age=0, s-maxage=0
connection: Keep-Alive
content-length: 710
content-security-policy: frame-ancestors 'self'; form-action 'self';
expires: 0
pragma: no-cache
server: ArangoDB
strict-transport-security: max-age=31536000 ; includeSubDomains
x-arango-queue-time-seconds: 0.000000
x-content-type-options: nosniff

{ 
  "server" : "arango", 
  "version" : "3.11.14", 
  "pid" : 243, 
  "license" : "enterprise", 
  "mode" : "server", 
  "operationMode" : "server", 
  "foxxApi" : true, 
  "host" : "localhost", 
  "hostname" : "dbe4acec7c06", 
  "serverInfo" : { 
    "progress" : { 
      "phase" : "in wait", 
      "feature" : "", 
      "recoveryTick" : 0 
    }, 
    "maintenance" : false, 
    "role" : "COORDINATOR", 
    "writeOpsEnabled" : true, 
    "readOnly" : false, 
    "persistedId" : "CRDN-fe15e622-35ae-4157-8fee-14b0bca4fb2e", 
    "rebootId" : 1, 
    "address" : "tcp://localhost:8529", 
    "serverId" : "CRDN-fe15e622-35ae-4157-8fee-14b0bca4fb2e", 
    "state" : "SERVING" 
  }, 
  "coordinator" : { 
    "foxxmaster" : "CRDN-a82d3b6c-7f7e-444f-991c-924847ec211d", 
    "isFoxxmaster" : false 
  }, 
  "agency" : { 
    "agencyComm" : { 
      "endpoints" : [ 
        "tcp://localhost:8531", 
        "tcp://localhost:8541", 
        "tcp://localhost:8551" 
      ] 
    } 
  } 
}

Return whether or not a server is available

GET http://<EXTERNAL_ENDPOINT>:8529/_admin/server/availability

Return availability information about a server.

The response is a JSON object with an attribute “mode”. The “mode” can either be “readonly”, if the server is in read-only mode, or “default”, if it is not. Please note that the JSON object with “mode” is only returned in case the server does not respond with HTTP response code 503.

This is a public API so it does not require authentication. It is meant to be used only in the context of server monitoring.

Responses

200 OK
This API will return HTTP 200 in case the server is up and running and usable for arbitrary operations, is not set to read-only mode and is currently not a follower in case of an Active Failover deployment setup.
503 Service Unavailable
HTTP 503 will be returned in case the server is during startup or during shutdown, is set to read-only mode or is currently a follower in an Active Failover deployment setup.
In addition, HTTP 503 will be returned in case the fill grade of the scheduler queue exceeds the configured high-water mark (adjustable via startup option --server.unavailability-queue-fill-grade), which by default is set to 75 % of the maximum queue length.

Get the required database version (deprecated)

GET http://<EXTERNAL_ENDPOINT>:8529/_admin/database/target-version

This endpoint is deprecated and should no longer be used. It is removed in ArangoDB v4.0. Use GET /_api/version instead.

Returns the database version that this server requires. The version is returned in the version attribute of the result.

Responses

200 OK
Is returned in all cases.

Get information about the deployment

GET http://<EXTERNAL_ENDPOINT>:8529/_db/_system/_admin/support-info

Retrieves deployment information for support purposes. The endpoint returns data about the ArangoDB version used, the host (operating system, server ID, CPU and storage capacity, current utilization, a few metrics) and the other servers in the deployment (in case of cluster deployments).

As this API may reveal sensitive data about the deployment, it can only be accessed from inside the _system database. In addition, there is a policy control startup option --server.support-info-api that controls if and to whom the API is made available.

Responses

200 OK
- date string
  ISO 8601 datetime string of when the information was requested.
- deployment object
  An object with at least a type attribute, indicating the deployment mode.
  In case of a "single" server, additional information is provided in the top-level host attribute.
  In case of a "cluster", there is a servers object that contains a nested object for each Coordinator and DB-Server, using the server ID as key. Each object holds information about the ArangoDB instance as well as the host machine. There are additional attributes for the number of agents, coordinators, dbServers, and shards.
- host object, optional
  An object that holds information about the ArangoDB instance as well as the host machine. Only set in case of single servers.
404 Not Found
The support info API is turned off.

Examples

Query support information from a single server

curl --header 'accept: application/json' --dump - 'http://localhost:8529/_db/_system/_admin/support-info'

Show output

HTTP/1.1 200 OK
content-type: application/json
cache-control: no-cache, no-store, must-revalidate, pre-check=0, post-check=0, max-age=0, s-maxage=0
connection: Keep-Alive
content-length: 1129
content-security-policy: frame-ancestors 'self'; form-action 'self';
expires: 0
pragma: no-cache
server: ArangoDB
strict-transport-security: max-age=31536000 ; includeSubDomains
x-arango-queue-time-seconds: 0.000000
x-content-type-options: nosniff

{ 
  "deployment" : { 
    "type" : "single" 
  }, 
  "host" : { 
    "role" : "SINGLE", 
    "maintenance" : false, 
    "readOnly" : false, 
    "version" : "3.11.14", 
    "build" : "refs/3.11.14 46e2b3087", 
    "license" : "enterprise", 
    "os" : "Linux version 6.8.0-1019-aws (buildd@lcy02-amd64-058) (x86_64-linux-gnu-gcc-12 (Ubuntu 12.3.0-1ubuntu1~22.04) 12.3.0, GNU ld (GNU Binutils for Ubuntu) 2.38) #21~22.04.1-Ubuntu SMP Thu Nov  7 17:33:30 UTC 2024", 
    "platform" : "linux", 
    "physicalMemory" : { 
      "value" : 33089753088, 
      "overridden" : false 
    }, 
    "numberOfCores" : { 
      "value" : 8, 
      "overridden" : false 
    }, 
    "processStats" : { 
      "processUptime" : 48.31603527069092, 
      "numberOfThreads" : 63, 
      "virtualSize" : 1112117248, 
      "residentSetSize" : 224190464 
    }, 
    "cpuStats" : { 
      "userPercent" : 5.682688035629212, 
      "systemPercent" : 2.47359659124365, 
      "idlePercent" : 90.21160197630786, 
      "iowaitPercent" : 1.459748518572048 
    }, 
    "engineStats" : { 
      "cache.limit" : 7735567360, 
      "cache.allocated" : 1281040, 
      "rocksdb.estimate-num-keys" : 1574, 
      "rocksdb.estimate-live-data-size" : 0, 
      "rocksdb.live-sst-files-size" : 0, 
      "rocksdb.block-cache-capacity" : 9282680832, 
      "rocksdb.block-cache-usage" : 96, 
      "rocksdb.free-disk-space" : 141042524160, 
      "rocksdb.total-disk-space" : 155897610240 
    } 
  }, 
  "date" : "2025-05-23T18:15:29Z" 
}

Query support information from a cluster

curl --header 'accept: application/json' --dump - 'http://localhost:8529/_db/_system/_admin/support-info'

Show output

HTTP/1.1 200 OK
content-type: application/json
cache-control: no-cache, no-store, must-revalidate, pre-check=0, post-check=0, max-age=0, s-maxage=0
connection: Keep-Alive
content-length: 6561
content-security-policy: frame-ancestors 'self'; form-action 'self';
expires: 0
pragma: no-cache
server: ArangoDB
strict-transport-security: max-age=31536000 ; includeSubDomains
x-arango-queue-time-seconds: 0.000000
x-content-type-options: nosniff

{ 
  "deployment" : { 
    "type" : "cluster", 
    "servers" : { 
      "CRDN-fe15e622-35ae-4157-8fee-14b0bca4fb2e" : { 
        "id" : "CRDN-fe15e622-35ae-4157-8fee-14b0bca4fb2e", 
        "alias" : "Coordinator0003", 
        "endpoint" : "tcp://localhost:8529", 
        "role" : "COORDINATOR", 
        "maintenance" : false, 
        "readOnly" : false, 
        "version" : "3.11.14", 
        "build" : "refs/3.11.14 46e2b3087", 
        "license" : "enterprise", 
        "os" : "Linux version 6.8.0-1019-aws (buildd@lcy02-amd64-058) (x86_64-linux-gnu-gcc-12 (Ubuntu 12.3.0-1ubuntu1~22.04) 12.3.0, GNU ld (GNU Binutils for Ubuntu) 2.38) #21~22.04.1-Ubuntu SMP Thu Nov  7 17:33:30 UTC 2024", 
        "platform" : "linux", 
        "physicalMemory" : { 
          "value" : 33089753088, 
          "overridden" : false 
        }, 
        "numberOfCores" : { 
          "value" : 8, 
          "overridden" : false 
        }, 
        "processStats" : { 
          "processUptime" : 45.513792276382446, 
          "numberOfThreads" : 39, 
          "virtualSize" : 734941184, 
          "residentSetSize" : 110473216 
        }, 
        "cpuStats" : { 
          "userPercent" : 5.683576081661929, 
          "systemPercent" : 2.4740524250745373, 
          "idlePercent" : 90.21031051445517, 
          "iowaitPercent" : 1.4597016363431985 
        } 
      }, 
      "PRMR-6db41c10-5f6a-4dad-901e-eea212248fe3" : { 
        "id" : "PRMR-6db41c10-5f6a-4dad-901e-eea212248fe3", 
        "alias" : "DBServer0001", 
        "endpoint" : "tcp://localhost:8540", 
        "role" : "PRIMARY", 
        "maintenance" : false, 
        "readOnly" : false, 
        "version" : "3.11.14", 
        "build" : "refs/3.11.14 46e2b3087", 
        "license" : "enterprise", 
        "os" : "Linux version 6.8.0-1019-aws (buildd@lcy02-amd64-058) (x86_64-linux-gnu-gcc-12 (Ubuntu 12.3.0-1ubuntu1~22.04) 12.3.0, GNU ld (GNU Binutils for Ubuntu) 2.38) #21~22.04.1-Ubuntu SMP Thu Nov  7 17:33:30 UTC 2024", 
        "platform" : "linux", 
        "physicalMemory" : { 
          "value" : 33089753088, 
          "overridden" : false 
        }, 
        "numberOfCores" : { 
          "value" : 8, 
          "overridden" : false 
        }, 
        "processStats" : { 
          "processUptime" : 46.50096297264099, 
          "numberOfThreads" : 68, 
          "virtualSize" : 960917504, 
          "residentSetSize" : 170102784 
        }, 
        "cpuStats" : { 
          "userPercent" : 5.683576081661929, 
          "systemPercent" : 2.4740524250745373, 
          "idlePercent" : 90.21031051445517, 
          "iowaitPercent" : 1.4597016363431985 
        }, 
        "engineStats" : { 
          "cache.limit" : 7735567360, 
          "cache.allocated" : 1082848, 
          "rocksdb.estimate-num-keys" : 211, 
          "rocksdb.estimate-live-data-size" : 0, 
          "rocksdb.live-sst-files-size" : 0, 
          "rocksdb.block-cache-capacity" : 9282680832, 
          "rocksdb.block-cache-usage" : 96, 
          "rocksdb.free-disk-space" : 141042524160, 
          "rocksdb.total-disk-space" : 155897610240 
        } 
      }, 
      "CRDN-9ac983de-5219-4f03-bd7c-160ac5ec1767" : { 
        "id" : "CRDN-9ac983de-5219-4f03-bd7c-160ac5ec1767", 
        "alias" : "Coordinator0001", 
        "endpoint" : "tcp://localhost:8539", 
        "role" : "COORDINATOR", 
        "maintenance" : false, 
        "readOnly" : false, 
        "version" : "3.11.14", 
        "build" : "refs/3.11.14 46e2b3087", 
        "license" : "enterprise", 
        "os" : "Linux version 6.8.0-1019-aws (buildd@lcy02-amd64-058) (x86_64-linux-gnu-gcc-12 (Ubuntu 12.3.0-1ubuntu1~22.04) 12.3.0, GNU ld (GNU Binutils for Ubuntu) 2.38) #21~22.04.1-Ubuntu SMP Thu Nov  7 17:33:30 UTC 2024", 
        "platform" : "linux", 
        "physicalMemory" : { 
          "value" : 33089753088, 
          "overridden" : false 
        }, 
        "numberOfCores" : { 
          "value" : 8, 
          "overridden" : false 
        }, 
        "processStats" : { 
          "processUptime" : 45.4971649646759, 
          "numberOfThreads" : 39, 
          "virtualSize" : 732581888, 
          "residentSetSize" : 110039040 
        }, 
        "cpuStats" : { 
          "userPercent" : 5.683576081661929, 
          "systemPercent" : 2.4740524250745373, 
          "idlePercent" : 90.21031051445517, 
          "iowaitPercent" : 1.4597016363431985 
        } 
      }, 
      "CRDN-a82d3b6c-7f7e-444f-991c-924847ec211d" : { 
        "id" : "CRDN-a82d3b6c-7f7e-444f-991c-924847ec211d", 
        "alias" : "Coordinator0002", 
        "endpoint" : "tcp://localhost:8549", 
        "role" : "COORDINATOR", 
        "maintenance" : false, 
        "readOnly" : false, 
        "version" : "3.11.14", 
        "build" : "refs/3.11.14 46e2b3087", 
        "license" : "enterprise", 
        "os" : "Linux version 6.8.0-1019-aws (buildd@lcy02-amd64-058) (x86_64-linux-gnu-gcc-12 (Ubuntu 12.3.0-1ubuntu1~22.04) 12.3.0, GNU ld (GNU Binutils for Ubuntu) 2.38) #21~22.04.1-Ubuntu SMP Thu Nov  7 17:33:30 UTC 2024", 
        "platform" : "linux", 
        "physicalMemory" : { 
          "value" : 33089753088, 
          "overridden" : false 
        }, 
        "numberOfCores" : { 
          "value" : 8, 
          "overridden" : false 
        }, 
        "processStats" : { 
          "processUptime" : 46.4935359954834, 
          "numberOfThreads" : 39, 
          "virtualSize" : 734941184, 
          "residentSetSize" : 110903296 
        }, 
        "cpuStats" : { 
          "userPercent" : 5.683576081661929, 
          "systemPercent" : 2.4740524250745373, 
          "idlePercent" : 90.21031051445517, 
          "iowaitPercent" : 1.4597016363431985 
        } 
      }, 
      "PRMR-21cb1072-7e9e-49b2-a09a-0939cdc68525" : { 
        "id" : "PRMR-21cb1072-7e9e-49b2-a09a-0939cdc68525", 
        "alias" : "DBServer0002", 
        "endpoint" : "tcp://localhost:8550", 
        "role" : "PRIMARY", 
        "maintenance" : false, 
        "readOnly" : false, 
        "version" : "3.11.14", 
        "build" : "refs/3.11.14 46e2b3087", 
        "license" : "enterprise", 
        "os" : "Linux version 6.8.0-1019-aws (buildd@lcy02-amd64-058) (x86_64-linux-gnu-gcc-12 (Ubuntu 12.3.0-1ubuntu1~22.04) 12.3.0, GNU ld (GNU Binutils for Ubuntu) 2.38) #21~22.04.1-Ubuntu SMP Thu Nov  7 17:33:30 UTC 2024", 
        "platform" : "linux", 
        "physicalMemory" : { 
          "value" : 33089753088, 
          "overridden" : false 
        }, 
        "numberOfCores" : { 
          "value" : 8, 
          "overridden" : false 
        }, 
        "processStats" : { 
          "processUptime" : 47.49887037277222, 
          "numberOfThreads" : 68, 
          "virtualSize" : 970878976, 
          "residentSetSize" : 171732992 
        }, 
        "cpuStats" : { 
          "userPercent" : 5.683576081661929, 
          "systemPercent" : 2.4740524250745373, 
          "idlePercent" : 90.21031051445517, 
          "iowaitPercent" : 1.4597016363431985 
        }, 
        "engineStats" : { 
          "cache.limit" : 7735567360, 
          "cache.allocated" : 1082848, 
          "rocksdb.estimate-num-keys" : 199, 
          "rocksdb.estimate-live-data-size" : 0, 
          "rocksdb.live-sst-files-size" : 0, 
          "rocksdb.block-cache-capacity" : 9282680832, 
          "rocksdb.block-cache-usage" : 96, 
          "rocksdb.free-disk-space" : 141042524160, 
          "rocksdb.total-disk-space" : 155897610240 
        } 
      }, 
      "PRMR-23a9538c-b4d7-4f6c-9a41-0fcb3f0776fd" : { 
        "id" : "PRMR-23a9538c-b4d7-4f6c-9a41-0fcb3f0776fd", 
        "alias" : "DBServer0003", 
        "endpoint" : "tcp://localhost:8530", 
        "role" : "PRIMARY", 
        "maintenance" : false, 
        "readOnly" : false, 
        "version" : "3.11.14", 
        "build" : "refs/3.11.14 46e2b3087", 
        "license" : "enterprise", 
        "os" : "Linux version 6.8.0-1019-aws (buildd@lcy02-amd64-058) (x86_64-linux-gnu-gcc-12 (Ubuntu 12.3.0-1ubuntu1~22.04) 12.3.0, GNU ld (GNU Binutils for Ubuntu) 2.38) #21~22.04.1-Ubuntu SMP Thu Nov  7 17:33:30 UTC 2024", 
        "platform" : "linux", 
        "physicalMemory" : { 
          "value" : 33089753088, 
          "overridden" : false 
        }, 
        "numberOfCores" : { 
          "value" : 8, 
          "overridden" : false 
        }, 
        "processStats" : { 
          "processUptime" : 46.51739144325256, 
          "numberOfThreads" : 68, 
          "virtualSize" : 958296064, 
          "residentSetSize" : 168275968 
        }, 
        "cpuStats" : { 
          "userPercent" : 5.683576081661929, 
          "systemPercent" : 2.4740524250745373, 
          "idlePercent" : 90.21031051445517, 
          "iowaitPercent" : 1.4597016363431985 
        }, 
        "engineStats" : { 
          "cache.limit" : 7735567360, 
          "cache.allocated" : 1082848, 
          "rocksdb.estimate-num-keys" : 12, 
          "rocksdb.estimate-live-data-size" : 0, 
          "rocksdb.live-sst-files-size" : 0, 
          "rocksdb.block-cache-capacity" : 9282680832, 
          "rocksdb.block-cache-usage" : 96, 
          "rocksdb.free-disk-space" : 141042524160, 
          "rocksdb.total-disk-space" : 155897610240 
        } 
      } 
    }, 
    "agents" : 3, 
    "coordinators" : 3, 
    "dbServers" : 3, 
    "shards" : { 
      "databases" : 1, 
      "collections" : 17, 
      "shards" : 30, 
      "leaders" : 17, 
      "realLeaders" : 5, 
      "followers" : 13, 
      "servers" : 3 
    } 
  }, 
  "date" : "2025-05-23T18:15:29Z" 
}

Server mode

Return whether or not a server is in read-only mode

GET http://<EXTERNAL_ENDPOINT>:8529/_db/:database-name/_admin/server/mode

Return mode information about a server. The json response will contain a field mode with the value readonly or default. In a read-only server all write operations will fail with an error code of 1004 (ERROR_READ_ONLY). Creating or dropping of databases and collections will also fail with error code 11 (ERROR_FORBIDDEN).

This API requires authentication.

Path Parameters

database-name string
The name of a database. Which database you use doesn’t matter as long as the user account you authenticate with has at least read access to this database.
Example: _system

Query Parameters

HTTP Headers

Responses

200 OK
This API will return HTTP 200 if everything is ok

Set the server mode to read-only or default

PUT http://<EXTERNAL_ENDPOINT>:8529/_db/:database-name/_admin/server/mode

Update mode information about a server. The JSON response will contain a field mode with the value readonly or default. In a read-only server all write operations will fail with an error code of 1004 (ERROR_READ_ONLY). Creating or dropping of databases and collections will also fail with error code 11 (ERROR_FORBIDDEN).

This is a protected API. It requires authentication and administrative server rights.

Path Parameters

database-name string
The name of a database. Which database you use doesn’t matter as long as the user account you authenticate with has at least read access to this database and administrate access to the _system database.
Example: _system

Query Parameters

HTTP Headers

Request Body application/json object

mode string, required
The mode of the server readonly or default.

Responses

200 OK
This API will return HTTP 200 if everything is ok
401 Unauthorized
if the request was not authenticated as a user with sufficient rights

License

The endpoints for license management allow you to view the current license status and update the license of your ArangoDB Enterprise Edition deployment.

Get information about the current license

GET http://<EXTERNAL_ENDPOINT>:8529/_db/:database-name/_admin/license

View the license information and status of an Enterprise Edition instance. Can be called on single servers, Coordinators, and DB-Servers.

Path Parameters

database-name string
The name of a database. Which database you use doesn’t matter as long as the user account you authenticate with has at least read access to this database. If the --server.harden startup option is enabled, administrate access to the _system database is required.
Example: _system

Query Parameters

HTTP Headers

Responses

200 OK
Returns the license information.
- features object, optional
  The properties of the license.
  expires number
  The expires key lists the expiry date as Unix timestamp (seconds since January 1st, 1970 UTC).
  Example: 1683173040
- hash string, optional
  The hash value of the license.
  Example: "982db5...44f3"
- license string
  The encrypted license key in Base64 encoding, or "none" in the Community Edition.
  Example: "V0h/W...wEDw=="
- status string, optional
  Possible values: "good", "expiring", "read-only"
  The status attribute allows you to confirm the state of the applied license at a glance.
  good: The license is still valid for more than a week.
  expiring: The license is valid for less than a week.
  read-only: The license has expired. The instance is now restricted to read-only mode.
  Example: "good"
- upgrading boolean, optional
  Whether the server is performing a database upgrade.
  Example: false
- version number, optional
  The license version number.
  Example: 1

Examples

curl --header 'accept: application/json' --dump - 'http://localhost:8529/_admin/license'

Show output

HTTP/1.1 200 OK
content-type: application/json
cache-control: no-cache, no-store, must-revalidate, pre-check=0, post-check=0, max-age=0, s-maxage=0
connection: Keep-Alive
content-length: 162
content-security-policy: frame-ancestors 'self'; form-action 'self';
expires: 0
pragma: no-cache
server: ArangoDB
strict-transport-security: max-age=31536000 ; includeSubDomains
x-arango-queue-time-seconds: 0.000000
x-content-type-options: nosniff

{ 
  "upgrading" : false, 
  "features" : { 
    "expires" : 1748034885 
  }, 
  "license" : "JD4EOXdkc1ZVOnlUBVR8UwNBZ1gHfSddW11kGWQMXE52GWAHeHEpCHwFIH8ydQlf", 
  "version" : 1, 
  "status" : "expiring" 
}

Set a new license

PUT http://<EXTERNAL_ENDPOINT>:8529/_db/:database-name/_admin/license

Set a new license for an Enterprise Edition instance. Can be called on single servers, Coordinators, and DB-Servers.

Path Parameters

database-name string
The name of a database. Which database you use doesn’t matter as long as the user account you authenticate with has at least read access to this database. If the --server.harden startup option is enabled, administrate access to the _system database is required.
Example: _system

Query Parameters

force boolean (default: false)
Whether to change the license even if it expires sooner than the current one.

HTTP Headers

Request Body application/json string

Example: "eyJncmFudCI6...(Base64-encoded license string)..."

Responses

201 Created
License successfully deployed.
- result object
  code integer
  The HTTP response status code.
  Example: 201
  error boolean
  A flag indicating that no error occurred.
  Example: false
400 Bad Request
If the license expires earlier than the previously installed one, or if the supplied license string is invalid.
- code integer
  The HTTP response status code.
  Example: 400
- error boolean
  A flag indicating that an error occurred.
  Example: true
- errorMessage string
  A descriptive error message.
- errorNum integer
  The ArangoDB error number for the error that occurred.
501 Not Implemented
If you try to apply a license in the Community Edition.
- code integer
  The HTTP response status code.
  Example: 501
- error boolean
  A flag indicating that an error occurred.
  Example: true
- errorMessage string
  A descriptive error message.
- errorNum integer
  The ArangoDB error number for the error that occurred.

Examples

curl --header 'accept: application/json' --dump - --data '"eyJncmFudCI6...(Base64-encoded license string)..."' -X PUT http://localhost:8529/_admin/license

Show output

HTTP/1.1 201 Created
content-type: application/json
cache-control: no-cache, no-store, must-revalidate, pre-check=0, post-check=0, max-age=0, s-maxage=0
connection: Keep-Alive
content-length: 37
content-security-policy: frame-ancestors 'self'; form-action 'self';
expires: 0
pragma: no-cache
server: ArangoDB
strict-transport-security: max-age=31536000 ; includeSubDomains
x-arango-queue-time-seconds: 0.000000
x-content-type-options: nosniff

{
  "result": {
    "error": false,
    "code": 201
  }
}

Shutdown

Start the shutdown sequence

DELETE http://<EXTERNAL_ENDPOINT>:8529/_db/:database-name/_admin/shutdown

This call initiates a clean shutdown sequence. Requires administrative privileges.

Path Parameters

database-name string
The name of a database. Which database you use doesn’t matter as long as the user account you authenticate with has at least read access to this database and administrate access to the _system database.
Example: _system

Query Parameters

soft boolean (default: false)
If set to true, this initiates a soft shutdown. This is only available on Coordinators. When issued, the Coordinator tracks a number of ongoing operations, waits until all have finished, and then shuts itself down normally. It will still accept new operations.
This feature can be used to make restart operations of Coordinators less intrusive for clients. It is designed for setups with a load balancer in front of Coordinators. Remove the designated Coordinator from the load balancer before issuing the soft-shutdown. The remaining Coordinators will internally forward requests that need to be handled by the designated Coordinator. All other requests will be handled by the remaining Coordinators, reducing the designated Coordinator’s load.
The following types of operations are tracked:
- AQL cursors (in particular streaming cursors)
- Transactions (in particular stream transactions)
- Pregel runs (conducted by this Coordinator)
- Ongoing asynchronous requests (using the x-arango-async: store HTTP header)
- Finished asynchronous requests, whose result has not yet been collected
- Queued low priority requests (most normal requests)
- Ongoing low priority requests

HTTP Headers

Responses

200 OK
is returned in all cases, OK will be returned in the result buffer on success.

Query the soft shutdown progress

GET http://<EXTERNAL_ENDPOINT>:8529/_db/:database-name/_admin/shutdown

This call reports progress about a soft Coordinator shutdown (see documentation of DELETE /_admin/shutdown?soft=true). In this case, the following types of operations are tracked:

AQL cursors (in particular streaming cursors)
Transactions (in particular stream transactions)
Pregel runs (conducted by this Coordinator)
Ongoing asynchronous requests (using the x-arango-async: store HTTP header)
Finished asynchronous requests, whose result has not yet been collected
Queued low priority requests (most normal requests)
Ongoing low priority requests

This API is only available on Coordinators.

Path Parameters

database-name string
The name of a database. Which database you use doesn’t matter as long as the user account you authenticate with has at least read access to this database and administrate access to the _system database.
Example: _system

Query Parameters

HTTP Headers

Responses

200 OK
The response indicates the fact that a soft shutdown is ongoing and the number of active operations of the various types. Once all numbers have gone to 0, the flag allClear is set and the Coordinator shuts down automatically.
- AQLcursors number
  Number of AQL cursors that are still active.
- allClear boolean
  Whether all active operations finished.
- doneJobs number
  Number of finished asynchronous requests, whose result has not yet been collected.
- lowPrioOngoingRequests number
  Number of queued low priority requests.
- lowPrioQueuedRequests number
  Number of ongoing low priority requests.
- pendingJobs number
  Number of ongoing asynchronous requests.
- pregelConductors number
  Number of ongoing Pregel jobs.
- softShutdownOngoing boolean
  Whether a soft shutdown of the Coordinator is in progress.
- transactions number
  Number of ongoing transactions.

Miscellaneous actions

Compact all databases

PUT http://<EXTERNAL_ENDPOINT>:8529/_admin/compact

This command can cause a full rewrite of all data in all databases, which may take very long for large databases. It should thus only be used with care and only when additional I/O load can be tolerated for a prolonged time.

This endpoint can be used to reclaim disk space after substantial data deletions have taken place, by compacting the entire database system data.

The endpoint requires superuser access.

Request Body application/json object

changeLevel boolean (default: false)
whether or not compacted data should be moved to the minimum possible level.
compactBottomMostLevel boolean (default: false)
Whether or not to compact the bottommost level of data.

Responses

200 OK
Compaction started successfully
401 Unauthorized
if the request was not authenticated as a user with sufficient rights

Examples

curl -X PUT --header 'accept: application/json' --dump - 'http://localhost:8529/_admin/compact'

Show output

HTTP/1.1 200 OK
content-type: application/json
cache-control: no-cache, no-store, must-revalidate, pre-check=0, post-check=0, max-age=0, s-maxage=0
connection: Keep-Alive
content-length: 2
content-security-policy: frame-ancestors 'self'; form-action 'self';
expires: 0
pragma: no-cache
server: ArangoDB
strict-transport-security: max-age=31536000 ; includeSubDomains
x-arango-queue-time-seconds: 0.000000
x-content-type-options: nosniff

{ 
}

Reload the routing table

POST http://<EXTERNAL_ENDPOINT>:8529/_db/:database-name/_admin/routing/reload

Reloads the routing information from the _routing system collection if it exists, and makes Foxx rebuild its local routing table on the next request.

Path Parameters

database-name string
The name of a database. Which database you use doesn’t matter as long as the user account you authenticate with has at least read access to this database.
Example: _system

Query Parameters

HTTP Headers

Responses

200 OK
The routing information has been reloaded successfully.

Echo a request

POST http://<EXTERNAL_ENDPOINT>:8529/_db/:database-name/_admin/echo

The call returns an object with the servers request information

Path Parameters

database-name string
The name of a database. Which database you use doesn’t matter as long as the user account you authenticate with has at least read access to this database.
Example: _system

Query Parameters

HTTP Headers

Request Body application/octet-stream

The request body can be of any type and is simply forwarded.

Responses

200 OK
Echo was returned successfully.
- authorized boolean
  Whether the session is authorized
- client object
  Attributes of the client connection
  address integer
  The IP address of the client
  id string
  A server generated ID
  port integer
  The port of the TCP connection on the client-side
- cookies object
  A list of the cookies you sent
- database string
  The name of the database this request was executed on
- headers object
  The list of the HTTP headers you sent
- internals object
  Contents of the server internals struct
- isAdminUser boolean
  Whether the current user is an administrator
- parameters object
  An object containing the query parameters
- path string
  The relative path of this request (decoded, excluding /_admin/echo)
- portType string
  The type of the socket, one of "tcp/ip", "unix", "unknown"
- prefix object
  The prefix of the database
- protocol string
  The transport protocol, one of "http", "https", "velocystream"
- rawRequestBody object
  The sent payload as a JSON-encoded Buffer object
- rawSuffix array of strings
  A list of the percent-encoded URL path suffixes
- requestBody string
  Stringified version of the request body you sent
- requestType string
  The HTTP method that was used for the request ("POST"). The endpoint can be queried using other verbs, too ("GET", "PUT", "PATCH", "DELETE").
- server object
  Attributes of the server connection
  address string
  The bind address of the endpoint this request was sent to
  endpoint string
  The endpoint this request was sent to
  port integer
  The port this request was sent to
- suffix array of strings
  A list of the decoded URL path suffixes. You can query the endpoint with arbitrary suffixes, e.g. /_admin/echo/foo/123
- url string
  The raw request URL
- user string
  The name of the current user that sent this request

Execute a script

POST http://<EXTERNAL_ENDPOINT>:8529/_db/:database-name/_admin/execute

Executes the JavaScript code in the body on the server as the body of a function with no arguments. If you have a return statement then the return value you produce will be returned as content type application/json. If the parameter returnAsJSON is set to true, the result will be a JSON object describing the return value directly, otherwise a string produced by JSON.stringify will be returned.

Note that this API endpoint is available if the server has been started with the --javascript.allow-admin-execute startup options enabled.

The default value of this option is false, which disables the execution of user-defined code and disables this API endpoint entirely. This is also the recommended setting for production.

Path Parameters

database-name string
The name of the database.
Example: _system

Query Parameters

HTTP Headers

Request Body text/javascript

The request body is the JavaScript code to be executed.

Responses

200 OK
is returned when everything went well, or if a timeout occurred. In the latter case a body of type application/json indicating the timeout is returned. depending on returnAsJSON this is a json object or a plain string.
403 Forbidden
is returned if ArangoDB is not running in cluster mode.
404 Not Found
is returned if ArangoDB was not compiled for cluster operation.

Endpoints

The /_api/endpoint endpoint is deprecated. For cluster deployments, you can use /_api/cluster/endpoints instead to find all current Coordinator endpoints. See Cluster.

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

The endpoints are normally specified either in the arangod configuration file or on the command-line, using the --server.endpoint startup option. The default endpoint for ArangoDB is tcp://127.0.0.1:8529 (IPv4 localhost on port 8529 over the HTTP protocol).

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

List the endpoints of a single server (deprecated)

GET http://<EXTERNAL_ENDPOINT>:8529/_db/_system/_api/endpoint

This endpoint 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.

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.

Responses

200 OK
is returned when the array of endpoints can be determined successfully.
400 Bad Request
is returned if the action is not carried out in the system database.
405 Method Not Allowed
The server will respond with HTTP 405 if an unsupported HTTP method is used.

Examples

curl --header 'accept: application/json' --dump - 'http://localhost:8529/_db/_system/_api/endpoint'

Show output

HTTP/1.1 200 OK
content-type: application/json
cache-control: no-cache, no-store, must-revalidate, pre-check=0, post-check=0, max-age=0, s-maxage=0
connection: Keep-Alive
content-length: 36
content-security-policy: frame-ancestors 'self'; form-action 'self';
expires: 0
pragma: no-cache
server: ArangoDB
strict-transport-security: max-age=31536000 ; includeSubDomains
x-arango-queue-time-seconds: 0.000000
x-content-type-options: nosniff

[ 
  { 
    "endpoint" : "http://0.0.0.0:8529" 
  } 
]