Modify parked zone settings

Description

Modify the settings of a parked zone


 Parameters

Name Data Type Status Description
auth-id or sub-auth-id or sub-auth-user Integer Required Authentication parameter
auth-password String Required Authentication parameter
domain-name String Required The name of the zone you want to modify the parked settings of.
template Integer Required The id of the template. You can get the available templates with Get parked templates. It must be 1, 2, 3 or 4.
title String Optional The title of the parked page
description String Optional The description of the parked page
keywords String Optional The keywords of the parked page
contact-form Integer Optional Whether or not to show a contact form. 1 is enabled, 2 is disabled. Default is 0.

Return: Array with status and status description.


Errors

When the authenctication of API user is not correct, any API request will fail with the following status and statusDescription:

{"status":"Failed","statusDescription":"Invalid authentication, incorrect auth-id or auth-password."}

In case the credentials of API sub user are invalid, the following status and statusDescription will be returned:

{"status":"Failed","statusDescription":"Invalid authentication, incorrect sub-auth-id, sub-auth-user or auth-password."}

When invalid or non-existant domain-name is entered, the following status will be returned:

{"status":"Failed","statusDescription":"Missing domain-name"}

When template paremeter is not from the suggested values (1, 2, 3 or 4) or Integer, the API request will fail and the following status and statusDescription will be returned:

{"status":"Failed","statusDescription":"You have to choose a template from the list."}

Note: These are example errors in JSON format.


 Example

URL JSON: https://api.cloudns.net/dns/set-parked-settings.json
POST/GET: auth-id=0&auth-password=password&domain-name=parked-zone.com&template=1&title=Title of my page&description=Description of my page&keywords=Keywords, for, my page&contact-form=1
POST/GET: sub-auth-id=0&auth-password=password&domain-name=parked-zone.com&template=1&title=Title of my page&description=Description of my page&keywords=Keywords, for, my page&contact-form=1

URL XML: https://api.cloudns.net/dns/set-parked-settings.xml
POST/GET: auth-id=0&auth-password=password&domain-name=parked-zone.com&template=1&title=Title of my page&description=Description of my page&keywords=Keywords, for, my page&contact-form=1
POST/GET: sub-auth-id=0&auth-password=password&domain-name=parked-zone.com&template=1&title=Title of my page&description=Description of my page&keywords=Keywords, for, my page&contact-form=1


Last modified: 2019-07-04
Cookies help us deliver our services. By using our services, you agree to our use of cookies. Learn more