ArangoDB v3.13 is under development and not released yet. This documentation is not final and potentially incomplete.

HTTP interface for named graphs

The HTTP API for named graphs lets you manage General Graphs, SmartGraphs, EnterpriseGraphs, and SatelliteGraphs

The HTTP API for named graphs is called Gharial.

You can manage all types of ArangoDB’s named graphs with Gharial:

The examples use the following example graphs:

Social Graph:

Social Example Graph

Knows Graph:

Social Example Graph

Management

List all graphs

GET /_db/{database-name}/_api/gharial

Lists all graphs stored in this database.

Path Parameters

database-name* string
The name of the database.

Query Parameters

HTTP Headers

Responses

200 OK
Is returned if the module is available and the graphs can be listed.
- code* integer
  The HTTP response status code.
- error* boolean
  A flag indicating that no error occurred.
- graphs* array of objects
  A list of all named graphs.
  graph object
  The properties of the named graph.
  _id* string
  The internal id value of this graph.
  _rev* string
  The revision of this graph. Can be used to make sure to not override concurrent modifications to this graph.
  edgeDefinitions* array of objects
  An array of definitions for the relations of the graph. Each has the following type:
  collection* string
  Name of the edge collection, where the edges are stored in.
  from* array of strings
  List of node collection names. Edges in collection can only be inserted if their _from is in any of the collections here.
  to* array of strings
  List of node collection names.
  Edges in collection can only be inserted if their _to is in any of the collections here.
  isDisjoint* boolean
  Whether the graph is a Disjoint SmartGraph.
  isSatellite* boolean
  Whether the graph is a SatelliteGraph.
  isSmart* boolean
  Whether the graph is a SmartGraph.
  name* string
  The name of the graph.
  numberOfShards* integer
  Number of shards created for every new collection in the graph.
  orphanCollections* array of strings
  An array of additional node collections. Documents in these collections do not have edges within this graph.
  replicationFactor* integer
  The replication factor used for every new collection in the graph. For SatelliteGraphs, it is the string "satellite".
  Default: The replicationFactor defined by the database.
  smartGraphAttribute string
  Name of the sharding attribute in the SmartGraph case.
  writeConcern integer
  The default write concern for new collections in the graph. It determines how many copies of each shard are required to be in sync on the different DB-Servers. If there are less than these many copies in the cluster, a shard refuses to write. Writes to shards with enough up-to-date copies succeed at the same time, however. The value of writeConcern cannot be greater than replicationFactor. For SatelliteGraphs, the writeConcern is automatically controlled to equal the number of DB-Servers and the attribute is not available. (cluster only)

Examples

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

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: 623
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

{ 
  "error" : false, 
  "code" : 200, 
  "graphs" : [ 
    { 
      "_id" : "_graphs/social", 
      "_key" : "social", 
      "_rev" : "_hg5kt_W---", 
      "edgeDefinitions" : [ 
        { 
          "collection" : "relation", 
          "from" : [ 
            "female", 
            "male" 
          ], 
          "to" : [ 
            "female", 
            "male" 
          ] 
        } 
      ], 
      "orphanCollections" : [ ], 
      "name" : "social" 
    }, 
    { 
      "_id" : "_graphs/routeplanner", 
      "_key" : "routeplanner", 
      "_rev" : "_hg5kt_m--_", 
      "edgeDefinitions" : [ 
        { 
          "collection" : "frenchHighway", 
          "from" : [ 
            "frenchCity" 
          ], 
          "to" : [ 
            "frenchCity" 
          ] 
        }, 
        { 
          "collection" : "germanHighway", 
          "from" : [ 
            "germanCity" 
          ], 
          "to" : [ 
            "germanCity" 
          ] 
        }, 
        { 
          "collection" : "internationalHighway", 
          "from" : [ 
            "frenchCity", 
            "germanCity" 
          ], 
          "to" : [ 
            "frenchCity", 
            "germanCity" 
          ] 
        } 
      ], 
      "orphanCollections" : [ ], 
      "name" : "routeplanner" 
    } 
  ] 
}

Create a graph

POST /_db/{database-name}/_api/gharial

The creation of a graph requires the name of the graph and a definition of its edges.

Path Parameters

database-name* string
The name of the database.

Query Parameters

waitForSync boolean
Define if the request should wait until everything is synced to disk. Changes the success HTTP response status code.

HTTP Headers

Request Body application/json object

edgeDefinitions array of objects
An array of definitions for the relations of the graph. Each has the following type:
- collection* string
  Name of the edge collection, where the edges are stored in.
- from* array of strings
  A list of node collection names. Edges you later insert into collection can only reference vertices from these collections in their _from attribute (if you use the interface for named graphs).
- to* array of strings
  A list of node collection names. Edges you later insert into collection can only reference vertices from these collections in their _to attribute (if you use the interface for named graphs).
isDisjoint boolean (default: false)
Whether to create a Disjoint SmartGraph instead of a regular SmartGraph.
isSmart boolean (default: false)
Define if the created graph should be smart.
name* string
Name of the graph.
options object
Options for creating collections within this graph. It can contain the following attributes:
- numberOfShards integer (default: 1)
  The number of shards that is used for every collection within this graph. Cannot be modified later.
- replicationFactor integer
  The replication factor used when initially creating collections for this graph. Can be set to "satellite" to create a SatelliteGraph, which then ignores numberOfShards, minReplicationFactor, and writeConcern.
  Default: The replicationFactor defined by the database.
- satellites array of strings
  An array of collection names that is used to create SatelliteCollections for a (Disjoint) SmartGraph using SatelliteCollections. Each array element must be a string and a valid collection name. The collection type cannot be modified later.
- smartGraphAttribute string
  Required to create a SmartGraph.
  The attribute name that is used to smartly shard the nodes of a graph. Every node in this SmartGraph has to have this attribute. Cannot be modified later.
- writeConcern integer
  Write concern for new collections in the graph. It determines how many copies of each shard are required to be in sync on the different DB-Servers. If there are less than these many copies in the cluster, a shard refuses to write. Writes to shards with enough up-to-date copies succeed at the same time, however. The value of writeConcern cannot be greater than replicationFactor. For SatelliteGraphs, the writeConcern is automatically controlled to equal the number of DB-Servers and the attribute is not available. (cluster only)
orphanCollections array of strings
An array of additional node collections. Documents in these collections do not have edges within this graph.

Responses

201 Created
Is returned if the graph can be created and waitForSync is enabled for the _graphs collection, or given in the request. The response body contains the graph configuration that has been stored.
- code* integer
  The HTTP response status code.
- error* boolean
  A flag indicating that no error occurred.
- graph* object
  The information about the newly created graph.
  _id* string
  The internal id value of this graph.
  _rev* string
  The revision of this graph. Can be used to make sure to not override concurrent modifications to this graph.
  edgeDefinitions* array of objects
  An array of definitions for the relations of the graph. Each has the following type:
  collection* string
  Name of the edge collection, where the edges are stored in.
  from* array of strings
  List of node collection names. Edges in collection can only be inserted if their _from is in any of the collections here.
  to* array of strings
  List of node collection names.
  Edges in collection can only be inserted if their _to is in any of the collections here.
  isDisjoint* boolean
  Whether the graph is a Disjoint SmartGraph.
  isSatellite* boolean
  Whether the graph is a SatelliteGraph.
  isSmart* boolean
  Whether the graph is a SmartGraph.
  name* string
  The name of the graph.
  numberOfShards* integer
  Number of shards created for every new collection in the graph.
  orphanCollections* array of strings
  An array of additional node collections. Documents in these collections do not have edges within this graph.
  replicationFactor* integer
  The replication factor used for every new collection in the graph. For SatelliteGraphs, it is the string "satellite".
  smartGraphAttribute string
  Name of the sharding attribute in the SmartGraph case.
  writeConcern integer
  The default write concern for new collections in the graph. It determines how many copies of each shard are required to be in sync on the different DB-Servers. If there are less than these many copies in the cluster, a shard refuses to write. Writes to shards with enough up-to-date copies succeed at the same time, however. The value of writeConcern cannot be greater than replicationFactor. For SatelliteGraphs, the writeConcern is automatically controlled to equal the number of DB-Servers and the attribute is not available. (cluster only)
202 Accepted
Is returned if the graph can be created and waitForSync is disabled for the _graphs collection and not given in the request. The response body contains the graph configuration that has been stored.
- code* integer
  The HTTP response status code.
- error* boolean
  A flag indicating that no error occurred.
- graph* object
  The information about the newly created graph.
  _id* string
  The internal id value of this graph.
  _rev* string
  The revision of this graph. Can be used to make sure to not override concurrent modifications to this graph.
  edgeDefinitions* array of objects
  An array of definitions for the relations of the graph. Each has the following type:
  collection* string
  Name of the edge collection, where the edges are stored in.
  from* array of strings
  List of node collection names. Edges in collection can only be inserted if their _from is in any of the collections here.
  to* array of strings
  List of node collection names.
  Edges in collection can only be inserted if their _to is in any of the collections here.
  isDisjoint* boolean
  Whether the graph is a Disjoint SmartGraph.
  isSatellite* boolean
  Whether the graph is a SatelliteGraph.
  isSmart* boolean
  Whether the graph is a SmartGraph.
  name* string
  The name of the graph.
  numberOfShards* integer
  Number of shards created for every new collection in the graph.
  orphanCollections* array of strings
  An array of additional node collections. Documents in these collections do not have edges within this graph.
  replicationFactor* integer
  The replication factor used for every new collection in the graph. For SatelliteGraphs, it is the string "satellite".
  smartGraphAttribute string
  Name of the sharding attribute in the SmartGraph case.
  writeConcern integer
  The default write concern for new collections in the graph. It determines how many copies of each shard are required to be in sync on the different DB-Servers. If there are less than these many copies in the cluster, a shard refuses to write. Writes to shards with enough up-to-date copies succeed at the same time, however. The value of writeConcern cannot be greater than replicationFactor. For SatelliteGraphs, the writeConcern is automatically controlled to equal the number of DB-Servers and the attribute is not available. (cluster only)
400 Bad Request
Returned if the request is in a wrong format.
- code* integer
  The HTTP response status code.
- error* boolean
  A flag indicating that an error occurred.
- errorMessage* string
  A descriptive error message.
- errorNum* integer
  The ArangoDB error number for the error that occurred.
403 Forbidden
Returned if your user has insufficient rights. In order to create a graph, you need to have at least the following privileges:
- Administrate access on the database.
- Read Only access on every collection used within this graph.
- code* integer
  The HTTP response status code.
- error* boolean
  A flag indicating that an error occurred.
- errorMessage* string
  A descriptive error message.
- errorNum* integer
  The ArangoDB error number for the error that occurred.
409 Conflict
Returned if there is a conflict storing the graph. This can occur either if a graph with this name already exists, or if there is an edge definition with the same edge collection but different from and to node collections in any other graph.
- code* integer
  The HTTP response status code.
- error* boolean
  A flag indicating that an error occurred.
- errorMessage* string
  A descriptive error message.
- errorNum* integer
  The ArangoDB error number for the error that occurred.

Examples

Create a General Graph. This graph type does not make use of any sharding strategy and is useful on the single server.

curl -X POST --header 'accept: application/json' --data-binary @- --dump - 'http://localhost:8529/_api/gharial' <<'EOF'
{
  "name": "myGraph",
  "edgeDefinitions": [
    {
      "collection": "edges",
      "from": [
        "startNodes"
      ],
      "to": [
        "endNodes"
      ]
    }
  ]
}
EOF

Show output

HTTP/1.1 202 Accepted
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: 221
content-security-policy: frame-ancestors 'self'; form-action 'self';
etag: _kKbju8q---
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

{ 
  "error" : false, 
  "code" : 202, 
  "graph" : { 
    "_key" : "myGraph", 
    "edgeDefinitions" : [ 
      { 
        "collection" : "edges", 
        "from" : [ 
          "startNodes" 
        ], 
        "to" : [ 
          "endNodes" 
        ] 
      } 
    ], 
    "orphanCollections" : [ ], 
    "_rev" : "_kKbju8q---", 
    "_id" : "_graphs/myGraph", 
    "name" : "myGraph" 
  } 
}

Create a SmartGraph. This graph uses 9 shards and is sharded by the “region” attribute.

curl -X POST --header 'accept: application/json' --data-binary @- --dump - 'http://localhost:8529/_api/gharial' <<'EOF'
{
  "name": "smartGraph",
  "edgeDefinitions": [
    {
      "collection": "edges",
      "from": [
        "startNodes"
      ],
      "to": [
        "endNodes"
      ]
    }
  ],
  "orphanCollections": [
    "orphanNodes"
  ],
  "isSmart": true,
  "options": {
    "replicationFactor": 2,
    "numberOfShards": 9,
    "smartGraphAttribute": "region"
  }
}
EOF

Show output

