Get site tracking domain options REST API

GET

/api/sites/{id}/tracking-domain-options

curl --request GET \
  --url https://hitkeep.com/api/sites/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/tracking-domain-options \
  --cookie hk_token=<hk_token>

Returns the default tracker URL and team custom tracking domains available to the site. Requires site.view.

Authorizations

• cookieAuth

Parameters

Path Parameters

id

required

string format: uuid

Responses

200

Tracking domain options

Media typeapplication/json

object

site_id

required

string format: uuid

team_id

required

string format: uuid

default_url

required

string

domains

required

Array<object>

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

{
  "domains": [
    {
      "target_status": "pending",
      "tls_mode": "external",
      "tls_status": "pending",
      "verification_status": "pending"
    }
  ]
}

403

Access denied

Media typeapplication/json

object

message

string

Example^generated

{
  "message": "example"
}