Skip to main content
GET
/
api
/
projects
/
api-key-info
Get info about current API key
curl --request GET \
  --url https://studio.edgeimpulse.com/v1/api/projects/api-key-info \
  --header 'x-api-key: <api-key>'
{
  "success": true,
  "apiKeyId": 123,
  "projectId": 123,
  "error": "<string>"
}

Authorizations

x-api-key
string
header
required

Response

200 - application/json

OK

success
boolean
required

Whether the operation succeeded

apiKeyId
integer
required
projectId
integer
required
role
enum<string>
required
Available options:
admin,
readonly,
ingestiononly,
ingestion_deployment
error
string

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