Sign in
api-key

Delete an existing API key. (admin access required)

Changed on

Removes a API key

delete/api-key

Request

  • Base URL: ./../api/v1/ (relative, and the document was published on a file host, not at the API’s origin)
  • URL: ./../api/v1/api-key
  • Auth: API key in header token

Request body

idstring required

The id of the API key to be (soft) deleted.

Example request

{
  "id": "id_or_apiKey_unique_cuid_v2_of_entry_to_delete"
}

Response

API key deleted

statusstring required

Example response

{
  "status": "Success",
  "data": {
    "id": "api_key_id",
    "token": "masumi_payment_api_key_secret",
    "permission": "Admin",
    "canRead": true,
    "canPay": true,
    "canAdmin": true,
    "usageLimited": true,
    "NetworkLimit": [
      "Preprod"
    ],
    "ChainIdLimit": [
      "cardano:preprod"
    ],
    "RemainingUsageCredits": [
      {
        "unit": "",
        "amount": "10000000"
      }
    ],
    "status": "Revoked",
    "walletScopeEnabled": false,
    "WalletScopes": [],
    "x402WalletScopeEnabled": false,
    "X402WalletScopes": []
  }
}

Changes

  • 315a2a763fb7Revision changes
    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

  • 87b151d07425Revision changes
    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status