ZITADEL Docs
APIsCore ResourcesV1Organization Objects

AddAPIApp

Create Application (API)

Deprecated: Use CreateApplication instead to create an API application

Create a new API client. The client id will be generated and returned in the response. Depending on the chosen configuration also a secret will be generated and returned.

POST
/projects/{project_id}/apps/api

Path Parameters

project_id*string

Request Body

application/json

name*string
authMethodType?string
Value in"API_AUTH_METHOD_TYPE_BASIC" | "API_AUTH_METHOD_TYPE_PRIVATE_KEY_JWT"
[key: string]?never

Response Body

application/json

application/json

curl -X POST "https://loading/projects/string/apps/api" \  -H "Content-Type: application/json" \  -d '{    "name": "string"  }'
{
  "appId": "string",
  "details": {
    "sequence": 0,
    "creationDate": "1s",
    "changeDate": "1s",
    "resourceOwner": "string"
  },
  "clientId": "string",
  "clientSecret": "string"
}
{
  "code": "not_found",
  "message": "string",
  "detail": {
    "type": "string",
    "value": "string",
    "debug": {}
  }
}

Was this page helpful?