Skip to main content

Custom domains

Your company's own domains (such as portal.yourcompany.com) pointed at the workspace's portal. dns-status checks the required CNAMEs without changing anything; verify checks DNS and provisions the domain (certificate and CDN) once it is ready.

CommandHTTPDescription
portal-custom-domains listGET /v1/portal_custom_domainsList custom domains
portal-custom-domains createPOST /v1/portal_custom_domainsAdd custom domain
portal-custom-domains deleteDELETE /v1/portal_custom_domains/{id}Delete custom domain
portal-custom-domains dns-statusGET /v1/portal_custom_domains/{id}/dns_statusCheck custom domain DNS
portal-custom-domains verifyPOST /v1/portal_custom_domains/{id}/verifyVerify and provision custom domain

Examples​

--params carries query, path and header parameters (id, page, filters, X-Workspace-Id); --json carries the request body; --fields limits which fields come back — worth using on every list/get to save context. See Global flags for the full reference.

# List custom domains
kobana dashboards portal-custom-domains list --fields "id,hostname,status"

# Add custom domain
kobana dashboards portal-custom-domains create \
  --json '{"hostname": "portal.example.com"}'

# Check custom domain DNS
kobana dashboards portal-custom-domains dns-status \
  --params '{"id": "DOMAIN_ID"}'

# Verify and provision custom domain
kobana dashboards portal-custom-domains verify --params '{"id": "DOMAIN_ID"}'

Next steps​