There's a new version of the HubSpot API

Check out the new API

As of November 30, 2022, HubSpot API keys are no longer a supported authentication method for accessing HubSpot APIs. Instead, you should use a private app access token or OAuth to authenticate API calls. Learn more about this change and how to migrate an API key integration to use a private app instead.

Get a domain by ID

Last updated May 31, 2023

GET /cos-domains/v1/domains/:domain_id

Method Details

HTTP Methods:

GET

Response Format:

json

Requires Authentication?

Yes

Rate Limited?

Yes

Headers

User-Agent

Products:

Marketing

Required Scope:

content

Get the metadata for a domain by ID.

There is a newer version of this API available.

Required Parameters How to use Description
OAuth access token or private app access token Authorization: Bearer {token} header Used to authenticate the request. Please see this page for more details about authentication.
domain_id Used in the request URL Unique identifier for a particular domain

Example Usage and Result

Hit this URL with a HTTP method of GET  http://api.hubapi.com/cos-domains/v1/domains/101304

JSON Fields returned in the response

Parameter name Type Description
created long When the domain was first created, in milliseconds since the epoch
domain string The actual domain or subdomain
id string The unique id of the domain
is_any_primary string True if this domain is primary for any category
is_dns_correct string True if DNS for this domain is optimally configured for use with HubSpot
is_legacy_domain string True is this domain is setup for use with the classic CMS
is_resolving string True if this domain is pointing to HubSpot servers
manually_marked_as_resolving string True if a user manually marked this domain as resolving. This is needed when their is some unique setup or proxy server involved, and the COS can not automatically detect if the domain is properly resolving
primary_blog_post string True if this domain is primary for COS blog posts
primary_email string True if this domain is primary for viewing emails as web page
primary_landing_page string True if this domain is primary for COS landing pages
primary_legacy_page string True if this domain is primary for the classic CMS
primary_site_page string True if this domain is primary for COS site pages
secondary_to_domain string The name of the domain that this domain redirects to. Only set for non-primary domains
updated long When the domain was last updated, in milliseconds since the epoch

About

Jobs

Learn Inbound

Support

Locations

HubSpot, Inc.
25 First Street, 2nd Floor
Cambridge, MA 02141
European Headquarters
Ground Floor, Two Dockland Central
Guild Street, Dublin 1
Asia/Pacific Office
20 Hunter St, Level 7
Sydney NSW 2000
View our other locations
Example GET URL: https://api.hubapi.com/cos-domains/v1/domains/:domain_id Example GET response: { "created":1333053016000, "domain":"demo-hubapi.sites.hubspot.com", "id":101304, "is_any_primary":false, "is_dns_correct":true, "is_internal_domain":true, "is_legacy_domain":false, "is_resolving":true, "manually_marked_as_resolving":false, "portal_id":62515, "primary_blog_post":false, "primary_email":false, "primary_landing_page":false, "primary_legacy_page":false, "primary_site_page":false, "secondary_to_domain":"62515.sites.hubspot.com", "updated":1364439000000 }