HTTP/1.1 202 Accepted
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: 434
content-security-policy: frame-ancestors 'self'; form-action 'self';
etag: _kKbjvAm--_
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

{ 
  "error" : false, 
  "code" : 202, 
  "graph" : { 
    "_key" : "smartGraph", 
    "numberOfShards" : 9, 
    "replicationFactor" : 2, 
    "minReplicationFactor" : 1, 
    "writeConcern" : 1, 
    "isSmart" : true, 
    "isSatellite" : false, 
    "edgeDefinitions" : [ 
      { 
        "collection" : "edges", 
        "from" : [ 
          "startNodes" 
        ], 
        "to" : [ 
          "endNodes" 
        ] 
      } 
    ], 
    "orphanCollections" : [ 
      "orphanNodes" 
    ], 
    "initial" : "startNodes", 
    "smartGraphAttribute" : "region", 
    "isDisjoint" : false, 
    "_rev" : "_kKbjvAm--_", 
    "_id" : "_graphs/smartGraph", 
    "name" : "smartGraph" 
  } 
}

Create a disjoint SmartGraph. This graph uses 9 shards and is sharded by the “region” attribute. Note that as you are using a disjoint version, you can only create edges between nodes sharing the same region.

curl -X POST --header 'accept: application/json' --data-binary @- --dump - 'http://localhost:8529/_api/gharial' <<'EOF'
{
  "name": "disjointSmartGraph",
  "edgeDefinitions": [
    {
      "collection": "edges",
      "from": [
        "startNodes"
      ],
      "to": [
        "endNodes"
      ]
    }
  ],
  "orphanCollections": [
    "orphanNodes"
  ],
  "isSmart": true,
  "options": {
    "isDisjoint": true,
    "replicationFactor": 2,
    "numberOfShards": 9,
    "smartGraphAttribute": "region"
  }
}
EOF

Show output

HTTP/1.1 202 Accepted
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: 457
content-security-policy: frame-ancestors 'self'; form-action 'self';
etag: _kKbjvFa---
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

{ 
  "error" : false, 
  "code" : 202, 
  "graph" : { 
    "_key" : "disjointSmartGraph", 
    "numberOfShards" : 9, 
    "replicationFactor" : 2, 
    "minReplicationFactor" : 1, 
    "writeConcern" : 1, 
    "isSmart" : true, 
    "isSatellite" : false, 
    "edgeDefinitions" : [ 
      { 
        "collection" : "edges", 
        "from" : [ 
          "startNodes" 
        ], 
        "to" : [ 
          "endNodes" 
        ] 
      } 
    ], 
    "orphanCollections" : [ 
      "orphanNodes" 
    ], 
    "initial" : "startNodes", 
    "smartGraphAttribute" : "region", 
    "isDisjoint" : true, 
    "_rev" : "_kKbjvFa---", 
    "_id" : "_graphs/disjointSmartGraph", 
    "name" : "disjointSmartGraph" 
  } 
}

Create a SmartGraph with a satellite node collection. It uses the collection “endNodes” as a satellite collection. This collection is cloned to all servers, all other node collections are split into 9 shards and are sharded by the “region” attribute.

curl -X POST --header 'accept: application/json' --data-binary @- --dump - 'http://localhost:8529/_api/gharial' <<'EOF'
{
  "name": "smartGraph",
  "edgeDefinitions": [
    {
      "collection": "edges",
      "from": [
        "startNodes"
      ],
      "to": [
        "endNodes"
      ]
    }
  ],
  "orphanCollections": [
    "orphanNodes"
  ],
  "isSmart": true,
  "options": {
    "replicationFactor": 2,
    "numberOfShards": 9,
    "smartGraphAttribute": "region",
    "satellites": [
      "endNodes"
    ]
  }
}
EOF

Show output

HTTP/1.1 202 Accepted
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: 434
content-security-policy: frame-ancestors 'self'; form-action 'self';
etag: _kKbjvJK--_
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

{ 
  "error" : false, 
  "code" : 202, 
  "graph" : { 
    "_key" : "smartGraph", 
    "numberOfShards" : 9, 
    "replicationFactor" : 2, 
    "minReplicationFactor" : 1, 
    "writeConcern" : 1, 
    "isSmart" : true, 
    "isSatellite" : false, 
    "edgeDefinitions" : [ 
      { 
        "collection" : "edges", 
        "from" : [ 
          "startNodes" 
        ], 
        "to" : [ 
          "endNodes" 
        ] 
      } 
    ], 
    "orphanCollections" : [ 
      "orphanNodes" 
    ], 
    "initial" : "startNodes", 
    "smartGraphAttribute" : "region", 
    "isDisjoint" : false, 
    "_rev" : "_kKbjvJK--_", 
    "_id" : "_graphs/smartGraph", 
    "name" : "smartGraph" 
  } 
}

Create an EnterpriseGraph. This graph uses 9 shards, it does not make use of specific sharding attributes.

curl -X POST --header 'accept: application/json' --data-binary @- --dump - 'http://localhost:8529/_api/gharial' <<'EOF'
{
  "name": "enterpriseGraph",
  "edgeDefinitions": [
    {
      "collection": "edges",
      "from": [
        "startNodes"
      ],
      "to": [
        "endNodes"
      ]
    }
  ],
  "orphanCollections": [],
  "isSmart": true,
  "options": {
    "replicationFactor": 2,
    "numberOfShards": 9
  }
}
EOF

Show output

HTTP/1.1 202 Accepted
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: 405
content-security-policy: frame-ancestors 'self'; form-action 'self';
etag: _kKbjvOu--_
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

{ 
  "error" : false, 
  "code" : 202, 
  "graph" : { 
    "_key" : "enterpriseGraph", 
    "numberOfShards" : 9, 
    "replicationFactor" : 2, 
    "minReplicationFactor" : 1, 
    "writeConcern" : 1, 
    "isSmart" : true, 
    "isSatellite" : false, 
    "edgeDefinitions" : [ 
      { 
        "collection" : "edges", 
        "from" : [ 
          "startNodes" 
        ], 
        "to" : [ 
          "endNodes" 
        ] 
      } 
    ], 
    "orphanCollections" : [ ], 
    "initial" : "startNodes", 
    "isDisjoint" : false, 
    "_rev" : "_kKbjvOu--_", 
    "_id" : "_graphs/enterpriseGraph", 
    "name" : "enterpriseGraph" 
  } 
}

Create a SatelliteGraph. A SatelliteGraph does not use shards, but uses “satellite” as replicationFactor. Make sure to keep this graph small as it is cloned to every server.

curl -X POST --header 'accept: application/json' --data-binary @- --dump - 'http://localhost:8529/_api/gharial' <<'EOF'
{
  "name": "satelliteGraph",
  "edgeDefinitions": [
    {
      "collection": "edges",
      "from": [
        "startNodes"
      ],
      "to": [
        "endNodes"
      ]
    }
  ],
  "orphanCollections": [],
  "options": {
    "replicationFactor": "satellite"
  }
}
EOF

Show output

HTTP/1.1 202 Accepted
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: 351
content-security-policy: frame-ancestors 'self'; form-action 'self';
etag: _kKbjvQu--_
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

{ 
  "error" : false, 
  "code" : 202, 
  "graph" : { 
    "_key" : "satelliteGraph", 
    "numberOfShards" : 1, 
    "replicationFactor" : "satellite", 
    "isSmart" : false, 
    "isSatellite" : true, 
    "edgeDefinitions" : [ 
      { 
        "collection" : "edges", 
        "from" : [ 
          "startNodes" 
        ], 
        "to" : [ 
          "endNodes" 
        ] 
      } 
    ], 
    "orphanCollections" : [ ], 
    "initial" : "startNodes", 
    "_rev" : "_kKbjvQu--_", 
    "_id" : "_graphs/satelliteGraph", 
    "name" : "satelliteGraph" 
  } 
}

Get a graph

GET /_db/{database-name}/_api/gharial/{graph}

Selects information for a given graph. Returns the edge definitions as well as the orphan collections, or returns an error if the graph does not exist.

Path Parameters

database-name* string
The name of the database.
graph* string
The name of the graph.

Query Parameters

HTTP Headers

Responses

200 OK
Returns the graph if it can be found. The result has the following format:
- code* integer
  The HTTP response status code.
- error* boolean
  A flag indicating that no error occurred.
- graph* object
  The information about the newly created graph
  _id* string
  The internal id value of this graph.
  _rev* string
  The revision of this graph. Can be used to make sure to not override concurrent modifications to this graph.
  edgeDefinitions* array of objects
  An array of definitions for the relations of the graph. Each has the following type:
  collection* string
  Name of the edge collection, where the edges are stored in.
  from* array of strings
  List of node collection names. Edges in collection can only be inserted if their _from is in any of the collections here.
  to* array of strings
  List of node collection names.
  Edges in collection can only be inserted if their _to is in any of the collections here.
  isDisjoint* boolean
  Whether the graph is a Disjoint SmartGraph.
  isSatellite* boolean
  Whether the graph is a SatelliteGraph.
  isSmart* boolean
  Whether the graph is a SmartGraph.
  name* string
  The name of the graph.
  numberOfShards* integer
  Number of shards created for every new collection in the graph.
  orphanCollections* array of strings
  An array of additional node collections. Documents in these collections do not have edges within this graph.
  replicationFactor* integer
  The replication factor used for every new collection in the graph. For SatelliteGraphs, it is the string "satellite".
  smartGraphAttribute string
  Name of the sharding attribute in the SmartGraph case.
  writeConcern integer
  The default write concern for new collections in the graph. It determines how many copies of each shard are required to be in sync on the different DB-Servers. If there are less than these many copies in the cluster, a shard refuses to write. Writes to shards with enough up-to-date copies succeed at the same time, however. The value of writeConcern cannot be greater than replicationFactor. For SatelliteGraphs, the writeConcern is automatically controlled to equal the number of DB-Servers and the attribute is not available. (cluster only)
404 Not Found
Returned if no graph with this name can be found.
- code* integer
  The HTTP response status code.
- error* boolean
  A flag indicating that an error occurred.
- errorMessage* string
  A descriptive error message.
- errorNum* integer
  The ArangoDB error number for the error that occurred.

Examples

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

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: 221
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

{ 
  "error" : false, 
  "code" : 200, 
  "graph" : { 
    "_key" : "myGraph", 
    "edgeDefinitions" : [ 
      { 
        "collection" : "edges", 
        "from" : [ 
          "startNodes" 
        ], 
        "to" : [ 
          "endNodes" 
        ] 
      } 
    ], 
    "orphanCollections" : [ ], 
    "_rev" : "_kKbjvZO--_", 
    "_id" : "_graphs/myGraph", 
    "name" : "myGraph" 
  } 
}

Drop a graph

DELETE /_db/{database-name}/_api/gharial/{graph}

Drops an existing graph object by name. Optionally all collections not used by other graphs can be dropped as well.

Path Parameters

database-name* string
The name of the database.
graph* string
The name of the graph.

Query Parameters

dropCollections boolean (default: false)
Drop the collections of this graph as well. Collections are only dropped if they are not used in other graphs.

HTTP Headers

Responses

202 Accepted
Is returned if the graph can be dropped.
- code* integer
  The HTTP response status code.
- error* boolean
  A flag indicating that no error occurred.
- removed* boolean
  Always true.
403 Forbidden
Returned if your user has insufficient rights. In order to drop a graph, you need to have at least the following privileges:
- Administrate access on the database.
- code* integer
  The HTTP response status code.
- error* boolean
  A flag indicating that an error occurred.
- errorMessage* string
  A descriptive error message.
- errorNum* integer
  The ArangoDB error number for the error that occurred.
404 Not Found
Returned if no graph with this name can be found.
- code* integer
  The HTTP response status code.
- error* boolean
  A flag indicating that an error occurred.
- errorMessage* string
  A descriptive error message.
- errorNum* integer
  The ArangoDB error number for the error that occurred.

Examples

curl -X DELETE --header 'accept: application/json' --dump - http://localhost:8529/_api/gharial/social?dropCollections=true

Show output

HTTP/1.1 202 Accepted
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: 41
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

{ 
  "error" : false, 
  "code" : 202, 
  "removed" : true 
}

List node collections

GET /_db/{database-name}/_api/gharial/{graph}/vertex

Lists all node collections within this graph, including orphan collections.

Path Parameters

database-name* string
The name of the database.
graph* string
The name of the graph.

Query Parameters

HTTP Headers

Responses

200 OK
Is returned if the collections can be listed.
- code* integer
  The HTTP response status code.
- collections* array of strings
  The list of all node collections within this graph. Includes the node collections used in edge definitions as well as orphan collections.
- error* boolean
  A flag indicating that no error occurred.
404 Not Found
Returned if no graph with this name can be found.
- code* integer
  The HTTP response status code.
- error* boolean
  A flag indicating that an error occurred.
- errorMessage* string
  A descriptive error message.
- errorNum* integer
  The ArangoDB error number for the error that occurred.

