Create a proxy

post https://{hostname}/config-dns/v2/proxies

Creates a new proxy.

Query Params

contractId

string

required

The contract to use for the proxy.

gid

integer

required

The currently selected group ID to manage.

accountSwitchKey

string

For customers who manage more than one account, this runs the operation from another account. The Identity and Access Management API provides a list of available account switch keys.

Body Params

contractId

string

required

The contract for this proxy.

createdTime

date-time

An ISO 8601 timestamp showing when the proxy was created.

healthCheck

object

required

The names or addresses of the master name servers to protect.

string

The proxy ID.

lastModifiedTime

date-time

An ISO 8601 timestamp showing when the proxy was last modified.

name

string

required

The proxy name.

originNameserverZoneTransferTargets

array of strings

The names or addresses to perform outbound zone transfers for AUTOMATIC filter mode. The default value is the originNameservers section.

originNameserverZoneTransferTargets

originNameservers

array of objects

required

The names or addresses of the master name servers to protect.

originNameservers*

Response

Response body

object

activationState

required

The current proxy activation status. Either NEW, PENDING, ACTIVE, LOCKED, DELETED, or ERROR.

authorities

array of strings

required

The authoritative service IPs.

authorities*

contractId

string

required

The contract for this proxy.

createdTime

date-time

required

An ISO 8601 timestamp showing when the proxy was created.

healthCheck

object

required

The names or addresses of the master name servers to protect.

recordName

string | null

Name of health check record. A null value indicates the record is at the apex of the zone.

recordType

string

The health check record's DNS record type. Refer to Supported DNS resource record types for a complete list.

string

required

The unique proxy ID.

lastModifiedTime

date-time

An ISO 8601 timestamp showing when the proxy was last modified.

name

string

required

The proxy name.

originNameserverZoneTransferTargets

array of strings

The names or addresses to perform outbound zone transfers with filter_mode of AUTOMATIC. If this field is omitted the originNameservers section is used.

originNameserverZoneTransferTargets

originNameservers

array of objects

required

The names or addresses of the master name servers to protect.

originNameservers*

object

name

string

Master name server name or address.

port

integer

Defaults to 53

The master name server port number.

Headers

object

Location

string

Provides a URL path you can GET the newly created resource from.

Language

Authentication

Remember to add your authentication credentials to run this code.

URL


xxxxxxxxxx
1
curl --request POST \
2
     --url https://hostname/config-dns/v2/proxies \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'


xxxxxxxxxx
19
 
1
{
2
  "activationState": "NEW",
3
  "authorities": [],
4
  "contractId": "C-0N7RAC7",
5
  "createdTime": "2024-03-28T20:55:47.890229Z",
6
  "healthCheck": {
7
    "recordName": "fqdn.com.",
8
    "recordType": "MX"
9
  },
10
  "id": "4de9ce8e-4182-416c-a7d1-8252023df4d3",
11
  "lastModifiedTime": "2024-03-28T20:55:47.890229Z",
12
  "name": "F5",
13
  "originNameserverZoneTransferTargets": [],
14
  "originNameservers": [
15
    {
16
      "name": "192.0.2.4"
17
    }
18
  ]
19
}

201Successful response.