Get API keys

Retrieve all API keys. This does not return the full API key, but only a portion (for security purposes). The development key will be returned in full, as it’ll be set in devices and is thus not private.

GET /api/{projectId}/apikeys

Try it

Get API keys

cURL

curl --request GET \
  --url https://studio.edgeimpulse.com/v1/api/{projectId}/apikeys \
  --header 'x-api-key: <api-key>'

200

{
  "success": true,
  "apiKeys": [
    {
      "id": 123,
      "apiKey": "<string>",
      "isDevelopmentKey": true,
      "name": "<string>",
      "created": "2023-11-07T05:31:56Z",
      "role": "admin"
    }
  ],
  "error": "<string>"
}

Authorizations

x-api-key · string · header · required

Path Parameters

projectId · integer · required

Project ID

Response

200 - application/json

OK

success · boolean · required

Whether the operation succeeded

apiKeys · object[] · required

List of API keys.

Show child attributes

apiKeys. id · integer · required

apiKeys. apiKey · string · required

apiKeys. isDevelopmentKey · boolean · required

apiKeys. name · string · required

apiKeys. created · string<date-time> · required

apiKeys. role · enum<string> · required

Available options: admin, readonly, ingestiononly, wladmin

error · string

Optional error description (set if 'success' was false)