Skip to content
KrakenKey Docs

Overview

KrakenKey API 0.1.0

Section titled “KrakenKey API 0.1.0”

Public API for KrakenKey: TLS certificate management and domain verification

Information

  • OpenAPI version: 3.0.0

Operations

Section titled “Operations”
GET
/health
GET
/health/readiness
GET
/auth/register
GET
/auth/login
GET
/auth/logout-url
GET
/auth/callback
GET
/auth/profile
PATCH
/auth/profile
GET
/auth/api-keys
POST
/auth/api-keys
POST
/auth/confirm-auto-renewal
DELETE
/auth/api-keys/{id}
POST
/auth/device/code
POST
/auth/device/token
GET
/auth/device/{userCode}
POST
/auth/device/approve
POST
/auth/device/deny
GET
/users
GET
/users/{id}
DELETE
/users/{id}
PATCH
/users/{id}
GET
/domains
POST
/domains
GET
/domains/{id}
DELETE
/domains/{id}
POST
/domains/{id}/verify
GET
/certs/tls
POST
/certs/tls
GET
/certs/tls/{id}/details
GET
/certs/tls/{id}/chain
GET
/certs/tls/{id}
DELETE
/certs/tls/{id}
PATCH
/certs/tls/{id}
POST
/certs/tls/{id}/revoke
POST
/certs/tls/{id}/renew
POST
/certs/tls/{id}/retry
GET
/
POST
/auth/github-oidc
GET
/auth/github-oidc/trusts
POST
/auth/github-oidc/trusts
DELETE
/auth/github-oidc/trusts/{id}
POST
/billing/checkout
GET
/billing/subscription
POST
/billing/portal
POST
/billing/upgrade/preview
POST
/billing/upgrade
GET
/connectors
POST
/connectors
GET
/connectors/deployments
GET
/connectors/{id}
DELETE
/connectors/{id}
PATCH
/connectors/{id}
POST
/connectors/{id}/enrollment-token
POST
/connectors/report
POST
/connectors/enroll
POST
/connectors/token
POST
/connectors/rotate
GET
/endpoints
POST
/endpoints
GET
/endpoints/{id}
DELETE
/endpoints/{id}
PATCH
/endpoints/{id}
GET
/endpoints/probes/mine
POST
/endpoints/{id}/probes
DELETE
/endpoints/{id}/probes/{probeId}
POST
/endpoints/{id}/regions
DELETE
/endpoints/{id}/regions/{region}
POST
/endpoints/{id}/scan
GET
/endpoints/{id}/results
GET
/endpoints/{id}/results/export
GET
/endpoints/{id}/results/latest
POST
/feedback
GET
/notifications/channels
POST
/notifications/channels
DELETE
/notifications/channels/{id}
PATCH
/notifications/channels/{id}
POST
/notifications/channels/{id}/test
POST
/notifications/channels/{id}/rotate-secret
POST
/organizations
GET
/organizations/{id}
DELETE
/organizations/{id}
PATCH
/organizations/{id}
POST
/organizations/{id}/members
DELETE
/organizations/{id}/members/{userId}
PATCH
/organizations/{id}/members/{userId}
POST
/organizations/{id}/transfer-ownership
POST
/probes/register
POST
/probes/report
GET
/probes/{probeId}/config
POST
/public-scan
GET
/reports
POST
/reports
GET
/reports/{id}
DELETE
/reports/{id}
GET
/reports/{id}/export
POST
/reports/{id}/share
DELETE
/reports/{id}/share
GET
/public/reports/{token}
GET
/public/reports/{token}/export

Authentication

Section titled “Authentication”

bearer

Section titled “bearer”

JWT access token obtained from the /auth/callback OAuth flow

Security scheme type: http

Bearer format: JWT

api-key

Section titled “api-key”

API key prefixed with “Bearer “ (e.g., “Bearer kk_abc123…”)

Security scheme type: apiKey

Header parameter name: Authorization