Examples

curl --header 'accept: application/json' --dump - http://localhost:8529/_api/gharial/social/vertex

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: 58
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

{ 
  "error" : false, 
  "code" : 200, 
  "collections" : [ 
    "female", 
    "male" 
  ] 
}

Add a node collection

Adding a node collection on its own to a graph adds it as an orphan collection. If you want to use an additional node collection for graph relations, add it by adding a new edge definition or modifying an existing edge definition instead.

POST /_db/{database-name}/_api/gharial/{graph}/vertex

Adds a node collection to the set of orphan collections of the graph. If the collection does not exist, it is created.

Path Parameters

database-name* string
The name of the database.
graph* string
The name of the graph.

Query Parameters

HTTP Headers

Request Body application/json object

collection* string
The name of the node collection to add to the graph definition.
options object
A JSON object to set options for creating node collections.
- satellites array of strings
  An array of collection names that is used to create SatelliteCollections for a (Disjoint) SmartGraph using SatelliteCollections. Each array element must be a string and a valid collection name. The collection type cannot be modified later.

Responses

201 Created
Is returned if the collection can be created and waitForSync is enabled for the _graphs collection, or given in the request. The response body contains the graph configuration that has been stored.
- code* integer
  The HTTP response status code.
- error* boolean
  A flag indicating that no error occurred.
- graph* object
  The information about the modified graph.
  _id* string
  The internal id value of this graph.
  _rev* string
  The revision of this graph. Can be used to make sure to not override concurrent modifications to this graph.
  edgeDefinitions* array of objects
  An array of definitions for the relations of the graph. Each has the following type:
  collection* string
  Name of the edge collection, where the edges are stored in.
  from* array of strings
  List of node collection names. Edges in collection can only be inserted if their _from is in any of the collections here.
  to* array of strings
  List of node collection names.
  Edges in collection can only be inserted if their _to is in any of the collections here.
  isDisjoint* boolean
  Whether the graph is a Disjoint SmartGraph.
  isSatellite* boolean
  Whether the graph is a SatelliteGraph.
  isSmart* boolean
  Whether the graph is a SmartGraph.
  name* string
  The name of the graph.
  numberOfShards* integer
  Number of shards created for every new collection in the graph.
  orphanCollections* array of strings
  An array of additional node collections. Documents in these collections do not have edges within this graph.
  replicationFactor* integer
  The replication factor used for every new collection in the graph. For SatelliteGraphs, it is the string "satellite".
  smartGraphAttribute string
  Name of the sharding attribute in the SmartGraph case.
  writeConcern integer
  The default write concern for new collections in the graph. It determines how many copies of each shard are required to be in sync on the different DB-Servers. If there are less than these many copies in the cluster, a shard refuses to write. Writes to shards with enough up-to-date copies succeed at the same time, however. The value of writeConcern cannot be greater than replicationFactor. For SatelliteGraphs, the writeConcern is automatically controlled to equal the number of DB-Servers and the attribute is not available. (cluster only)
202 Accepted
Is returned if the collection can be created and waitForSync is disabled for the _graphs collection, or given in the request. The response body contains the graph configuration that has been stored.
- code* integer
  The HTTP response status code.
- error* boolean
  A flag indicating that no error occurred.
- graph* object
  The information about the newly created graph
  _id* string
  The internal id value of this graph.
  _rev* string
  The revision of this graph. Can be used to make sure to not override concurrent modifications to this graph.
  edgeDefinitions* array of objects
  An array of definitions for the relations of the graph. Each has the following type:
  collection* string
  Name of the edge collection, where the edges are stored in.
  from* array of strings
  List of node collection names. Edges in collection can only be inserted if their _from is in any of the collections here.
  to* array of strings
  List of node collection names.
  Edges in collection can only be inserted if their _to is in any of the collections here.
  isDisjoint* boolean
  Whether the graph is a Disjoint SmartGraph.
  isSatellite* boolean
  Whether the graph is a SatelliteGraph.
  isSmart* boolean
  Whether the graph is a SmartGraph.
  name* string
  The name of the graph.
  numberOfShards* integer
  Number of shards created for every new collection in the graph.
  orphanCollections* array of strings
  An array of additional node collections. Documents in these collections do not have edges within this graph.
  replicationFactor* integer
  The replication factor used for every new collection in the graph. For SatelliteGraphs, it is the string "satellite".
  smartGraphAttribute string
  Name of the sharding attribute in the SmartGraph case.
  writeConcern integer
  The default write concern for new collections in the graph. It determines how many copies of each shard are required to be in sync on the different DB-Servers. If there are less than these many copies in the cluster, a shard refuses to write. Writes to shards with enough up-to-date copies succeed at the same time, however. The value of writeConcern cannot be greater than replicationFactor. For SatelliteGraphs, the writeConcern is automatically controlled to equal the number of DB-Servers and the attribute is not available. (cluster only)
400 Bad Request
Returned if the request is in an invalid format.
- code* integer
  The HTTP response status code.
- error* boolean
  A flag indicating that an error occurred.
- errorMessage* string
  A descriptive error message.
- errorNum* integer
  The ArangoDB error number for the error that occurred.
403 Forbidden
Returned if your user has insufficient rights. In order to modify a graph, you need to have at least the following privileges:
- Administrate access on the database.
- Read Only access on every collection used within this graph.
- code* integer
  The HTTP response status code.
- error* boolean
  A flag indicating that an error occurred.
- errorMessage* string
  A descriptive error message.
- errorNum* integer
  The ArangoDB error number for the error that occurred.
404 Not Found
Returned if no graph with this name can be found.
- code* integer
  The HTTP response status code.
- error* boolean
  A flag indicating that an error occurred.
- errorMessage* string
  A descriptive error message.
- errorNum* integer
  The ArangoDB error number for the error that occurred.

Examples

curl -X POST --header 'accept: application/json' --data-binary @- --dump - 'http://localhost:8529/_api/gharial/social/vertex' <<'EOF'
{
  "collection": "otherNodes"
}
EOF

Show output

HTTP/1.1 202 Accepted
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: 241
content-security-policy: frame-ancestors 'self'; form-action 'self';
etag: _kKbjv2K--_
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

{ 
  "error" : false, 
  "code" : 202, 
  "graph" : { 
    "_key" : "social", 
    "edgeDefinitions" : [ 
      { 
        "collection" : "relation", 
        "from" : [ 
          "female", 
          "male" 
        ], 
        "to" : [ 
          "female", 
          "male" 
        ] 
      } 
    ], 
    "orphanCollections" : [ 
      "otherNodes" 
    ], 
    "_rev" : "_kKbjv2K--_", 
    "_id" : "_graphs/social", 
    "name" : "social" 
  } 
}

Remove a node collection

DELETE /_db/{database-name}/_api/gharial/{graph}/vertex/{collection}

Removes a node collection from the list of the graph’s orphan collections. It can optionally delete the collection if it is not used in any other graph.

You cannot remove node collections that are used in one of the edge definitions of the graph. You need to modify or remove the edge definition first in order to fully remove a node collection from the graph.

Path Parameters

database-name* string
The name of the database.
graph* string
The name of the graph.
collection* string
The name of the node collection.

Query Parameters

dropCollection boolean (default: false)
Drop the collection in addition to removing it from the graph. The collection is only dropped if it is not used in other graphs.

HTTP Headers

Responses

200 OK
Returned if the node collection was removed from the graph successfully and waitForSync is true.
- code* integer
  The HTTP response status code.
- error* boolean
  A flag indicating that no error occurred.
- graph* object
  The information about the newly created graph
  _id* string
  The internal id value of this graph.
  _rev* string
  The revision of this graph. Can be used to make sure to not override concurrent modifications to this graph.
  edgeDefinitions* array of objects
  An array of definitions for the relations of the graph. Each has the following type:
  collection* string
  Name of the edge collection, where the edges are stored in.
  from* array of strings
  List of node collection names. Edges in collection can only be inserted if their _from is in any of the collections here.
  to* array of strings
  List of node collection names.
  Edges in collection can only be inserted if their _to is in any of the collections here.
  isDisjoint* boolean
  Whether the graph is a Disjoint SmartGraph.
  isSatellite* boolean
  Whether the graph is a SatelliteGraph.
  isSmart* boolean
  Whether the graph is a SmartGraph.
  name* string
  The name of the graph.
  numberOfShards* integer
  Number of shards created for every new collection in the graph.
  orphanCollections* array of strings
  An array of additional node collections. Documents in these collections do not have edges within this graph.
  replicationFactor* integer
  The replication factor used for every new collection in the graph. For SatelliteGraphs, it is the string "satellite".
  smartGraphAttribute string
  Name of the sharding attribute in the SmartGraph case.
  writeConcern integer
  The default write concern for new collections in the graph. It determines how many copies of each shard are required to be in sync on the different DB-Servers. If there are less than these many copies in the cluster, a shard refuses to write. Writes to shards with enough up-to-date copies succeed at the same time, however. The value of writeConcern cannot be greater than replicationFactor. For SatelliteGraphs, the writeConcern is automatically controlled to equal the number of DB-Servers and the attribute is not available. (cluster only)
202 Accepted
Returned if the request was successful but waitForSync is false.
- code* integer
  The HTTP response status code.
- error* boolean
  A flag indicating that no error occurred.
- graph* object
  The information about the newly created graph
  _id* string
  The internal id value of this graph.
  _rev* string
  The revision of this graph. Can be used to make sure to not override concurrent modifications to this graph.
  edgeDefinitions* array of objects
  An array of definitions for the relations of the graph. Each has the following type:
  collection* string
  Name of the edge collection, where the edges are stored in.
  from* array of strings
  List of node collection names. Edges in collection can only be inserted if their _from is in any of the collections here.
  to* array of strings
  List of node collection names.
  Edges in collection can only be inserted if their _to is in any of the collections here.
  isDisjoint* boolean
  Whether the graph is a Disjoint SmartGraph.
  isSatellite* boolean
  Whether the graph is a SatelliteGraph.
  isSmart* boolean
  Whether the graph is a SmartGraph.
  name* string
  The name of the graph.
  numberOfShards* integer
  Number of shards created for every new collection in the graph.
  orphanCollections* array of strings
  An array of additional node collections. Documents in these collections do not have edges within this graph.
  replicationFactor* integer
  The replication factor used for every new collection in the graph. For SatelliteGraphs, it is the string "satellite".
  smartGraphAttribute string
  Name of the sharding attribute in the SmartGraph case.
  writeConcern integer
  The default write concern for new collections in the graph. It determines how many copies of each shard are required to be in sync on the different DB-Servers. If there are less than these many copies in the cluster, a shard refuses to write. Writes to shards with enough up-to-date copies succeed at the same time, however. The value of writeConcern cannot be greater than replicationFactor. For SatelliteGraphs, the writeConcern is automatically controlled to equal the number of DB-Servers and the attribute is not available. (cluster only)
400 Bad Request
Returned if the node collection is still used in an edge definition. In this case it cannot be removed from the graph yet, it has to be removed from the edge definition first.
- code* integer
  The HTTP response status code.
- error* boolean
  A flag indicating that an error occurred.
- errorMessage* string
  A descriptive error message.
- errorNum* integer
  The ArangoDB error number for the error that occurred.
403 Forbidden
Returned if your user has insufficient rights. In order to drop a node, you need to have at least the following privileges:
- Administrate access on the database.
- code* integer
  The HTTP response status code.
- error* boolean
  A flag indicating that an error occurred.
- errorMessage* string
  A descriptive error message.
- errorNum* integer
  The ArangoDB error number for the error that occurred.
404 Not Found
Returned if no graph with this name can be found.
- code* integer
  The HTTP response status code.
- error* boolean
  A flag indicating that an error occurred.
- errorMessage* string
  A descriptive error message.
- errorNum* integer
  The ArangoDB error number for the error that occurred.

Examples

You can remove node collections that are not used in any edge definition:

curl -X DELETE --header 'accept: application/json' --dump - 'http://localhost:8529/_api/gharial/social/vertex/otherNodes'

Show output

HTTP/1.1 202 Accepted
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: 229
content-security-policy: frame-ancestors 'self'; form-action 'self';
etag: _kKbjwpC---
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

{ 
  "error" : false, 
  "code" : 202, 
  "graph" : { 
    "_key" : "social", 
    "edgeDefinitions" : [ 
      { 
        "collection" : "relation", 
        "from" : [ 
          "female", 
          "male" 
        ], 
        "to" : [ 
          "female", 
          "male" 
        ] 
      } 
    ], 
    "orphanCollections" : [ ], 
    "_rev" : "_kKbjwpC---", 
    "_id" : "_graphs/social", 
    "name" : "social" 
  } 
}

You cannot remove node collections that are used in edge definitions:

curl -X DELETE --header 'accept: application/json' --dump - 'http://localhost:8529/_api/gharial/social/vertex/male'

Show output

