{
"basePath": "/",
"swaggerVersion": "1.1",
"apiVersion": "0.1",
"apis": [
{
"operations": [
{
"errorResponses": [],
"parameters": [
{
"dataType": "Json",
"paramType": "body",
"required": "true",
"name": "body",
"description": "the body with name, options of a collection. "
}
],
"notes": "Creates an new collection with a given name. The request must contain an object with the following attributes.
- name: The name of the collection.
- waitForSync (optional, default: false): If true then the data is synchronised to disk before returning from a create or update of a document.
- journalSize (optional, default is a @ref CommandLineArangod \"configuration parameter\"): The maximal size of a journal or datafile. Note that this also limits the maximal size of a single object. Must be at least 1MB.
- isSystem (optional, default is false): If true, create a system collection. In this case collection-name should start with an underscore. End users should normally create non-system collections only. API implementors may be required to create system collections in very special occasions, but normally a regular collection will do.
- isVolatile (optional, default is false): If true then the collection data is kept in-memory only and not made persistent. Unloading the collection will cause the collection data to be discarded. Stopping or re-starting the server will also cause full loss of data in the collection. Setting this option will make the resulting collection be slightly faster than regular collections because ArangoDB does not enforce any synchronisation to disk and does not calculate any CRC checksums for datafiles (as there are no datafiles).
This option should threrefore be used for cache-type collections only, and not for data that cannot be re-created otherwise.
- keyOptions (optional) additional options for key generation. If specified, then keyOptions should be a JSON array containing the following attributes (note: some of them are optional): - type: specifies the type of the key generator. The currently available generators are traditional and autoincrement. - allowUserKeys: if set to true, then it is allowed to supply own key values in the _key attribute of a document. If set to false, then the key generator will solely be responsible for generating keys and supplying own key values in the _key attribute of documents is considered an error. - increment: increment value for autoincrement key generator. Not used for other key generator types. - offset: initial offset value for autoincrement key generator. Not used for other key generator types.
- type (optional, default is 2): the type of the collection to create. The following values for type are valid: - 2: document collection - 3: edges collection
",
"summary": "creates a collection",
"httpMethod": "POST",
"examples": "
unix> curl -X POST --data @- --dump - http://localhost:8529/_api/collection\n{ \"name\": \"testCollectionBasics\" }\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nlocation: /_api/collection/testCollectionBasics\n\n{ \n \"id\" : \"78916828\", \n \"name\" : \"testCollectionBasics\", \n \"waitForSync\" : false, \n \"isVolatile\" : false, \n \"isSystem\" : false, \n \"status\" : 3, \n \"type\" : 2, \n \"error\" : false, \n \"code\" : 200 \n}\n\nunix> curl -X POST --data @- --dump - http://localhost:8529/_api/collection\n{ \"name\": \"testCollectionEdges\", \"type\" : 3 }\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nlocation: /_api/collection/testCollectionEdges\n\n{ \n \"id\" : \"79703260\", \n \"name\" : \"testCollectionEdges\", \n \"waitForSync\" : false, \n \"isVolatile\" : false, \n \"isSystem\" : false, \n \"status\" : 3, \n \"type\" : 3, \n \"error\" : false, \n \"code\" : 200 \n}\n\n
unix> curl -X POST --data @- --dump - http://localhost:8529/_api/collection\n{ \"name\": \"testCollectionUsers\", \"keyOptions\" : { \"type\" : \"autoincrement\", \"increment\" : 5, \"allowUserKeys\" : true }}\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nlocation: /_api/collection/testCollectionUsers\n\n{ \n \"id\" : \"47525084\", \n \"name\" : \"testCollectionUsers\", \n \"waitForSync\" : false, \n \"isVolatile\" : false, \n \"isSystem\" : false, \n \"status\" : 3, \n \"type\" : 2, \n \"error\" : false, \n \"code\" : 200 \n}\n\n
",
"nickname": "createsACollection"
}
],
"path": "/_api/collection"
},
{
"operations": [
{
"errorResponses": [],
"parameters": [
{
"dataType": "Boolean",
"paramType": "path",
"required": "false",
"name": "excludeSystem",
"description": ""
}
],
"notes": "Returns an object with an attribute collections containing a list of all collection descriptions. The same information is also available in the names as hash map with the collection names as keys.
By providing the optional URL parameter excludeSystem with a value of true, all system collections will be excluded from the response.
",
"summary": "reads all collections",
"httpMethod": "GET",
"examples": "Return information about all collections:
unix> curl --dump - http://localhost:8529/_api/collection\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n \"collections\" : [ \n { \n \"id\" : \"2763996\", \n \"name\" : \"_modules\", \n \"status\" : 3, \n \"type\" : 2 \n }, \n { \n \"id\" : \"7810268\", \n \"name\" : \"_aqlfunctions\", \n \"status\" : 3, \n \"type\" : 2 \n }, \n { \n \"id\" : \"77020\", \n \"name\" : \"_users\", \n \"status\" : 3, \n \"type\" : 2 \n }, \n { \n \"id\" : \"21245148\", \n \"name\" : \"demo\", \n \"status\" : 3, \n \"type\" : 2 \n }, \n { \n \"id\" : \"3681500\", \n \"name\" : \"_routing\", \n \"status\" : 3, \n \"type\" : 2 \n }, \n { \n \"id\" : \"10038492\", \n \"name\" : \"_trx\", \n \"status\" : 3, \n \"type\" : 2 \n }, \n { \n \"id\" : \"1649884\", \n \"name\" : \"_graphs\", \n \"status\" : 3, \n \"type\" : 2 \n }, \n { \n \"id\" : \"6630620\", \n \"name\" : \"_aal\", \n \"status\" : 3, \n \"type\" : 2 \n }, \n { \n \"id\" : \"47525084\", \n \"name\" : \"testCollectionUsers\", \n \"status\" : 3, \n \"type\" : 2 \n }, \n { \n \"id\" : \"8793308\", \n \"name\" : \"_fishbowl\", \n \"status\" : 3, \n \"type\" : 2 \n }, \n { \n \"id\" : \"23080156\", \n \"name\" : \"animals\", \n \"status\" : 3, \n \"type\" : 2 \n }, \n { \n \"id\" : \"5582044\", \n \"name\" : \"_structures\", \n \"status\" : 3, \n \"type\" : 2 \n } \n ], \n \"names\" : { \n \"_modules\" : { \n \"id\" : \"2763996\", \n \"name\" : \"_modules\", \n \"status\" : 3, \n \"type\" : 2 \n }, \n \"_aqlfunctions\" : { \n \"id\" : \"7810268\", \n \"name\" : \"_aqlfunctions\", \n \"status\" : 3, \n \"type\" : 2 \n }, \n \"_users\" : { \n \"id\" : \"77020\", \n \"name\" : \"_users\", \n \"status\" : 3, \n \"type\" : 2 \n }, \n \"demo\" : { \n \"id\" : \"21245148\", \n \"name\" : \"demo\", \n \"status\" : 3, \n \"type\" : 2 \n }, \n \"_routing\" : { \n \"id\" : \"3681500\", \n \"name\" : \"_routing\", \n \"status\" : 3, \n \"type\" : 2 \n }, \n \"_trx\" : { \n \"id\" : \"10038492\", \n \"name\" : \"_trx\", \n \"status\" : 3, \n \"type\" : 2 \n }, \n \"_graphs\" : { \n \"id\" : \"1649884\", \n \"name\" : \"_graphs\", \n \"status\" : 3, \n \"type\" : 2 \n }, \n \"_aal\" : { \n \"id\" : \"6630620\", \n \"name\" : \"_aal\", \n \"status\" : 3, \n \"type\" : 2 \n }, \n \"testCollectionUsers\" : { \n \"id\" : \"47525084\", \n \"name\" : \"testCollectionUsers\", \n \"status\" : 3, \n \"type\" : 2 \n }, \n \"_fishbowl\" : { \n \"id\" : \"8793308\", \n \"name\" : \"_fishbowl\", \n \"status\" : 3, \n \"type\" : 2 \n }, \n \"animals\" : { \n \"id\" : \"23080156\", \n \"name\" : \"animals\", \n \"status\" : 3, \n \"type\" : 2 \n }, \n \"_structures\" : { \n \"id\" : \"5582044\", \n \"name\" : \"_structures\", \n \"status\" : 3, \n \"type\" : 2 \n } \n }, \n \"error\" : false, \n \"code\" : 200 \n}\n\n
",
"nickname": "readsAllCollections"
}
],
"path": "/_api/collection"
},
{
"operations": [
{
"errorResponses": [
{
"reason": "If the collection-name is unknown, then a HTTP 404 is returned. ",
"code": "404"
}
],
"parameters": [
{
"dataType": "String",
"paramType": "path",
"required": "true",
"name": "collection-name",
"description": ""
}
],
"notes": "The result is an object describing the collection with the following attributes:
- id: The identifier of the collection.
- name: The name of the collection.
- status: The status of the collection as number. - 1: new born collection - 2: unloaded - 3: loaded - 4: in the process of being unloaded - 5: deleted
Every other status indicates a corrupted collection.
- type: The type of the collection as number. - 2: document collection (normal case) - 3: edges collection
",
"summary": "reads a collection",
"httpMethod": "GET",
"examples": "",
"nickname": "readsACollection"
}
],
"path": "/_api/collection/{collection-name}"
},
{
"operations": [
{
"errorResponses": [
{
"reason": "If the collection-name is missing, then a HTTP 400 is returned. ",
"code": "400"
},
{
"reason": "If the collection-name is unknown, then a HTTP 404 is returned. ",
"code": "404"
}
],
"parameters": [
{
"dataType": "String",
"paramType": "path",
"required": "true",
"name": "collection-name",
"description": ""
}
],
"notes": "In addition to the above, the result will always contain the waitForSync, journalSize, and isVolatile properties. This is achieved by forcing a load of the underlying collection.
- waitForSync: If true then creating or changing a document will wait until the data has been synchronised to disk.
- journalSize: The maximal size of a journal / datafile.
- isVolatile: If true then the collection data will be kept in memory only and ArangoDB will not write or sync the data to disk.
",
"summary": "reads a collection with properties",
"httpMethod": "GET",
"examples": "Using an identifier:
unix> curl --dump - http://localhost:8529/_api/collection/208547036/properties\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nlocation: /_api/collection/products/properties\n\n{ \n \"id\" : \"208547036\", \n \"name\" : \"products\", \n \"isVolatile\" : false, \n \"isSystem\" : false, \n \"journalSize\" : 1048576, \n \"keyOptions\" : { \n \"type\" : \"traditional\", \n \"allowUserKeys\" : true \n }, \n \"waitForSync\" : true, \n \"status\" : 3, \n \"type\" : 2, \n \"error\" : false, \n \"code\" : 200 \n}\n\n
Using a name:
unix> curl --dump - http://localhost:8529/_api/collection/products/properties\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nlocation: /_api/collection/products/properties\n\n{ \n \"id\" : \"171584732\", \n \"name\" : \"products\", \n \"isVolatile\" : false, \n \"isSystem\" : false, \n \"journalSize\" : 1048576, \n \"keyOptions\" : { \n \"type\" : \"traditional\", \n \"allowUserKeys\" : true \n }, \n \"waitForSync\" : true, \n \"status\" : 3, \n \"type\" : 2, \n \"error\" : false, \n \"code\" : 200 \n}\n\n
",
"nickname": "readsACollectionWithProperties"
}
],
"path": "/_api/collection/{collection-name}/properties"
},
{
"operations": [
{
"errorResponses": [
{
"reason": "If the collection-name is missing, then a HTTP 400 is returned. ",
"code": "400"
},
{
"reason": "If the collection-name is unknown, then a HTTP 404 is returned. ",
"code": "404"
}
],
"parameters": [
{
"dataType": "String",
"paramType": "path",
"required": "true",
"name": "collection-name",
"description": ""
}
],
"notes": "In addition to the above, the result also contains the number of documents. Note that this will always load the collection into memory.
- count: The number of documents inside the collection.
",
"summary": "reads a collection with count",
"httpMethod": "GET",
"examples": "Using an identifier and requesting the number of documents:
unix> curl --dump - http://localhost:8529/_api/collection/172567772/count\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nlocation: /_api/collection/products/count\n\n{ \n \"id\" : \"172567772\", \n \"name\" : \"products\", \n \"isVolatile\" : false, \n \"isSystem\" : false, \n \"journalSize\" : 1048576, \n \"keyOptions\" : { \n \"type\" : \"traditional\", \n \"allowUserKeys\" : true \n }, \n \"waitForSync\" : true, \n \"count\" : 100, \n \"status\" : 3, \n \"type\" : 2, \n \"error\" : false, \n \"code\" : 200 \n}\n\n
",
"nickname": "readsACollectionWithCount"
}
],
"path": "/_api/collection/{collection-name}/count"
},
{
"operations": [
{
"errorResponses": [
{
"reason": "If the collection-name is missing, then a HTTP 400 is returned. ",
"code": "400"
},
{
"reason": "If the collection-name is unknown, then a HTTP 404 is returned. ",
"code": "404"
}
],
"parameters": [
{
"dataType": "String",
"paramType": "path",
"required": "true",
"name": "collection-name",
"description": ""
}
],
"notes": "In addition to the above, the result also contains the number of documents and additional statistical information about the collection. Note that this will always load the collection into memory.
- count: The number of documents inside the collection.
- figures.alive.count: The number of living documents.
- figures.alive.size: The total size in bytes used by all living documents.
- figures.dead.count: The number of dead documents.
- figures.dead.size: The total size in bytes used by all dead documents.
- figures.dead.deletion: The total number of deletion markers.
- figures.datafiles.count: The number of active datafiles.- figures.datafiles.fileSize: The total filesize of datafiles.
- figures.journals.count: The number of journal files.- figures.journals.fileSize: The total filesize of journal files.
- figures.shapes.count: The total number of shapes used in the collection (this includes shapes that are not in use anymore)
- figures.attributes.count: The total number of attributes used in the collection (this includes attributes that are not in use anymore)
- journalSize: The maximal size of the journal in bytes.
Note: the filesizes of shapes and compactor files are not reported.
",
"summary": "reads a collection with stats",
"httpMethod": "GET",
"examples": "Using an identifier and requesting the figures of the collection:
unix> curl --dump - http://localhost:8529/_api/collection/111422684/figures\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nlocation: /_api/collection/products/figures\n\n{ \n \"id\" : \"111422684\", \n \"name\" : \"products\", \n \"isVolatile\" : false, \n \"isSystem\" : false, \n \"journalSize\" : 1048576, \n \"keyOptions\" : { \n \"type\" : \"traditional\", \n \"allowUserKeys\" : true \n }, \n \"waitForSync\" : true, \n \"count\" : 0, \n \"figures\" : { \n \"alive\" : { \n \"count\" : 0, \n \"size\" : 0 \n }, \n \"dead\" : { \n \"count\" : 0, \n \"size\" : 0, \n \"deletion\" : 0 \n }, \n \"datafiles\" : { \n \"count\" : 0, \n \"fileSize\" : 0 \n }, \n \"journals\" : { \n \"count\" : 0, \n \"fileSize\" : 0 \n }, \n \"shapes\" : { \n \"count\" : 6 \n }, \n \"attributes\" : { \n \"count\" : 0 \n } \n }, \n \"status\" : 3, \n \"type\" : 2, \n \"error\" : false, \n \"code\" : 200 \n}\n\n
",
"nickname": "readsACollectionWithStats"
}
],
"path": "/_api/collection/{collection-name}/figures"
},
{
"operations": [
{
"errorResponses": [
{
"reason": "If the collection-name is missing, then a HTTP 400 is returned. ",
"code": "400"
},
{
"reason": "If the collection-name is unknown, then a HTTP 404 is returned. ",
"code": "404"
}
],
"parameters": [
{
"dataType": "String",
"paramType": "path",
"required": "true",
"name": "collection-name",
"description": ""
}
],
"notes": "In addition to the above, the result will also contain the collection's revision id. The revision id is a server-generated string that clients can use to check whether data in a collection has changed since the last revision check.
- revision: The collection revision id as a string.
",
"summary": " reads a collection with revision id",
"httpMethod": "GET",
"examples": "",
"nickname": "readsACollectionWithRevisionId"
}
],
"path": "/_api/collection/{collection-name}/revision"
},
{
"operations": [
{
"errorResponses": [
{
"reason": "If the collection-name is missing, then a HTTP 400 is returned. ",
"code": "400"
},
{
"reason": "If the collection-name is unknown, then a HTTP 404 is returned. ",
"code": "404"
}
],
"parameters": [
{
"dataType": "String",
"paramType": "path",
"required": "true",
"name": "collection-name",
"description": ""
}
],
"notes": "Loads a collection into memory. Returns the collection on success.
The request might optionally contain the following attribute:
- count: If set, this controls whether the return value should include the number of documents in the collection. Setting count to false may speed up loading a collection. The default value for count is true.
On success an object with the following attributes is returned:
- id: The identifier of the collection.
- name: The name of the collection.
- count: The number of documents inside the collection. This is only returned if the count input parameters is set to true or has not been specified.
- status: The status of the collection as number.
- type: The collection type. Valid types are: - 2: document collection - 3: edges collection
",
"summary": "loads a collection",
"httpMethod": "PUT",
"examples": "
unix> curl -X PUT --dump - http://localhost:8529/_api/collection/244985052/load\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n \"id\" : \"244985052\", \n \"name\" : \"products\", \n \"count\" : 0, \n \"status\" : 3, \n \"type\" : 2, \n \"error\" : false, \n \"code\" : 200 \n}\n\n
",
"nickname": "loadsACollection"
}
],
"path": "/_api/collection/{collection-name}/load"
},
{
"operations": [
{
"errorResponses": [
{
"reason": "If the collection-name is missing, then a HTTP 400 is returned. ",
"code": "400"
},
{
"reason": "If the collection-name is unknown, then a HTTP 404 is returned. ",
"code": "404"
}
],
"parameters": [
{
"dataType": "String",
"paramType": "path",
"required": "true",
"name": "collection-name",
"description": ""
}
],
"notes": "Removes a collection from memory. This call does not delete any documents. You can use the collection afterwards; in which case it will be loaded into memory, again. On success an object with the following attributes is returned:
- id: The identifier of the collection.
- name: The name of the collection.
- status: The status of the collection as number.
- type: The collection type. Valid types are: - 2: document collection - 3: edges collection
",
"summary": "unloads a collection",
"httpMethod": "PUT",
"examples": "
unix> curl -X PUT --dump - http://localhost:8529/_api/collection/39070940/unload\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n \"id\" : \"39070940\", \n \"name\" : \"products\", \n \"status\" : 2, \n \"type\" : 2, \n \"error\" : false, \n \"code\" : 200 \n}\n\n
",
"nickname": "unloadsACollection"
}
],
"path": "/_api/collection/{collection-name}/unload"
},
{
"operations": [
{
"errorResponses": [],
"parameters": [
{
"dataType": "String",
"paramType": "path",
"required": "true",
"name": "collection-name",
"description": ""
}
],
"notes": "Removes all documents from the collection, but leaves the indexes intact.
",
"summary": "truncates a collection",
"httpMethod": "PUT",
"examples": "
unix> curl -X PUT --dump - http://localhost:8529/_api/collection/159067356/truncate\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n \"id\" : \"159067356\", \n \"name\" : \"products\", \n \"status\" : 3, \n \"type\" : 2, \n \"error\" : false, \n \"code\" : 200 \n}\n\n
",
"nickname": "truncatesACollection"
}
],
"path": "/_api/collection/{collection-name}/truncate"
},
{
"operations": [
{
"errorResponses": [],
"parameters": [
{
"dataType": "String",
"paramType": "path",
"required": "true",
"name": "collection-name",
"description": ""
}
],
"notes": "Changes the properties of a collection. Expects an object with the attribute(s)
- waitForSync: If true then creating or changing a document will wait until the data has been synchronised to disk.
- journalSize: Size (in bytes) for new journal files that are created for the collection.
If returns an object with the attributes
- id: The identifier of the collection.
- name: The name of the collection.
- waitForSync: The new value.
- journalSize: The new value.
- status: The status of the collection as number.
- type: The collection type. Valid types are: - 2: document collection - 3: edges collection
Note: some other collection properties, such as type or isVolatile cannot be changed once the collection is created.
",
"summary": "changes the properties of a collection",
"httpMethod": "PUT",
"examples": "
unix> curl -X PUT --data @- --dump - http://localhost:8529/_api/collection/201927900/properties\n{\"waitForSync\":true}\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n \"id\" : \"201927900\", \n \"name\" : \"products\", \n \"isVolatile\" : false, \n \"isSystem\" : false, \n \"journalSize\" : 1048576, \n \"keyOptions\" : { \n \"type\" : \"traditional\", \n \"allowUserKeys\" : true \n }, \n \"waitForSync\" : true, \n \"status\" : 3, \n \"type\" : 2, \n \"error\" : false, \n \"code\" : 200 \n}\n\n
",
"nickname": "changesThePropertiesOfACollection"
}
],
"path": "/_api/collection/{collection-name}/properties"
},
{
"operations": [
{
"errorResponses": [],
"parameters": [
{
"dataType": "String",
"paramType": "path",
"required": "true",
"name": "collection-name",
"description": ""
}
],
"notes": "Renames a collection. Expects an object with the attribute(s)
- name: The new name.
If returns an object with the attributes
- id: The identifier of the collection.
- name: The new name of the collection.
- status: The status of the collection as number.
- type: The collection type. Valid types are: - 2: document collection - 3: edges collection
",
"summary": "renames a collection",
"httpMethod": "PUT",
"examples": "
unix> curl -X PUT --data @- --dump - http://localhost:8529/_api/collection/199437532/rename\n{\"name\":\"newname\"}\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n \"id\" : \"199437532\", \n \"name\" : \"newname\", \n \"status\" : 3, \n \"type\" : 2, \n \"error\" : false, \n \"code\" : 200 \n}\n\n
",
"nickname": "renamesACollection"
}
],
"path": "/_api/collection/{collection-name}/rename"
},
{
"operations": [
{
"errorResponses": [
{
"reason": "If the collection-name is missing, then a HTTP 400 is returned. ",
"code": "400"
},
{
"reason": "If the collection-name is unknown, then a HTTP 404 is returned. ",
"code": "404"
}
],
"parameters": [
{
"dataType": "String",
"paramType": "path",
"required": "true",
"name": "collection-name",
"description": ""
}
],
"notes": "Deletes a collection identified by collection-name.
If the collection was successfully deleted then, an object is returned with the following attributes:
- error: false
- id: The identifier of the deleted collection.
",
"summary": "deletes a collection",
"httpMethod": "DELETE",
"examples": "Using an identifier:
unix> curl -X DELETE --dump - http://localhost:8529/_api/collection/217066716\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n \"id\" : \"217066716\", \n \"error\" : false, \n \"code\" : 200 \n}\n\n
Using a name:
unix> curl -X DELETE --dump - http://localhost:8529/_api/collection/products1\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n \"id\" : \"132590812\", \n \"error\" : false, \n \"code\" : 200 \n}\n\n
",
"nickname": "deletesACollection"
}
],
"path": "/_api/collection/{collection-name}"
}
]
}