Skip to content

Register a new monitored endpoint

POST
/endpoints
curl --request POST \
--url https://api.krakenkey.io/endpoints \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "host": "example.com", "port": 443, "sni": "example.com", "label": "Production API", "probeIds": [ "probe-uuid-1" ], "hostedRegions": [ "us-east-1" ] }'
Media typeapplication/json
object
host
required

Hostname to monitor

string
Example
example.com
port

Port to connect to (default: 443)

number
Example
443
sni

SNI override (defaults to host)

string
Example
example.com
label

User-friendly label

string
Example
Production API
probeIds

IDs of connected probes to assign for scanning

Array<string>
Example
[
"probe-uuid-1"
]
hostedRegions

Hosted probe regions to enable for scanning (Team tier+)

Array<string>
Example
[
"us-east-1"
]

Endpoint created

Plan limit exceeded