ArangoDB's Reference Manual for API Implementors (1.1.0)

• REST Interface
  • REST Interface for Documents
    • Documents, Identifiers, Handles
    • Address and ETag of an Document
    • Working with Documents using REST
      • GET /_api/document/document-handle
      • POST /_api/document?collection=collection-identifier
      • PUT /_api/document/document-handle
      • PATCH /_api/document/document-handle
      • DELETE /_api/document/document-handle
      • HEAD /_api/document/document-handle
      • GET /_api/document?collection=collection-identifier
  • REST Interface for Edges
    • Documents, Identifiers, Handles
    • Address and ETag of an Edge
    • Working with Edges using REST
      • GET /_api/edge/document-handle
      • POST /_api/edge?collection=collection-identifier&from=from-handle&to=to-handle
      • PUT /_api/edge/document-handle
      • DELETE /_api/edge/document-handle
      • HEAD /_api/edge/document-handle
      • GET /_api/edges/collection-identifier?vertex=vertex-handle&directory=direction
• Light-Weight HTTP for Queries and Cursors
  • HTTP Interface for AQL Query Cursors
    • Retrieving query results
      • Single roundtrip
      • Using a Cursor
    • Accessing Cursors via HTTP
      • POST /_api/cursor
      • POST /_api/query
      • PUT /_api/cursor/cursor-identifier
      • DELETE /_api/cursor/cursor-identifier
  • HTTP Interface for AQL Queries
    • POST /_api/explain
    • POST /_api/query
  • HTTP Interface for Simple Queries
    • Simple Queries
    • Working with Simples Queries using HTTP
      • POST /_api/simple/all
      • POST /_api/simple/by-example
      • POST /_api/simple/first-example
      • POST /_api/simple/range
      • POST /_api/simple/near
      • POST /_api/simple/within
  • Accessing Cap Constraints via Http
    • POST /_api/index
  • Accessing Geo Indexes via Http
    • POST /_api/index
    • POST /_api/simple/near
    • POST /_api/simple/within
  • Accessing Hash Indexes via Http
    • POST /_api/index
    • POST /_api/simple/by-example
    • POST /_api/simple/first-example
  • Accessing Skip-List Indexes via Http
    • POST /_api/index
    • POST /_api/simple/range
• Light-Weight HTTP for Administration
  • HTTP Interface for Collections
    • Collections
    • Address of a Collection
    • Working with Collections using HTTP
      • Creating and Deleting Collections
        • POST /_api/collection
        • DELETE /_api/collection/collection-identifier
        • PUT /_api/collection/collection-identifier/truncate
      • Getting Information about a Collection
        • GET /_api/collection/collection-identifier
        • GET /_api/collection/collection-identifier/properties
        • GET /_api/collection/collection-identifier/count
        • GET /_api/collection/collection-identifier/figures
        • GET /_api/collection/collection-identifier
        • GET /_api/collection/
      • Modifying a Collection
        • PUT /_api/collection/collection-identifier/load
        • PUT /_api/collection/collection-identifier/unload
        • PUT /_api/collection/collection-identifier/properties
        • PUT /_api/collection/collection-identifier/rename
  • HTTP Interface for Indexes
    • Indexes
    • Address of an Index
    • Working with Indexes using HTTP
      • GET /_api/index/index-handle
      • POST /_api/index?collection=collection-identifier
      • DELETE /_api/index/index-handle
      • GET /_api/index?collection=index-handle
  • HTTP Interface for Administration and Monitoring
    • GET /_admin/log
    • GET /_admin/status
    • GET /_admin/connection-statistics
    • GET /_admin/request-statistics
  • HTTP Interface for Miscellaneous functions
    • GET /_admin/version
    • GET /_admin/time
    • GET /_admin/echo
• Interface for bulk imports
  • HTTP Interface for bulk imports
    • Importing self-contained documents
    • Importing headers and values
• Interface for batch operations
  • HTTP Interface for Batch Requests
• Advanced Topics
  • Error codes and meanings
• Under Construction
  • REST Interface for storing key-value pairs
    • POST /_api/key/collection-name/key
    • PUT /_api/key/collection-name/key
    • GET /_api/key/collection-name/key
    • DELETE /_api/key/collection-name/key
    • GET /_api/keys/collection-name/prefix