Add API key

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

Authorizations

ApiKeyAuthenticationJWTAuthenticationJWTHttpHeaderAuthentication

Path parameters

projectIdintegerrequired

Project ID

Body

namestringrequired

Description of the key

apiKeystring

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.

isDevelopmentKeybooleanrequired

Whether this key should be used as a development key.

rolestring · enumrequired

Options: admin, readonly, ingestiononly

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

200

{
  "success": true,
  "error": "text",
  "id": 1,
  "apiKey": "text"
}

OK