v1

latestOpenAPI 3.1.0Proprietary2026-07-13197242444.9 KB

Project Keys

Create Project Key

Create a Project Key with API credentials and optional Kafka access.

Returns a credential file (JSON) with plaintext secrets. This is a one-time delivery — secrets are masked in all subsequent responses. Optionally creates a Kafka user with SCRAM credentials, K8s proxy, and ACLs.

post/project-keys

Request body

namestring required

Human-readable name for this Project Key

descriptionstring nullable

Optional description (HTML sanitized)

role_idsstring[] nullable

Role IDs to assign. Mutually exclusive with permission_ids.

permission_idsstring[] nullable

Permission IDs to assign directly. Mutually exclusive with role_ids.

tool_profile'full' | 'read-only' | 'agent-operator' | 'infra-admin'

allowed_toolsstring[] nullable

MCP tool whitelist. If set, overrides profile and block list.

blocked_toolsstring[] nullable

MCP tool blacklist. Removes tools even if profile allows them.

Response

Successful Response

typestring

project_key_idstring required

projectobject required

kafka_aclsobject[]

tool_profile'full' | 'read-only' | 'agent-operator' | 'infra-admin'

allowed_toolsstring[] nullable

blocked_toolsstring[] nullable

created_atstring date-time required

created_bystring nullable