Create dir example:

curl -X 'POST' \
'http://localhost:3003/api/v1/filespaces/dcb2e737-1bd7-4a81-bf3b-03f6789bb8a6/entries' \
-H 'accept: application/json' \
-H 'Authorization: Bearer <Bearer_token> -H 'Content-Type: application/json' \
-d '{
"parentId": "4294967294:0",
"name": "myDir",
"type": "dir"
}'

List dir example (with default page size):

curl -X 'GET' \
'http://localhost:3003/api/v1/filespaces/dcb2e737-1bd7-4a81-bf3b-03f6789bb8a6/entries/103%3A3/children' \
-H 'accept: application/json' \
-H 'Authorization: Bearer <Bearer_token>

List dir example (with explicitly set page size):

curl -X 'GET' \
'http://localhost:3003/api/v1/filespaces/dcb2e737-1bd7-4a81-bf3b-03f6789bb8a6/entries/103%3A3/children?limit=50' \
-H 'accept: application/json' \
-H 'Authorization: <Bearer_token>

LucidLink Connect API

The LucidLink Connect API enables the connection of external data stores (such as S3 object storage) and the linking of stored assets directly within the filespace without the need to first download or copy the data into the filespace. Linked assets can then be streamed directly from any compatible LucidLink client (desktop, mobile, web) in the same manner as data added through conventional means.

The Connect API allows integration and automation opportunities for existing data in its native form. This may be from a standalone bucket, or from storage being managed by another service or application. Multiple data sources from multiple different providers can be linked in a single filespace.

Note that only linking is performed via the API - data access itself is achieved through LucidLink client applications. 

LucidLink Connect is a purchased add-on available only to LucidLink Enterprise plans.

Core API Capabilities

The LucidLink Connect API provides the following endpoints:

Due to the fact that assets linked via LucidLink Connect are stored outside of LucidLink in their native format and without client-side encryption, they are not covered by LucidLink’s zero-knowledge guarantees.

This does not mean that LucidLink Connect is insecure - merely that it offers a more relaxed mode of data privacy on par with the data storage providers from whom the data is being streamed. 

More explicitly, this means that it is not technically impossible for  the external storage provider, or for LucidLink with authorised access, to view or access external entries linked via LucidLink Connect (in contrast with the architecture of our base product). However, LucidLink does not read or download the contents of externally linked storage as part of normal operations. 

As a matter of policy, customer file contents are not accessed during day-to-day use of LucidLink Connect. Because LucidLink Connect is not designed to make access to externally linked data cryptographically impossible, LucidLink retains a technical capability to access such data in exceptional circumstances where this is necessary to operate or support the service and where authorised internal access is used. Any such access is subject to LucidLink’s internal security controls, including restricted access, role-based permissions, and logging.

This differs from LucidLink’s standard layout, which is designed to prevent LucidLink from accessing customer data by design. Customers should therefore treat LucidLink Connect as operating under a trusted service-provider model rather than a strict zero-knowledge model.

Endpoints: LucidLink Connect

Create DataStore example:

curl -X 'POST' \
'http://localhost:3003/api/v1/filespaces/dcb2e737-1bd7-4a81-bf3b-03f6789bb8a6/external/data-stores' \
-H 'accept: application/json' \
-H 'Authorization: Bearer <Bearer_token> -H 'Content-Type: application/json' \
-d '{
"name": "my_bucket",
"kind": "S3DataStore",
"s3StorageParams": {
"accessKey": "AKIAIOSFODNN7EXAMPLE",
"bucketName": "my-company-data",
"region": "us-east-1",
"useVirtualAddressing": true,
"secretKey": "<Secret_key>",
"urlExpirationMinutes": 10080
}
}'

List DataStores example:

curl -X 'GET' \
'http://localhost:3003/api/v1/filespaces/dcb2e737-1bd7-4a81-bf3b-03f6789bb8a6/external/data-stores' \
-H 'accept: application/json' \
-H 'Authorization: Bearer <Bearer_token>

Create ExternalEntry example:

curl -X 'POST' \
'http://localhost:3003/api/v1/filespaces/dcb2e737-1bd7-4a81-bf3b-03f6789bb8a6/external/entries' \
-H 'accept: application/json' \
-H 'Authorization: Bearer <Bearer_token> -H 'Content-Type: application/json' \
-d '{
"path": "/Documents/Project",
"kind": "SingleObjectFile",
"dataStoreId": "string",
"singleObjectFileParams": {
"objectId": "string"
}
}'

List ExternalEntry IDs example:

curl -X 'GET' \
'http://localhost:3003/api/v1/filespaces/dcb2e737-1bd7-4a81-bf3b-03f6789bb8a6/external/entries/ids' \
-H 'accept: application/json' \
-H 'Authorization: <Bearer_token>