Information
- OpenAPI version:
3.1.0
HitKeep REST API Reference
HitKeep REST API v1
Section titled “HitKeep REST API v1”Complete HTTP API for HitKeep (session, API key, and public share-token endpoints). While the shared database or an open tenant database is unavailable, database-dependent API and ingest routes return HTTP 503 using components.responses.DatabaseUnavailable.
Operations
Section titled “Operations”GET
/api/statusGET
/healthzGET
/readyzPOST
/ingestOPTIONS
/ingestPOST
/ingest/eventOPTIONS
/ingest/eventOPTIONS
/ingest/web-vitalsPOST
/api/loginPOST
/api/logoutDELETE
/api/admin/sites/{id}DELETE
/api/admin/teams/{id}DELETE
/api/admin/users/{id}GET
/api/sitesPOST
/api/sitesDELETE
/api/sites/{id}GET
/q/{token}POST
/api/user/teamsPATCH
/api/user/teams/{id}Authentication
Section titled “Authentication”apiKeyAuth
Section titled “apiKeyAuth”API client token in X-API-Key header.
Security scheme type: apiKey
Header parameter name: X-API-Key
bearerAuth
Section titled “bearerAuth”API client token in Authorization header.
Security scheme type: http
Bearer format: APIClientToken
cookieAuth
Section titled “cookieAuth”Session cookie authentication.
Security scheme type: apiKey
Cookie parameter name: hk_token