Rest API

Table of Contents

Authentication

Settings

Graph

Schema

Authentication

Login - GET /api/auth/providers

This endpoint retrieves information about authentication providers and their respective URLs for sign-in and callback.

Responses

  • 200: Successful authentication provider retrieval
    • Content-Type: application/json

    • Example response:

      {
  "credentials": {
    "id": "credentials",
    "name": "Credentials",
    "type": "credentials",
    "signinUrl": "http://localhost:3000/api/auth/signin/credentials",
    "callbackUrl": "http://localhost:3000/api/auth/callback/credentials"
  }
}

Logout - POST /api/auth/signout

This endpoint signs out a user, ending their authenticated session.

Request Body

  • Content-Type: application/x-www-form-urlencoded

  • Example request:

      {
    "csrfToken": "insert csrfToken",
    "callbackUrl": "/login",
    "json": true
  }

Responses

  • 200: Successful logout
    • Content-Type: application/json

    • Example response:

      {
  "url": "http://localhost:3000/api/auth/signout?csrf=true"
}

Settings

Set Configuration Value - POST /api/config

This endpoint sets a configuration value for MAX_QUEUED_QUERIES.

Parameters

  • cookie (header, required): Cookie header with session and auth tokens.
  • config (query, required): The configuration name.
  • value (query, required): The integer value to set.

Responses

  • 200: Successful configuration update
    • Content-Type: application/json

    • Example response:

      {
  "config": "OK"
}

Get Configuration Value - GET /api/config

This endpoint retrieves the value for MAX_QUEUED_QUERIES.

Parameters

  • cookie (header, required): Cookie header with session and auth tokens.
  • config (query, required): The name of the configuration to retrieve.

Responses

  • 200: Successful configuration retrieval
    • Content-Type: application/json

    • Example response:

      {
  "config": [
    "MAX_QUEUED_QUERIES",
    25
  ]
}

Create New User - POST /api/user

This endpoint creates a new user with specified credentials.

Request Body

  • Content-Type: application/json

  • Example request:

      {
    "username": "user",
    "password": "Pass123@",
    "role": "Read-Write"
  }

Responses

  • 201: User created successfully
    • Content-Type: application/json

    • Example response:

      {
  "message": "User created"
}

Delete User - DELETE /api/user

This endpoint deletes a user based on their username and role.

Request Body

  • Content-Type: application/json

  • Example request:

      {
    "users": [
      {
        "username": "userName",
        "role": "Read-Write"
      }
    ]
  }

Responses

  • 200: User deleted successfully
    • Content-Type: application/json

    • Example response:

      {
  "message": "User deleted"
}

Get All Users - GET /api/user

This endpoint retrieves a list of all users.

Responses

  • 200: List of users retrieved successfully
    • Content-Type: application/json

    • Example response:

      {
  "result": [
    {
      "username": "default",
      "role": "Admin",
      "checked": false
    }
  ]
}

Modify A User - PATCH /api/user/{userName}

This endpoint updates the role of a specific user.

Parameters

  • cookie (header, required): Cookie header with session and auth tokens.
  • userName (path, required): The username of the user to modify.
  • role (query, required): The new role to assign to the user (Admin, Read-Only, Read-Write).

Responses

  • 200: User updated successfully
    • Content-Type: application/json

    • Example response:

      {
  "message": "User role updated"
}

Graph

Create A Graph & Run A Query - GET /api/graph/{graphName}

This endpoint creates a graph and runs a query.

Parameters

  • cookie (header, required): Cookie header with session and auth tokens.
  • graphName (path, required): The name of the graph to be created.
  • query (query, required): The query to run, such as RETURN 1.

Responses

  • 200: Graph created and query executed
    • Content-Type: application/json

    • Example response:

      {
  "result": {
    "metadata": [
      "Nodes created: 40",
      "Relationships created: 20",
      "Cached execution: 1",
      "Query internal execution time: 0.201420 milliseconds"
    ],
    "data": [
      {
        "queryData": "exampleData"
      }
    ]
  }
}

Delete A Graph - DELETE /api/graph/{graphName}

This endpoint deletes a specified graph.

Parameters

  • cookie (header, required): Cookie header with session and auth tokens.
  • graphName (path, required): The name of the graph to be deleted.

Responses

  • 200: Graph deleted successfully
    • Content-Type: application/json

    • Example response:

      {
  "message": "GraphName graph deleted"
}

Get All Graphs - GET /api/graph

This endpoint retrieves a list of all graphs.

Responses

  • 200: List of graphs retrieved successfully
    • Content-Type: application/json

    • Example response:

      {
  "result": [
    "graphName"
  ]
}

Duplicate A Graph - POST /api/graph/{destinationGraphName}

This endpoint duplicates a graph from source to destination.

