{
"basePath": "/",
"swaggerVersion": "1.1",
"apiVersion": "0.1",
"apis": [
{
"operations": [
{
"errorResponses": [
{
"reason": "Routing information was reloaded successfully. ",
"code": "200"
}
],
"parameters": [],
"notes": "
Reloads the routing information from the collection routing.
",
"summary": "reloads the routing collection",
"httpMethod": "POST",
"examples": "",
"nickname": "reloadsTheRoutingCollection"
}
],
"path": "/_admin/routing/reload"
},
{
"operations": [
{
"errorResponses": [
{
"reason": "Module cache was flushed successfully. ",
"code": "200"
}
],
"parameters": [],
"notes": "
The call flushes the modules cache on the server. See JSModulesCache for details about this cache.
",
"summary": "flushs the module cache",
"httpMethod": "POST",
"examples": "",
"nickname": "flushsTheModuleCache"
}
],
"path": "/_admin/modules/flush"
},
{
"operations": [
{
"errorResponses": [
{
"reason": "Time was returned successfully. ",
"code": "200"
}
],
"parameters": [],
"notes": "
The call returns an object with the attribute time. This contains the current system time as a Unix timestamp with microsecond precision.
",
"summary": "returns the system time",
"httpMethod": "GET",
"examples": "",
"nickname": "returnsTheSystemTime"
}
],
"path": "/_admin/time"
},
{
"operations": [
{
"errorResponses": [
{
"reason": "Echo was returned successfully. ",
"code": "200"
}
],
"parameters": [],
"notes": "
The call returns an object with the following attributes:
- headers: a list of HTTP headers received
- requestType: the HTTP request method (e.g. GET)
- parameters: list of URL parameters received
",
"summary": "returns the current request",
"httpMethod": "GET",
"examples": "",
"nickname": "returnsTheCurrentRequest"
}
],
"path": "/_admin/echo"
},
{
"operations": [
{
"errorResponses": [
{
"reason": "Statistics were returned successfully. ",
"code": "200"
}
],
"parameters": [],
"notes": "
Returns the statistics information. The returned object contains the statistics figures grouped together according to the description returned by _admin/statistics-description. For instance, to access a figure userTime from the group system, you first select the sub-object describing the group stored in system and in that sub-object the value for userTime is stored in the attribute of the same name.
In case of a distribution, the returned object contains the total count in count and the distribution list in counts. The sum (or total) of the individual values is returned in sum.
",
"summary": "reads the statistics",
"httpMethod": "GET",
"examples": "
unix> curl --dump - http://localhost:8529/_admin/statistics\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n \"system\" : { \n \"minorPageFaults\" : 151186, \n \"majorPageFaults\" : 1916, \n \"userTime\" : 12.340944, \n \"systemTime\" : 1.824307, \n \"numberOfThreads\" : 16, \n \"residentSize\" : 58097664, \n \"virtualSize\" : 4995203072 \n }, \n \"client\" : { \n \"httpConnections\" : 1, \n \"connectionTime\" : { \n \"sum\" : 0.00037288665771484375, \n \"count\" : 1, \n \"counts\" : [ \n 1, \n 0, \n 0, \n 0 \n ] \n }, \n \"totalTime\" : { \n \"sum\" : 24.456818103790283, \n \"count\" : 850, \n \"counts\" : [ \n 521, \n 211, \n 44, \n 58, \n 13, \n 1, \n 2 \n ] \n }, \n \"requestTime\" : { \n \"sum\" : 24.292680501937866, \n \"count\" : 850, \n \"counts\" : [ \n 524, \n 208, \n 44, \n 58, \n 13, \n 1, \n 2 \n ] \n }, \n \"queueTime\" : { \n \"sum\" : 0.01846766471862793, \n \"count\" : 848, \n \"counts\" : [ \n 848, \n 0, \n 0, \n 0, \n 0, \n 0, \n 0 \n ] \n }, \n \"bytesSent\" : { \n \"sum\" : 381724, \n \"count\" : 850, \n \"counts\" : [ \n 234, \n 501, \n 115, \n 0, \n 0, \n 0 \n ] \n }, \n \"bytesReceived\" : { \n \"sum\" : 197140, \n \"count\" : 850, \n \"counts\" : [ \n 625, \n 225, \n 0, \n 0, \n 0, \n 0 \n ] \n } \n }, \n \"http\" : { \n \"requestsTotal\" : 850, \n \"requestsAsync\" : 0, \n \"requestsGet\" : 225, \n \"requestsHead\" : 0, \n \"requestsPost\" : 446, \n \"requestsPut\" : 34, \n \"requestsPatch\" : 3, \n \"requestsDelete\" : 142, \n \"requestsOptions\" : 0, \n \"requestsOther\" : 0 \n }, \n \"server\" : { \n \"uptime\" : 29.041420936584473 \n }, \n \"error\" : false, \n \"code\" : 200 \n}\n\n
unix> curl --dump - http://localhost:8529/_admin/statistics-description\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n \"groups\" : [ \n { \n \"group\" : \"system\", \n \"name\" : \"Process Statistics\", \n \"description\" : \"Statistics about the ArangoDB process\" \n }, \n { \n \"group\" : \"client\", \n \"name\" : \"Client Connection Statistics\", \n \"description\" : \"Statistics about the connections.\" \n }, \n { \n \"group\" : \"http\", \n \"name\" : \"HTTP Request Statistics\", \n \"description\" : \"Statistics about the HTTP requests.\" \n }, \n { \n \"group\" : \"server\", \n \"name\" : \"Server Statistics\", \n \"description\" : \"Statistics about the ArangoDB server\" \n } \n ], \n \"figures\" : [ \n { \n \"group\" : \"system\", \n \"identifier\" : \"userTime\", \n \"name\" : \"User Time\", \n \"description\" : \"Amount of time that this process has been scheduled in user mode, measured in cl...\", \n \"type\" : \"accumulated\", \n \"units\" : \"seconds\" \n }, \n { \n \"group\" : \"system\", \n \"identifier\" : \"systemTime\", \n \"name\" : \"System Time\", \n \"description\" : \"Amount of time that this process has been scheduled in kernel mode, measured in ...\", \n \"type\" : \"accumulated\", \n \"units\" : \"seconds\" \n }, \n { \n \"group\" : \"system\", \n \"identifier\" : \"numberOfThreads\", \n \"name\" : \"Number of Threads\", \n \"description\" : \"Number of threads in this process.\", \n \"type\" : \"current\", \n \"units\" : \"number\" \n }, \n { \n \"group\" : \"system\", \n \"identifier\" : \"residentSize\", \n \"name\" : \"Resident Set Size\", \n \"description\" : \"The total size of the number of pages the process has in real memory. This is ju...\", \n \"type\" : \"current\", \n \"units\" : \"bytes\" \n }, \n { \n \"group\" : \"system\", \n \"identifier\" : \"virtualSize\", \n \"name\" : \"Virtual Memory Size\", \n \"description\" : \"The size of the virtual memory the process is using.\", \n \"type\" : \"current\", \n \"units\" : \"bytes\" \n }, \n { \n \"group\" : \"system\", \n \"identifier\" : \"minorPageFaults\", \n \"name\" : \"Minor Page Faults\", \n \"description\" : \"The number of minor faults the process has made which have not required loading ...\", \n \"type\" : \"accumulated\", \n \"units\" : \"number\" \n }, \n { \n \"group\" : \"system\", \n \"identifier\" : \"majorPageFaults\", \n \"name\" : \"Major Page Faults\", \n \"description\" : \"The number of major faults the process has made which have required loading a me...\", \n \"type\" : \"accumulated\", \n \"units\" : \"number\" \n }, \n { \n \"group\" : \"client\", \n \"identifier\" : \"httpConnections\", \n \"name\" : \"Client Connections\", \n \"description\" : \"The number of connections that are currently open.\", \n \"type\" : \"current\", \n \"units\" : \"number\" \n }, \n { \n \"group\" : \"client\", \n \"identifier\" : \"totalTime\", \n \"name\" : \"Total Time\", \n \"description\" : \"Total time needed to answer a request.\", \n \"type\" : \"distribution\", \n \"cuts\" : [ \n 0.01, \n 0.05, \n 0.1, \n 0.2, \n 0.5, \n 1 \n ], \n \"units\" : \"seconds\" \n }, \n { \n \"group\" : \"client\", \n \"identifier\" : \"requestTime\", \n \"name\" : \"Request Time\", \n \"description\" : \"Request time needed to answer a request.\", \n \"type\" : \"distribution\", \n \"cuts\" : [ \n 0.01, \n 0.05, \n 0.1, \n 0.2, \n 0.5, \n 1 \n ], \n \"units\" : \"seconds\" \n }, \n { \n \"group\" : \"client\", \n \"identifier\" : \"queueTime\", \n \"name\" : \"Queue Time\", \n \"description\" : \"Queue time needed to answer a request.\", \n \"type\" : \"distribution\", \n \"cuts\" : [ \n 0.01, \n 0.05, \n 0.1, \n 0.2, \n 0.5, \n 1 \n ], \n \"units\" : \"seconds\" \n }, \n { \n \"group\" : \"client\", \n \"identifier\" : \"bytesSent\", \n \"name\" : \"Bytes Sent\", \n \"description\" : \"Bytes sents for a request.\", \n \"type\" : \"distribution\", \n \"cuts\" : [ \n 250, \n 1000, \n 2000, \n 5000, \n 10000 \n ], \n \"units\" : \"bytes\" \n }, \n { \n \"group\" : \"client\", \n \"identifier\" : \"bytesReceived\", \n \"name\" : \"Bytes Received\", \n \"description\" : \"Bytes receiveds for a request.\", \n \"type\" : \"distribution\", \n \"cuts\" : [ \n 250, \n 1000, \n 2000, \n 5000, \n 10000 \n ], \n \"units\" : \"bytes\" \n }, \n { \n \"group\" : \"client\", \n \"identifier\" : \"connectionTime\", \n \"name\" : \"Connection Time\", \n \"description\" : \"Total connection time of a client.\", \n \"type\" : \"distribution\", \n \"cuts\" : [ \n 0.1, \n 1, \n 60 \n ], \n \"units\" : \"seconds\" \n }, \n { \n \"group\" : \"http\", \n \"identifier\" : \"requestsTotal\", \n \"name\" : \"Total requests\", \n \"description\" : \"Total number of HTTP requests.\", \n \"type\" : \"accumulated\", \n \"units\" : \"number\" \n }, \n { \n \"group\" : \"http\", \n \"identifier\" : \"requestsAsync\", \n \"name\" : \"Async requests\", \n \"description\" : \"Number of asynchronously executed HTTP requests.\", \n \"type\" : \"accumulated\", \n \"units\" : \"number\" \n }, \n { \n \"group\" : \"http\", \n \"identifier\" : \"requestsGet\", \n \"name\" : \"HTTP GET requests\", \n \"description\" : \"Number of HTTP GET requests.\", \n \"type\" : \"accumulated\", \n \"units\" : \"number\" \n }, \n { \n \"group\" : \"http\", \n \"identifier\" : \"requestsHead\", \n \"name\" : \"HTTP HEAD requests\", \n \"description\" : \"Number of HTTP HEAD requests.\", \n \"type\" : \"accumulated\", \n \"units\" : \"number\" \n }, \n { \n \"group\" : \"http\", \n \"identifier\" : \"requestsPost\", \n \"name\" : \"HTTP POST requests\", \n \"description\" : \"Number of HTTP POST requests.\", \n \"type\" : \"accumulated\", \n \"units\" : \"number\" \n }, \n { \n \"group\" : \"http\", \n \"identifier\" : \"requestsPut\", \n \"name\" : \"HTTP PUT requests\", \n \"description\" : \"Number of HTTP PUT requests.\", \n \"type\" : \"accumulated\", \n \"units\" : \"number\" \n }, \n { \n \"group\" : \"http\", \n \"identifier\" : \"requestsPatch\", \n \"name\" : \"HTTP PATCH requests\", \n \"description\" : \"Number of HTTP PATCH requests.\", \n \"type\" : \"accumulated\", \n \"units\" : \"number\" \n }, \n { \n \"group\" : \"http\", \n \"identifier\" : \"requestsDelete\", \n \"name\" : \"HTTP DELETE requests\", \n \"description\" : \"Number of HTTP DELETE requests.\", \n \"type\" : \"accumulated\", \n \"units\" : \"number\" \n }, \n { \n \"group\" : \"http\", \n \"identifier\" : \"requestsOptions\", \n \"name\" : \"HTTP OPTIONS requests\", \n \"description\" : \"Number of HTTP OPTIONS requests.\", \n \"type\" : \"accumulated\", \n \"units\" : \"number\" \n }, \n { \n \"group\" : \"server\", \n \"identifier\" : \"uptime\", \n \"name\" : \"Server Uptime\", \n \"description\" : \"Number of seconds elapsed since server start.\", \n \"type\" : \"current\", \n \"units\" : \"seconds\" \n } \n ], \n \"error\" : false, \n \"code\" : 200 \n}\n\n