Api Keys

Manage API keys for the Masumi Registry Service API

/api-key-status

This endpoint is used for checking the status of the existing API keys.

REQUIRES API KEY Authentication (+user)

get

Gets the status of an API key

Authorizations

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url './../api/v1//api-key-status/' \
  --header 'token: YOUR_API_KEY'

200

200

{
  "data": {
    "token": "masumi-registry-api-key-secret",
    "permission": "Admin",
    "usageLimited": true,
    "maxUsageCredits": 1000000,
    "accumulatedUsageCredits": 0,
    "status": "Active"
  },
  "status": "success"
}

API Key Status

/api-key

These endpoints are used for managing API keys.

REQUIRES API KEY Authentication (+admin)

get

Gets registry sources, can be paginated

Authorizations

Query parameters

cursorIdstring · max: 550optional

limitinteger · min: 1 · max: 100 · default: 10optional

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url './../api/v1//api-key/' \
  --header 'token: YOUR_API_KEY'

200

400

401

500

200

{
  "data": {
    "apiKeys": [
      {
        "token": "masumi-registry-api-key-secret",
        "permission": "Admin",
        "usageLimited": true,
        "maxUsageCredits": 1000000,
        "accumulatedUsageCredits": 0,
        "status": "Active"
      }
    ]
  },
  "status": "success"
}

Registry entries

REQUIRES API KEY Authentication (+admin)

post

Create a new API key

Authorizations

Body

usageLimitedboolean · default: falseoptional

maxUsageCreditsinteger | nullableoptional

permissionstring · enum · default: "User"optional

Options: User, Admin

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url './../api/v1//api-key/' \
  --header 'token: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "permission": "Admin",
    "usageLimited": true,
    "maxUsageCredits": 1000000
  }'

200

400

401

500

200

{
  "data": {
    "id": "unique-cuid-v2-auto-generated",
    "status": "Active",
    "token": "masumi-registry-api-key-secret",
    "permission": "User",
    "usageLimited": true,
    "maxUsageCredits": 1000000,
    "accumulatedUsageCredits": 0
  },
  "status": "success"
}

API Key

REQUIRES API KEY Authentication (+admin)

patch

Updates a API key

Authorizations

Body

apiKeystring · max: 550required

usageLimitedboolean · default: falseoptional

maxUsageCreditsinteger | nullableoptional

statusstring · enum · default: "Active"optional

Options: Active, Revoked

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PATCH \
  --url './../api/v1//api-key/' \
  --header 'token: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "apiKey": "id_or_apiKey_api-key-to-update",
    "usageLimited": true,
    "maxUsageCredits": 1000000
  }'

200

400

401

500

200

{
  "data": {
    "token": "masumi-registry-api-key-secret",
    "permission": "User",
    "usageLimited": true,
    "maxUsageCredits": 1000000,
    "accumulatedUsageCredits": 0,
    "status": "Active"
  },
  "status": "success"
}

Registry entries

REQUIRES API KEY Authentication (+admin)

delete

Removes a API key

Authorizations

Body

tokenstring · max: 550required

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url './../api/v1//api-key/' \
  --header 'token: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "token": "api-key-to-delete"
  }'

200

400

401

500

200

{
  "data": {
    "token": "deleted-masumi-registry-api-key-secret"
  },
  "status": "success"
}

API Key