Teams

Update tracking domain

Enables or disables a team custom tracking domain. Disabled domains are not offered as snippet hosts and cannot serve tracker traffic. Requires team.manage_settings.

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

Request

  • Base URL: https://demo.hitkeep.com
  • URL: https://demo.hitkeep.com/api/user/teams/{id}/tracking-domains/{domainId}
  • Auth: API key in cookie hk_token

Path parameters

idstring uuid required
domainIdstring uuid required

Request body

enabledboolean required

Response

Tracking domain

activeboolean required

True when the domain is enabled and all verification states are verified.

created_atstring date-time required
dns_targetstring required
dns_txt_namestring required
dns_txt_valuestring required
enabledboolean required
hostnamestring required
idstring uuid required
last_checked_atstring date-time
last_errorstring
last_tls_ask_atstring date-time
target_status'pending' | 'verified' | 'failed' required
team_idstring uuid required
tls_mode'external' | 'caddy-on-demand' required
tls_status'pending' | 'verified' | 'failed' required
updated_atstring date-time required
verification_status'pending' | 'verified' | 'failed' required
verified_atstring date-time

Changes

No recorded changes to this operation across all 1 revision of this API.