Update API key

patch

https://api.loopcrypto.xyz/api/v2/api-key/{apiKeyId}

Updates an API key associated with the authenticated entity. You can modify the name and permissions associated with the API key. The actual API key value cannot be changed. If you need to rotate the API key, you should delete the existing one and create a new one. Note that updating an API key name does not affect its validity or permissions.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

apiKeyId

string

required

The unique identifier of the API key to be updated. This must be a valid API key ID associated with your entity. This is not the API key value, but the unique identifier for the API key that can be obtained using the list API keys endpoint.

Body Params

name

string

(Optional) The new name that identifies the API key

grantPermissions

array of strings

(Optional) The list of additional permissions to grant to the API key. These will be added to any existing permissions

Valid values: CreateEntities, UpdateEntities, CreateApiKeys, UpdateApiKey, GetApiKeys, DeactivateApiKey, CreateMerchants, UpdateMerchants, GetMerchants, CreatePaymentTypes, GetPaymentTypes, DeletePaymentTypes, CreatePayoutDestinations, GetPayoutDestinations, DeletePayoutDestinations, CreatePaymentMethods, GetPaymentMethods, DeletePaymentMethods, CreatePayins, GetPayins, CreateCustomers, GetCustomers, CreateWebhooks, GetWebhooks, DeleteWebhooks, UpdateWebhooks, CreateWebhookSecret, GetWebhookSecret, GetTokens

grantPermissions

revokePermissions

array of strings

(Optional) The list of permissions to revoke from the API key. These will be removed from any existing permissions

revokePermissions

Responses

200Ok

401Unauthorized

403Forbidden

404Not Found

422Unprocessable Content

500Internal Server Error

504Gateway Timeout