v51

latestOpenAPI 3.0.0GPL-3.0raw.githubusercontent.com2026-08-01199241439.9 KB

api-keys

Create API key

Full key returned only in this response. Community edition installs can create up to 2 API keys.

post/api-keys

Request body

namestring required

Human-readable name

descriptionstring

Purpose description

role'admin' | 'manager' | 'developer' | 'operator' | 'viewer' required

User role determining access permissions. admin: full access including user management, manager: DAG CRUD and execution with audit log access, developer: DAG CRUD and execution, operator: DAG execution only, viewer: read-only

allowedSurfacesstring[] required

Interfaces where this API key may be accepted

attributionClass'user_owned' | 'service_account' required

Whether this key is owned by a user or represents a service account

ownerUserIdstring

Owner user ID when attributionClass is user_owned

serviceAccountNamestring

Service-account display name when attributionClass is service_account

Response

Created

keystring required

Full key secret, only returned once