Create key store

POST

/v1/key-store/

Creates a new key store and registers it for secure operations.

Request

Add parameter in header authorization

Example: Authorization: Bearer <token>

Body Params application/json

key string required

Unique identifier serving as the lookup key for retrieving and managing stored data.

≤ 128 characters · Match pattern: ^^(?!admin)[a-z][a-z0-9-_]+[a-z0-9]$

data object required

Stored value associated with the key containing arbitrary structured data such as configuration settings, user preferences, feature states, or application-specific payloads.

force boolean optional

Flag indicating whether to overwrite existing entries with the same key without raising conflicts.

createOrUpdate boolean optional

Flag enabling upsert behavior that creates new entries or updates existing ones when the key is already present.

{
    "key": "string",
    "data": {},
    "force": true,
    "createOrUpdate": true
}

Responses

200 Response application/json

status boolean required

data object required

key string required

Unique identifier serving as the lookup key for retrieving and managing stored data.

≤ 128 characters · Match pattern: ^^(?!admin)[a-z][a-z0-9-_]+[a-z0-9]$

data object required

Stored value associated with the key containing arbitrary structured data such as configuration settings, user preferences, feature states, or application-specific payloads.

createdBy string required

Identifier referencing the user who initiated resource creation, enabling attribution, accountability tracking, ownership, and establishing audit trail for resource origin and responsibility assignment purposes.

Match pattern: ^[a-fA-F0-9]{24}$

{
    "status": true,
    "data": {
        "key": "string",
        "data": {},
        "createdBy": "string"
    }
}

401 Response application/json

status boolean optional

false

error object optional

code number optional

4004

message string optional

Invalid Token

{
    "status": false,
    "error": {
        "code": 4002,
        "message": "No auth token"
    }
}

404 Response application/json

status boolean optional

false

error object optional

code number optional

3001

message string optional

Entity not found

{
    "status": false,
    "error": {
        "code": 3001,
        "message": "Entity not found"
    }
}