HTTP/1.1 400 Bad Request
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: 106
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

{ 
  "code" : 400, 
  "error" : true, 
  "errorMessage" : "collection is not in list of orphan collections", 
  "errorNum" : 1928 
}

List edge collections

GET /_db/{database-name}/_api/gharial/{graph}/edge

Lists all edge collections within this graph.

Path Parameters

database-name* string
The name of the database.
graph* string
The name of the graph.

Query Parameters

HTTP Headers

Responses

200 OK
Is returned if the edge definitions can be listed.
- code* integer
  The HTTP response status code.
- collections* array of strings
  A list of all edge collections used in the edge definitions of this graph.
- error* boolean
  A flag indicating that no error occurred.
404 Not Found
Returned if no graph with this name can be found.
- code* integer
  The HTTP response status code.
- error* boolean
  A flag indicating that an error occurred.
- errorMessage* string
  A descriptive error message.
- errorNum* integer
  The ArangoDB error number for the error that occurred.

Examples

curl --header 'accept: application/json' --dump - http://localhost:8529/_api/gharial/social/edge

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: 53
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

{ 
  "error" : false, 
  "code" : 200, 
  "collections" : [ 
    "relation" 
  ] 
}

Add an edge definition

POST /_db/{database-name}/_api/gharial/{graph}/edge

Adds an additional edge definition to the graph.

This edge definition has to contain a collection and an array of each from and to node collections. An edge definition can only be added if this definition is either not used in any other graph, or it is used with exactly the same definition. For example, it is not possible to store a definition “e” from “v1” to “v2” in one graph, and “e” from “v2” to “v1” in another graph, but both can have “e” from “v1” to “v2”.

Additionally, collection creation options can be set.

Path Parameters

database-name* string
The name of the database.
graph* string
The name of the graph.

Query Parameters

HTTP Headers

Request Body application/json object

collection* string
The name of the edge collection to be used.
from* array of strings
One or many node collections that can contain source nodes.
options object
A JSON object to set options for creating collections within this edge definition.
- satellites array of strings
  An array of collection names that is used to create SatelliteCollections for a (Disjoint) SmartGraph using SatelliteCollections. Each array element must be a string and a valid collection name. The collection type cannot be modified later.
to* array of strings
One or many node collections that can contain target nodes.

Responses

201 Created
Returned if the definition can be added successfully and waitForSync is enabled for the _graphs collection. The response body contains the graph configuration that has been stored.
- code* integer
  The HTTP response status code.
- error* boolean
  A flag indicating that no error occurred.
- graph* object
  The information about the modified graph.
  _id* string
  The internal id value of this graph.
  _rev* string
  The revision of this graph. Can be used to make sure to not override concurrent modifications to this graph.
  edgeDefinitions* array of objects
  An array of definitions for the relations of the graph. Each has the following type:
  collection* string
  Name of the edge collection, where the edges are stored in.
  from* array of strings
  List of node collection names. Edges in collection can only be inserted if their _from is in any of the collections here.
  to* array of strings
  List of node collection names.
  Edges in collection can only be inserted if their _to is in any of the collections here.
  isDisjoint* boolean
  Whether the graph is a Disjoint SmartGraph.
  isSatellite* boolean
  Whether the graph is a SatelliteGraph.
  isSmart* boolean
  Whether the graph is a SmartGraph.
  name* string
  The name of the graph.
  numberOfShards* integer
  Number of shards created for every new collection in the graph.
  orphanCollections* array of strings
  An array of additional node collections. Documents in these collections do not have edges within this graph.
  replicationFactor* integer
  The replication factor used for every new collection in the graph. For SatelliteGraphs, it is the string "satellite".
  smartGraphAttribute string
  Name of the sharding attribute in the SmartGraph case.
  writeConcern integer
  The default write concern for new collections in the graph. It determines how many copies of each shard are required to be in sync on the different DB-Servers. If there are less than these many copies in the cluster, a shard refuses to write. Writes to shards with enough up-to-date copies succeed at the same time, however. The value of writeConcern cannot be greater than replicationFactor. For SatelliteGraphs, the writeConcern is automatically controlled to equal the number of DB-Servers and the attribute is not available. (cluster only)
202 Accepted
Returned if the definition can be added successfully and waitForSync is disabled for the _graphs collection. The response body contains the graph configuration that has been stored.
- code* integer
  The HTTP response status code.
- error* boolean
  A flag indicating that no error occurred.
- graph* object
  The information about the modified graph.
  _id* string
  The internal id value of this graph.
  _rev* string
  The revision of this graph. Can be used to make sure to not override concurrent modifications to this graph.
  edgeDefinitions* array of objects
  An array of definitions for the relations of the graph. Each has the following type:
  collection* string
  Name of the edge collection, where the edges are stored in.
  from* array of strings
  List of node collection names. Edges in collection can only be inserted if their _from is in any of the collections here.
  to* array of strings
  List of node collection names.
  Edges in collection can only be inserted if their _to is in any of the collections here.
  isDisjoint* boolean
  Whether the graph is a Disjoint SmartGraph.
  isSatellite* boolean
  Whether the graph is a SatelliteGraph.
  isSmart* boolean
  Whether the graph is a SmartGraph.
  name* string
  The name of the graph.
  numberOfShards* integer
  Number of shards created for every new collection in the graph.
  orphanCollections* array of strings
  An array of additional node collections. Documents in these collections do not have edges within this graph.
  replicationFactor* integer
  The replication factor used for every new collection in the graph. For SatelliteGraphs, it is the string "satellite".
  smartGraphAttribute string
  Name of the sharding attribute in the SmartGraph case.
  writeConcern integer
  The default write concern for new collections in the graph. It determines how many copies of each shard are required to be in sync on the different DB-Servers. If there are less than these many copies in the cluster, a shard refuses to write. Writes to shards with enough up-to-date copies succeed at the same time, however. The value of writeConcern cannot be greater than replicationFactor. For SatelliteGraphs, the writeConcern is automatically controlled to equal the number of DB-Servers and the attribute is not available. (cluster only)
400 Bad Request
Returned if the edge definition can not be added. This can be because it is ill-formed, or if there is an edge definition with the same edge collection but different from and to node collections in any other graph.
- code* integer
  The HTTP response status code.
- error* boolean
  A flag indicating that an error occurred.
- errorMessage* string
  A descriptive error message.
- errorNum* integer
  The ArangoDB error number for the error that occurred.
403 Forbidden
Returned if your user has insufficient rights. In order to modify a graph, you need to have at least the following privileges:
- Administrate access on the database.
- code* integer
  The HTTP response status code.
- error* boolean
  A flag indicating that an error occurred.
- errorMessage* string
  A descriptive error message.
- errorNum* integer
  The ArangoDB error number for the error that occurred.
404 Not Found
Returned if no graph with this name can be found.
- code* integer
  The HTTP response status code.
- error* boolean
  A flag indicating that an error occurred.
- errorMessage* string
  A descriptive error message.
- errorNum* integer
  The ArangoDB error number for the error that occurred.

Examples

curl -X POST --header 'accept: application/json' --data-binary @- --dump - http://localhost:8529/_api/gharial/social/edge
{
  "collection": "works_in",
  "from": [
    "female",
    "male"
  ],
  "to": [
    "city"
  ]
}

Show output

HTTP/1.1 202 Accepted
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: 294
content-security-policy: frame-ancestors 'self'; form-action 'self';
etag: _hg5kyX---_
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

{ 
  "error" : false, 
  "code" : 202, 
  "graph" : { 
    "_key" : "social", 
    "edgeDefinitions" : [ 
      { 
        "collection" : "relation", 
        "from" : [ 
          "female", 
          "male" 
        ], 
        "to" : [ 
          "female", 
          "male" 
        ] 
      }, 
      { 
        "collection" : "works_in", 
        "from" : [ 
          "female", 
          "male" 
        ], 
        "to" : [ 
          "city" 
        ] 
      } 
    ], 
    "orphanCollections" : [ ], 
    "_rev" : "_hg5kyX---_", 
    "_id" : "_graphs/social", 
    "name" : "social" 
  } 
}

Replace an edge definition

PUT /_db/{database-name}/_api/gharial/{graph}/edge/{collection}

Change the node collections of one specific edge definition. This modifies all occurrences of this definition in all graphs known to your database.

Path Parameters

database-name* string
The name of the database.
graph* string
The name of the graph.
collection* string
The name of the edge collection used in the edge definition.

Query Parameters

waitForSync boolean
Define if the request should wait until synced to disk.
dropCollections boolean (default: false)
Drop the edge collection in addition to removing it from the graph. The collection is only dropped if it is not used in other graphs.

HTTP Headers

Request Body application/json object

collection* string
The name of the edge collection to modify.
from* array of strings
One or many node collections that can contain source nodes.
options object
A JSON object to set options for modifying collections within this edge definition.
- satellites array of strings
  An array of collection names that is used to create SatelliteCollections for a (Disjoint) SmartGraph using SatelliteCollections. Each array element must be a string and a valid collection name. The collection type cannot be modified later.
to* array of strings
One or many node collections that can contain target nodes.

Responses

201 Created
Returned if the request was successful and waitForSync is true.
- code* integer
  The HTTP response status code.
- error* boolean
  A flag indicating that no error occurred.
- graph* object
  The information about the modified graph.
  _id* string
  The internal id value of this graph.
  _rev* string
  The revision of this graph. Can be used to make sure to not override concurrent modifications to this graph.
  edgeDefinitions* array of objects
  An array of definitions for the relations of the graph. Each has the following type:
  collection* string
  Name of the edge collection, where the edges are stored in.
  from* array of strings
  List of node collection names. Edges in collection can only be inserted if their _from is in any of the collections here.
  to* array of strings
  List of node collection names.
  Edges in collection can only be inserted if their _to is in any of the collections here.
  isDisjoint* boolean
  Whether the graph is a Disjoint SmartGraph.
  isSatellite* boolean
  Whether the graph is a SatelliteGraph.
  isSmart* boolean
  Whether the graph is a SmartGraph.
  name* string
  The name of the graph.
  numberOfShards* integer
  Number of shards created for every new collection in the graph.
  orphanCollections* array of strings
  An array of additional node collections. Documents in these collections do not have edges within this graph.
  replicationFactor* integer
  The replication factor used for every new collection in the graph. For SatelliteGraphs, it is the string "satellite".
  smartGraphAttribute string
  Name of the sharding attribute in the SmartGraph case.
  writeConcern integer
  The default write concern for new collections in the graph. It determines how many copies of each shard are required to be in sync on the different DB-Servers. If there are less than these many copies in the cluster, a shard refuses to write. Writes to shards with enough up-to-date copies succeed at the same time, however. The value of writeConcern cannot be greater than replicationFactor. For SatelliteGraphs, the writeConcern is automatically controlled to equal the number of DB-Servers and the attribute is not available. (cluster only)
202 Accepted
Returned if the request was successful but waitForSync is false.
- code* integer
  The HTTP response status code.
- error* boolean
  A flag indicating that no error occurred.
- graph* object
  The information about the modified graph.
  _id* string
  The internal id value of this graph.
  _rev* string
  The revision of this graph. Can be used to make sure to not override concurrent modifications to this graph.
  edgeDefinitions* array of objects
  An array of definitions for the relations of the graph. Each has the following type:
  collection* string
  Name of the edge collection, where the edges are stored in.
  from* array of strings
  List of node collection names. Edges in collection can only be inserted if their _from is in any of the collections here.
  to* array of strings
  List of node collection names.
  Edges in collection can only be inserted if their _to is in any of the collections here.
  isDisjoint* boolean
  Whether the graph is a Disjoint SmartGraph.
  isSatellite* boolean
  Whether the graph is a SatelliteGraph.
  isSmart* boolean
  Whether the graph is a SmartGraph.
  name* string
  The name of the graph.
  numberOfShards* integer
  Number of shards created for every new collection in the graph.
  orphanCollections* array of strings
  An array of additional node collections. Documents in these collections do not have edges within this graph.
  replicationFactor* integer
  The replication factor used for every new collection in the graph. For SatelliteGraphs, it is the string "satellite".
  smartGraphAttribute string
  Name of the sharding attribute in the SmartGraph case.
  writeConcern integer
  The default write concern for new collections in the graph. It determines how many copies of each shard are required to be in sync on the different DB-Servers. If there are less than these many copies in the cluster, a shard refuses to write. Writes to shards with enough up-to-date copies succeed at the same time, however. The value of writeConcern cannot be greater than replicationFactor. For SatelliteGraphs, the writeConcern is automatically controlled to equal the number of DB-Servers and the attribute is not available. (cluster only)
400 Bad Request
Returned if the new edge definition is ill-formed and cannot be used.
- code* integer
  The HTTP response status code.
- error* boolean
  A flag indicating that an error occurred.
- errorMessage* string
  A descriptive error message.
- errorNum* integer
  The ArangoDB error number for the error that occurred.
