Manage API keys for the Masumi Registry Service API
Last updated 1 month ago
Was this helpful?
This endpoint is used for checking the status of the existing API keys.
These endpoints are used for managing API keys.
Gets the status of an API key
curl -L \ --url './../api/v1//api-key-status/' \ --header 'token: YOUR_API_KEY'
{ "data": { "token": "masumi-registry-api-key-secret", "permission": "Admin", "usageLimited": true, "maxUsageCredits": 1000000, "accumulatedUsageCredits": 0, "status": "Active" }, "status": "success" }
Gets registry sources, can be paginated
curl -L \ --url './../api/v1//api-key/' \ --header 'token: YOUR_API_KEY'
{ "data": { "apiKeys": [ { "token": "masumi-registry-api-key-secret", "permission": "Admin", "usageLimited": true, "maxUsageCredits": 1000000, "accumulatedUsageCredits": 0, "status": "Active" } ] }, "status": "success" }
Create a new API key
User
Admin
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 }'
{ "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" }
Updates a API key
Active
Revoked
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 }'
{ "data": { "token": "masumi-registry-api-key-secret", "permission": "User", "usageLimited": true, "maxUsageCredits": 1000000, "accumulatedUsageCredits": 0, "status": "Active" }, "status": "success" }
Removes a API key
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" }'
{ "data": { "token": "deleted-masumi-registry-api-key-secret" }, "status": "success" }