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.

GEThttps://studio.edgeimpulse.com/v1/api/{projectId}/apikeys

Path parameters

projectId*integer

Project ID

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

apiKeys*array of object

List of API keys.

id*integer

apiKey*string

isDevelopmentKey*boolean

name*string

created*string (date-time)

role*enum

adminreadonlyingestiononlywladmin

Request

Response

Get API keys

GEThttps://studio.edgeimpulse.com/v1/api/{projectId}/apikeys

Path parameters

projectId*integer

Project ID

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

apiKeys*array of object

List of API keys.

id*integer

apiKey*string

isDevelopmentKey*boolean

name*string

created*string (date-time)

role*enum

adminreadonlyingestiononlywladmin

Request

Response

const response = await fetch('https://studio.edgeimpulse.com/v1/api/{projectId}/apikeys', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

{
  "success": false,
  "error": "text",
  "apiKeys": [
    {
      "apiKey": "text",
      "isDevelopmentKey": false,
      "name": "text",
      "created": "2024-11-21T10:42:39.862Z",
      "role": "admin"
    }
  ]
}