403 Forbidden
Returned if your user has insufficient rights. In order to drop a node, you need to have at least the following privileges:
- Administrate access on the database.
- code* integer
  The HTTP response status code.
- error* boolean
  A flag indicating that an error occurred.
- errorMessage* string
  A descriptive error message.
- errorNum* integer
  The ArangoDB error number for the error that occurred.
404 Not Found
Returned if no graph with this name can be found, or if no edge definition with this name is found in the graph.
- code* integer
  The HTTP response status code.
- error* boolean
  A flag indicating that an error occurred.
- errorMessage* string
  A descriptive error message.
- errorNum* integer
  The ArangoDB error number for the error that occurred.

Examples

curl -X PUT --header 'accept: application/json' --data-binary @- --dump - http://localhost:8529/_api/gharial/social/edge/relation
{
  "collection": "relation",
  "from": [
    "female",
    "male",
    "animal"
  ],
  "to": [
    "female",
    "male",
    "animal"
  ]
}

Show output

HTTP/1.1 202 Accepted
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: 247
content-security-policy: frame-ancestors 'self'; form-action 'self';
etag: _hg5kzb2---
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

{ 
  "error" : false, 
  "code" : 202, 
  "graph" : { 
    "_key" : "social", 
    "edgeDefinitions" : [ 
      { 
        "collection" : "relation", 
        "from" : [ 
          "animal", 
          "female", 
          "male" 
        ], 
        "to" : [ 
          "animal", 
          "female", 
          "male" 
        ] 
      } 
    ], 
    "orphanCollections" : [ ], 
    "_rev" : "_hg5kzb2---", 
    "_id" : "_graphs/social", 
    "name" : "social" 
  } 
}

Remove an edge definition

DELETE /_db/{database-name}/_api/gharial/{graph}/edge/{collection}

Remove one edge definition from the graph. This only removes the edge collection from the graph definition. The node collections of the edge definition become orphan collections but otherwise remain untouched and can still be used in your queries.

Path Parameters

database-name* string
The name of the database.
graph* string
The name of the graph.
collection* string
The name of the edge collection used in the edge definition.

Query Parameters

waitForSync boolean
Define if the request should wait until synced to disk.
dropCollections boolean (default: false)
Drop the edge collection in addition to removing it from the graph. The collection is only dropped if it is not used in other graphs.

HTTP Headers

Responses

201 Created
Returned if the edge definition can be removed from the graph and waitForSync is true.
- code* integer
  The HTTP response status code.
- error* boolean
  A flag indicating that no error occurred.
- graph* object
  The information about the modified graph.
  _id* string
  The internal id value of this graph.
  _rev* string
  The revision of this graph. Can be used to make sure to not override concurrent modifications to this graph.
  edgeDefinitions* array of objects
  An array of definitions for the relations of the graph. Each has the following type:
  collection* string
  Name of the edge collection, where the edges are stored in.
  from* array of strings
  List of node collection names. Edges in collection can only be inserted if their _from is in any of the collections here.
  to* array of strings
  List of node collection names.
  Edges in collection can only be inserted if their _to is in any of the collections here.
  isDisjoint* boolean
  Whether the graph is a Disjoint SmartGraph.
  isSatellite* boolean
  Whether the graph is a SatelliteGraph.
  isSmart* boolean
  Whether the graph is a SmartGraph.
  name* string
  The name of the graph.
  numberOfShards* integer
  Number of shards created for every new collection in the graph.
  orphanCollections* array of strings
  An array of additional node collections. Documents in these collections do not have edges within this graph.
  replicationFactor* integer
  The replication factor used for every new collection in the graph. For SatelliteGraphs, it is the string "satellite".
  smartGraphAttribute string
  Name of the sharding attribute in the SmartGraph case.
  writeConcern integer
  The default write concern for new collections in the graph. It determines how many copies of each shard are required to be in sync on the different DB-Servers. If there are less than these many copies in the cluster, a shard refuses to write. Writes to shards with enough up-to-date copies succeed at the same time, however. The value of writeConcern cannot be greater than replicationFactor. For SatelliteGraphs, the writeConcern is automatically controlled to equal the number of DB-Servers and the attribute is not available. (cluster only)
202 Accepted
Returned if the edge definition can be removed from the graph and waitForSync is false.
- code* integer
  The HTTP response status code.
- error* boolean
  A flag indicating that no error occurred.
- graph* object
  The information about the modified graph.
  _id* string
  The internal id value of this graph.
  _rev* string
  The revision of this graph. Can be used to make sure to not override concurrent modifications to this graph.
  edgeDefinitions* array of objects
  An array of definitions for the relations of the graph. Each has the following type:
  collection* string
  Name of the edge collection, where the edges are stored in.
  from* array of strings
  List of node collection names. Edges in collection can only be inserted if their _from is in any of the collections here.
  to* array of strings
  List of node collection names.
  Edges in collection can only be inserted if their _to is in any of the collections here.
  isDisjoint* boolean
  Whether the graph is a Disjoint SmartGraph.
  isSatellite* boolean
  Whether the graph is a SatelliteGraph.
  isSmart* boolean
  Whether the graph is a SmartGraph.
  name* string
  The name of the graph.
  numberOfShards* integer
  Number of shards created for every new collection in the graph.
  orphanCollections* array of strings
  An array of additional node collections. Documents in these collections do not have edges within this graph.
  replicationFactor* integer
  The replication factor used for every new collection in the graph. For SatelliteGraphs, it is the string "satellite".
  smartGraphAttribute string
  Name of the sharding attribute in the SmartGraph case.
  writeConcern integer
  The default write concern for new collections in the graph. It determines how many copies of each shard are required to be in sync on the different DB-Servers. If there are less than these many copies in the cluster, a shard refuses to write. Writes to shards with enough up-to-date copies succeed at the same time, however. The value of writeConcern cannot be greater than replicationFactor. For SatelliteGraphs, the writeConcern is automatically controlled to equal the number of DB-Servers and the attribute is not available. (cluster only)
403 Forbidden
Returned if your user has insufficient rights. In order to drop a node, you need to have at least the following privileges:
- Administrate access on the database.
- code* integer
  The HTTP response status code.
- error* boolean
  A flag indicating that an error occurred.
- errorMessage* string
  A descriptive error message.
- errorNum* integer
  The ArangoDB error number for the error that occurred.
404 Not Found
Returned if no graph with this name can be found, or if no edge definition with this name is found in the graph.
- code* integer
  The HTTP response status code.
- error* boolean
  A flag indicating that an error occurred.
- errorMessage* string
  A descriptive error message.
- errorNum* integer
  The ArangoDB error number for the error that occurred.

Examples

curl -X DELETE --header 'accept: application/json' --dump - http://localhost:8529/_api/gharial/social/edge/relation

Show output

HTTP/1.1 202 Accepted
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: 171
content-security-policy: frame-ancestors 'self'; form-action 'self';
etag: _hg5kzfK---
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

{ 
  "error" : false, 
  "code" : 202, 
  "graph" : { 
    "_key" : "social", 
    "edgeDefinitions" : [ ], 
    "orphanCollections" : [ 
      "female", 
      "male" 
    ], 
    "_rev" : "_hg5kzfK---", 
    "_id" : "_graphs/social", 
    "name" : "social" 
  } 
}

Nodes

Create a node

POST /_db/{database-name}/_api/gharial/{graph}/vertex/{collection}

Adds a node to the given collection.

Path Parameters

database-name* string
The name of the database.
graph* string
The name of the graph.
collection* string
The name of the node collection the node should be inserted into.

Query Parameters

waitForSync boolean
Define if the request should wait until synced to disk.
returnNew boolean (default: false)
Whether to additionally include the complete new document under the new attribute in the result.

HTTP Headers

x-arango-trx-id string
To make this operation a part of a Stream Transaction, set this header to the transaction ID returned by the POST /_api/transaction/begin call.

Request Body application/json object

The body has to be a JSON object you want to store as a node document.

Responses

201 Created
Returned if the node can be added and waitForSync is true.
- code* integer
  The HTTP response status code.
- error* boolean
  A flag indicating that no error occurred.
- new object
  The complete newly written node document. Includes all written attributes in the request body and all internal attributes generated by ArangoDB. Only present if returnNew is true.
  _id* string
  The _id value of the stored data.
  _key* string
  The _key value of the stored data.
  _rev* string
  The _rev value of the stored data.
- vertex* object
  The internal attributes for the node.
  _id* string
  The _id value of the stored data.
  _key* string
  The _key value of the stored data.
  _rev* string
  The _rev value of the stored data.
202 Accepted
Returned if the request was successful but waitForSync is false.
- code* integer
  The HTTP response status code.
- error* boolean
  A flag indicating that no error occurred.
- new object
  The complete newly written node document. Includes all written attributes in the request body and all internal attributes generated by ArangoDB. Only present if returnNew is true.
  _id* string
  The _id value of the stored data.
  _key* string
  The _key value of the stored data.
  _rev* string
  The _rev value of the stored data.
- vertex* object
  The internal attributes generated while storing the node. Does not include any attribute given in request body.
  _id* string
  The _id value of the stored data.
  _key* string
  The _key value of the stored data.
  _rev* string
  The _rev value of the stored data.
403 Forbidden
Returned if your user has insufficient rights. In order to insert nodes into the graph, you need to have at least the following privileges:
- Read Only access on the database.
- Write access on the given collection.
- code* integer
  The HTTP response status code.
- error* boolean
  A flag indicating that an error occurred.
- errorMessage* string
  A descriptive error message.
- errorNum* integer
  The ArangoDB error number for the error that occurred.
404 Not Found
The graph cannot be found or the collection is not part of the graph.
This error also occurs if you try to run this operation as part of a Stream Transaction but the transaction ID specified in the x-arango-trx-id header is unknown to the server.
- code* integer
  The HTTP response status code.
- error* boolean
  A flag indicating that an error occurred.
- errorMessage* string
  A descriptive error message.
- errorNum* integer
  The ArangoDB error number for the error that occurred.
410 Gone
This error occurs if you try to run this operation as part of a Stream Transaction that has just been canceled or timed out.
- code* integer
  The HTTP response status code.
- error* boolean
  A flag indicating that an error occurred.
- errorMessage* string
  A descriptive error message.
- errorNum* integer
  The ArangoDB error number for the error that occurred.

Examples

curl -X POST --header 'accept: application/json' --data-binary @- --dump - http://localhost:8529/_api/gharial/social/vertex/male
{
  "name": "Francis"
}

Show output

HTTP/1.1 202 Accepted
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: 92
content-security-policy: frame-ancestors 'self'; form-action 'self';
etag: _hg5kzo2---
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

{ 
  "error" : false, 
  "code" : 202, 
  "vertex" : { 
    "_id" : "male/71018", 
    "_key" : "71018", 
    "_rev" : "_hg5kzo2---" 
  } 
}

Get a node

GET /_db/{database-name}/_api/gharial/{graph}/vertex/{collection}/{vertex}

Gets a node from the given collection.

Path Parameters

database-name* string
The name of the database.
graph* string
The name of the graph.
collection* string
The name of the node collection the node belongs to.
vertex* string
The _key attribute of the node.

Query Parameters

HTTP Headers

If-Match string
If you provide an If-Match header, it must contain exactly one ETag. The document is returned if it has the same revision as the given ETag. Otherwise, an error with HTTP status code 412 is returned.
If-None-Match string
If you provide an If-None-Match header, it must contain exactly one ETag. The document is returned if it has a different revision as the given ETag. Otherwise, an error with HTTP status code 304 is returned.
x-arango-trx-id string
To make this operation a part of a Stream Transaction, set this header to the transaction ID returned by the POST /_api/transaction/begin call.

Responses

200 OK
Returned if the node can be found.
- code* integer
  The HTTP response status code.
- error* boolean
  A flag indicating that no error occurred.
- vertex* object
  The complete node.
  _id* string
  The _id value of the stored data.
  _key* string
  The _key value of the stored data.
  _rev* string
  The _rev value of the stored data.
304 Not Modified
The If-None-Match header has been specified and the currently stored node still has this revision value. There was no update since the last time the node was fetched by the caller.
- code* integer
  The HTTP response status code.
- error* boolean
  A flag indicating that an error occurred.
- errorMessage* string
  A descriptive error message.
- errorNum* integer
  The ArangoDB error number for the error that occurred.
403 Forbidden
Returned if your user has insufficient rights. In order to update nodes in the graph, you need to have at least the following privileges:
- Read Only access on the database.
- Read Only access on the given collection.
- code* integer
  The HTTP response status code.
- error* boolean
  A flag indicating that an error occurred.
- errorMessage* string
  A descriptive error message.
- errorNum* integer
  The ArangoDB error number for the error that occurred.
404 Not Found
Returned in the following cases:
- The graph cannot be found.
- The collection is not part of the graph.
- The node does not exist.
This error also occurs if you try to run this operation as part of a Stream Transaction but the transaction ID specified in the x-arango-trx-id header is unknown to the server.
- code* integer
  The HTTP response status code.
