Update key store

PUT

/v1/key-store/:keyStoreKey

Updates an existing key store with new configuration or metadata.

Request

Add parameter in header authorization

Example: Authorization: Bearer <token>

keyStoreKey string

required

URL path parameter identifying which key-value store entry to retrieve, update, or delete.

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

Body Params application/json

data object optional

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.

{
    "data": {},
    "force": 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"
    }
}