Create a domain

Create a domain for the authenticated workspace.

1 min read

post/domains

Request example

from dub import Dub


with Dub(
    token="DUB_API_KEY",
) as d_client:

    res = d_client.domains.create(request={
        "slug": "acme.com",
        "expired_url": "https://acme.com/expired",
        "not_found_url": "https://acme.com/not-found",
        "placeholder": "https://dub.co/help/article/what-is-dub",
    })

    # Handle response
    print(res)

Response

{
  "id": "<string>",
  "slug": "acme.com",
  "verified": false,
  "primary": false,
  "archived": false,
  "placeholder": "https://dub.co/help/article/dub-links",
  "expiredUrl": "https://acme.com/expired",
  "notFoundUrl": "https://acme.com/not-found",
  "logo": "<string>",
  "assetLinks": null,
  "appleAppSiteAssociation": null,
  "createdAt": "<string>",
  "updatedAt": "<string>",
  "registeredDomain": {
    "id": "<string>",
    "autoRenewalDisabledAt": "<string>",
    "createdAt": "<string>",
    "expiresAt": "<string>",
    "renewalFee": 1
  }
}

post/domains

Authorization

Authorizationstringheaderrequired#

Default authentication mechanism

Body

application/json

slugstringrequired#

Name of the domain.

Length: 1–190

expiredUrlstring#

Redirect users to a specific URL when any link under this domain has expired.

Length: max 32000

notFoundUrlstring#

Redirect users to a specific URL when a link under this domain doesn't exist.

Length: max 32000

archivedboolean#

Whether to archive this domain. false will unarchive a previously archived domain.

Default: false

placeholderstring#

Provide context to your teammates in the link creation modal by showing them an example of a link to be shortened.

Length: max 100

logostring#

The logo of the domain.

Show child attributes

Any of

assetLinksstring#

assetLinks.json configuration file (for deep link support on Android).

appleAppSiteAssociationstring#

apple-app-site-association configuration file (for deep link support on iOS).

Responses

application/json

The domain was created.

idstringrequired#

The unique identifier of the domain.

slugstringrequired#

The domain name.

verifiedbooleanrequired#

Whether the domain is verified.

Default: false

primarybooleanrequired#

Whether the domain is the primary domain for the workspace.

Default: false

archivedbooleanrequired#

Whether the domain is archived.

Default: false

placeholderstringrequired#

Provide context to your teammates in the link creation modal by showing them an example of a link to be shortened.

expiredUrlstringrequired#

The URL to redirect to when a link under this domain has expired.

notFoundUrlstringrequired#

The URL to redirect to when a link under this domain doesn't exist.

logostringrequired#

The logo of the domain.

assetLinksstringrequired#

assetLinks.json configuration file (for deep link support on Android).

Default: null

appleAppSiteAssociationstringrequired#

apple-app-site-association configuration file (for deep link support on iOS).

Default: null

createdAtstringrequired#

The date the domain was created.

updatedAtstringrequired#

The date the domain was last updated.

registeredDomainobjectrequired#

The registered domain record.

Show child attributes

idstringrequired#

The ID of the registered domain record.

autoRenewalDisabledAtstringrequired#

The date the domain auto-renew is disabled.

createdAtstringrequired#

The date the domain was created.

expiresAtstringrequired#

The date the domain expires.

renewalFeenumberrequired#

The fee to renew the domain.

Bulk delete links Update domain