Parameters

  • destinationGraphName (path, required): The name of the destination graph.
  • sourceName (query, required): The name of the source graph to duplicate.

Responses

  • 200: Graph duplicated successfully
    • Content-Type: application/json

    • Example response:

      {
  "success": "OK"
}

Get Graph Count - GET /api/graph/{graphName}/count

This endpoint retrieves the count of nodes and edges in a specified graph.

Parameters

  • cookie (header, required): Cookie header with session and auth tokens.
  • graphName (path, required): The name of the graph to count nodes and edges.

Responses

  • 200: Graph count retrieved successfully
    • Content-Type: application/json

    • Example response:

      {
  "result": {
    "data": [
      {
        "nodes": 7417,
        "edges": 4341
      }
    ]
  }
}

Add Node Attribute - POST /api/graph/{graphName}/{id}/{attribute}

This endpoint adds an attribute to a node in a graph.

Parameters

  • cookie (header, required): Cookie header with session and auth tokens.
  • graphName (path, required): The name of the graph.
  • id (path, required): The ID of the node to which the attribute will be added.
  • attribute (path, required): The name of the attribute to add.

Request Body

  • Content-Type: application/json

  • Example request:

      {
    "value": "your_attribute_value",
    "type": true
  }

Responses

  • 200: Node attribute added successfully
    • Content-Type: application/json

    • Example response:

      {
  "result": {
    "metadata": [
      "Cached execution: 0",
      "Query internal execution time: 0.412958 milliseconds"
    ]
  }
}

Delete Node Attribute - DELETE /api/graph/{graphName}/{id}/{attribute}

This endpoint deletes an attribute from a node in a graph.

Parameters

  • cookie (header, required): Cookie header with session and auth tokens.
  • graphName (path, required): The name of the graph.
  • id (path, required): The ID of the node from which the attribute will be deleted.
  • attribute (path, required): The name of the attribute to delete.

Request Body

  • Content-Type: application/json

  • Example request:

      {
    "type": true
  }

Responses

  • 200: Node attribute deleted successfully
    • Content-Type: application/json

    • Example response:

      {
  "result": {
    "metadata": [
      "Cached execution: 0",
      "Query internal execution time: 0.407125 milliseconds"
    ]
  }
}

Add Node Label - POST /api/graph/{graphName}/{id}/label

This endpoint adds a label to a node in a graph.

Parameters

  • cookie (header, required): Cookie header with session and auth tokens.
  • graphName (path, required): The name of the graph.
  • id (path, required): The ID of the node to which the label will be added.

Request Body

  • Content-Type: application/json

  • Example request:

      {
    "label": "your_label_name"
  }

Responses

  • 200: Node label added successfully
    • Content-Type: application/json

    • Example response:

      {
  "message": "Label added successfully"
}

Delete Node Label - DELETE /api/graph/{graphName}/{id}/label

This endpoint deletes a label from a node in a graph.

Parameters

  • cookie (header, required): Cookie header with session and auth tokens.
  • graphName (path, required): The name of the graph.
  • id (path, required): The ID of the node from which the label will be deleted.

Request Body

  • Content-Type: application/json

  • Example request:

      {
    "label": "your_label_name"
  }

Responses

  • 200: Node label deleted successfully
    • Content-Type: application/json

    • Example response:

      {
  "message": "Label removed successfully"
}

Delete Node - DELETE /api/graph/{graphName}/{id}

This endpoint deletes a node from a graph.

Parameters

  • cookie (header, required): Cookie header with session and auth tokens.
  • graphName (path, required): The name of the graph.
  • id (path, required): The ID of the node to delete.

Request Body

  • Content-Type: application/json

  • Example request:

      {
    "type": true
  }

Responses

  • 200: Node deleted successfully
    • Content-Type: application/json

    • Example response:

      {
  "message": "Node deleted successfully"
}

Schema

Create New Schema & Run A Query - GET /api/graph/{schemaName}

This endpoint creates a new schema and runs a query.

Parameters

  • schemaName (path, required): The name of the schema to create.
  • query (query, required): The query to execute.

Responses

  • 200: Schema created and query executed
    • Content-Type: application/json

    • Example response:

      {
  "result": {
    "metadata": [
      "Cached execution: 0",
      "Query internal execution time: 0.153307 milliseconds"
    ],
    "data": [
      {
        "1": 1
      }
    ]
  }
}

Delete A Schema - DELETE /api/graph/{schemaName}

This endpoint deletes a specified schema.

Parameters

  • schemaName (path, required): The name of the schema to delete.

Responses

  • 200: Schema deleted successfully
    • Content-Type: application/json

    • Example response:

      {
  "message": "SchemaName schema deleted"
}

