API Key - Update

Update an existing API Key.

• Method: PUT

• Path: /v2/api-keys/{id}

• Host (sandbox example): https://sandbox.hyperswitch.io

Authorization

Header: api-key (string, required) Admin API keys allow privileged actions such as creating a merchant account and Connector account.

Path parameters

Name	Type	Required	Description
id	string	yes	The unique identifier for the API Key

Request body

Content-Type: application/json

Properties:

• name — string | null A unique name for the API Key to help you identify it. Maximum length: 64 Example: "Sandbox integration key"

• description — string | null A description to provide more context about the API Key. Maximum length: 256 Example: "Key used by our developers to integrate with the sandbox environment"

• expiration — enum | string Available option: never

Example request (cURL)

cURL

curl --request PUT \
  --url https://sandbox.hyperswitch.io/v2/api-keys/{id} \
  --header 'Content-Type: application/json' \
  --header 'api-key: <api-key>' \
  --data '
{
  "name": "Sandbox integration key",
  "description": "Key used by our developers to integrate with the sandbox environment",
  "expiration": "never"
}
'

Example response (200 — application/json)

Response body

{
  "key_id": "5hEEqkgJUyuxgSKGArHA4mWSnX",
  "merchant_id": "y3oqhf46pyzuxjbcn2giaqnb44",
  "name": "Sandbox integration key",
  "prefix": "<string>",
  "created": "2022-09-10T10:11:12Z",
  "expiration": "never",
  "description": "Key used by our developers to integrate with the sandbox environment"
}

Response fields

• key_id — string The identifier for the API Key. Max length: 64. Example: "5hEEqkgJUyuxgSKGArHA4mWSnX"

• merchant_id — string The identifier for the Merchant Account. Max length: 64. Example: "y3oqhf46pyzuxjbcn2giaqnb44"

• name — string The unique name for the API Key. Max length: 64. Example: "Sandbox integration key"

• prefix — string The first few characters of the plaintext API Key to help you identify it.

• created — string (date-time) The time at which the API Key was created. Example: "2022-09-10T10:11:12Z"

• expiration — enum | string Available option: never

• description — string | null Description for context. Max length: 256. Example: "Key used by our developers to integrate with the sandbox environment"

Links

• Suggest edits: https://github.com/juspay/hyperswitch/edit/main/api-reference/v2/api-key/api-key--update.mdx

• Raise issue: https://github.com/juspay/hyperswitch/issues/new?title=Issue%20on%20docs&body=Path:%20/v2/api-key/api-key--update

Related:

• API Key — Retrieve: https://api-reference.hyperswitch.io/v2/api-key/api-key--retrieve

• API Key — Revoke: https://api-reference.hyperswitch.io/v2/api-key/api-key--revoke