Nokku API
v1.0.0OpenAPI 3.1.0The Nokku API is Connect RPC over HTTP. Every procedure is a POST to
/nokku.v1.<Service>/<Method> with a JSON body, so plain curl works and
no client library is needed.
Authentication
- Bearer token for API clients: a service account token in the
Authorizationheader. - Cookie for the web app: the session cookie the browser gets at sign-in.
Rate limiting
Requests are limited per client address. A limited request gets status
429 with a Retry-After header.
Errors
Errors follow the Connect RPC error format: a JSON object with a code
like unauthenticated and a message.
Servers
(1)https://app.nokku.shProduction
About
- Contact
- Nokku Supportsupport@mizuchi.dev
Authentication
- BearerAuthHTTP · Bearer
A service account token. Include it in the Authorization header: `Authorization: Bearer <token>`
- CookieAuthAPI Key · cookie
The session cookie the web app uses. Browsers send it after sign-in. Only on `localhost` it is named `nokku_session`.
Groups
(20)- nokku.v1.AccessRequestService11 endpoints
- nokku.v1.AccountService12 endpoints
- nokku.v1.AuditStreamService6 endpoints
- nokku.v1.AuthService8 endpoints
- nokku.v1.BillingService5 endpoints
- nokku.v1.CertificateService5 endpoints
A workspace has one CA, made with it. A server has no tie to it, so every call here is about that one.
- nokku.v1.DaemonControlService7 endpoints
- nokku.v1.DaemonService8 endpoints
- nokku.v1.DashboardService2 endpoints
- nokku.v1.InvitationService7 endpoints
An invite names one address and one role, and works once. Only Join spends it, opening the link does not.
- nokku.v1.JoinTokenService4 endpoints
- nokku.v1.RecordingService4 endpoints
- nokku.v1.SCIMService4 endpoints
- nokku.v1.ServiceAccountService15 endpoints
- nokku.v1.SSOService4 endpoints
- nokku.v1.TargetAccountService13 endpoints
- nokku.v1.TargetService18 endpoints
- nokku.v1.TeamService13 endpoints
- nokku.v1.UtilService12 endpoints
- nokku.v1.WorkspaceService16 endpoints