Domain Object

The Domain Object defines a custom or shared domain used for generating shortened URLs through the Shortener API.

Each domain determines the behavior of links under it — including how the system responds to expired links, missing links, security requirements, and link naming rules. The configuration also allows partners to define the scope of access (who can create links with that domain) and specify whether HTTPS is enforced.

A Domain Object includes the following key elements:

• A unique domain_name and domain_sid identifier.
• Rules for handling expired or missing links (expired_mode, not_found_mode).
• Optional custom pages and HTTP status codes for each case.
• Access control through the scope attribute.
• Secure link configuration with the secure attribute.
• Optional suffix_pattern filters for partial link matching.

This configuration ensures that all links created under a given domain follow consistent behavior and security policies.

Domain Object Attributes

The fields listed in the table below will be returned in a JSON object when a successful request has been made.

Attribute	Data Type	Description
domain_name createupdate	string	The unique domain name.
domain_sid read only	string	The domain secure ID.
expired_mode createupdate	string	Determines whether to redirect or serve page contents directly if the link expires. Values accepted in this field are: proxy_pass to serve the contents of the page directly. redirect_permanent to return the permanent redirect status code before redirect. redirect_temporary to return the temporary redirect status code before redirect. The default value is redirect_temporary.
expired_page createupdate	string	The content to serve when a link expires.
expired_status_code createupdate	integer	The status code to be returned if the expired_mode value is proxy_pass. Values accepted in this field are: 2xx to return one of the success status codes. 4xx to return one of the client error status codes. 5xx to return one of the server error status codes.
minimum_length createupdate	integer	The shortest link that the system will create. The default value is 6.
not_found_mode createupdate	string	Determines whether to redirect or serve page contents directly if the link is not found. Values accepted in this field are: proxy_pass to serve the contents of the page directly. redirect_permanent to return the permanent redirect status code before redirect. redirect_temporary to return the temporary redirect status code before redirect. The default value is redirect_temporary.
not_found_page createupdate	string	The content to serve when a link is not found.
not_found_status_code createupdate	integer	The status code to be returned if the not_found_mode value is proxy_pass. Values accepted in this field are: 2xx to return one of the success status codes. 4xx to return one of the client error status codes. 5xx to return one of the server error status codes.
partner_sid read only	string	The secure ID of the partner associated with the domain.
scope createupdate	string	Determines who can create a link using the domain_sid . Values accepted in this field are: children to allow sub-partners to create links with the domain. public to allow all partners to create links with the domain. self to allow only the partner who has created the domain to create links with this domain. The default value is children.
secure createupdate	string	Determines whether links returned should be prefixed with https. Values accepted in this field are: disabled to use the insecure http prefix with the domain name. optional to allow using both http and https prefixes with the domain name. required to use only secure https prefix with the domain name. The default value is disabled.
suffix_pattern createupdate	string	The regular expressions of suffixes allowed for partial links by the HTTP server. For example, .(.mp3|mp4) will allow file names ending in .mp3 or .mp4. By default, the server will not allow suffixes.

Sample Domain Object

{
    "domain_name": "newdomain.com",
    "domain_sid": "a0625551-63de-428e-889d-2d467b4e77a3",
    "expired_mode": "redirect_temporary",
    "expired_page": null,
    "expired_status_code": null,
    "minimum_length": 6,
    "not_found_mode": "redirect_temporary",
    "not_found_page": null,
    "not_found_status_code": null,
    "partner_sid": "e00430c3-a7d0-4666-ab5c-f7202448382f",
    "scope": "children",
    "secure": "disabled",
    "suffix_pattern": null
}