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

200

API Key Status

application/json

get

HTTPcURLJavaScriptPython

GET / HTTP/1.1
Host: api-key-status
token: YOUR_API_KEY
Accept: */*

200

API Key Status

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

/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: 100OptionalDefault: 10

Responses

200

Registry entries

application/json

400

Bad Request (possible parameters missing or invalid)

401

Unauthorized

500

Internal Server Error

get

HTTPcURLJavaScriptPython

GET / HTTP/1.1
Host: api-key
token: YOUR_API_KEY
Accept: */*

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

REQUIRES API KEY Authentication (+admin)

post

Create a new API key

Authorizations

Body

usageLimitedbooleanOptionalDefault: false

maxUsageCreditsinteger | nullableOptionalDefault: 0

permissionstring · enumOptionalDefault: UserPossible values:

Responses

200

API Key

application/json

400

Bad Request (possible parameters missing or invalid)

401

Unauthorized

500

Internal Server Error

post

HTTPcURLJavaScriptPython

POST / HTTP/1.1
Host: api-key
token: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 68

{
  "permission": "Admin",
  "usageLimited": true,
  "maxUsageCredits": 1000000
}

{
  "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"
}

REQUIRES API KEY Authentication (+admin)

patch

Updates a API key

Authorizations

Body

tokenstring · max: 550Required

usageLimitedbooleanOptionalDefault: false

maxUsageCreditsinteger | nullableOptionalDefault: 0

statusstring · enumOptionalDefault: ActivePossible values:

Responses

200

Registry entries

application/json

400

Bad Request (possible parameters missing or invalid)

401

Unauthorized

500

Internal Server Error

patch

HTTPcURLJavaScriptPython

PATCH / HTTP/1.1
Host: api-key
token: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 88

{
  "token": "id_or_apiKey_api-key-to-update",
  "usageLimited": true,
  "maxUsageCredits": 1000000
}

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

REQUIRES API KEY Authentication (+admin)

delete

Removes a API key

Authorizations

Body

tokenstring · max: 550Required

Responses

200

API Key

application/json

400

Bad Request (possible parameters missing or invalid)

401

Unauthorized

500

Internal Server Error

delete

HTTPcURLJavaScriptPython

DELETE / HTTP/1.1
Host: api-key
token: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 29

{
  "token": "api-key-to-delete"
}

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