Informations
- OpenAPI version:
3.1.0
Overview
HitKeep REST API v1
Section titled “HitKeep REST API v1”Complete HTTP API for HitKeep (session, API key, and public share-token endpoints).
Operations
Section titled “ Operations ”GET
/api/status GET
/healthz GET
/readyz POST
/ingest OPTIONS
/ingest POST
/ingest/event OPTIONS
/ingest/event POST
/ingest/web-vitals OPTIONS
/ingest/web-vitals POST
/api/initial-user POST
/api/login POST
/api/logout POST
/api/user/password POST
/api/cloud/signup DELETE
/api/user/api-clients/{id} GET
/api/user/avatar GET
/api/admin/sites DELETE
/api/admin/sites/{id} GET
/api/admin/teams DELETE
/api/admin/teams/{id} GET
/api/admin/users DELETE
/api/admin/users/{id} GET
/api/sites POST
/api/sites DELETE
/api/sites/{id} GET
/api/user/teams POST
/api/user/teams PATCH
/api/user/teams/{id} DELETE
/api/user/teams/{id}/leave 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