Skip to content
Start in HitKeep Cloud

Verify tracking domain REST API

POST
/api/user/teams/{id}/tracking-domains/{domainId}/verify
curl --request POST \
--url https://hitkeep.com/api/user/teams/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/tracking-domains/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/verify \
--cookie hk_token=<hk_token>

Rechecks TXT ownership, DNS target, and HTTPS tracker readiness for a custom tracking domain. Requires team.manage_settings.

id
required
string format: uuid
domainId
required
string format: uuid

Tracking domain

Media typeapplication/json
object
active
boolean
created_at
string format: date-time
dns_target
string
dns_txt_name
string
dns_txt_value
string
enabled
boolean
hostname
string
id
string format: uuid
last_checked_at
string format: date-time
last_error
string
last_tls_ask_at
string format: date-time
target_status
string
Allowed values: pending verified failed
team_id
string format: uuid
tls_mode
string
Allowed values: external caddy-on-demand
tls_status
string
Allowed values: pending verified failed
updated_at
string format: date-time
verification_status
string
Allowed values: pending verified failed
verified_at
string format: date-time
Example
{
"target_status": "pending",
"tls_mode": "external",
"tls_status": "pending",
"verification_status": "pending"
}

Access denied

Media typeapplication/json
object
message
string
Examplegenerated
{
"message": "example"
}

Tracking domain not found

Media typeapplication/json
object
message
string
Examplegenerated
{
"message": "example"
}