Provide Key 1

POST /custodian/key1

Provide key 1 to unlock the locker.

cURL
curl --request POST \
  --url https://api.example.com/custodian/key1 \
  --header 'Content-Type: application/json' \
  --data '
{
  "key": "801bb63c1bd51820acbc8ac20c674675"
}
'

Headers

  • x-tenant-id — string

Body (application/json)

  • key — string — required Example: "801bb63c1bd51820acbc8ac20c674675"

Response

  • 200 — text/plain Key 1 provided Example:

    "Received Key1"

Related:

  • Get Health: https://api-reference.hyperswitch.io/locker-api-reference/locker-health/get-health

  • Provide Key 2: https://api-reference.hyperswitch.io/locker-api-reference/key-custodian/provide-key-2

Suggest edits: https://github.com/juspay/hyperswitch/edit/main/api-reference/locker-api-reference/key-custodian/provide-key-1.mdx Raise issue: https://github.com/juspay/hyperswitch/issues/new?title=Issue%20on%20docs&body=Path:%20/locker-api-reference/key-custodian/provide-key-1

Previouskey-custodianNextProvide Key 2