- error* boolean
  A flag indicating that an error occurred.
- errorMessage* string
  A descriptive error message.
- errorNum* integer
  The ArangoDB error number for the error that occurred.
410 Gone
This error occurs if you try to run this operation as part of a Stream Transaction that has just been canceled or timed out.
- code* integer
  The HTTP response status code.
- error* boolean
  A flag indicating that an error occurred.
- errorMessage* string
  A descriptive error message.
- errorNum* integer
  The ArangoDB error number for the error that occurred.
412 Precondition Failed
The If-Match header has been specified but the stored document’s revision is different.
- code* integer
  The HTTP response status code.
- error* boolean
  A flag indicating that an error occurred.
- errorMessage* string
  A descriptive error message.
- errorNum* integer
  The ArangoDB error number for the error that occurred.

Examples

curl --header 'accept: application/json' --dump - http://localhost:8529/_api/gharial/social/vertex/female/alice

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: 109
content-security-policy: frame-ancestors 'self'; form-action 'self';
etag: _hg5kz0u---
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

{ 
  "error" : false, 
  "code" : 200, 
  "vertex" : { 
    "_key" : "alice", 
    "_id" : "female/alice", 
    "_rev" : "_hg5kz0u---", 
    "name" : "Alice" 
  } 
}

Update a node

PATCH /_db/{database-name}/_api/gharial/{graph}/vertex/{collection}/{vertex}

Updates the data of the specific node in the collection.

Path Parameters

database-name* string
The name of the database.
graph* string
The name of the graph.
collection* string
The name of the node collection the node belongs to.
vertex* string
The _key attribute of the node.

Query Parameters

waitForSync boolean
Define if the request should wait until synced to disk.
keepNull boolean (default: true)
Define if values set to null should be stored. By default (true), the given documents attribute(s) are set to null. If this parameter is set to false, top-level attribute and sub-attributes with a null value in the request are removed from the document (but not attributes of objects that are nested inside of arrays).
returnOld boolean (default: false)
Whether to additionally include the complete previous document under the old attribute in the result.
returnNew boolean (default: false)
Whether to additionally include the complete new document under the new attribute in the result.

HTTP Headers

If-Match string
If you provide an If-Match header, it must contain exactly one ETag. The document is updated if it has the same revision as the given ETag. Otherwise, an error with HTTP status code 412 is returned.
x-arango-trx-id string
To make this operation a part of a Stream Transaction, set this header to the transaction ID returned by the POST /_api/transaction/begin call.

Request Body application/json object

The body has to be a JSON object containing exactly the attributes that should be overwritten. All other attributes remain unchanged.

Responses

200 OK
Returned if the node can be updated, and waitForSync is true.
- code* integer
  The HTTP response status code.
- error* boolean
  A flag indicating that no error occurred.
- new object
  The complete newly written node document. Includes all written attributes in the request body and all internal attributes generated by ArangoDB. Only present if returnNew is true.
  _id* string
  The _id value of the stored data.
  _key* string
  The _key value of the stored data.
  _rev* string
  The _rev value of the stored data.
- old object
  The complete overwritten node document. Includes all attributes stored before this operation. Only present if returnOld is true.
  _id* string
  The _id value of the stored data.
  _key* string
  The _key value of the stored data.
  _rev* string
  The _rev value of the stored data.
- vertex* object
  The internal attributes for the node.
  _id* string
  The _id value of the stored data.
  _key* string
  The _key value of the stored data.
  _rev* string
  The _rev value of the stored data.
202 Accepted
Returned if the request was successful, and waitForSync is false.
- code* integer
  The HTTP response status code.
- error* boolean
  A flag indicating that no error occurred.
- new object
  The complete newly written node document. Includes all written attributes in the request body and all internal attributes generated by ArangoDB. Only present if returnNew is true.
  _id* string
  The _id value of the stored data.
  _key* string
  The _key value of the stored data.
  _rev* string
  The _rev value of the stored data.
- old object
  The complete overwritten node document. Includes all attributes stored before this operation. Only present if returnOld is true.
  _id* string
  The _id value of the stored data.
  _key* string
  The _key value of the stored data.
  _rev* string
  The _rev value of the stored data.
- vertex* object
  The internal attributes for the node.
  _id* string
  The _id value of the stored data.
  _key* string
  The _key value of the stored data.
  _rev* string
  The _rev value of the stored data.
403 Forbidden
Returned if your user has insufficient rights. In order to update nodes in the graph, you need to have at least the following privileges:
- Read Only access on the database.
- Write access on the given collection.
- code* integer
  The HTTP response status code.
- error* boolean
  A flag indicating that an error occurred.
- errorMessage* string
  A descriptive error message.
- errorNum* integer
  The ArangoDB error number for the error that occurred.
404 Not Found
Returned in the following cases:
- The graph cannot be found.
- The collection is not part of the graph.
- The node to update does not exist.
This error also occurs if you try to run this operation as part of a Stream Transaction but the transaction ID specified in the x-arango-trx-id header is unknown to the server.
- code* integer
  The HTTP response status code.
- error* boolean
  A flag indicating that an error occurred.
- errorMessage* string
  A descriptive error message.
- errorNum* integer
  The ArangoDB error number for the error that occurred.
410 Gone
This error occurs if you try to run this operation as part of a Stream Transaction that has just been canceled or timed out.
- code* integer
  The HTTP response status code.
- error* boolean
  A flag indicating that an error occurred.
- errorMessage* string
  A descriptive error message.
- errorNum* integer
  The ArangoDB error number for the error that occurred.
412 Precondition Failed
The If-Match header has been specified but the stored document’s revision is different.
- code* integer
  The HTTP response status code.
- error* boolean
  A flag indicating that an error occurred.
- errorMessage* string
  A descriptive error message.
- errorNum* integer
  The ArangoDB error number for the error that occurred.

Examples

curl -X PATCH --header 'accept: application/json' --data-binary @- --dump - http://localhost:8529/_api/gharial/social/vertex/female/alice
{
  "age": 26
}

Show output

HTTP/1.1 202 Accepted
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: 118
content-security-policy: frame-ancestors 'self'; form-action 'self';
etag: _hg5k0_a--B
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

{ 
  "error" : false, 
  "code" : 202, 
  "vertex" : { 
    "_id" : "female/alice", 
    "_key" : "alice", 
    "_oldRev" : "_hg5k0_W---", 
    "_rev" : "_hg5k0_a--B" 
  } 
}

Replace a node

PUT /_db/{database-name}/_api/gharial/{graph}/vertex/{collection}/{vertex}

Replaces the data of a node in the collection.

Path Parameters

database-name* string
The name of the database.
graph* string
The name of the graph.
collection* string
The name of the node collection the node belongs to.
vertex* string
The _key attribute of the node.

Query Parameters

waitForSync boolean
Define if the request should wait until synced to disk.
keepNull boolean (default: true)
Define if values set to null should be stored. By default (true), the given documents attribute(s) are set to null. If this parameter is set to false, top-level attribute and sub-attributes with a null value in the request are removed from the document (but not attributes of objects that are nested inside of arrays).
returnOld boolean (default: false)
Whether to additionally include the complete previous document under the old attribute in the result.
returnNew boolean (default: false)
Whether to additionally include the complete new document under the new attribute in the result.

HTTP Headers

If-Match string
If you provide an If-Match header, it must contain exactly one ETag. The document is replaced if it has the same revision as the given ETag. Otherwise, an error with HTTP status code 412 is returned.
x-arango-trx-id string
To make this operation a part of a Stream Transaction, set this header to the transaction ID returned by the POST /_api/transaction/begin call.

Request Body application/json object

The body has to be a JSON object you want to replace the existing node document with.

Responses

200 OK
Returned if the node can be replaced, and waitForSync is true.
- code* integer
  The HTTP response status code.
- error* boolean
  A flag indicating that no error occurred.
- new object
  The complete newly written node document. Includes all written attributes in the request body and all internal attributes generated by ArangoDB. Only present if returnNew is true.
  _id* string
  The _id value of the stored data.
  _key* string
  The _key value of the stored data.
  _rev* string
  The _rev value of the stored data.
- old object
  The complete overwritten node document. Includes all attributes stored before this operation. Only present if returnOld is true.
  _id* string
  The _id value of the stored data.
  _key* string
  The _key value of the stored data.
  _rev* string
  The _rev value of the stored data.
- vertex* object
  The internal attributes for the node.
  _id* string
  The _id value of the stored data.
  _key* string
  The _key value of the stored data.
  _rev* string
  The _rev value of the stored data.
202 Accepted
Returned if the node can be replaced, and waitForSync is false.
- code* integer
  The HTTP response status code.
- error* boolean
  A flag indicating that no error occurred.
- new object
  The complete newly written node document. Includes all written attributes in the request body and all internal attributes generated by ArangoDB. Only present if returnNew is true.
  _id* string
  The _id value of the stored data.
  _key* string
  The _key value of the stored data.
  _rev* string
  The _rev value of the stored data.
- old object
  The complete overwritten node document. Includes all attributes stored before this operation. Only present if returnOld is true.
  _id* string
  The _id value of the stored data.
  _key* string
  The _key value of the stored data.
  _rev* string
  The _rev value of the stored data.
- vertex* object
  The internal attributes for the node.
  _id* string
  The _id value of the stored data.
  _key* string
  The _key value of the stored data.
  _rev* string
  The _rev value of the stored data.
403 Forbidden
Returned if your user has insufficient rights. In order to replace nodes in the graph, you need to have at least the following privileges:
- Read Only access on the database.
- Write access on the given collection.
- code* integer
  The HTTP response status code.
- error* boolean
  A flag indicating that an error occurred.
- errorMessage* string
  A descriptive error message.
- errorNum* integer
  The ArangoDB error number for the error that occurred.
404 Not Found
Returned in the following cases:
- The graph cannot be found.
- The collection is not part of the graph.
- The node to replace does not exist.
This error also occurs if you try to run this operation as part of a Stream Transaction but the transaction ID specified in the x-arango-trx-id header is unknown to the server.
- code* integer
  The HTTP response status code.
- error* boolean
  A flag indicating that an error occurred.
- errorMessage* string
  A descriptive error message.
- errorNum* integer
  The ArangoDB error number for the error that occurred.
410 Gone
This error occurs if you try to run this operation as part of a Stream Transaction that has just been canceled or timed out.
- code* integer
  The HTTP response status code.
- error* boolean
  A flag indicating that an error occurred.
- errorMessage* string
  A descriptive error message.
- errorNum* integer
  The ArangoDB error number for the error that occurred.
412 Precondition Failed
The If-Match header has been specified but the stored document’s revision is different.
- code* integer
  The HTTP response status code.
- error* boolean
  A flag indicating that an error occurred.
- errorMessage* string
  A descriptive error message.
- errorNum* integer
  The ArangoDB error number for the error that occurred.

Examples

curl -X PUT --header 'accept: application/json' --data-binary @- --dump - http://localhost:8529/_api/gharial/social/vertex/female/alice
{
  "name": "Alice Cooper",
  "age": 26
}

Show output

HTTP/1.1 202 Accepted
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: 118
content-security-policy: frame-ancestors 'self'; form-action 'self';
etag: _hg5k0N---A
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

{ 
  "error" : false, 
  "code" : 202, 
  "vertex" : { 
    "_id" : "female/alice", 
    "_key" : "alice", 
    "_oldRev" : "_hg5k0Mq---", 
    "_rev" : "_hg5k0N---A" 
  } 
}

Remove a node

DELETE /_db/{database-name}/_api/gharial/{graph}/vertex/{collection}/{vertex}

Removes a node from a collection of the named graph. Additionally removes all incoming and outgoing edges of the node.

Path Parameters

database-name* string
The name of the database.
graph* string
The name of the graph.
collection* string
The name of the node collection the node belongs to.
vertex* string
The _key attribute of the node.

Query Parameters

waitForSync boolean
Define if the request should wait until synced to disk.
returnOld boolean (default: false)
Whether to additionally include the complete previous document under the old attribute in the result.

HTTP Headers

If-Match string
If you provide an If-Match header, it must contain exactly one ETag. The document is deleted if it has the same revision as the given ETag. Otherwise, an error with HTTP status code 412 is returned.
x-arango-trx-id string
To make this operation a part of a Stream Transaction, set this header to the transaction ID returned by the POST /_api/transaction/begin call.

Responses

200 OK
Returned if the node can be removed.
- code* integer
  The HTTP response status code.
- error* boolean
  A flag indicating that no error occurred.
- old object
  The complete deleted node document. Includes all attributes stored before this operation. Only present if returnOld is true.
  _id* string
  The _id value of the stored data.
  _key* string
  The _key value of the stored data.
  _rev* string
  The _rev value of the stored data.
- removed* boolean
  Is set to true if the remove was successful.
