Skip to content
KrakenKey Docs
Search
Ctrl
K
Cancel
GitHub
Select theme
Dark
Light
Auto
Menu
Start here
Overview
Getting started
How it fits your stack
Set up with an AI agent
Integrations
AWS (ACM, ALB, CloudFront)
Azure Key Vault
Caddy
GitHub Actions
nginx and HAProxy
Terraform
CLI
Install and configure
Command reference
API reference
Overview
Health
Overview
Liveness check
GET
Readiness check — verifies DB, Redis, and Authentik
GET
Authentication
Overview
Redirect to registration
GET
Redirect to SSO login
GET
Get the SSO logout URL
GET
OAuth callback
GET
Get current user profile with resource counts
GET
Update current user profile
PATCH
List API keys for the current user
GET
Create an API key
POST
Confirm intent to keep auto-renewal active (free tier)
POST
Revoke an API key
DELETE
Start a CLI browser login
POST
Poll a CLI browser login
POST
Show a pending CLI login before approving it
GET
Approve a CLI login
POST
Deny a CLI login
POST
Users
Overview
List all users (admin only)
GET
Get user by ID (own record or admin)
GET
Delete a user account with cascade (own record or admin)
DELETE
Update a user (own record or admin)
PATCH
Domains
Overview
List all domains
GET
Register a new domain
POST
Get domain details
GET
Delete a domain
DELETE
Trigger DNS verification
POST
TLS Certificates
Overview
List all TLS certificates
GET
Request a new TLS certificate
POST
Get parsed certificate details from issued cert
GET
Get full certificate chain with parsed details
GET
Get certificate details
GET
Delete a failed, revoked or awaiting_csr certificate
DELETE
Update a certificate
PATCH
Revoke a certificate
POST
Renew a certificate
POST
Retry a failed certificate issuance
POST
Info
Get API info
GET
GitHub OIDC
Exchange a GitHub Actions OIDC token for a short-lived API key (15 minutes)
POST
List GitHub OIDC trust policies
GET
Trust a GitHub repository to exchange OIDC tokens for keys (dashboard session only)
POST
Delete a GitHub OIDC trust policy (dashboard session only)
DELETE
Billing
Create a Stripe Checkout session
POST
Get current user's subscription
GET
Create a Stripe Customer Portal session
POST
Preview prorated cost for a plan upgrade
POST
Upgrade subscription with proration
POST
Connectors
List connectors, including revoked ones, with counts of their deployments
GET
Create a connector and its single-use enrollment token (dashboard session only)
POST
Where a certificate is deployed, across the user's active connectors
GET
Get a connector with its deployments
GET
Revoke a connector and every key it was issued (dashboard session only)
DELETE
Rename a connector or change its client label (dashboard session only)
PATCH
Issue a new enrollment token for a connector that has not enrolled (dashboard session only)
POST
Report where the connector deployed each certificate (connector-issued keys only)
POST
Enroll a connector with its single-use token and public key
POST
Exchange a signed request for an API key that lasts one hour
POST
Replace a connector's public key, signed by the current key
POST
Endpoints
List all monitored endpoints
GET
Register a new monitored endpoint
POST
Get endpoint details
GET
Delete an endpoint
DELETE
Update endpoint
PATCH
List the user's connected probes available for assignment
GET
Assign connected probes to an endpoint
POST
Unassign a connected probe from an endpoint
DELETE
Add a hosted probe region to an endpoint
POST
Remove a hosted probe region from an endpoint
DELETE
Request an on-demand scan of this endpoint
POST
Get paginated scan results for an endpoint
GET
Export raw scan results as CSV or JSON
GET
Get the latest scan result per probe for an endpoint
GET
Feedback
Submit feedback
POST
Notification channels
List Slack, Teams and webhook channels
GET
Add a notification channel
POST
Delete a notification channel
DELETE
Update a notification channel
PATCH
Send a test alert
POST
Rotate a webhook signing secret
POST
Organizations
Create a new organization
POST
Get organization details
GET
Delete organization
DELETE
Update organization
PATCH
Invite a user to the organization
POST
Remove a member from the organization
DELETE
Update a member's role
PATCH
Transfer organization ownership
POST
Probes
ProbesController_register
POST
ProbesController_report
POST
ProbesController_getConfig
GET
Public Scan
Scan a TLS endpoint (no auth required)
POST
Reports
List reports, newest first (summary only)
GET
Create a portfolio TLS report for a list of hosts
POST
Get a report with every host, most urgent first
GET
Delete a report and its share link
DELETE
Download a report as CSV
GET
Create a read-only share link (replaces any existing link)
POST
Revoke the share link
DELETE
View a shared report (no auth required)
GET
Download a shared report as CSV (no auth)
GET
GitHub
Select theme
Dark
Light
Auto
Overview
Health
Section titled “Health”
API status and health checks
Operations
Section titled “Operations”
GET
/health
GET
/health/readiness
