Masumi Logo

/api-key

Creates a API key

POST
/api-key
token<token>

API key authentication via header (token)

In: header

usageLimited?string

Whether the API key is usage limited. Meaning only allowed to use the specified credits or can freely spend

Default"true"
UsageCreditsarray<object>

The credits allowed to be used by the API key. Only relevant if usageLimited is true.

networkLimit?array<string>

The networks the API key is allowed to use

Default["Mainnet","Preprod"]
permission?string

The permission of the API key

Default"Read"
Value in"Read" | "ReadAndPay" | "Admin"

Response Body

curl -X POST "https://loading/./../api/v1/api-key/" \
  -H "Content-Type: application/json" \
  -d '{
    "usageLimited": "true",
    "UsageCredits": [
      {
        "unit": "",
        "amount": "10000000"
      }
    ],
    "permission": "Admin"
  }'
{
  "status": "success",
  "data": {
    "id": "unique_cuid_v2_of_entry_to_delete",
    "token": "masumi_payment_api_key_secret",
    "permission": "Admin",
    "usageLimited": true,
    "networkLimit": [
      "Preprod"
    ],
    "status": "Active"
  }
}
Empty
Empty
Empty