202 Accepted
Returned if the request was successful but waitForSync is false.
- code* integer
  The HTTP response status code.
- error* boolean
  A flag indicating that no error occurred.
- old object
  The complete deleted node document. Includes all attributes stored before this operation. Only present if returnOld is true.
  _id* string
  The _id value of the stored data.
  _key* string
  The _key value of the stored data.
  _rev* string
  The _rev value of the stored data.
- removed* boolean
  Is set to true if the remove was successful.
403 Forbidden
Returned if your user has insufficient rights. In order to delete nodes in the graph, you need to have at least the following privileges:
- Read Only access on the database.
- Write access on the given collection.
- code* integer
  The HTTP response status code.
- error* boolean
  A flag indicating that an error occurred.
- errorMessage* string
  A descriptive error message.
- errorNum* integer
  The ArangoDB error number for the error that occurred.
404 Not Found
Returned in the following cases:
- The graph cannot be found.
- The collection is not part of the graph.
- The node to remove does not exist.
This error also occurs if you try to run this operation as part of a Stream Transaction but the transaction ID specified in the x-arango-trx-id header is unknown to the server.
- code* integer
  The HTTP response status code.
- error* boolean
  A flag indicating that an error occurred.
- errorMessage* string
  A descriptive error message.
- errorNum* integer
  The ArangoDB error number for the error that occurred.
410 Gone
This error occurs if you try to run this operation as part of a Stream Transaction that has just been canceled or timed out.
- code* integer
  The HTTP response status code.
- error* boolean
  A flag indicating that an error occurred.
- errorMessage* string
  A descriptive error message.
- errorNum* integer
  The ArangoDB error number for the error that occurred.
412 Precondition Failed
The If-Match header has been specified but the stored document’s revision is different.
- code* integer
  The HTTP response status code.
- error* boolean
  A flag indicating that an error occurred.
- errorMessage* string
  A descriptive error message.
- errorNum* integer
  The ArangoDB error number for the error that occurred.

Examples

curl -X DELETE --header 'accept: application/json' --dump - http://localhost:8529/_api/gharial/social/vertex/female/alice

Show output

HTTP/1.1 202 Accepted
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: 41
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

{ 
  "error" : false, 
  "code" : 202, 
  "removed" : true 
}

Edges

Create an edge

POST /_db/{database-name}/_api/gharial/{graph}/edge/{collection}

Creates a new edge in the specified collection. Within the body the edge has to contain a _from and _to value referencing to valid nodes in the graph. Furthermore, the edge has to be valid according to the edge definitions.

Path Parameters

database-name* string
The name of the database.
graph* string
The name of the graph.
collection* string
The name of the edge collection the edge belongs to.

Query Parameters

waitForSync boolean
Define if the request should wait until synced to disk.
returnNew boolean (default: false)
Whether to additionally include the complete new document under the new attribute in the result.

HTTP Headers

x-arango-trx-id string
To make this operation a part of a Stream Transaction, set this header to the transaction ID returned by the POST /_api/transaction/begin call.

Request Body application/json object

_from* string
The source node of this edge. Has to be valid within the used edge definition.
_to* string
The target node of this edge. Has to be valid within the used edge definition.

Responses

201 Created
Returned if the edge can be created and waitForSync is true.
- code* integer
  The HTTP response status code.
- edge* object
  The internal attributes for the edge.
  _from* string
  The _from value of the stored data.
  _id* string
  The _id value of the stored data.
  _key* string
  The _key value of the stored data.
  _rev* string
  The _rev value of the stored data.
  _to* string
  The _to value of the stored data.
- error* boolean
  A flag indicating that no error occurred.
- new object
  The complete newly written edge document. Includes all written attributes in the request body and all internal attributes generated by ArangoDB. Only present if returnNew is true.
  _from* string
  The _from value of the stored data.
  _id* string
  The _id value of the stored data.
  _key* string
  The _key value of the stored data.
  _rev* string
  The _rev value of the stored data.
  _to* string
  The _to value of the stored data.
202 Accepted
Returned if the request was successful but waitForSync is false.
- code* integer
  The HTTP response status code.
- edge* object
  The internal attributes for the edge.
  _from* string
  The _from value of the stored data.
  _id* string
  The _id value of the stored data.
  _key* string
  The _key value of the stored data.
  _rev* string
  The _rev value of the stored data.
  _to* string
  The _to value of the stored data.
- error* boolean
  A flag indicating that no error occurred.
- new object
  The complete newly written edge document. Includes all written attributes in the request body and all internal attributes generated by ArangoDB. Only present if returnNew is true.
  _from* string
  The _from value of the stored data.
  _id* string
  The _id value of the stored data.
  _key* string
  The _key value of the stored data.
  _rev* string
  The _rev value of the stored data.
  _to* string
  The _to value of the stored data.
400 Bad Request
Returned if the input document is invalid. This can for instance be the case if the _from or _to attribute is missing or malformed.
- code* integer
  The HTTP response status code.
- error* boolean
  A flag indicating that an error occurred.
- errorMessage* string
  A descriptive error message.
- errorNum* integer
  The ArangoDB error number for the error that occurred.
403 Forbidden
Returned if your user has insufficient rights. In order to insert edges into the graph, you need to have at least the following privileges:
- Read Only access on the database.
- Write access on the given collection.
- code* integer
  The HTTP response status code.
- error* boolean
  A flag indicating that an error occurred.
- errorMessage* string
  A descriptive error message.
- errorNum* integer
  The ArangoDB error number for the error that occurred.
404 Not Found
Returned in any of the following cases:
- The graph cannot be found.
- The edge collection is not part of the graph.
- The node collection referenced in the _from or _to attribute is not part of the graph.
- The node collection is part of the graph, but does not exist.
- _from or _to node does not exist.
This error also occurs if you try to run this operation as part of a Stream Transaction but the transaction ID specified in the x-arango-trx-id header is unknown to the server.
- code* integer
  The HTTP response status code.
- error* boolean
  A flag indicating that an error occurred.
- errorMessage* string
  A descriptive error message.
- errorNum* integer
  The ArangoDB error number for the error that occurred.
410 Gone
This error occurs if you try to run this operation as part of a Stream Transaction that has just been canceled or timed out.
- code* integer
  The HTTP response status code.
- error* boolean
  A flag indicating that an error occurred.
- errorMessage* string
  A descriptive error message.
- errorNum* integer
  The ArangoDB error number for the error that occurred.

Examples

curl -X POST --header 'accept: application/json' --data-binary @- --dump - http://localhost:8529/_api/gharial/social/edge/relation
{
  "type": "friend",
  "_from": "female/alice",
  "_to": "female/diana"
}

Show output

HTTP/1.1 202 Accepted
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: 94
content-security-policy: frame-ancestors 'self'; form-action 'self';
etag: _hg5k0hi--_
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

{ 
  "error" : false, 
  "code" : 202, 
  "edge" : { 
    "_id" : "relation/71629", 
    "_key" : "71629", 
    "_rev" : "_hg5k0hi--_" 
  } 
}

Get an edge

GET /_db/{database-name}/_api/gharial/{graph}/edge/{collection}/{edge}

Gets an edge from the given collection.

Path Parameters

database-name* string
The name of the database.
graph* string
The name of the graph.
collection* string
The name of the edge collection the edge belongs to.
edge* string
The _key attribute of the edge.

Query Parameters

HTTP Headers

If-Match string
If you provide an If-Match header, it must contain exactly one ETag. The document is returned if it has the same revision as the given ETag. Otherwise, an error with HTTP status code 412 is returned.
If-None-Match string
If you provide an If-None-Match header, it must contain exactly one ETag. The document is returned if it has a different revision as the given ETag. Otherwise, an error with HTTP status code 304 is returned.
x-arango-trx-id string
To make this operation a part of a Stream Transaction, set this header to the transaction ID returned by the POST /_api/transaction/begin call.

Responses

200 OK
Returned if the edge can be found.
- code* integer
  The HTTP response status code.
- edge* object
  The complete edge.
  _from* string
  The _from value of the stored data.
  _id* string
  The _id value of the stored data.
  _key* string
  The _key value of the stored data.
  _rev* string
  The _rev value of the stored data.
  _to* string
  The _to value of the stored data.
- error* boolean
  A flag indicating that no error occurred.
304 Not Modified
The If-None-Match header has been specified and the currently stored edge still has this revision value. There was no update since the last time the edge was fetched by the caller.
- code* integer
  The HTTP response status code.
- error* boolean
  A flag indicating that an error occurred.
- errorMessage* string
  A descriptive error message.
- errorNum* integer
  The ArangoDB error number for the error that occurred.
403 Forbidden
Returned if your user has insufficient rights. In order to update nodes in the graph, you need to have at least the following privileges:
- Read Only access on the database.
- Read Only access on the given collection.
- code* integer
  The HTTP response status code.
- error* boolean
  A flag indicating that an error occurred.
- errorMessage* string
  A descriptive error message.
- errorNum* integer
  The ArangoDB error number for the error that occurred.
404 Not Found
Returned in the following cases:
- The graph cannot be found.
- The collection is not part of the graph.
- The edge does not exist.
This error also occurs if you try to run this operation as part of a Stream Transaction but the transaction ID specified in the x-arango-trx-id header is unknown to the server.
- code* integer
  The HTTP response status code.
- error* boolean
  A flag indicating that an error occurred.
- errorMessage* string
  A descriptive error message.
- errorNum* integer
  The ArangoDB error number for the error that occurred.
410 Gone
This error occurs if you try to run this operation as part of a Stream Transaction that has just been canceled or timed out.
- code* integer
  The HTTP response status code.
- error* boolean
  A flag indicating that an error occurred.
- errorMessage* string
  A descriptive error message.
- errorNum* integer
  The ArangoDB error number for the error that occurred.
412 Precondition Failed
The If-Match header has been specified but the stored document’s revision is different.
- code* integer
  The HTTP response status code.
- error* boolean
  A flag indicating that an error occurred.
- errorMessage* string
  A descriptive error message.
- errorNum* integer
  The ArangoDB error number for the error that occurred.

Examples

curl --header 'accept: application/json' --dump - http://localhost:8529/_api/gharial/social/edge/relation/71727

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: 172
content-security-policy: frame-ancestors 'self'; form-action 'self';
etag: _hg5k0s6--C
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

{ 
  "error" : false, 
  "code" : 200, 
  "edge" : { 
    "_key" : "71727", 
    "_id" : "relation/71727", 
    "_from" : "male/charly", 
    "_to" : "female/diana", 
    "_rev" : "_hg5k0s6--C", 
    "type" : "married", 
    "vertex" : "charly" 
  } 
}

Update an edge

PATCH /_db/{database-name}/_api/gharial/{graph}/edge/{collection}/{edge}

Partially modify the data of the specific edge in the collection.

Path Parameters

database-name* string
The name of the database.
graph* string
The name of the graph.
collection* string
The name of the edge collection the edge belongs to.
edge* string
The _key attribute of the node.

Query Parameters

waitForSync boolean
Define if the request should wait until synced to disk.
keepNull boolean (default: true)
Define if values set to null should be stored. By default (true), the given documents attribute(s) are set to null. If this parameter is set to false, top-level attribute and sub-attributes with a null value in the request are removed from the document (but not attributes of objects that are nested inside of arrays).
returnOld boolean (default: false)
Whether to additionally include the complete previous document under the old attribute in the result.
returnNew boolean (default: false)
Whether to additionally include the complete new document under the new attribute in the result.

HTTP Headers

If-Match string
If you provide an If-Match header, it must contain exactly one ETag. The document is updated if it has the same revision as the given ETag. Otherwise, an error with HTTP status code 412 is returned.
x-arango-trx-id string
To make this operation a part of a Stream Transaction, set this header to the transaction ID returned by the POST /_api/transaction/begin call.

Request Body application/json object

The body has to be a JSON object containing exactly the attributes that should be overwritten. All other attributes remain unchanged.

Responses

200 OK
Returned if the edge can be updated, and waitForSync is false.
- code* integer
  The HTTP response status code.
- edge* object
  The internal attributes for the edge.
  _from* string
  The _from value of the stored data.
  _id* string
  The _id value of the stored data.
  _key* string
  The _key value of the stored data.
  _rev* string
  The _rev value of the stored data.
  _to* string
  The _to value of the stored data.
- error* boolean
  A flag indicating that no error occurred.
- new object
  The complete newly written edge document. Includes all written attributes in the request body and all internal attributes generated by ArangoDB. Only present if returnNew is true.
  _from* string
  The _from value of the stored data.
  _id* string
  The _id value of the stored data.
  _key* string
  The _key value of the stored data.
  _rev* string
  The _rev value of the stored data.
  _to* string
  The _to value of the stored data.
- old object
  The complete overwritten edge document. Includes all attributes stored before this operation. Only present if returnOld is true.
  _from* string
  The _from value of the stored data.
  _id* string
  The _id value of the stored data.
  _key* string
  The _key value of the stored data.
  _rev* string
  The _rev value of the stored data.
  _to* string
  The _to value of the stored data.
