HubSpot · JSON Structure

Domains Api Domain Structure

Represents a domain connected to a HubSpot CMS site

Type: object Properties: 21 Required: 8

AnalyticsCommerceContentCRMCustomer ServiceEmail MarketingMarketingMarketing AutomationOperationsSales

Domain is a JSON Structure definition published by HubSpot, describing 21 properties, of which 8 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

id domain createdAt updatedAt isResolving isManuallyMarkedAsResolving isSslEnabled isSslOnly isPrimaryBlogPost isPrimarySitePage isPrimaryLandingPage isPrimaryEmail isPrimaryKnowledge isUsedForBlogPost isUsedForSitePage isUsedForLandingPage isUsedForEmail isUsedForKnowledge expectedCname redirectTo secondaryToDomain

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/hubspot/refs/heads/main/json-structure/domains-api-domain-structure.json",
  "name": "Domain",
  "description": "Represents a domain connected to a HubSpot CMS site",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "The unique identifier for the domain",
      "example": "3210329704"
    },
    "domain": {
      "type": "string",
      "description": "The actual domain or sub-domain (e.g., www.hubspot.com)",
      "example": "99558489.hubspot.com"
    },
    "createdAt": {
      "type": "datetime",
      "description": "When the domain was created",
      "example": "2017-07-11T13:00:52.928Z"
    },
    "updatedAt": {
      "type": "datetime",
      "description": "When the domain was last updated",
      "example": "2019-10-08T16:54:57.165Z"
    },
    "isResolving": {
      "type": "boolean",
      "description": "Whether the DNS for this domain is optimally configured for use with HubSpot",
      "example": true
    },
    "isManuallyMarkedAsResolving": {
      "type": "boolean",
      "description": "Whether the domain has been manually marked as resolving",
      "example": false
    },
    "isSslEnabled": {
      "type": "boolean",
      "description": "Whether SSL is enabled for this domain",
      "example": true
    },
    "isSslOnly": {
      "type": "boolean",
      "description": "Whether the domain only accepts HTTPS connections",
      "example": false
    },
    "isPrimaryBlogPost": {
      "type": "boolean",
      "description": "Whether this is the primary domain for blog posts",
      "example": true
    },
    "isPrimarySitePage": {
      "type": "boolean",
      "description": "Whether this is the primary domain for site pages",
      "example": false
    },
    "isPrimaryLandingPage": {
      "type": "boolean",
      "description": "Whether this is the primary domain for landing pages",
      "example": false
    },
    "isPrimaryEmail": {
      "type": "boolean",
      "description": "Whether this is the primary domain for email web pages",
      "example": false
    },
    "isPrimaryKnowledge": {
      "type": "boolean",
      "description": "Whether this is the primary domain for knowledge base",
      "example": false
    },
    "isUsedForBlogPost": {
      "type": "boolean",
      "description": "Whether the domain is used for CMS blog posts",
      "example": true
    },
    "isUsedForSitePage": {
      "type": "boolean",
      "description": "Whether the domain is used for CMS site pages",
      "example": false
    },
    "isUsedForLandingPage": {
      "type": "boolean",
      "description": "Whether the domain is used for CMS landing pages",
      "example": false
    },
    "isUsedForEmail": {
      "type": "boolean",
      "description": "Whether the domain is used for CMS email web pages",
      "example": false
    },
    "isUsedForKnowledge": {
      "type": "boolean",
      "description": "Whether the domain is used for CMS knowledge pages",
      "example": false
    },
    "expectedCname": {
      "type": "string",
      "description": "The expected CNAME record for this domain",
      "example": "99558489.group39.sites.hubspot.net"
    },
    "redirectTo": {
      "type": "string",
      "description": "The domain to redirect to, if any",
      "example": ""
    },
    "secondaryToDomain": {
      "type": "string",
      "description": "The primary domain this domain is secondary to",
      "example": "example.hubspot.com"
    }
  },
  "required": [
    "id",
    "domain",
    "isResolving",
    "isUsedForBlogPost",
    "isUsedForSitePage",
    "isUsedForLandingPage",
    "isUsedForEmail",
    "isUsedForKnowledge"
  ]
}