Basic REST API

This cheat sheet provides a review of the RESTful API for Rexster. Note that beyond the query parameters provided in the table below, the standard Rexster parameters rexster.offset.start, rexster.offset.end, and rexster.returnKeys also work in cases where it makes sense. The <graph> is the unique name of a graph configured within Rexster. The base of the URI, when running locally, is generally localhost:8182.

Please note that there are Rexster MIME Types that affect operations within the API.

GET Operations

returns	uri	description
graphs	/graphs	get all the graphs
graph	/graphs/<graph>	get the graph named
vertices	/graphs/<graph>/vertices	get all vertices
vertices	/graphs/<graph>/vertices?key=<key>&value=<value>	get all vertices for a key index given the specified <key>/<value>
vertex	/graphs/<graph>/vertices/<id>	get vertex with id <id>
vertices	/graphs/<graph>/vertices/<id>/out	get the adjacent out vertices of vertex <id>
vertices	/graphs/<graph>/vertices/<id>/in	get the adjacent in vertices of vertex <id>
vertices	/graphs/<graph>/vertices/<id>/both	get the both adjacent in and out vertices of vertex <id>
edges	/graphs/<graph>/vertices/<id>/<dir>?_label=written_by	get the adjacent vertices of <id> with edge label equal to “written_by” (value may also be a comma separated list)
edges	/graphs/<graph>/edges	get all edges
edges	/graphs/<graph>/edges?key=<key>&value=<value>	get all edges for a key index given the specified <key>/<value>
edge	/graphs/<graph>/edges/<id>	get edge with id <id>
edges	/graphs/<graph>/vertices/<id>/outE	get the out edges of vertex <id>
edges	/graphs/<graph>/vertices/<id>/inE	get the in edges of vertex <id>
edges	/graphs/<graph>/vertices/<id>/bothE	get the both in and out edges of vertex <id>
edges	/graphs/<graph>/vertices/<id>/<dir>E?_label=written_by	get the edges of vertex <id> with edge label equal to “written_by” (value may also be a comma separated list)
indices	/graphs/<graph>/indices	get all the indices associated with the graph
elements	/graphs/<graph>/indices/index?key=<key>&value=<value>	get all elements with <key> property equal to <value> in index
long	/graphs/<graph>/indices/index/count?key=<key>&value=<value>	get a count of all elements with <key> property equal to <value> in index
keys	/graphs/<graph>/keyindices/	get the combination of vertex and edge keys
keys	/graphs/<graph>/keyindices/vertex	get vertex keys
keys	/graphs/<graph>/keyindices/edge	get edge keys
prefixes 1	/graphs/<graph>/prefixes	get the list of SailGraph prefixes
prefix 1	/graphs/<graph>/prefixes/prefix	get a specific prefix value

POST Operations

returns	uri	description
vertex	/graphs/<graph>/vertices	create a vertex with no specified identifier
vertex	/graphs/<graph>/vertices/<id>	create a vertex with id <id> 2
vertex	/graphs/<graph>/vertices/<id>?<key>=<value>&<key'>=<value'>	create a vertex with id <id> and the provided properties (or update vertex properties if vertex already exists). 2
edge	/graphs/<graph>/edges?_outV=<id>&_label=friend&_inV=2&<key>=<key'>	create an out edge with no specified identifier from vertex <id> to vertex 2 labeled “friend” with provided properties. 2
edge	/graphs/<graph>/edges/3?_outV=<id>&_label=friend&_inV=2&<key>=<key'>	create an out edge with id 3 from vertex <id> to vertex 2 labeled “friend” with provided properties. 2
edge	/graphs/<graph>/edges/3?<key>=<key'>	update the properties of the edge with id 3
index 3	/graphs/<graph>/indices/index?class=vertex	create a new manual index named index
void	/graphs/<graph>/keyindices/vertex/<key>	create a new key index for a vertex
void	/graphs/<graph>/keyindices/edge/<key>	create a new key index for an edge
void 1	/graphs/<graph>/prefixes?namespace=http%3A%2F%2Fwww.ggl.com&prefix=pf	add a new SailGraph prefix with namespace http://www.ggl.com and prefix pf

PUT Operations

returns	uri	description
vertex	/graphs/<graph>/vertices/<id>?<key>=<value>&<key'>=<value'>	replaces the all existing properties of the vertex <id> with those specified
edge	/graphs/<graph>/edges/<id>?<key>=<value>&<key'>=<value'>	replaces the all existing properties of the edge <id> with those specified
void	/graphs/<graph>/indices/index?key=<key>&value=<value>&id=<id>	put vertex with id <id> into index at <key>/<value>

DELETE Operations

returns	uri	description
void	/graphs/<graph>/vertices/<id>	remove vertex <id>
void	/graphs/<graph>/vertices/<id>?<key>&<key'>	remove properties <key> and <key'> from vertex <id>
void	/graphs/<graph>/edges/3	remove the edge with id 3
void	/graphs/<graph>/edges/3?<key>&<key'>	remove properties <key> and <key'> from edge 3
void	/graphs/<graph>/indices/index	drop the index named index
void	/graphs/<graph>/indices/index?key=<key>&value=<value>&class=vertex&id=<id>	remove the vertex <id> from index at <key>/<value>
void 1	/graphs/<graph>/prefixes/prefix	remove the specified prefix

¹ Only applies to SailGraph configurations.
² Underlying graph database implementations must support the ability to assign the edge/vertex identifier. In cases where the graph database does not support the identifier (ie. Neo4j), the identifier supplied with be ignored and the graph assigned identifier will be returned in the JSON after successful graph element creation.
³ Note that when POSTing an index you may also pass a params query string argument. This argument allows configuration parameters to be passed into the index itself (support of this feature is specific to the graph implementation itself). Please read the Neo4j Blueprints implementation for an example on how to configure an index. The params argument is parsed to JSON so a query string that looked like params.to_lower_case=true&params.type=fulltext&params.provider=lucene would construct a map of three index parameters.

In all cases, parameters may be POSTed or PUTed on the URI or as JSON using one of the Rexster MIME Types.

Rexster Parameters

• rexster.offset.start – Expects a numeric value that represents the start point for returning a set of records and is used in conjunction with rexster.offset.end to allow for paging of results. If used without a valid rexster.offset.end parameter specified, Rexster will return all remaining records in the set.
• rexster.offset.end – Expects a numeric value that represents the end point for returning a set of records and is used in conjunction with rexster.offset.start to allow for paging of results. If used without a valid rexster.offset.start parameter specified, Rexster will assume the start value to be zero.
• rexster.returnKeys – Expects a comma separated list of property names to return in the results. Element meta-data will always be returned even if rexster.returnKeys are specified. If a valid value for this parameter is not specified, then all properties are returned.