Get Schema Count - GET /api/schema/{schemaName}/count

This endpoint retrieves the count of nodes and edges in a specified schema.

Parameters

  • cookie (header, required): Cookie header with session and auth tokens.
  • schemaName (path, required): The name of the schema to count nodes and edges.

Responses

  • 200: Schema count retrieved successfully
    • Content-Type: application/json

    • Example response:

      {
  "result": {
    "data": [
      {
        "nodes": 0,
        "edges": 0
      }
    ]
  }
}

Add Schema Node - POST /api/schema/{schemaName}/{id}

This endpoint adds a node to a schema.

Parameters

  • cookie (header, required): Cookie header with session and auth tokens.
  • schemaName (path, required): The name of the schema.
  • id (path, required): The ID of the node to add (use -1 for new nodes).

Request Body

  • Content-Type: application/json

  • Example request:

      {
    "type": true,
    "label": ["your_label_name"],
    "attributes": [["attribute_name", ["String", "default_value", "true", "true"]]],
    "selectedNodes": [null, null]
  }

Responses

  • 200: Schema node added successfully
    • Content-Type: application/json

    • Example response:

      {
  "result": {
    "metadata": [
      "Labels added: 1",
      "Nodes created: 1",
      "Properties set: 1",
      "Cached execution: 0",
      "Query internal execution time: 0.987458 milliseconds"
    ],
    "data": [
      {
        "n": {
          "id": 0,
          "labels": [
            "your_label_name"
          ],
          "properties": {
            "attribute_name": "String!*default_value"
          }
        }
      }
    ]
  }
}

Delete Schema Node - DELETE /api/schema/{schemaName}/{id}

This endpoint deletes a node from a schema.

Parameters

  • cookie (header, required): Cookie header with session and auth tokens.
  • schemaName (path, required): The name of the schema.
  • id (path, required): The ID of the node to delete.

Request Body

  • Content-Type: application/json

  • Example request:

      {
    "type": true
  }

Responses

  • 200: Schema node deleted successfully
    • Content-Type: application/json

    • Example response:

      {
  "message": "Node deleted successfully"
}

Add Schema Attribute - PATCH /api/schema/{schemaName}/{id}/{attribute}

This endpoint adds an attribute to a node in a schema.

Parameters

  • cookie (header, required): Cookie header with session and auth tokens.
  • schemaName (path, required): The name of the schema.
  • id (path, required): The ID of the node to which the attribute will be added.
  • attribute (path, required): The name of the attribute to add.

Request Body

  • Content-Type: application/json

  • Example request:

      {
    "type": true,
    "attribute": ["String", "default_value", "true", "true"]
  }

Responses

  • 200: Schema node attribute added successfully
    • Content-Type: application/json

    • Example response:

      {
  "message": "Attribute updated successfully"
}

Delete Schema Attribute - DELETE /api/schema/{schemaName}/{id}/{attribute}

This endpoint deletes an attribute from a node in a schema.

Parameters

  • cookie (header, required): Cookie header with session and auth tokens.
  • schemaName (path, required): The name of the schema.
  • id (path, required): The ID of the node from which the attribute will be deleted.
  • attribute (path, required): The name of the attribute to delete.

Request Body

  • Content-Type: application/json

  • Example request:

      {
    "type": true
  }

Responses

  • 200: Schema node attribute deleted successfully
    • Content-Type: application/json

    • Example response:

      {
  "message": "Attribute deleted successfully"
}

Add Schema Label - POST /api/schema/{schemaName}/{id}/label

This endpoint adds a label to a node in a schema.

Parameters

  • cookie (header, required): Cookie header with session and auth tokens.
  • schemaName (path, required): The name of the schema.
  • id (path, required): The ID of the node to which the label will be added.

Request Body

  • Content-Type: application/json

  • Example request:

      {
    "label": "your_label_name"
  }

Responses

  • 200: Schema node label added successfully
    • Content-Type: application/json

    • Example response:

      {
  "result": {
    "metadata": [
      "Cached execution: 0",
      "Query internal execution time: 0.417250 milliseconds"
    ]
  }
}

Delete Schema Label - DELETE /api/schema/{schemaName}/{id}/label

This endpoint deletes a label from a node in a schema.

Parameters

  • cookie (header, required): Cookie header with session and auth tokens.
  • schemaName (path, required): The name of the schema.
  • id (path, required): The ID of the node from which the label will be deleted.

Request Body

  • Content-Type: application/json

  • Example request:

      {
    "label": "your_label_name"
  }

Responses

  • 200: Schema node label deleted successfully
    • Content-Type: application/json

    • Example response:

      {
  "result": {
    "metadata": [
      "Cached execution: 0",
      "Query internal execution time: 0.829917 milliseconds"
    ]
  }
}