Add API key

Add an API key. If you set developmentKey to true this flag will be removed from the current development API key.

POST /api/{projectId}/apikeys

Try it

Add API key

cURL

curl --request POST \
  --url https://studio.edgeimpulse.com/v1/api/{projectId}/apikeys \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "<string>",
  "isDevelopmentKey": true,
  "role": "admin",
  "apiKey": "<string>"
}
'

200

{
  "success": true,
  "id": 123,
  "apiKey": "<string>",
  "error": "<string>"
}

Authorizations

x-api-key · string · header · required

Path Parameters

projectId · integer · required

Project ID

Body

application/json

name · string · required

Description of the key

isDevelopmentKey · boolean · required

Whether this key should be used as a development key.

role · enum<string> · required

Available options: admin, readonly, ingestiononly

apiKey · string

Optional: API key. This needs to start with ei_ and will need to be at least 32 characters long. If this field is not passed in, a new API key is generated for you.

Response

200 - application/json

OK

success · boolean · required

Whether the operation succeeded

id · integer · required

ID of the new API key

apiKey · string · required

New API Key (starts with "ei_...") - this'll be shared only once.

error · string

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