API Documentation

The Lucid API is the logical interface used to interact with a node. By default, your node's server listens on port 7021.

Store Data (Create & Update)

PUT https://localhost:7021/api/kv/:key

This endpoint allows you store data at a specific key. If the key is not used yet, it will be created.

Path Parameters

Name	Type	Description
key	string	Key of the value to store

Headers

Name	Type	Description
Authorization	string	API authentification JSON Web Token

Request Body

Name	Type	Description
Raw Body	string	Raw body (Plain text, JSON, ...) or raw binary content

200 Data was successfully updated.

{
  "message": "The specified key was successfully updated."
}

201 Data was successfully created.

{
  "message": "The specified key was successfully created."
}

401

{
  "message": "You are not allowed to perform this action."
}

409

{
  "message": "The specified key cannot be updated."
}

Get Data

GET https://localhost:7021/api/kv/:key

This endpoint allows you to get data associated with a key.

Path Parameters

Name	Type	Description
key	string	Key of the data to get

Headers

Name	Type	Description
Authorization	string	API authentification JSON Web Token

200

hello world

404

{
  "message": "The specified key does not exists."
}

Delete Data

DELETE https://localhost:7021/api/kv/:key

This endpoint allows you to delete an existing key with its associated data.

Path Parameters

Name	Type	Description
key	string	Key of the data to remove

Headers

Name	Type	Description
Authorization	string	API authentification JSON Web Token

200

{
  "message": "The specified key and its data was successfully deleted."
}

401

{
  "message": "You are not allowed to perform this action."
}

404

{
  "message": "The specified key does not exists."
}

Check key initialization

HEAD https://localhost:7021/api/kv/:key

Check if a key was initialized in the Lucid node.

Path Parameters

Name	Type	Description
key	string	Key of the data to check

Headers

Name	Type	Description
Authorization	string	API authentification JSON Web Token

200 The specified key is initialized.

{
  "message": "The specified key is initialized."
}

401

{
  "message": "You are not allowed to perform this action."
}

404

{
  "message": "The specified key does not exists."
}

Execute a Specific Operation

PATCH https://localhost:7021/api/kv/:key

Execute some operation like lock/unlock or other.

Path Parameters

Name	Type	Description
key	string	Key of the data to operate

Headers

Name	Type	Description
Authorization	string	API authentification JSON Web Token

Request Body

Name	Type	Description
operation	string	Operation to perform (lock, unlock etc)

200