Add a domain

The ADDDOMAIN action adds a new or additional Fully Qualified Domain Name (FQDN) or wildcard domain to the subscription. The included domain is added to the specified ACME account and to any other ACME accounts that share the same EAB details.

A subscription is initiated when you add your first domain.

For more information about subscriptions and domains, see Subscription overview.

Action: ADDDOMAIN

Variable Name Type Max. Length Description

Variable Name	Type	Max. Length	Description
`loginName`	string	64 chars	Your account username. This value is case sensitive.
`loginPassword`	string	128 chars	Your account password. This value is case sensitive.
`action`	string	30 chars	The action to be taken. In this case, the value is: `ADDDOMAIN`.
`acmeAccountID`	string	32 chars	Your Base64 url encoded ACME account ID.
`domainName`	string	255 chars	Your FQDN or wildcard domain name.
`quoteOnly`	string	1 char	Indicates whether to return a quote or perform the actual action. The possible values are: `N` — (Default) Performs the actual `ADDDOMAIN` action. `Y` — Returns a quote for the requested action, valid at the time of request, but does not perform any action.
`addAssociatedFQDN`	string	1 char	Indicates whether to include an FQDN associated with the domain being added. The possible values are: `N` — (Default) Adds only the specified domain name, in which case a check is performed to determine whether it is eligible to be added for free. `Y` — Also adds the domain name allowed for free based on the domain type being added. See Domain Details for more details.

loginName

string

64 chars

Your account username.

This value is case sensitive.

loginPassword

string

128 chars

Your account password.

This value is case sensitive.

action

string

30 chars

The action to be taken.

In this case, the value is: ADDDOMAIN.

acmeAccountID

string

32 chars

Your Base64 url encoded ACME account ID.

domainName

string

255 chars

Your FQDN or wildcard domain name.

quoteOnly

string

1 char

Indicates whether to return a quote or perform the actual action.

The possible values are:

N — (Default) Performs the actual ADDDOMAIN action.
Y — Returns a quote for the requested action, valid at the time of request, but does not perform any action.

addAssociatedFQDN

string

1 char

Indicates whether to include an FQDN associated with the domain being added.

The possible values are:

N — (Default) Adds only the specified domain name, in which case a check is performed to determine whether it is eligible to be added for free.
Y — Also adds the domain name allowed for free based on the domain type being added.

See Domain Details for more details.

An associated domain can always be added for free throughout the validity of the subscription if needed. To do so, addAssociatedFQDN must be set to N. In this case, the system will perform a lookup for the domain in the subscription to associate it accordingly. Therefore, there is no need to automatically set addAssociatedFQDN = Y unless necessary, as this will complicate subscription management and unnecessarily expand the domain list.

Sample request

curl --location --request POST 'https://secure.trust-provider.com/products/!ACMEAdmin' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'loginName=loginName' \
--data-urlencode 'loginPassword=loginPassword' \
--data-urlencode 'action=ADDDOMAIN' \
--data-urlencode 'acmeAccountID=ABc_123xYZ456' \
--data-urlencode 'domainName=domain.com'

Success responses

Success response

{
    "success": true,
    "orderNumber": 123456789,
    "cost": 200.00,
    // displayed price is for sample purposes only
    "currency": "USD",
    "domains": [
        {
            "domainName": "domain.com"
        }
    ]
}

Success response with quoteOnly set to Y

{
    "success": true,
    "cost": 200.00,
    // displayed price is for sample purposes only
    "currency": "USD",
    "domains": [
        {
            "domainName": "domain.com"
        }
    ]
}