Stardog HTTP API

https://stardog-union.github.io/http-docs/
Admin
Stardog supports the standard SPARQL Protocol HTTP bindings, as well as additional functionality via...
Tokens:55,569
Snippets:368
Trust Score:9.7
Update:3 months ago
Show doc for...
Tokens:
Raw
### Get Server/Database Metrics Response

Source: https://stardog-union.github.io/http-docs

Example JSON response for retrieving server or database metrics.

```json
{
  * "property1": "string",
  * "property2": "string"

}
```

--------------------------------

### SPARQL Query Example

Source: https://stardog-union.github.io/http-docs/openapi.json

Example of a SPARQL SELECT query to retrieve entities and their labels.

```sparql
PREFIX rdfs: <http://www.w3.org/2000/01/rdf-schema#>
PREFIX : <http://example.org/stardog#>
 
SELECT ?s ?label WHERE {
    ?s a :Example ;
       rdfs:label ?label
}
```

--------------------------------

### Get All Database Options

Source: https://stardog-union.github.io/http-docs/openapi.json

Get the value of every metadata option for a specific database.

```APIDOC
## GET /admin/databases/{db}/options

### Description
Get the value of every metadata option for a database.

### Method
GET

### Endpoint
/admin/databases/{db}/options

### Parameters
#### Path Parameters
- **db** (string) - Required - The identifier for the database.

### Responses
#### Success Response (200)
- GENERIC_JSON_OBJECT (object) - JSON object detailing all database metadata.

#### Error Response (404)
- Database does not exist.
```

--------------------------------

### Turtle RDF Example

Source: https://stardog-union.github.io/http-docs/openapi.json

A generic example of RDF data in Turtle format, including common prefixes.

```turtle
@prefix : <urn:example:> .
@prefix owl: <http://www.w3.org/2002/07/owl#> .
@prefix rdf: <http://www.w3.org/1999/02/22-rdf-syntax-ns#> .
@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
@prefix stardog: <tag:stardog:api:> .
@prefix xsd: <http://www.w3.org/2001/XMLSchema#> .

<urn:example:Entity1> a <urn:example:Entity> ;
	<urn:example:hasProp> 42 .
```

--------------------------------

### Get All Metadata Properties

Source: https://stardog-union.github.io/http-docs/openapi.json

Retrieves information on all database metadata properties, including their descriptions and example values. This is useful for understanding available configuration options.

```APIDOC
## GET /admin/config_properties

### Description
Get information on all database metadata properties, including description and example values.

### Method
GET

### Endpoint
/admin/config_properties

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- JSON object detailing all metadata options
```

--------------------------------

### SPARQL Update Query Example

Source: https://stardog-union.github.io/http-docs/openapi.json

Example of a SPARQL INSERT query to add data to the graph.

```sparql
PREFIX rdfs: <http://www.w3.org/2000/01/rdf-schema#>
PREFIX : <http://example.org/stardog#>
 
INSERT {
    ?s ?p ?newO
}
WHERE {
    ?s ?p ?o .
    BIND(CONCAT(?o, " ", - New) as ?newO)
}
```

--------------------------------

### Get Specific Process Details

Source: https://stardog-union.github.io/http-docs

Retrieves details for a specific process by its name. Returns a 404 error if the process does not exist.

```json
{
  "type": "query",
  "db": "string",
  "endTime": 0,
  "startTime": 0,
  "id": "string",
  "user": "string",
  "status": "Not started"

}
```

--------------------------------

### Get All DB Options Response Sample

Source: https://stardog-union.github.io/http-docs

This JSON response details all metadata options for a specific database. It includes various properties and their string values.

```json
{
  "property1": "string",
  "property2": "string"

}
```

--------------------------------

### SPARQL Query Plan

Source: https://stardog-union.github.io/http-docs/openapi.json

An example of a query execution plan. This format is useful for performance analysis and understanding query optimization.

