Sign in
api-key

Get information about all API keys. (admin access required)

Changed on

Gets api key status

get/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

Query parameters

takenumber

The number of API keys to return

cursorIdstring

Used to paginate through the API keys (provide the id of the last returned key)

Response

Api key status

statusstring required

Example response

{
  "data": {
    "ApiKeys": [
      {
        "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": "Active",
        "walletScopeEnabled": false,
        "WalletScopes": [],
        "x402WalletScopeEnabled": false,
        "X402WalletScopes": []
      }
    ]
  },
  "status": "Success"
}

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