API Queries - Add Domains

The add_domains function adds domains to your Above.com Parking Manger account (up to 1,000 at a time - see note below). Additional parameters are required for this function.

Additional Parameters

• domains - The domain or domains to be added to your account, comma separated (up to 1,000 per query - see note below). (Required)
• folder - Name of the folder to add domains to. If omitted, the default folder will be used. If the folder does not exist, an error will be returned. (Optional)

Note: For larger queries (when adding more than 100 domains at a time), you MUST use a POST request to ensure you do not reach any request length limitations.

Note: Make sure to URL encode all values.

Example query and response:

In this example, we will add the domains abc123.com, efg456.com and lmn789.net (domains=abc123.com,efg456.com,lmn789.net) to the "(Default)" folder (default, if folder is omitted).

Note: This function will return the status "Success", even if the domains are already in your account.

Example query:
https://www.above.com/api.php?username=user&password=pass&api_key=key&mode=add_domains&domains=abc123.com,
efg456.com,lmn789.net&folder=(Default)

Response:

<resultsstatus="Success"/>

<info>

<resultmessage="3 new domains added"/>

</info>

 

The message(s) will show the number of domains that were added/re-added or moved.

Note: If domains fail to be added for any reason, the response will still be successful, but will show a list of failed domains. See the example below:

Example query:
https://www.above.com/api.php?username=user&password=pass&api_key=key&mode=add_domains&domains=fakedomain1.com,
fakedomain2.net&folder=(Default)

Response:

<resultsstatus="Success">

<info>

<resultmessage="2 domains failed">

<detail>

<result>fakedomain1.com</result>

<result>fakedomain2.net</result>

</detail>

</result>

</info>

</results>

 

If many domains are being added and the task takes longer than 30 seconds a jobid will be provided. See the example below:

Example query:
https://www.above.com/api.php?username=user&password=pass&api_key=key&mode=add_domains&domains=domain515.com,
domain032.com,domain041.com,+ many more domains

Response:

<results>

<resultjobid="12345"status="Processing"/>

</results>

 

You can then view the progress using the jobid with the Job Status function.

Error Responses:

Possible error responses for this function are:

• 410 - No domain or domains parameter passed
• 413 - Folder Not Found
• 500 - Job failed. Please contact support if problems persist.
• General errors, such as 200 - Internal Error or 300 - Username or password invalid.

For a complete list of error responses, see the Error Codes manual page.