Skip to content
DashboardGet API key

Create sub-account API key

View .md
POST

Create sub-account API key. Requires a parent project API key; sub-account API keys receive HTTP 403.

Authorization

  • Authorizationheaderrequired

    Bearer YOUR_API_KEY. Create a key in the dashboard.

Path parameters

  • idstringrequired

    Sub-account ID.

Body

application/json

  • namestringrequired
  • environmentstring
    One oflivetest
    Defaultlive
  • permissionsstring[]

Responses

201API key created. The full key is only returned once.
  • apiKeyobjectrequired
    4 properties
    • idstringrequired
    • keystringrequired
    • namestringrequired
    • environmentstringrequired
      One oflivetest
400Invalid request.
  • codestringrequired
  • messagestringrequired
  • detailsobject
401Unauthorized.
  • codestringrequired
  • messagestringrequired
  • detailsobject
403Forbidden. Sub-account API keys cannot manage sub-accounts.
  • codestringrequired
  • messagestringrequired
  • detailsobject
404Not a sub-account of this team. The parent project's own id is not a sub-account and answers 404.
  • codestringrequired
  • messagestringrequired
  • detailsobject