ApiManagementV1WorkspacesWorkspaceidApplications

Create an application

POST
/management/v1/workspaces/{workspaceId}/applications
AuthorizationBearer <token>

Management token (nhm_...)

In: header

Path Parameters

workspaceIdstring
externalId?string

Your internal identifier for this application (optional)

namestring
metadata?object

Key-value metadata (max 5 keys)

Empty Object

maxEndpoints?integer | null

Max endpoints this application may have. Omit or null = unlimited (the workspace plan limit still applies); 0 = the application's tenant cannot create any endpoints. Disabled endpoints still count toward the cap.

Range0 <= value
showEventTypes?boolean

Whether the Developer Portal exposes the event-type catalog to this application's tenant. Default true. When false, the portal hides events and blocks new subscriptions (existing subscriptions keep delivering).

Response Body

curl -X POST "https://loading/management/v1/workspaces/string/applications" \  -H "Content-Type: application/json" \  -d '{    "name": "string"  }'
{
  "id": "string",
  "externalId": "string",
  "name": "string",
  "metadata": {
    "property1": "string",
    "property2": "string"
  },
  "maxEndpoints": 0,
  "showEventTypes": true,
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z"
}

{
  "error": {
    "code": "validation_error",
    "message": "metadata exceeds max keys (5)"
  }
}

{
  "error": {
    "code": "unauthorized",
    "message": "Missing or invalid authorization header"
  }
}

{
  "error": {
    "code": "token_disabled",
    "message": "Management token is disabled"
  }
}

{
  "error": {
    "code": "conflict",
    "message": "An application with this externalId already exists"
  }
}