Doc Store

Get the document value for a given key

get

Retrieves the document content and version for the specified key. Returns 404 if the key does not exist. The version can be used for optimistic concurrency control in subsequent updates.

Authorizations

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

keystringRequired

Responses

200

The document value has been successfully retrieved.

No content

403

Forbidden - Requires role: member, application

404

The key was not found.

500

Internal server error.

get

/sfp/api/doc-store/docs/{key}

HTTPcURLJavaScriptPython

GET /sfp/api/doc-store/docs/{key} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Create or update a document entry

post

Stores or updates a document with the specified key. Supports optimistic concurrency control via version parameter. If version is provided, it must match the current version for updates. For new documents, version should not be provided.

Authorizations

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

keystringRequired

Body

application/json

valueobjectOptional

Responses

201

The document entry has been successfully created or updated.

403

Forbidden - Requires role: member, application

500

Internal server error.

post

/sfp/api/doc-store/docs/{key}

HTTPcURLJavaScriptPython

POST /sfp/api/doc-store/docs/{key} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 12

{
  "value": {}
}

No content

Delete a document entry

delete

Permanently removes a document from the store. This operation cannot be undone. Returns 404 if the key does not exist. Only users with owner role or application tokens can perform this operation.

Authorizations

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

keystringRequired

Body

application/json

versionnumberOptional

Responses

204

The document entry has been successfully deleted.

403

Forbidden - Requires role: owner, application

404

The key was not found.

409

Version mismatch.

500

Internal server error.

delete

/sfp/api/doc-store/docs/{key}

HTTPcURLJavaScriptPython

DELETE /sfp/api/doc-store/docs/{key} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 13

{
  "version": 1
}

No content

Get the document version for a given key

get

Retrieves only the version number for the specified key without the document content. Useful for checking if a document has been modified before fetching the full content. Returns 404 if the key does not exist.

Authorizations

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

keystringRequired

Responses

200

The document version has been successfully retrieved.

No content

403

Forbidden - Requires role: member, application

404

The key was not found.

500

Internal server error.

get

/sfp/api/doc-store/docs/{key}/version

HTTPcURLJavaScriptPython

GET /sfp/api/doc-store/docs/{key}/version HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

List all keys

get

Returns an array of all document keys in the store. This operation may be expensive for large stores. Keys are returned in no particular order. Use with caution in production environments with many documents.

Authorizations

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

standaloneDocumentsOnlybooleanOptional

When true, returns only documents that are not part of any collection (collection_id is null). When false or omitted, returns all documents including those in collections.

Responses

200

The list of keys has been successfully retrieved.

No content

403

Forbidden - Requires role: member, application

500

Internal server error.

get

/sfp/api/doc-store/docs

HTTPcURLJavaScriptPython

GET /sfp/api/doc-store/docs HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content