Dub · Schema

DomainSchema

Dub DomainSchema

Link ManagementURL ShortenerAnalyticsConversion TrackingAffiliate ProgramsOpen Source

Properties

Name Type Description
id string The unique identifier of the domain.
slug string The domain name.
verified boolean Whether the domain is verified.
primary boolean Whether the domain is the primary domain for the workspace.
archived boolean Whether the domain is archived.
placeholder string Provide context to your teammates in the link creation modal by showing them an example of a link to be shortened.
expiredUrl string The URL to redirect to when a link under this domain has expired.
notFoundUrl string The URL to redirect to when a link under this domain doesn't exist.
logo string The logo of the domain.
assetLinks string assetLinks.json configuration file (for deep link support on Android).
appleAppSiteAssociation string apple-app-site-association configuration file (for deep link support on iOS).
createdAt string The date the domain was created.
updatedAt string The date the domain was last updated.
registeredDomain object The registered domain record.
View JSON Schema on GitHub

JSON Schema

dub-domain-schema.json Raw ↑ 
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/dub/refs/heads/main/json-schema/dub-domain-schema.json",
  "title": "DomainSchema",
  "description": "Dub DomainSchema",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "The unique identifier of the domain."
    },
    "slug": {
      "type": "string",
      "description": "The domain name.",
      "example": "acme.com"
    },
    "verified": {
      "default": false,
      "description": "Whether the domain is verified.",
      "type": "boolean"
    },
    "primary": {
      "default": false,
      "description": "Whether the domain is the primary domain for the workspace.",
      "type": "boolean"
    },
    "archived": {
      "default": false,
      "type": "boolean",
      "description": "Whether the domain is archived."
    },
    "placeholder": {
      "nullable": true,
      "description": "Provide context to your teammates in the link creation modal by showing them an example of a link to be shortened.",
      "example": "https://dub.co/help/article/dub-links",
      "type": "string"
    },
    "expiredUrl": {
      "nullable": true,
      "description": "The URL to redirect to when a link under this domain has expired.",
      "example": "https://acme.com/expired",
      "type": "string"
    },
    "notFoundUrl": {
      "nullable": true,
      "description": "The URL to redirect to when a link under this domain doesn't exist.",
      "example": "https://acme.com/not-found",
      "type": "string"
    },
    "logo": {
      "nullable": true,
      "description": "The logo of the domain.",
      "type": "string"
    },
    "assetLinks": {
      "default": null,
      "description": "assetLinks.json configuration file (for deep link support on Android).",
      "nullable": true,
      "type": "string"
    },
    "appleAppSiteAssociation": {
      "default": null,
      "description": "apple-app-site-association configuration file (for deep link support on iOS).",
      "nullable": true,
      "type": "string"
    },
    "createdAt": {
      "description": "The date the domain was created.",
      "type": "string"
    },
    "updatedAt": {
      "description": "The date the domain was last updated.",
      "type": "string"
    },
    "registeredDomain": {
      "nullable": true,
      "description": "The registered domain record.",
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "The ID of the registered domain record."
        },
        "autoRenewalDisabledAt": {
          "nullable": true,
          "description": "The date the domain auto-renew is disabled.",
          "type": "string"
        },
        "createdAt": {
          "description": "The date the domain was created.",
          "type": "string"
        },
        "expiresAt": {
          "description": "The date the domain expires.",
          "type": "string"
        },
        "renewalFee": {
          "type": "number",
          "description": "The fee to renew the domain."
        }
      },
      "required": [
        "id",
        "autoRenewalDisabledAt",
        "createdAt",
        "expiresAt",
        "renewalFee"
      ],
      "additionalProperties": false
    }
  },
  "required": [
    "id",
    "slug",
    "verified",
    "primary",
    "archived",
    "placeholder",
    "expiredUrl",
    "notFoundUrl",
    "logo",
    "assetLinks",
    "appleAppSiteAssociation",
    "createdAt",
    "updatedAt",
    "registeredDomain"
  ],
  "additionalProperties": false
}