Create tracking domain REST API

POST

/api/user/teams/{id}/tracking-domains

curl --request POST \
  --url https://hitkeep.com/api/user/teams/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/tracking-domains \
  --header 'Content-Type: application/json' \
  --cookie hk_token=<hk_token> \
  --data '{ "hostname": "example" }'

Creates a custom tracking domain and returns DNS verification instructions. Requires team.manage_settings.

Authorizations

• cookieAuth

Parameters

Path Parameters

id

required

string format: uuid

Request Body^required

Media typeapplication/json

object

hostname

required

string

Example^generated

{
  "hostname": "example"
}

Responses

201

Created 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"
}

400

Invalid hostname

Media typeapplication/json

object

message

string

Example^generated

{
  "message": "example"
}

403

Access denied

Media typeapplication/json

object

message

string

Example^generated

{
  "message": "example"
}

409

Domain conflict

Media typeapplication/json

object

message

string

Example^generated

{
  "message": "example"
}