```text
prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#>
prefix : <http://example.org/stardog#>

Projection(?s, ?label) [#625]
`─ MergeJoin(?s) [#625]
   +─ Scan[POSC](?s, <http://www.w3.org/1999/02/22-rdf-syntax-ns#type>, :Example) [#1]
   `─ Scan[PSOC](?s, rdfs:label, ?label) [#718K]
```

--------------------------------

### Get Process List

Source: https://stardog-union.github.io/http-docs/openapi.json

Retrieves a list of all running processes on the server.

```APIDOC
## GET /admin/processes

### Description
Retrieves a list of all running processes on the server.

### Method
GET

### Endpoint
/admin/processes

### Responses
#### Success Response (200)
- **PROCESS_LIST** (object) - A list of processes.
```

--------------------------------

### Get Server Diagnostics Report

Source: https://stardog-union.github.io/http-docs

Initiates the creation of a server diagnostics report, returned as a zip file upon successful completion.

```http
post/admin/diagnostics
http://localhost:5820/admin/diagnostics
```

--------------------------------

### Query Response Sample

Source: https://stardog-union.github.io/http-docs

Example JSON response structure for a query, including its type, database, timing, ID, user, and status.

```json
{
  "type": "query",
  "db": "string",
  "endTime": 0,
  "startTime": 0,
  "id": "string",
  "user": "string",
  "status": "Not started"
}
```

--------------------------------

### Get Process

Source: https://stardog-union.github.io/http-docs/openapi.json

Retrieves details of a specific process by its name.

```APIDOC
## GET /admin/processes/{name}

### Description
Get details of a specific process.

### Method
GET

### Endpoint
/admin/processes/{name}

### Parameters
#### Path Parameters
- **name** (string) - Required - The name of the process.

### Responses
#### Success Response (200)
- **PROCESS** (object) - Details of the process.
#### Error Response (404)
- **NAME_PROCESS_404** (object) - Process not found.
```

--------------------------------

### Get Virtual Graph Options

Source: https://stardog-union.github.io/http-docs

Retrieve the options for a specific virtual graph. Returns a 404 if the virtual graph is not found.

```http
GET /admin/virtual_graphs/{name}/options HTTP/1.1
Host: localhost:5820
```

--------------------------------

### Query Not Found Response Sample

Source: https://stardog-union.github.io/http-docs

Example JSON response when a requested query is not found, including a message and an error code.

```json
{
  "message": "Query does not exist",
  "code": "QEQNF2"
}
```

--------------------------------

### Standby Nodes List Response Sample

Source: https://stardog-union.github.io/http-docs

Example JSON response containing an array of standby node addresses.

```json
{
  "standbynodes": [
    "165.7.29.42:5820"
  ]
}
```

--------------------------------

### List Running Queries

Source: https://stardog-union.github.io/http-docs/openapi.json

Get a list of all currently running queries on the server.

```APIDOC
## GET /admin/queries

### Description
Get a list of all running queries

### Method
GET

### Endpoint
/admin/queries

### Response
#### Success Response (200)
- Description: A list of all running queries
```

--------------------------------

### Explain SPARQL Query (GET)

Source: https://stardog-union.github.io/http-docs/openapi.json

Retrieves the query plan for a given SPARQL query. This endpoint is useful for understanding how a query will be executed.

```APIDOC
## GET /{db}/explain

### Description
Retrieves the query plan for a given SPARQL query.

### Method
GET

### Endpoint
/{db}/explain

### Parameters
#### Query Parameters
- **query** (string) - Required - The SPARQL query to explain.
- **reasoning** (boolean) - Optional - Whether to use reasoning.

### Response
#### Success Response (200)
- **(text/plain)**: Query plan as plain text.
- **(application/json)**: Query plan as JSON.

#### Response Example
{
  "example": "{\"queryPlan\": \"...\"}"
}

#### Error Response (400)
- **INVALID_QUERY**: The provided query is invalid.

#### Error Response (404)
- **Database does not exist** (application/json) - The specified database does not exist.
```

--------------------------------

### Get All Metadata Properties Response

Source: https://stardog-union.github.io/http-docs

A successful response detailing all database metadata options, including their properties and possible values.

```json
{
  "property1": {
    "name": "reasoning.sameas",
    "type": "Enum",
    "mutable": true,
    "mutableWhileOnline": true,
    "category": "Reasoning",
    "label": "SameAs",
    "description": "Option to enable owl:sameas reasoning. When this option is set to ON reflexive, symmetric, and transitive closure of the owl:sameas triples in the database is computed. When it is set to FULL, owl:sameas inferences are computed based on the schema axioms such as functional properties",
    "possibleValues": [
      "OFF",
      "ON",
      "FULL"
    ],
    "defaultValue": "OFF"
  },
  "property2": {
    "name": "reasoning.sameas",
    "type": "Enum",
    "mutable": true,
    "mutableWhileOnline": true,
    "category": "Reasoning",
    "label": "SameAs",
    "description": "Option to enable owl:sameas reasoning. When this option is set to ON reflexive, symmetric, and transitive closure of the owl:sameas triples in the database is computed. When it is set to FULL, owl:sameas inferences are computed based on the schema axioms such as functional properties",
    "possibleValues": [
      "OFF",
      "ON",
      "FULL"
    ],
    "defaultValue": "OFF"
  }
}
```

--------------------------------

### Standby Pause Status Response Sample

Source: https://stardog-union.github.io/http-docs

Example JSON response indicating the current state of a standby node.

```json
{
  "STATE": "WAITING"
}
```

--------------------------------

### Get virtual graph options

Source: https://stardog-union.github.io/http-docs

Retrieves the options for a specified virtual graph. Returns a 200 on success or a 404 if the virtual graph does not exist.

```APIDOC
## Get virtual graph options

### Description
Retrieves the options for a specified virtual graph. Returns a 200 on success or a 404 if the virtual graph does not exist.

### Method
GET

### Endpoint
/admin/virtual_graphs/{name}/options

### Parameters
#### Path Parameters
- **name** (string) - Required - The name of the virtual graph

### Responses
#### Success Response (200)
Operation successful

#### Error Response (404)
Virtual Graph does not exist
```

--------------------------------

### List Databases with Options

Source: https://stardog-union.github.io/http-docs

Retrieves a list of all databases on the server along with their configuration options. The response includes a DATABASE_LIST array containing database names and their settings.

```json
"{ DATABASE_LIST = [{
  "database.name": "db1",
  "query.all.graphs": true
},
  "database.name": "db2",
  "query.all.graphs": true
}]}"
```

--------------------------------

### List Databases Response Sample

Source: https://stardog-union.github.io/http-docs

This is a sample JSON response when listing all databases on the server. It returns a list of database names.

```json
{
  "databases": [
    "string"
  ]

}
```

--------------------------------

### Create Database

Source: https://stardog-union.github.io/http-docs/openapi.json

Add a new database to the server, optionally with RDF bulk-loaded.

```APIDOC
## POST /admin/databases

### Description
Add a new database to the server, optionally with RDF bulk-loaded.

### Method
POST

### Endpoint
/admin/databases

### Request Body
- multipart/form-data - Required - A multipart request with a JSON root element and optionally RDF file contents (DB_CREATE).

### Responses
#### Success Response (201)
- Database created.

#### Error Response (400)
- Invalid or malformed request body.
```

--------------------------------

### Get Standby Pause Status

Source: https://stardog-union.github.io/http-docs/openapi.json

Get the pause status of a standby node.

```APIDOC
## GET /admin/cluster/standby/pause

### Description
Get the pause status of a standby node.

### Method
GET

### Endpoint
/admin/cluster/standby/pause

### Response
#### Success Response (200)
- (STANDBY_PAUSED) - Operation successful

#### Response Example
{
  "example": "response body"
}
```

--------------------------------

### List Databases With Options

Source: https://stardog-union.github.io/http-docs/openapi.json

Retrieves a list of all databases on the server, including their configuration options.

```APIDOC
## GET /admin/databases/options

### Description
List all the databases in the server including all database configuration options.

### Method
GET

### Endpoint
/admin/databases/options

### Response
#### Success Response (200)
- **DATABASE_LIST** (array) - A list of databases with their configurations.

### Response Example
{
  "DATABASE_LIST": [
    {
      "database.name": "db1",
      "query.all.graphs": true
    },
    {
      "database.name": "db2",
      "query.all.graphs": true
    }
  ]
}
```

--------------------------------

### Get Server Properties

Source: https://stardog-union.github.io/http-docs/openapi.json

Retrieves the current values of server configuration properties. This can be used to inspect system settings.

```APIDOC
## GET /admin/properties

### Description
Gets the property value for a server configuration option. This value will be the default for the option or the override in the properties file.

### Method
GET

### Endpoint
/admin/properties

### Parameters
#### Query Parameters
- **name** (string) - Optional - Specific names of server properties to retrieve (multiple params can be specified).

### Response
#### Success Response (200)
- **GENERIC_JSON_OBJECT** - JSON object detailing all server properties.
```

--------------------------------

### List Virtual Graphs Info

Source: https://stardog-union.github.io/http-docs

Retrieves a list of all configured virtual graphs and their basic information. This is useful for an overview of your virtual graph setup.

```json
{
  "virtual_graphs": [
    {
      "name": "string",
      "database": "string",
      "available": true
}
]

}
```

--------------------------------

### Backup All Databases

Source: https://stardog-union.github.io/http-docs

Creates a backup of all databases on the server. The backup location defaults to $STARDOG_HOME/.backup.

```http
put /admin/databases/backup_all
http://localhost:5820/admin/databases/backup_all
```

--------------------------------

### GraphQL Query (GET)

Source: https://stardog-union.github.io/http-docs/openapi.json

Perform a GraphQL query using GET. The query is passed as a URL parameter.

```APIDOC
## GET /graphql

### Description
Perform a GraphQL query using GET. The query is passed as a URL parameter.

### Method
GET

### Endpoint
/graphql

### Parameters
#### Query Parameters
- **db** (string) - Required - The database to query.
- **query** (string) - Required - The GraphQL query string.

### Response
#### Success Response (200)
- **result** (object) - The result of the GraphQL query.

#### Response Example
{
  "result": {
    "data": {
      "yourQuery": "yourResult"
    }
  }
}

#### Error Response (404)
- **message** (string) - Description of the error.
- **code** (string) - Error code.

#### Response Example
{
  "message": "Database does not exist",
  "code": "0D0DU2"
}
```

--------------------------------

### List Running Queries Response Sample

Source: https://stardog-union.github.io/http-docs

This is a sample JSON response for the 'List queries' endpoint, showing the structure of running queries on the server.

```json
{
  "queries": [
    {
      "query": "SELECT * WHERE {?s ?p ?o}",
      "db": "string",
      "endTime": 0,
      "startTime": 0,
      "id": "string",
      "kernelId": "string",
      "timeout": 0,
      "user": "string",
      "reasoning": true,
      "reasoningSchema": "string",
      "status": "Not started"
}
]

}
```

--------------------------------

### Create a New Database

Source: https://stardog-union.github.io/http-docs/openapi.json

Creates a new, empty database.

```APIDOC
## POST /virtual/db

### Description
Creates a new, empty database.

### Method
POST

### Endpoint
/virtual/db

### Parameters
#### Query Parameters
- **db** (string) - Required - The name of the database to create.

### Request Example
{
  "example": "POST /virtual/db?db=newDb HTTP/1.1\nHost: localhost:5820\n"
}

### Response
#### Success Response (200)
- **message** (string) - A confirmation message.

#### Response Example
{
  "message": "Database 'newDb' created successfully."
}
```

--------------------------------

### Backup a Database

Source: https://stardog-union.github.io/http-docs

Creates a backup of a specific database on the server. The backup location defaults to $STARDOG_HOME/.backup.

```http
put /admin/databases/{db}/backup
http://localhost:5820/admin/databases/myDb/backup
```

--------------------------------

### Perform GraphQL Query with Schema (GET)

Source: https://stardog-union.github.io/http-docs/openapi.json

Performs a GraphQL query against a specific schema within a database using the GET method.

```APIDOC
## GET /{db}/graphql/{schema}

### Description
Performs a GraphQL query against a specific schema within a database.

### Method
GET

### Endpoint
`/{db}/graphql/{schema}`

### Parameters
#### Path Parameters
- **db** (string) - Required - The name of the database.
- **schema** (string) - Required - The name of the schema.

#### Query Parameters
- **query** (GRAPHQL_QUERY) - Required - The GraphQL query string.
- **name** (string) - Optional - The name of the schema.

### Responses
#### Success Response (200)
- **GRAPHQL_QUERY_RESULT** - The result of the GraphQL query.
```

--------------------------------

### Get Virtual Graph Options

Source: https://stardog-union.github.io/http-docs/openapi.json

Retrieves the configuration options for a specific virtual graph. This endpoint provides details about how the virtual graph is set up.

```APIDOC
## GET /admin/virtual_graphs/{name}/options

### Description
Get the options for a virtual graph.

### Method
GET

### Endpoint
/admin/virtual_graphs/{name}/options

### Parameters
#### Path Parameters
- **name** (string) - Required - The name of the virtual graph.

### Response
#### Success Response (200)
- **(VIRTUAL_GRAPH_OPTIONS)** - The virtual graph options.

#### Error Response (404)
- Not Found: The specified virtual graph does not exist.
```

--------------------------------

### Perform SPARQL query (GET)

Source: https://stardog-union.github.io/http-docs/openapi.json

Executes a SPARQL query against a specified database using the HTTP GET method. This is suitable for queries that can be passed as URL parameters.

```APIDOC
## GET /{db}/query

### Description
Performs a SPARQL query against the specified database. This endpoint is suitable for GET requests where the query can be passed as a parameter.

### Method
GET

### Endpoint
`/{db}/query`

### Parameters
#### Query Parameters
- **db** (string) - Required - The name of the database to query.
- **query** (string) - Required - The SPARQL query string.
- **reasoning** (boolean) - Optional - Whether to enable reasoning.
- **schema** (boolean) - Optional - Whether to include schema in the query.
- **txid** (string) - Optional - Transaction ID (UUID format).
- **baseURI** (string) - Optional - The base URI for the query.
- **timeout** (integer) - Optional - The query timeout in seconds.
- **limit** (integer) - Optional - The maximum number of results to return.
- **offset** (integer) - Optional - The number of results to skip.
- **useNamespaces** (boolean) - Optional - Whether to use namespaces.
- **default-graph-uri** (string) - Optional - The default graph URI.
- **named-graph-uri** (string) - Optional - The named graph URI.
- **exclude-graph-uri** (string) - Optional - The graph URI to exclude.

### Response
#### Success Response (200)
- **SPARQL_RESULTS** - The results of the SPARQL query.

#### Error Responses
- **400** - `INVALID_QUERY` - The provided query is invalid.
- **404** - Database does not exist.
- **406** - Accept header invalid for the type of query sent.
```

--------------------------------

### Perform SPARQL Update Query (GET)

Source: https://stardog-union.github.io/http-docs/openapi.json

Performs a SPARQL Update query using GET method. Supports various parameters for query execution and transaction management.

```APIDOC
## GET /{db}/update

### Description
Perform SPARQL Update query.

### Method
GET

### Endpoint
`/{db}/update`

### Parameters
#### Path Parameters
- **db** (string) - Required - The database name.

#### Query Parameters
- **QUERY_NOT_REQ** (string) - Optional - SPARQL query string.
- **update** (string) - Optional - SPARQL Update string.
- **reasoning** (boolean) - Optional - Enable reasoning.
- **schema** (boolean) - Optional - Enable schema.
- **txid** (string) - Optional - Transaction ID (UUID format).
- **baseURI** (string) - Optional - Base URI for the query.
- **timeout** (integer) - Optional - Query timeout in seconds.
- **limit** (integer) - Optional - Limit for results.
- **offset** (integer) - Optional - Offset for results.
- **useNamespaces** (boolean) - Optional - Use namespaces.
- **graph-uri** (string) - Optional - Target graph URI.
- **using-graph-uri** (string) - Optional - Using graph URI.
- **default-graph-uri** (string) - Optional - Default graph URI.
- **using-named-graph-uri** (string) - Optional - Using named graph URI.
- **named-graph-uri** (string) - Optional - Named graph URI.
- **exclude-graph-uri** (string) - Optional - Exclude graph URI.
- **insert-graph-uri** (string) - Optional - Insert graph URI.
- **remove-graph-uri** (string) - Optional - Remove graph URI.

### Responses
#### Success Response (200)
- **description**: Update query succeeded

#### Error Response (400)
- **description**: Invalid query sent
- **content**: application/json (schema: GENERIC_RESPONSE_ERROR_MESSAGE)

#### Error Response (404)
- **description**: Database does not exist
- **content**: application/json (schema: {"required": ["message", "code"], "properties": {"message": {"type": "string", "example": "Database does not exist"}, "code": {"type": "string", "example": "0D0DU2"}}})
```

--------------------------------

### Get DB Options Response Sample

Source: https://stardog-union.github.io/http-docs

This JSON response shows the values of specific metadata options for a database after a successful request. It returns the configured values for the requested properties.

```json
{
  "spatial.result.limit": 10000,
  "query.all.graphs": true

}
```

--------------------------------

### Get Data Source Options

Source: https://stardog-union.github.io/http-docs/openapi.json

Retrieves the configuration options for a specific data source. This is useful for inspecting or modifying existing data source settings.

```APIDOC
## GET /admin/data_sources/{name}/options

### Description
Retrieves the configuration options for a specific data source.

### Method
GET

### Endpoint
/admin/data_sources/{name}/options

### Parameters
#### Path Parameters
- **name** (string) - Required - The name of the data source.

### Responses
#### Success Response (200)
- **DATA_SOURCE_OPTIONS** (object) - The data source configuration options.
#### Error Response (404)
- **NAME_DS_404** (object) - Data source not found.
```

--------------------------------

### List Checkpoints

Source: https://stardog-union.github.io/http-docs

Lists all available checkpoints for a given database. Requires the database name as a path parameter.

```json
{
  "checkpoints": [
    {
      "checkpoint": "system_2021-05-14_02.34",
      "description": "Prior to 8.0.1 upgrade"
}
]

}
```

--------------------------------

### Get Cluster Information

Source: https://stardog-union.github.io/http-docs

Retrieves information about the current cluster. Returns a JSON object containing node information. Use this to get a general overview of the cluster's status.

```http
get/admin/cluster
```

```json
{
  "nodes": [
    "165.7.29.42:5820"
  ]

}
```

--------------------------------

### Get query

Source: https://stardog-union.github.io/http-docs

Retrieves details of a specific stored query.

```APIDOC
## Get query

### Description
Get details of a specific query.

### Method
GET

### Endpoint
/admin/queries/{name}

### Parameters
#### Path Parameters
- **name** (string) - Required - The name of the query

#### Query Parameters
- **plan** (string) - Optional - 
- **verbose** (string) - Optional - 

### Responses
#### Success Response (200)
Process

#### Error Response (404)
Query does not exist

### Response Example (200)
```json
{
  "type": "query",
  "db": "string",
  "endTime": 0,
  "startTime": 0,
  "id": "string",
  "user": "string",
  "status": "Not started"
}
```
```

--------------------------------

### Get Role Information

Source: https://stardog-union.github.io/http-docs/openapi.json

Retrieves information about a specific role.

```APIDOC
## GET /security/role/{role}

### Description
Retrieves information about a specific role.

### Method
GET

### Endpoint
/security/role/{role}

### Parameters
#### Path Parameters
- **role** (string) - Required - Role name

### Response
#### Success Response (200)
- **name** (string) - The name of the role.
- **permissions** (array) - A list of permissions associated with the role.

#### Response Example
{
  "name": "admin",
  "permissions": ["read", "write", "delete"]
}
```

--------------------------------

### Get DB Options Request Sample

Source: https://stardog-union.github.io/http-docs

This is a sample JSON payload for requesting specific metadata options for a database. It uses null values to indicate which properties to retrieve.

```json
{
  "spatial.result.limit": null,
  "query.all.graphs": null

}
```

--------------------------------

### Get User Information

Source: https://stardog-union.github.io/http-docs/openapi.json

Retrieves information about a specific user.

```APIDOC
## GET /security/user/{user}

### Description
Retrieves information about a specific user.

### Method
GET

### Endpoint
/security/user/{user}

### Parameters
#### Path Parameters
- **user** (string) - Required - Username

### Response
#### Success Response (200)
- **username** (string) - The username.
- **roles** (array) - A list of roles assigned to the user.

#### Response Example
{
  "username": "alice",
  "roles": ["admin", "editor"]
}
```

--------------------------------

### Get Transaction Information

Source: https://stardog-union.github.io/http-docs/openapi.json

Retrieves information about a specific transaction.

```APIDOC
## GET /virtual/db/{db}/transaction/{txid}

### Description
Retrieves information about a specific transaction.

### Method
GET

### Endpoint
/virtual/db/{db}/transaction/{txid}

### Parameters
#### Path Parameters
- **db** (string) - Required - Database name
- **txid** (string) - Required - Transaction ID

### Response
#### Success Response (200)
- **id** (string) - The transaction ID.
- **status** (string) - The status of the transaction (e.g., ACTIVE, COMMITTED, ROLLED_BACK).
- **startTime** (string) - The timestamp when the transaction started.

#### Response Example
{
  "id": "4ea1ebac-48f0-459c-a9a7-6cad7189403d",
  "status": "COMMITTED",
  "startTime": "2023-10-27T10:05:00Z"
}
```

--------------------------------

### Get Database Information

Source: https://stardog-union.github.io/http-docs/openapi.json

Retrieves information about a specific database.

```APIDOC
## GET /virtual/db/{db}

### Description
Retrieves information about a specific database.

### Method
GET

### Endpoint
/virtual/db/{db}

### Parameters
#### Path Parameters
- **db** (string) - Required - Database name

### Response
#### Success Response (200)
- **name** (string) - The name of the database.
- **size** (integer) - The size of the database in triples.
- **lastModified** (string) - The timestamp of the last modification.

#### Response Example
{
  "name": "myDb",
  "size": 10000,
  "lastModified": "2023-10-27T10:00:00Z"
}
```

--------------------------------

### Get Logs

Source: https://stardog-union.github.io/http-docs/openapi.json

Retrieves logs based on specified options.

```APIDOC
## GET /admin/logs

### Description
Retrieves logs based on specified options.

### Method
GET

### Endpoint
/admin/logs

### Parameters
#### Query Parameters
- **log.rotated** (boolean) - Optional - Flag to include rotated logs or not. Defaults to false.
- **log.types** (array) - Optional - List of log types to include. Defaults to [stardog, starrocks, gc]. Allowed values: [stardog, starrocks, audit, gc].
- **log.line.count** (integer) - Optional - The last N number of lines to return.

### Response
#### Success Response (200)
- **logs** (string) - The log content.

### Response Example
{
  "logs": "Log entry 1\nLog entry 2"
}
```

--------------------------------

### Get Cached Graphs

Source: https://stardog-union.github.io/http-docs/openapi.json

Retrieves a list of all cached graphs.

```APIDOC
## GET /admin/cache/graphs

### Description
Get cached graphs

### Method
GET

### Endpoint
/admin/cache/graphs

### Response
#### Success Response (200)
- **CACHE_GRAPH_LIST** - Description
```

--------------------------------

### Begin Transaction

Source: https://stardog-union.github.io/http-docs/openapi.json

This endpoint initiates a new transaction. It returns the transaction ID upon successful creation.

```APIDOC
## POST /{db}/transaction/begin

### Description
Begin a transaction.

### Method
POST

### Endpoint
/{db}/transaction/begin

### Parameters
#### Path Parameters
- **db** (string) - Required - The database name.

### Response
#### Success Response (200)
- **text/plain** (string) - The unique identifier for the newly created transaction, e.g., "067e6162-3b6f-4ae2-a171-2470b63dff00".

#### Error Response (404)
- **message** (string) - Description of the error.
- **code** (string) - An error code.
```

--------------------------------

### List Databases

Source: https://stardog-union.github.io/http-docs/openapi.json

List all the databases available on the server.

```APIDOC
## GET /admin/databases

### Description
List all the databases in the server.

### Method
GET

### Endpoint
/admin/databases

### Responses
#### Success Response (200)
- DATABASE_LIST (object) - A list of databases.
```

--------------------------------

### Get Cluster Info

Source: https://stardog-union.github.io/http-docs

Retrieves general information about the Stardog cluster.

```APIDOC
## Get cluster info 

### Description
Retrieves general information about the Stardog cluster.

### Method
GET

### Endpoint
/admin/cluster

### Response
#### Success Response (200)
- **nodes** (array of strings) - A list of node addresses in the cluster.

### Response Example
```json
{
  "nodes": [
    "165.7.29.42:5820"
  ]
}
```
```

--------------------------------

### Get User

Source: https://stardog-union.github.io/http-docs/openapi.json

Retrieve attributes, roles, and permissions of a specific user.

```APIDOC
## GET /admin/users/{user}

### Description
Retrieve attributes, roles, and permissions of a User.

### Method
GET

### Endpoint
/admin/users/{user}

### Parameters
#### Path Parameters
- **user** (string) - Required - The identifier for the user.

### Responses
#### Success Response (200)
- USER (object) - The user's attributes, roles, and permissions.

#### Error Response (404)
- **message** (string) - Example: "User does not exist"
- **code** (string) - Example: "SERNF2"
```

--------------------------------

### Create Checkpoint

Source: https://stardog-union.github.io/http-docs

Creates a new checkpoint for a database. Requires the database name as a path parameter and an optional description.

```json
{
  "description": "Prior to 8.0.2 upgrade"

}
```

--------------------------------

### Get Stored Query

Source: https://stardog-union.github.io/http-docs/openapi.json

Retrieve a specific stored query by its name.

```APIDOC
## GET /admin/queries/stored/{name}

### Description
Get stored query

### Method
GET

### Endpoint
/admin/queries/stored/{name}

### Parameters
#### Path Parameters
- **name** (string) - Required - The name of the stored query.

### Response
#### Success Response (200)
- Description: The stored query details
#### Error Response (404)
- Description: Stored query not found
```

--------------------------------

### Create a New User

Source: https://stardog-union.github.io/http-docs/openapi.json

Creates a new user in the system.

```APIDOC
## POST /security/user

### Description
Creates a new user in the system.

### Method
POST

### Endpoint
/security/user

### Parameters
#### Request Body
- **username** (string) - Required - The username for the new user.
- **password** (string) - Required - The password for the new user.
- **roles** (array) - Optional - A list of roles to assign to the new user.

### Request Example
{
  "example": "POST /security/user HTTP/1.1\nHost: localhost:5820\nContent-Type: application/json\n\n{\"username\": \"newuser\", \"password\": \"password123\", \"roles\": [\"viewer\"]}"
}

### Response
#### Success Response (200)
- **message** (string) - A confirmation message.

#### Response Example
{
  "message": "User 'newuser' created successfully."
}
```

--------------------------------

### Get Stored Function

Source: https://stardog-union.github.io/http-docs/openapi.json

Retrieves a specific stored function by its name.

```APIDOC
## GET /admin/functions/stored/{name}

### Description
Get Stored Function.

### Method
GET

### Endpoint
/admin/functions/stored/{name}

### Parameters
#### Path Parameters
- **name** (string) - Required - The name of the stored function.

### Responses
#### Success Response (200)
- **description**: Operation successful.
- **content**: text/plain (string) - The stored function definition.
#### Error Response (400)
- **description**: Function does not exist.
#### Error Response (404)
- **NAME_FUNCTION_404** (object) - Function not found.
```

--------------------------------

### Describe Data Source Types and Options

Source: https://stardog-union.github.io/http-docs

Retrieves a JSON object describing supported data source types and their configuration options. This is useful for understanding available parameters for data source creation and configuration.

```json
{
  "data_source_type_description": {
    "DATA_SOURCE_OPTIONS": {
      "property1": {
        "default": null,
        "type": "string",
        "description": "string",
        "examples": [
          null
],
        "required": false,
        "optionGroup": "advanced options"
},
      "property2": {
        "default": null,
        "type": "string",
        "description": "string",
        "examples": [
          null
],
        "required": false,
        "optionGroup": "advanced options"
}
},
    "VIRTUAL_GRAPH_OPTIONS": {
      "property1": {
        "default": null,
        "type": "string",
        "description": "string",
        "examples": [
          null
],
        "required": false,
        "optionGroup": "advanced options"
},
      "property2": {
        "default": null,
        "type": "string",
        "description": "string",
        "examples": [
          null
],
        "required": false,
        "optionGroup": "advanced options"
}
},
    "DATA_SOURCE_FAMILIES": {
      "DATA_SOURCE_OPTIONS": {
        "property1": {
          "default": null,
          "type": "string",
          "description": "string",
          "examples": [
            null
],
          "required": false,
          "optionGroup": "advanced options"
},
        "property2": {
          "default": null,
          "type": "string",
          "description": "string",
          "examples": [
            null
],
          "required": false,
          "optionGroup": "advanced options"
}
},
      "VIRTUAL_GRAPH_OPTIONS": {
        "property1": {
          "default": null,
          "type": "string",
          "description": "string",
          "examples": [
            null
],
          "required": false,
          "optionGroup": "advanced options"
},
        "property2": {
          "default": null,
          "type": "string",
          "description": "string",
          "examples": [
            null
],
          "required": false,
          "optionGroup": "advanced options"
}
}
},
    "DATA_SOURCE_TYPES": {
      "label": "string",
      "dataSourceFamily": "CASSANDRA",
      "vendorClientDownloadUrl": "string",
      "vendorClientDocumentationUrl": "string",
      "driverInstalled": true,
      "DATA_SOURCE_OPTIONS": {
        "jdbc.url": {
          "examples": [
            "string"
]
},
        "jdbc.driver": {
          "default": "string"
}
}
}
}

}
```

--------------------------------

### List All Processes

Source: https://stardog-union.github.io/http-docs

Retrieves a list of all running processes on the server. The 'all' query parameter can be used to include processes in the cloud.

```json
{
  "processes": [
    {
      "type": "query",
      "db": "string",
      "endTime": 0,
      "startTime": 0,
      "id": "string",
      "user": "string",
      "status": "Not started"
}
]

}
```

--------------------------------

### Get User Permissions

Source: https://stardog-union.github.io/http-docs/openapi.json

Retrieves all permissions assigned to a specific user.

```APIDOC
## GET /admin/permissions/user/{user}

### Description
Get all permissions assigned to a given user.

### Method
GET

### Endpoint
/admin/permissions/user/{user}

### Parameters
#### Path Parameters
- **user** (string) - Required - The username for which to retrieve permissions.

### Request Example
None

### Response
(Response details not provided in the source text)
```

--------------------------------

### Get DB options

Source: https://stardog-union.github.io/http-docs

Retrieves the value of specific metadata options for a database.

```APIDOC
## Get DB options

### Description
Get the value of specific metadata options for a database.

### Method
PUT

### Endpoint
/admin/databases/{db}/options

### Parameters
#### Path Parameters
- **db** (string) - Required - Database name.

### Request Body
- **additional property** (string) - Required - Property name.

### Request Example
```json
{
  "spatial.result.limit": null,
  "query.all.graphs": null
}
```

### Responses
#### Success Response (200)
Operation successful.

#### Error Response (404)
Database does not exist.

### Response Example
```json
{
  "spatial.result.limit": 10000,
  "query.all.graphs": true
}
```
```

--------------------------------

### List Data Sources Info

Source: https://stardog-union.github.io/http-docs

Retrieves a list of all configured data sources and their basic information. This is useful for an overview of available data sources.

```json
{
  "data_sources": [
    {
      "entityName": "string",
      "sharable": true,
      "available": true
}
]

}
```

--------------------------------

### Begin Transaction

Source: https://stardog-union.github.io/http-docs/openapi.json

Begins a new transaction with a specified transaction ID.

```APIDOC
## POST /{db}/transaction/begin/{txid}

### Description
Begin a transaction with specified txid

### Method
POST

### Endpoint
/{db}/transaction/begin/{txid}

### Parameters
#### Path Parameters
- **db** (string) - Required - The name of the database
- **txid** (string) - Required - The transaction ID

### Response
#### Success Response (200)
- **text/plain** (string) - Transaction begun

### Response Example
```text
067e6162-3b6f-4ae2-a171-2470b63dff00
```

#### Error Response (404)
- **application/json** - Database/Transaction does not exist
  - **message** (string) - Error message
  - **code** (string) - Error code
```

--------------------------------

### Get standby node status

Source: https://stardog-union.github.io/http-docs

Retrieves the status information for a standby node.

```APIDOC
## GET /admin/cluster/standby/status

### Description
Retrieves the status of a standby node.

### Method
GET

### Endpoint
/admin/cluster/standby/status

### Responses
#### Success Response (200)
Operation successful

### Response Example
```json
{
  "address": "string",
  "state": "string",
  "readReplica": false,
  "geoReplica": false,
  "totalBytesToSync": 0,
  "syncCount": 0,
  "stardogVersion": "string",
  "syncIntervalMs": 0,
  "lastClusterAdminTx": "string",
  "lastStandbyNodeAdminTx": "string",
  "dbSyncBytes": {
    "property1": 42,
    "property2": 42
  }
}
```
```

--------------------------------

### Get Prometheus Metrics

Source: https://stardog-union.github.io/http-docs

Retrieves metric information from the registry in Prometheus format.

```APIDOC
## Get Prometheus Metrics

### Description
Retrieves metric information from the registry in Prometheus format.

### Method
GET

### Endpoint
/admin/status/prometheus

### Query Parameters
- **include** (string) - Optional - Regex used to match metric names to be included.
- **exclude** (string) - Optional - Regex used to match metric names to be excluded, takes precedence over include.

### Responses
#### Success Response (200)
Returns Prometheus metrics.
```

--------------------------------

### Generate Reasoning Model

Source: https://stardog-union.github.io/http-docs

Generate the reasoning model for a database in various RDF formats. Optionally enable reasoning and specify the output format. Returns 404 if the database does not exist.

```turtle
@prefix : <urn:example:> .
@prefix owl: <http://www.w3.org/2002/07/owl#> .
@prefix rdf: <http://www.w3.org/1999/02/22-rdf-syntax-ns#> .
@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
@prefix stardog: <tag:stardog:api:> .
@prefix xsd: <http://www.w3.org/2001/XMLSchema#> .

<urn:example:Entity1> a <urn:example:Entity> ;
	<urn:example:hasProp> 42 .

```

--------------------------------

### Get Stored Process Information

Source: https://stardog-union.github.io/http-docs/openapi.json

Retrieves information about a specific stored process.

```APIDOC
## GET /virtual/db/{db}/process/{name}

### Description
Retrieves information about a specific stored process.

### Method
GET

### Endpoint
/virtual/db/{db}/process/{name}

### Parameters
#### Path Parameters
- **db** (string) - Required - Database name
- **name** (string) - Required - The name of the stored process

### Response
#### Success Response (200)
- **name** (string) - The name of the stored process.
- **script** (string) - The script content of the stored process.

#### Response Example
{
  "name": "myProcess",
  "script": "// Stored process script content"
}
```

--------------------------------

### Bring Database Online

Source: https://stardog-union.github.io/http-docs

Brings a database online. Specify a timeout in milliseconds for the operation.

```http
put /admin/databases/{db}/online
http://localhost:5820/admin/databases/myDb/online
```

--------------------------------

### List of Reasoning Proofs

Source: https://stardog-union.github.io/http-docs/openapi.json

Retrieves a list of reasoning proofs. This endpoint is relevant for systems utilizing Stardog's reasoning capabilities.

```APIDOC
## GET /reasoning/proofs

### Description
Retrieves a list of reasoning proofs.

### Method
GET

### Endpoint
/reasoning/proofs

### Response
#### Success Response (200)
- **REASONING_PROOF_LIST** (object) - A list of reasoning proofs.
```

--------------------------------

### Get Stored Query Information

Source: https://stardog-union.github.io/http-docs/openapi.json

Retrieves information about a specific stored query.

```APIDOC
## GET /virtual/db/{db}/query/{name}

### Description
Retrieves information about a specific stored query.

### Method
GET

### Endpoint
/virtual/db/{db}/query/{name}

### Parameters
#### Path Parameters
- **db** (string) - Required - Database name
- **name** (string) - Required - The name of the stored query

### Response
#### Success Response (200)
- **name** (string) - The name of the stored query.
- **query** (string) - The SPARQL query string.

#### Response Example
{
  "name": "myQuery",
  "query": "SELECT ?s WHERE { ?s a ?type . }"
}
```

--------------------------------

### List processes

Source: https://stardog-union.github.io/http-docs

Retrieves a list of all running processes on the server. An option to include all processes in the cloud is available.

```APIDOC
## List processes 

### Description
Get a list of all running processes

### Method
GET

### Endpoint
/admin/processes

### Query Parameters
- **all** (boolean) - Optional - Whether to include all processes in cloud

### Responses
#### Success Response (200)
List of Processes

### Response Example
```json
{
  "processes": [
    {
      "type": "query",
      "db": "string",
      "endTime": 0,
      "startTime": 0,
      "id": "string",
      "user": "string",
      "status": "Not started"
    }
  ]
}
```
```

--------------------------------

### Get Stored Function Information

Source: https://stardog-union.github.io/http-docs/openapi.json

Retrieves information about a specific stored function.

```APIDOC
## GET /virtual/db/{db}/function/{name}

### Description
Retrieves information about a specific stored function.

### Method
GET

### Endpoint
/virtual/db/{db}/function/{name}

### Parameters
#### Path Parameters
- **db** (string) - Required - Database name
- **name** (string) - Required - The name of the stored function

### Response
#### Success Response (200)
- **name** (string) - The name of the stored function.
- **language** (string) - The language of the stored function (e.g., SPARQL, JavaScript).
- **body** (string) - The body of the stored function.

#### Response Example
{
  "name": "myFunction",
  "language": "SPARQL",
  "body": "SELECT ?s WHERE { ?s a ?type . }"
}
```
Tokens:
Raw