Add Data in Locker

POST /api/v2/vault/add

cURL
curl --request POST \
  --url https://api.example.com/api/v2/vault/add \
  --header 'Content-Type: application/json' \
  --data '
{
  "entity_id": "<string>",
  "vault_id": "<string>",
  "data": {},
  "ttl": 123
}
'

Headers

  • x-tenant-id (string)

Body (application/json)

The request body might be JWE + JWS encrypted when using middleware.

Possible body formats:

  • Option 1: JWEReq

  • Option 2: (plain JSON as shown in the example)

Fields:

  • entity_id (string) Unique identifier for the entity

  • vault_id (string) Unique identifier for the vault

  • data (object) Arbitrary object to store

  • ttl (integer) Time-to-live in seconds

Responses

200 — application/json

Store Data Response

  • Option 1: JWERes

Response fields:

  • entity_id (string) Unique identifier for the entity

  • vault_id (string) Unique identifier for the vault

Suggest edits: https://github.com/juspay/hyperswitch/edit/main/api-reference/locker-api-reference/locker-general-purpose-storage/add-data-in-locker.mdx

Raise issue: https://github.com/juspay/hyperswitch/issues/new?title=Issue%20on%20docs&body=Path:%20/locker-api-reference/locker-general-purpose-storage/add-data-in-locker

Related:

  • https://api-reference.hyperswitch.io/locker-api-reference/cards/get-or-insert-the-card-fingerprint

  • https://api-reference.hyperswitch.io/locker-api-reference/locker-general-purpose-storage/retrieve-data-from-locker

PreviousInvalidate windowsNextUnlock the locker