202 Accepted
Returned if the request was successful but waitForSync is false.
- code* integer
  The HTTP response status code.
- edge* object
  The internal attributes for the edge.
  _from* string
  The _from value of the stored data.
  _id* string
  The _id value of the stored data.
  _key* string
  The _key value of the stored data.
  _rev* string
  The _rev value of the stored data.
  _to* string
  The _to value of the stored data.
- error* boolean
  A flag indicating that no error occurred.
- new object
  The complete newly written edge document. Includes all written attributes in the request body and all internal attributes generated by ArangoDB. Only present if returnNew is true.
  _from* string
  The _from value of the stored data.
  _id* string
  The _id value of the stored data.
  _key* string
  The _key value of the stored data.
  _rev* string
  The _rev value of the stored data.
  _to* string
  The _to value of the stored data.
- old object
  The complete overwritten edge document. Includes all attributes stored before this operation. Only present if returnOld is true.
  _from* string
  The _from value of the stored data.
  _id* string
  The _id value of the stored data.
  _key* string
  The _key value of the stored data.
  _rev* string
  The _rev value of the stored data.
  _to* string
  The _to value of the stored data.
403 Forbidden
Returned if your user has insufficient rights. In order to update edges in the graph, you need to have at least the following privileges:
- Read Only access on the database.
- Write access on the given collection.
- code* integer
  The HTTP response status code.
- error* boolean
  A flag indicating that an error occurred.
- errorMessage* string
  A descriptive error message.
- errorNum* integer
  The ArangoDB error number for the error that occurred.
404 Not Found
Returned in the following cases:
- The graph cannot be found.
- The collection is not part of the graph.
- The edge to update does not exist.
- Either _from or _to node does not exist (if updated).
This error also occurs if you try to run this operation as part of a Stream Transaction but the transaction ID specified in the x-arango-trx-id header is unknown to the server.
- code* integer
  The HTTP response status code.
- error* boolean
  A flag indicating that an error occurred.
- errorMessage* string
  A descriptive error message.
- errorNum* integer
  The ArangoDB error number for the error that occurred.
410 Gone
This error occurs if you try to run this operation as part of a Stream Transaction that has just been canceled or timed out.
- code* integer
  The HTTP response status code.
- error* boolean
  A flag indicating that an error occurred.
- errorMessage* string
  A descriptive error message.
- errorNum* integer
  The ArangoDB error number for the error that occurred.
412 Precondition Failed
The If-Match header has been specified but the stored document’s revision is different.
- code* integer
  The HTTP response status code.
- error* boolean
  A flag indicating that an error occurred.
- errorMessage* string
  A descriptive error message.
- errorNum* integer
  The ArangoDB error number for the error that occurred.

Examples

curl -X PATCH --header 'accept: application/json' --data-binary @- --dump - http://localhost:8529/_api/gharial/social/edge/relation/71840
{
  "since": "01.01.2001"
}

Show output

HTTP/1.1 202 Accepted
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: 118
content-security-policy: frame-ancestors 'self'; form-action 'self';
etag: _hg5k05a---
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

{ 
  "error" : false, 
  "code" : 202, 
  "edge" : { 
    "_id" : "relation/71840", 
    "_key" : "71840", 
    "_oldRev" : "_hg5k05W--A", 
    "_rev" : "_hg5k05a---" 
  } 
}

Replace an edge

PUT /_db/{database-name}/_api/gharial/{graph}/edge/{collection}/{edge}

Replaces the data of an edge in the collection.

Path Parameters

database-name* string
The name of the database.
graph* string
The name of the graph.
collection* string
The name of the edge collection the edge belongs to.
edge* string
The _key attribute of the node.

Query Parameters

waitForSync boolean
Define if the request should wait until synced to disk.
keepNull boolean (default: true)
Define if values set to null should be stored. By default (true), the given documents attribute(s) are set to null. If this parameter is set to false, top-level attribute and sub-attributes with a null value in the request are removed from the document (but not attributes of objects that are nested inside of arrays).
returnOld boolean (default: false)
Whether to additionally include the complete previous document under the old attribute in the result.
returnNew boolean (default: false)
Whether to additionally include the complete new document under the new attribute in the result.

HTTP Headers

If-Match string
If you provide an If-Match header, it must contain exactly one ETag. The document is replaced if it has the same revision as the given ETag. Otherwise, an error with HTTP status code 412 is returned.
x-arango-trx-id string
To make this operation a part of a Stream Transaction, set this header to the transaction ID returned by the POST /_api/transaction/begin call.

Request Body application/json object

_from* string
The source node of this edge. Has to be valid within the used edge definition.
_to* string
The target node of this edge. Has to be valid within the used edge definition.

Responses

201 Created
Returned if the request was successful but waitForSync is true.
- code* integer
  The HTTP response status code.
- edge* object
  The internal attributes for the edge
  _from* string
  The _from value of the stored data.
  _id* string
  The _id value of the stored data.
  _key* string
  The _key value of the stored data.
  _rev* string
  The _rev value of the stored data.
  _to* string
  The _to value of the stored data.
- error* boolean
  A flag indicating that no error occurred.
- new object
  The complete newly written edge document. Includes all written attributes in the request body and all internal attributes generated by ArangoDB. Only present if returnNew is true.
  _from* string
  The _from value of the stored data.
  _id* string
  The _id value of the stored data.
  _key* string
  The _key value of the stored data.
  _rev* string
  The _rev value of the stored data.
  _to* string
  The _to value of the stored data.
- old object
  The complete overwritten edge document. Includes all attributes stored before this operation. Only present if returnOld is true.
  _from* string
  The _from value of the stored data.
  _id* string
  The _id value of the stored data.
  _key* string
  The _key value of the stored data.
  _rev* string
  The _rev value of the stored data.
  _to* string
  The _to value of the stored data.
202 Accepted
Returned if the request was successful but waitForSync is false.
- code* integer
  The HTTP response status code.
- edge* object
  The internal attributes for the edge
  _from* string
  The _from value of the stored data.
  _id* string
  The _id value of the stored data.
  _key* string
  The _key value of the stored data.
  _rev* string
  The _rev value of the stored data.
  _to* string
  The _to value of the stored data.
- error* boolean
  A flag indicating that no error occurred.
- new object
  The complete newly written edge document. Includes all written attributes in the request body and all internal attributes generated by ArangoDB. Only present if returnNew is true.
  _from* string
  The _from value of the stored data.
  _id* string
  The _id value of the stored data.
  _key* string
  The _key value of the stored data.
  _rev* string
  The _rev value of the stored data.
  _to* string
  The _to value of the stored data.
- old object
  The complete overwritten edge document. Includes all attributes stored before this operation. Only present if returnOld is true.
  _from* string
  The _from value of the stored data.
  _id* string
  The _id value of the stored data.
  _key* string
  The _key value of the stored data.
  _rev* string
  The _rev value of the stored data.
  _to* string
  The _to value of the stored data.
403 Forbidden
Returned if your user has insufficient rights. In order to replace edges in the graph, you need to have at least the following privileges:
- Read Only access on the database.
- Write access on the given collection.
- code* integer
  The HTTP response status code.
- error* boolean
  A flag indicating that an error occurred.
- errorMessage* string
  A descriptive error message.
- errorNum* integer
  The ArangoDB error number for the error that occurred.
404 Not Found
Returned in the following cases:
- The graph cannot be found.
- The collection is not part of the graph.
- The edge to replace does not exist.
- Either _from or _to node does not exist.
This error also occurs if you try to run this operation as part of a Stream Transaction but the transaction ID specified in the x-arango-trx-id header is unknown to the server.
- code* integer
  The HTTP response status code.
- error* boolean
  A flag indicating that an error occurred.
- errorMessage* string
  A descriptive error message.
- errorNum* integer
  The ArangoDB error number for the error that occurred.
410 Gone
This error occurs if you try to run this operation as part of a Stream Transaction that has just been canceled or timed out.
- code* integer
  The HTTP response status code.
- error* boolean
  A flag indicating that an error occurred.
- errorMessage* string
  A descriptive error message.
- errorNum* integer
  The ArangoDB error number for the error that occurred.
412 Precondition Failed
The If-Match header has been specified but the stored document’s revision is different.
- code* integer
  The HTTP response status code.
- error* boolean
  A flag indicating that an error occurred.
- errorMessage* string
  A descriptive error message.
- errorNum* integer
  The ArangoDB error number for the error that occurred.

Examples

curl -X PUT --header 'accept: application/json' --data-binary @- --dump - http://localhost:8529/_api/gharial/social/edge/relation/71970
{
  "type": "divorced",
  "_from": "female/alice",
  "_to": "male/bob"
}

Show output

HTTP/1.1 202 Accepted
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: 118
content-security-policy: frame-ancestors 'self'; form-action 'self';
etag: _hg5k1FG---
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

{ 
  "error" : false, 
  "code" : 202, 
  "edge" : { 
    "_id" : "relation/71970", 
    "_key" : "71970", 
    "_oldRev" : "_hg5k1FC--_", 
    "_rev" : "_hg5k1FG---" 
  } 
}

Remove an edge

DELETE /_db/{database-name}/_api/gharial/{graph}/edge/{collection}/{edge}

Removes an edge from an edge collection of the named graph. Any other edges that directly reference this edge like a node are removed, too.

Path Parameters

database-name* string
The name of the database.
graph* string
The name of the graph.
collection* string
The name of the edge collection the edge belongs to.
edge* string
The _key attribute of the edge.

Query Parameters

waitForSync boolean
Define if the request should wait until synced to disk.
returnOld boolean (default: false)
Whether to additionally include the complete previous document under the old attribute in the result.

HTTP Headers

If-Match string
If you provide an If-Match header, it must contain exactly one ETag. The document is deleted if it has the same revision as the given ETag. Otherwise, an error with HTTP status code 412 is returned.
x-arango-trx-id string
To make this operation a part of a Stream Transaction, set this header to the transaction ID returned by the POST /_api/transaction/begin call.

Responses

200 OK
Returned if the edge can be removed.
- code* integer
  The HTTP response status code.
- error* boolean
  A flag indicating that no error occurred.
- old object
  The complete deleted edge document. Includes all attributes stored before this operation. Only present if returnOld is true.
  _from* string
  The _from value of the stored data.
  _id* string
  The _id value of the stored data.
  _key* string
  The _key value of the stored data.
  _rev* string
  The _rev value of the stored data.
  _to* string
  The _to value of the stored data.
- removed* boolean
  Is set to true if the remove was successful.
202 Accepted
Returned if the request was successful but waitForSync is false.
- code* integer
  The HTTP response status code.
- error* boolean
  A flag indicating that no error occurred.
- old object
  The complete deleted edge document. Includes all attributes stored before this operation. Only present if returnOld is true.
  _from* string
  The _from value of the stored data.
  _id* string
  The _id value of the stored data.
  _key* string
  The _key value of the stored data.
  _rev* string
  The _rev value of the stored data.
  _to* string
  The _to value of the stored data.
- removed* boolean
  Is set to true if the remove was successful.
403 Forbidden
Returned if your user has insufficient rights. In order to delete nodes in the graph, you need to have at least the following privileges:
- Read Only access on the database.
- Write access on the given collection.
- code* integer
  The HTTP response status code.
- error* boolean
  A flag indicating that an error occurred.
- errorMessage* string
  A descriptive error message.
- errorNum* integer
  The ArangoDB error number for the error that occurred.
404 Not Found
Returned in the following cases:
- The graph cannot be found.
- The collection is not part of the graph.
- The edge to remove does not exist.
This error also occurs if you try to run this operation as part of a Stream Transaction but the transaction ID specified in the x-arango-trx-id header is unknown to the server.
- code* integer
  The HTTP response status code.
- error* boolean
  A flag indicating that an error occurred.
- errorMessage* string
  A descriptive error message.
- errorNum* integer
  The ArangoDB error number for the error that occurred.
410 Gone
This error occurs if you try to run this operation as part of a Stream Transaction that has just been canceled or timed out.
- code* integer
  The HTTP response status code.
- error* boolean
  A flag indicating that an error occurred.
- errorMessage* string
  A descriptive error message.
- errorNum* integer
  The ArangoDB error number for the error that occurred.
412 Precondition Failed
The If-Match header has been specified but the stored document’s revision is different.
- code* integer
  The HTTP response status code.
- error* boolean
  A flag indicating that an error occurred.
- errorMessage* string
  A descriptive error message.
- errorNum* integer
  The ArangoDB error number for the error that occurred.

Examples

curl -X DELETE --header 'accept: application/json' --dump - http://localhost:8529/_api/gharial/social/edge/relation/72111

Show output

HTTP/1.1 202 Accepted
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: 41
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

{ 
  "error" : false, 
  "code" : 202, 
  "removed" : true 
}