FirelinksInstall

Summary

Add a new domain in Firelinks by specifying a domain name and its linked server IP, with optional parameters to configure default redirect URL, domain expiration end date, default domain status, and SSL certificate generation.

Inputs

• Domain Name (required) — The domain name to register, e.g., 'link.example.com'.
• Server IP (required) — The IP address of the server to link the domain to; this IP must be registered in advance.
• Additional Fields — Optional settings including a default URL for redirects without code, domain end date (expiration), whether to make this domain the default for links, and whether to generate an SSL certificate with Let's Encrypt.

Output shape

a list containing the newly created domain object returned from the Firelinks API.

The output data is the 'data' field from the API response, always returned as an array for consistency regardless of single or multiple domain objects.

Examples

Example 1: Add domain with required fields only

Provide 'Domain Name' and 'Server IP' only.

Example 2: Add domain with SSL and default settings

Set 'Generate SSL Certificate' to true and 'Is Default' to true in Additional Fields.