ManageEngine CloudDNS REST API- Documentation

ManageEngine CloudDNS REST API- Documentation

API Calls

 Generating Access Token

    1. Login to https://clouddns.manageengine.com and click on user profile in the right corner of the  Navbar
    2. Click on view client credentials and copy the client ID and client secret.
    3. Make an API call to https://clouddns.manageengine.com/oauth2/token/ (POST) with the credentials received and set the key grand_type as client_credentials, these must be set in the form data
    4. Access token has 30 minutes of validity

 

 

 

Headers

URLEncoded-Form Data

Example Response

 

Content-Type     application/json

 

 

client_id: ggV0IWqAU3huwyNeakhlrmbjhdbsjsd15Lax9YPzhQ6Uws

 

client_secret: EOPEF3MppjQ4zbZPZ9If K53YJ4qv026ARLlhugiuiuSus9VYVb4sJjtFOyvOgpOmmWmbsYaQupZfc3nioSjLTS2TtmachidshihsidsdVIPoHbHJmpkXKULCwHzt6UnUB

 

grant_type: client_credentials

 

{

    "access_token": "Pn82NLlMc5ONG5AmBdEoB8BtBqljPe",

    "expires_in": 1800,

    "token_type": "Bearer",

    "scope": "read write"

}

 

 

 

Domains:

GET All: 

Returns a list of all domains in the organization

 

 

Headers

Example Response

 

Content-Type                     application/json

authorization Bearer {{access_token}}

 

[

    {

        "zone_id": 1,

        "zone_name": "test.com.",

        "zone_ttl": 500,

         "zone_type":0,

        "zone_targeting": true,

        "zone_logging": "{}",

        "zone_contact": "mathes.zoho.com",

        "refresh": 43200,

        "retry": 3600,

        "expiry": 1209600,

        "minimum": 180,

        "org": 2,

        "any_query": false,

        "dnssec": true,

        "vanity": false,

        "ns_id": 1,

        "serial": 2022042206,

        "ns": ["ns11.zns-53.com.",

                   "ns21.zns-53.net.",
                   "ns31.zns-53.com.",
                   "ns41.zns-53.net."]",
       "contact_group": ["test_contact1",
                                       "test_contact2"]",
         "ds": [

            {

                "record_id": 59,

                "keyTag": 36938,

                "algorithm": 13,

                "digestType": 1,

                "digest": "e9f03d176455d5d16f826b69f9ecb11f59be35e7",

                "domain_id": 30

            },

            {

                "record_id": 60,

                "keyTag": 36938,

                "algorithm": 13,

                "digestType": 2,

                "digest": "7ea640a8668eafd9d89a9b2e9994f5fcfb1dee0668d1e93ba556aa57ac047f96",

                "domain_id": 30

            }

        ]

    },

    {

        "zone_id": 2,

        "zone_name": "yourdomain.com.",

        "zone_ttl": 1000,

          "zone_type":0,

        "zone_targeting": false,

        "zone_logging": "{}",

        "zone_contact": "contact.yourdomain.com",

        "refresh": 43200,

        "retry": 3600,

        "expiry": 1209600,

        "minimum": 180,

        "org": 2,

        "any_query": false,

        "dnssec": false,

        "vanity": true,
        "vanity_grp": "yourdomain"

        "ns_id": 1,

        "serial": 2022040608,

        "ns": ["ns11.yourdomain.com.",

                   "ns21.yourdomain.net.",
                   "ns31.yourdomain.com.",
                   "ns41.yourdomain.net."]

    },

    {

        "zone_id": 20,

        "zone_name": "hello45.com.",

        "zone_ttl": 3000,

        "zone_targeting": false,

        "zone_logging": "{}",

        "zone_contact": "mathes.zoho.com",

        "refresh": 43200,

        "retry": 3600,

        "expiry": 1209600,

        "minimum": 180,

        "org": 2,

        "any_query": false,

        "dnssec": false,

        "ns_id": 1,

        "serial": 2022040711,

        "ns": ["ns11.zns-53.com.",

                   "ns21.zns-53.net.",
                   "ns31.zns-53.com.",
                   "ns41.zns-53.net."]

    },

    {

        "zone_id": 22,

        "zone_name": "zohoaccl.com.",

        "zone_ttl": 300,

         "zone_type":0,

        "zone_targeting": true,

        "zone_logging": "{}",

        "zone_contact": "networkone.zohocorp.com",

        "refresh": 43200,

        "retry": 3600,

        "expiry": 1209600,

        "minimum": 180,

        "org": 2,

        "any_query": false,

        "dnssec": false,

        "ns_id": 1,

        "serial": 2022042206,

        "ns": ["ns11.zns-53.com.",

                   "ns21.zns-53.net.",
                   "ns31.zns-53.com.",
                   "ns41.zns-53.net."]

    },

    {

        "zone_id": 23,

        "zone_name": "zohocal.com.",

        "zone_ttl": 300,

          "zone_type":0,

        "zone_targeting": true,

        "zone_logging": "{}",

        "zone_contact": "mathes.zoho.com",

        "refresh": 43200,

        "retry": 3600,

        "expiry": 1209600,

        "minimum": 180,

        "org": 2,

        "any_query": false,

        "dnssec": false,

        "ns_id": 1,

        "serial": 2022041310,

        "ns": ["ns11.zns-53.com.",

                   "ns21.zns-53.net.",
                   "ns31.zns-53.com.",
                   "ns41.zns-53.net."]

    }

]

 

 

 

 

POST Create:

 

Creates a domain in the organization.(Note: set  'zone_type' as  0 for Primary GeoDNS, 1 for Primary AXFR and 2 for Secondary)

 

 

Headers

Form Data

Example Response

 

Content-Type     application/json

authorization Bearer {{access_token}}

 

 

config:
    {
       
        "zone_name": "zohocal.eu.",
        "zone_ttl": 300,
        "zone_targeting": false,

        "zone_type":0,
        "zone_logging": "{}",
        "zone_contact": "zoho-accl.zohocorp.com",
        "refresh": 43200,
        "retry": 3600,
        "expiry": 1209600,
        "minimum": 180,
        "vanity": false
        "contact_group": [
                                       "test_contact1",
                                       "test_contact2"
                                     ]
    }

 

{

    "zone_id": 13,

    "zone_name": "zohocal.eu.",

    "zone_ttl": 300,

      "zone_type":0,

    "zone_targeting": false,

    "zone_logging": "{}",

    "zone_contact": "zoho-accl.zohocorp.com",

    "refresh": 43200,

    "retry": 3600,

    "expiry": 1209600,

    "minimum": 180,

    "org": 3,

    "any_query": false,

    "dnssec": true,

    "ns_id": 1,

    "serial": 2022042505,

    "ns": ["ns11.zns-53.com.",

               "ns21.zns-53.net.",
               "ns31.zns-53.com.",
               "ns41.zns-53.net."],
      "contact_group": [" test_contact1"
                                     "test_contact2"],
     "ds": [

        {

            "record_id": 11,

            "keyTag": 5166,

            "algorithm": 13,

            "digestType": 1,

            "digest": "2d1e7a0fd81e1b0f7cfcaa370adcb21b4871443b",

            "domain_id": 6

        },

        {

            "record_id": 12,

            "keyTag": 5166,

            "algorithm": 13,

            "digestType": 2,

            "digest": "71a7081914647a410ac26216faca8b6f731596a45310ce1fbecfdd5dc9aa23e0",

            "domain_id": 6

        }

    ]

}

 

 

The contact group keyword under the post command is optional. The post command  would work fine even without the contact group keyword.

GET Specific:

Returns the requested domain in the organization

 

 

Headers

Example Response

 

Content-Type                     application/json

authorization Bearer {{access_token}}

 

{

    "zone_id": 1,

    "zone_name": "test.com.",

    "zone_ttl": 500,

      "zone_type":0,

    "zone_targeting": true,

    "zone_logging": "{}",

    "zone_contact": "mathes.zoho.com",

    "refresh": 43200,

    "retry": 3600,

    "expiry": 1209600,

    "minimum": 180,

    "org": 2,

    "any_query": false,

    "dnssec": true,

    "ns_id": 1,

    "serial": 2022042206,

    "ns": ["ns11.zns-53.com.",

              "ns21.zns-53.net.",
              "ns31.zns-53.com.",
              "ns41.zns-53.net."],

    "ds": [

        {

            "record_id": 59,

            "keyTag": 36938,

            "algorithm": 13,

            "digestType": 1,

            "digest": "e9f03d176455d5d16f826b69f9ecb11f59be35e7",

            "domain_id": 30

        },

        {

            "record_id": 60,

            "keyTag": 36938,

            "algorithm": 13,

            "digestType": 2,

            "digest": "7ea640a8668eafd9d89a9b2e9994f5fcfb1dee0668d1e93ba556aa57ac047f96",

            "domain_id": 30

        }

    ]

}

 

 

PUT Update:

Update an existing domain in the organization

 

 

Headers

Form Data

Example Response

 

Content-Type     application/json

authorization Bearer {{access_token}}

 

config:
    {
       "zone_id":1,
        "zone_name": "zohocal.eu.",

         "zone_type":0,
        "zone_ttl": 800,
        "zone_targeting": false,
        "zone_logging": "{}",
        "zone_contact": "zoho-accl.zohocorp.com",
        "refresh": 43200,
        "retry": 3600,
        "expiry": 1209600,
        "minimum": 180,

         "dnssec":true

         "contact_group": [
                                     "test contact_1",
                                     "test contact_2"
                                     ]
    }

 

{"message" : "Updated successfully"}

 

 The contact group keyword under the put command is optional. The Put command it would work fine even without the contact group keyword.


DEL Delete:

Deletes an existing domain in the organization

 

 

Headers

Example Response

 

Content-Type                     application/json

authorization Bearer {{access_token}}

 

 

{"message" : "deleted successfully"}

 


 Vanity Nameserver


To configure vanity nameservers via API click here.

Zone Groups

GET All:

 

 

 

                   Headers

                Formdata

 Content-Type                     application/json

authorization Bearer {{access_token}}

[

    {

        "group_id": 1,

        "group_name": "Sample group",

        "mail_list": [

            "ssss.g@gmail.com"

        ],

        "domains": ["brigh10.com.",

            "eurohost.com.",

            "akshra.com."]

 

    },

    {

        "group_id": 15,

        "group_name": "mygp5",

        "mail_list": [

            "ssss.g@gmail.com"

        ],

        "domains": ["brigh10.com.",

            "eurohost.com.",

            "akshra.com."]

    }

]

 

POST Create:


 

               Headers

 Formdata                                

ExampleResponse

Content-Type                     application/json

authorization Bearer {{access_token}}

domains:["brigh10.com.",

            "eurohost.com.",

            "akshra.com."]

group_name:data group

email_addresses:[

            "ssss.g@gmail.com"

        ]

{

    "message": "Group Created Successfully."

}

 

 

 

 

GET Specific:


 

                    Headers

                    Formdata

Content-Type                     application/json

authorization Bearer {{access_token}}

[

{

        "group_id": 4,

        "group_name": "mygp5",

        "mail_list": [

            "ssss.g@gmail.com"

        ],

        "domains": ["brigh10.com.",

            "eurohost.com.",

            "akshra.com."]

    }

]


PUT Update:


 

             Headers

              Formdata

Example Response

Content-Type                     application/json

authorization Bearer {{access_token}}

config:

[

{

        "group_id": 4,

        "group_name": "mygp5",

        "mail_list": [

            "ssss.g@gmail.com"

        ],

        "domains": ["brigh10.com.",

            "eurohost.com.",

            "akshra.com."]

    }

]

{

    "message": "Group Updated Successfully."

}

 

 

DEL Delete:


 

 

              Headers

            Formdata

    Content-Type                     application/json

authorization Bearer {{access_token}}

{

    "message": "Group Deleted Successfully."

}

 


A(IPv4)

 GET All:


https://clouddns.manageengine.com/v1/dns/domain/4/records/A

 

Returns a list of all A records in the specified domain

 

 

Headers

Example Response

 

Content-Type                     application/json

authorization Bearer {{access_token}}

 

[

    {

        "a_domain_id": 14,

        "zone_id": 4,

        "domain_name": "t.zohocal.eu.",

        "domain_ttl": 300,

        "domain_maxhost": 1,

        "domain_closest": true,

        "domain_location_id": 1,

        "record_mode": "standard",

        "records": [

            {

                "record_id": 15,

                "ip": "172.21.100.102",

                "weight": 10,

                "active": true,

                "backup": false,

                "monitor_id": null,

                "monitor_status": 1,

                 "disabled":false,

                "domain_id": 14

            }

        ]

    },

    {

        "a_domain_id": 13,

        "zone_id": 4,

        "domain_name": "testing.zohocal.eu.",

        "domain_ttl": 300,

        "domain_maxhost": 1,

        "domain_closest": true,

        "domain_location_id": 1,

        "record_mode": "standard",

        "records": [

            {

                "record_id": 14,

                "ip": "172.21.100.101",

                "weight": 10,

                "active": true,

                "backup": false,

                "monitor_id": null,

                "monitor_status": 1,

                "disabled":false,

                "domain_id": 13

            }

        ]

    }
]


POST Create: 

https://clouddns.manageengine.com/v1/dns/domain/4/records/A/

  

Creates one or more new A record(s) in a specified domain

  

 

Headers

Form Data

Example Response

 

Content-Type     application/json

authorization Bearer {{access_token}}

 

 

config: [
     {

        "zone_id": 4,

        "domain_name": "t.zohocal.eu.",

        "domain_ttl": 300,

        "domain_maxhost": 1,

        "domain_closest": true,

        "domain_location_id": 1,

      

        "records": [

            {

                

                "ip": "172.21.100.102"

              

 

              

            }

        ]

    }
]

 

{"message" : "Record created successfully"}

 

GET Specific:

 
https://clouddns.manageengine.com/v1/dns/domain/4/records/A/6/

 

Returns a specified A record in the specified domain

 

 

Headers

Example Response

 

Content-Type                     application/json

authorization Bearer {{access_token}}

 

[

    {

        "a_domain_id": 6,

        "zone_id": 4,

        "domain_name": "testing.zohodns.net.",

        "domain_ttl": 300,

        "domain_maxhost": 1,

        "domain_closest": true,

        "domain_location_id": 1,

        "record_mode": "standard",

        "records": [

            {

                "record_id": 6,

                "ip": "169.38.34.46",

                "weight": 10,

                "active": true,

                "backup": false,

                "monitor_id": null,

                "monitor_status": 1, 

                "disabled":false,

                "domain_id": 6

            }

        ]

    }

]

 



PUT Update:

https://clouddns.manageengine.com/v1/dns/domain/4/records/A/6/

  

Update an existing A record in the specified domain

 

 

Headers

Form Data

Example Response

 

Content-Type     application/json

authorization Bearer {{access_token}}

 

config: [

    {

        "a_domain_id": 6,

        "zone_id": 4,

        "domain_name": "testing.zohodns.net.",

        "domain_ttl": 300,

        "domain_maxhost": 1,

        "domain_closest": true,

        "domain_location_id": 1,

      

        "records": [

            {

                "record_id": 6,

                "ip": "169.38.34.46",

                "disabled":false,

                "domain_id": 6

            }

        ]

    }

]

 

{"message" : "Record updated successfully"}

 

 DEL Delete:

Deletes an existing A record in the specified domain

 

 

Headers

Example Response

 

Content-Type                     application/json

authorization Bearer {{access_token}}

 

 

{"message" : "Record deleted successfully"}

 

   

AAAA(IPv6) 

GET All: 

https://clouddns.manageengine.com/v1/dns/domain/4/records/AAAA

 Returns a list of all AAAA records in the specified domain

 

 

Headers

Example Response

 

Content-Type                     application/json

authorization Bearer {{access_token}}

 

[

    {

        "aaaa_domain_id": 14,

        "zone_id": 4,

        "domain_name": "t.zohocal.eu.",

        "domain_ttl": 300,

        "domain_maxhost": 1,

        "domain_closest": true,

        "domain_location_id": 1,

        "record_mode": "standard",

        "records": [

            {

                "record_id": 15,

                "ip": "2001:db8:3333:4444:5555:6666:7777:7777",

                "weight": 10,

                "active": true,

                "backup": false,

                "monitor_id": null,

                "monitor_status": 1,,

                "disabled":false,

                "domain_id": 14

            }

        ]

    },

    {

        "aaaa_domain_id": 13,

        "zone_id": 4,

        "domain_name": "testing.zohocal.eu.",

        "domain_ttl": 300,

        "domain_maxhost": 1,

        "domain_closest": true,

        "domain_location_id": 1,

        "record_mode": "standard",

        "records": [

            {

                "record_id": 14,

                "ip": "2001:db8:3333:4444:5555:6666:7777:7799",

                "weight": 10,

                "active": true,

                "backup": false,

                "monitor_id": null,

                "monitor_status": 1,

                "disabled":false,

                "domain_id": 13

            }

        ]

    }
]

 

 

POST Create:

Creates one or more new AAAA record(s) in a specified domain

 

Headers

Form Data

Example Response

 

Content-Type     application/json

authorization Bearer {{access_token}}

 

config: [

 {

      

        "zone_id": 4,

        "domain_name": "t.zohocal.eu.",

        "domain_ttl": 300,

        "domain_maxhost": 1,

        "domain_closest": true,

        "domain_location_id": 1,

    

        "records": [

            {

               

                "ip": "2001:db8:3333:4444:5555:6666:7777:7777"

 

             

            }

        ]

    }

]

 

 

{"message" : "Record created successfully"}

 

 GET Specific:

Returns a specified AAAA record in the specified domain

Headers

Example Response

 

Content-Type                     application/json

authorization Bearer {{access_token}}

 

[

 {

        "aaaa_domain_id": 6,

        "zone_id": 4,

        "domain_name": "t.zohocal.eu.",

        "domain_ttl": 300,

        "domain_maxhost": 1,

        "domain_closest": true,

        "domain_location_id": 1,

        "record_mode": "standard",

        "records": [

            {

                "record_id": 15,

                "ip": "2001:db8:3333:4444:5555:6666:7777:7777",

                "weight": 10,

                "active": true,

                "backup": false,

                "monitor_id": null,

                "monitor_status": 1,

                "domain_id": 14

            }

        ]

    }

]

 

 

 

 PUT Update:

Update an existing AAAA record in the specified domain

 

 

Headers

Form Data

Example Response

 

Content-Type     application/json

authorization Bearer {{access_token}}

 

config: [

 {

        "aaaa_domain_id": 6,

        "zone_id": 4,

        "domain_name": "t.zohocal.eu.",

        "domain_ttl": 300,

        "domain_maxhost": 1,

        "domain_closest": true,

        "domain_location_id": 9,

        

        "records": [

            {

                "record_id": 15,

                "ip": "2001:db8:3333:4444:5555:6666:7777:7777",

                "disabled":false,

             

 

                "domain_id": 14

            }

        ]

    }

]

 

{"message" : "Record updated successfully"}

 


DEL Delete: 

 

Deletes an existing AAAA record in the specified domain

 

 

Headers

Example Response

 

Content-Type                     application/json

authorization Bearer {{access_token}}

 

 

{"message" : "Record deleted successfully"}

 

 

 

CNAME

GET All:

Returns a list of all CNAME records in the specified domain

 

Headers

Example Response

 

Content-Type     application/json

authorization   Bearer {{access_token}}

 

[

    {

        "cname_domain_id": 14,

        "zone_id": 4,

        "domain_name": "t.zohocal.eu.",

        "domain_ttl": 300,

        "domain_maxhost": 1,

        "domain_closest": true,

        "domain_location_id": 9,

        "record_mode": "standard",

        "records": [

            {

                "record_id": 15,

                "host_fqdn": "www.test.com.",

                "weight": 10,

                "active": true,

                "backup": false,

                "monitor_id": null,

                "monitor_status": 1,

                "disabled":false,

                "domain_id": 14

            }

        ]

    },

    {

        "cname_domain_id": 13,

        "zone_id": 4,

        "domain_name": "testing.zohocal.eu.",

        "domain_ttl": 300,

        "domain_maxhost": 1,

        "domain_closest": true,

        "domain_location_id": 8,

        "record_mode": "standard",

        "records": [

            {

                "record_id": 14,

                  "host_fqdn": "www.test1.com.",

                "weight": 10,

                "active": true,

                "backup": false,

                "disabled":false,

  "monitor_id": null,

                "monitor_status": 1,

                "disabled":false,

                "domain_id": 13

            }

        ]

    }
]

 

 

POST Create: 

Creates one or more new CNAME record(s) in a specified domain

 

Headers

Form Data

Example Response

 

Content-Type     application/json

authorization Bearer {{access_token}}

 

 

config: [
     {

       

        "zone_id": 4,

        "domain_name": "t.zohocal.eu.",

        "domain_ttl": 300,

        "domain_maxhost": 1,

        "domain_closest": true,

        "domain_location_id": 9,

     

        "records": [

            {   

               "host_fqdn": "www.test.com."

 

              

            }

        ]

    }
]

 

{"message" : "Record created successfully"}

 

 GET Specific:

Returns a specified CNAME record in the specified domain

 

Headers

Example Response

 

Content-Type                     application/json

authorization Bearer {{access_token}}

 

[

    {

        "cname_domain_id": 6,

        "zone_id": 4,

        "domain_name": "testing.zohodns.net.",

        "domain_ttl": 300,

        "domain_maxhost": 1,

        "domain_closest": true,

        "domain_location_id": 1,

        "record_mode": "standard",

        "records": [

            {

                "record_id": 6,

                "host_fqdn": "www.test.com.",

                "weight": 10,

                "active": true,

                "backup": false,

                "monitor_id": null,

                "monitor_status": 1,

                "disabled":false,

                "domain_id": 6

            }

    ]

    }

]

    

 

 

 

PUT Update: 


Update an existing CNAME record in the specified domain

 

Headers

Form Data

Example Response

 

Content-Type   application/json

authorization  Bearer {{access_token}}

 

config: [

    {

        "cname_domain_id": 6,

        "zone_id": 4,

        "domain_name": "testing.zohodns.net.",

        "domain_ttl": 300,

        "domain_maxhost": 1,

        "domain_closest": true,

        "domain_location_id": 1,

      

        "records": [

            {

                "record_id": 6,

               "host_fqdn": "www.test.com.",

                "disabled":false,

  "domain_id": 6

            }

        ]

    }

]

 

{"message" : "Record updated successfully"}




DEL Delete:

Deletes an existing CNAME record in the specified domain

 

Headers

Example Response

 

Content-Type                 application/json

authorization Bearer {{access_token}}

 

 

{"message" : "Record deleted successfully"}

 

 

ANAME

GET All:

Returns a list of all ANAME records in the specified domain

 

Headers

Example Response

 

Content-Type     application/json

authorization   Bearer {{access_token}}

 

[

    {

        "cname_domain_id": 14,

        "zone_id": 4,

        "domain_name": "@.zohocal.eu.",

        "domain_ttl": 300,

        "domain_maxhost": 1,

        "domain_closest": true,

        "domain_location_id": 1,

        "record_mode": "standard",

        "records": [

            {

                "record_id": 15,

                "host_fqdn": "www.test.com.",

                "weight": 10,

                "active": true,

                "backup": false,

                "monitor_id": null,

                "monitor_status": 1,

                "disabled":false,

                "domain_id": 14

            }

        ]

    },

    {

        "cname_domain_id": 13,

        "zone_id": 4,

        "domain_name": "@.zohocal.eu.",

        "domain_ttl": 300,

        "domain_maxhost": 1,

        "domain_closest": true,

        "domain_location_id": 8,

        "record_mode": "standard",

        "records": [

            {

                "record_id": 14,

                 "host_fqdn": "www.test1.com.",

                "weight": 10,

                "active": true,

                "backup": false,

  "monitor_id": null,

                "monitor_status": 1,

                "domain_id": 13

            }

        ]

    }
]

 



POST Create:

Creates one or more new ANAME record(s) in a specified domain

 

Headers

Form Data

Example Response

 

Content-Type     application/json

authorization Bearer {{access_token}}

 

 

config: [
     {

       

        "zone_id": 4,

        "domain_name": "@.zohocal.eu.",

        "domain_ttl": 300,

        "domain_maxhost": 1,

        "domain_closest": true,

        "domain_location_id": 9,

      

        "records": [

            {   

               "host_fqdn": "www.test.com."

            

 

              

            }

        ]

    }
]

 

{"message" : "Record created successfully"}



GET Specific:

 Returns a specified ANAME record in the specified domain

 

Headers

Example Response

 

Content-Type                     application/json

authorization Bearer {{access_token}}

 

[ {

        "cname_domain_id": 6,

        "zone_id": 4,

        "domain_name": "@.zohodns.net.",

        "domain_ttl": 300,

        "domain_maxhost": 1,

        "domain_closest": true,

        "domain_location_id": 1,

        "record_mode": "standard",

        "records": [

            {

                "record_id": 6,

                "host_fqdn": "www.test.com.",

                "weight": 10,

                "active": true,

                "backup": false,

                "monitor_id": null,

                "monitor_status": 1,

                "disabled":false,

                "domain_id": 6

            }

        ] } ]

 

 

 



PUT Update:

 Update an existing CNAME record in the specified domain

 

Headers

Form Data

Example Response

 

Content-Type   application/json

authorization  Bearer {{access_token}}

 

config: [

    {

        "cname_domain_id": 6,

        "zone_id": 4,

        "domain_name": "@.zohodns.net.",

        "domain_ttl": 300,

        "domain_maxhost": 1,

        "domain_closest": true,

        "domain_location_id": 1,

       

        "records": [

            {

                "record_id": 6,

               "host_fqdn": "www.test.com.",

                "disabled":false,

              

 

                "domain_id": 6

            }

        ]

    }

]

 

{"message" : "Record updated successfully"}



DEL Delete:

Deletes an existing ANAME record in the specified domain

 

Headers

Example Response

 

Content-Type                 application/json

authorization Bearer {{access_token}}

 

 

{"message" : "Record deleted successfully"}

 

 

ALIAS

GET All:

Returns a list of all ALIAS records in the specified domain

 

Headers

Example Response

 

Content-Type     application/json

authorization   Bearer {{access_token}}

 

[

    {

        "alias_domain_id": 14,

        "zone_id": 4,

        "domain_name": "test.zohocal.eu.",

        "domain_ttl": 300,

        "domain_maxhost": 1,

        "domain_closest": true,

        "domain_location_id": 1,

        "record_mode": "standard",

        "records": [

            {

                "record_id": 15,

                "host_fqdn": "www.test.zohocal.eu",

                "weight": 10,

                "active": true,

                "backup": false,

                "monitor_id": null,

                "monitor_status": 1,

                "disabled":false,

                "domain_id": 14

            }

        ]

    },

    {

        "alias_domain_id": 13,

        "zone_id": 4,

        "domain_name": "testing.zohocal.eu.",

        "domain_ttl": 300,

        "domain_maxhost": 1,

        "domain_closest": true,

        "domain_location_id": 1

        "record_mode": "standard",

        "records": [

            {

                "record_id": 14,

                 "host_fqdn": "www.test1.com.",

                "weight": 10,

                "active": true,

                "backup": false,

  "monitor_id": null,

                "monitor_status": 1,

                "disabled":false,

                "domain_id": 13

            }

        ]

    }
]

 


POST Create:

Creates one or more new ALIAS record(s) in a specified domain

 

Headers

Form Data

Example Response

 

Content-Type     application/json

authorization Bearer {{access_token}}

 

 

config: [
     {

       

        "zone_id": 4,

        "domain_name": "test.zohocal.eu.",

        "domain_ttl": 300,

        "domain_maxhost": 1,

        "domain_closest": true,

        "domain_location_id": 9,

        "record_mode": "standard",

        "records": [

            {   

               "host_fqdn": "www.test.zohocal.eu.",

                "weight": 10,

                "active": true,

                "backup": false,

                "monitor_id": null,

                "monitor_status": 1

              

            }

        ]

    }
]

 

{"message" : "Record created successfully"}



GET Specific:

 Returns a specified ALIAS record in the specified domain

 

Headers

Example Response

 

Content-Type                     application/json

authorization Bearer {{access_token}}

 

[ {

        "alias_domain_id": 6,

        "zone_id": 4,

        "domain_name": "test.zohodns.net.",

        "domain_ttl": 300,

        "domain_maxhost": 1,

        "domain_closest": true,

        "domain_location_id": 1,

        "record_mode": "standard",

        "records": [

            {

                "record_id": 6,

                "host_fqdn": "www.test.zohodns.net.",

                "weight": 10,

                "active": true,

                "backup": false,

                "monitor_id": null,

                "monitor_status": 1,

                "disabled":false,

                "domain_id": 6

            }

        ] } ]

 

 

 


PUT Update:

Update an existing ALIAS record in the specified domain

 

Headers

Form Data

Example Response

 

Content-Type   application/json

authorization  Bearer{{access_token}}

 

config: [

    {

        "alias_domain_id": 6,

        "zone_id": 4,

        "domain_name": "test.zohodns.net.",

        "domain_ttl": 300,

        "domain_maxhost": 1,

        "domain_closest": true,

        "domain_location_id": 1,

        "record_mode": "standard",

        "records": [

            {

                "record_id": 6,

               "host_fqdn": "www.test.zohodns.net.",

                "weight": 10,

                "active": true,

                "backup": false,

                "monitor_id": null,

                "monitor_status": 1,

                "disabled":false,

                "domain_id": 6

            }

        ]

    }

]

 

{"message" : "Record updated successfully"}


DEL Delete:

 Deletes an existing ALIAS record in the specified domain

 

Headers

Example Response

 

Content-Type                 application/json

authorization Bearer {{access_token}}

 

 

{"message" : "Record deleted successfully"}

 



MX

GET All:

  Returns a list of all MX records in the specified domain 

Headers

Example Response

 

Content-Type     application/json

authorization   Bearer {{access_token}}

 

[

   {

      "mx_domain_id":6,

      "zone_id":4,

      "domain_name":"mxtest.zohocal.eu.",

      "domain_ttl":300,

      "domain_location_id":1,

      "records":[

         {

            "record_id":1,

            "host_fqdn":"testing.zohodns.net.",

            "weight":10,

            "preference":1,

                "disabled":false,

            "domain_id":6

         }

      ]

   },

   {

      "mx_domain_id":13,

      "zone_id":4,

      "domain_name":"@.zohocal.eu.",

      "domain_ttl":300,

      "domain_maxhost":1,

      "domain_location_id":1,

      "records":[

         {

            "record_id":1,

            "host_fqdn":"testing.zohodns.net.",

            "weight":10,

            "preference":1,,

                "disabled":false,

            "domain_id":6

         }

      ]

   }]

 

 

POST Create:

Creates one or more new MX record(s) in a specified domain

 

Headers

Form Data

Example Response

 

Content-Type     application/json

authorization Bearer {{access_token}}

 

 

config: [

   {

      "zone_id":4,

      "domain_name":"mxtest.zohocal.eu.",

      "domain_ttl":300,

      "domain_location_id":1,

      "records":[

         {

            "host_fqdn":"testing.zohodns.net.",

            "weight":10,

            "preference":1

         }

      ]

   }

]

 

{"message" : "Record created successfully"}



GET Specific:


  Returns a specified MX record in the specified domain


Headers

Example Response

 

Content-Type                     application/json

authorization Bearer {{access_token}}

 

[

   {

      "mx_domain_id":6,

      "zone_id":4,

      "domain_name":"mxtest.zohocal.eu.",

      "domain_ttl":300,

      "domain_location_id":1,

      "records":[

         {

            "record_id":1,

            "host_fqdn":"testing.zohodns.net.",

            "weight":10,

            "preference":1,

                "disabled":false,

            "domain_id":6

         }

      ]

   }

]

 

 

 


PUT Update:

 Update an existing MX record in the specified domain

 

Headers

Form Data

Example Response

 

Content-Type   application/json

authorization  Bearer {{access_token}}

 

config: [

   {

      "mx_domain_id":6,

      "zone_id":4,

      "domain_name":"mxtest.zohocal.eu.",

      "domain_ttl":300,

      "domain_location_id":1,

      "records":[

         {

            "record_id":1,

            "host_fqdn":"testing.zohodns.net.",

            "weight":10,

            "preference":1,,

                "disabled":false,

            "domain_id":6

         }

      ]

   }

]

 

 

{"message" : "Record updated successfully"}



DEL Delete:

 Deletes an existing MX record in the specified domain

 

Headers

Example Response

 

Content-Type                 application/json

authorization Bearer {{access_token}}

 

 

{"message" : "Record deleted successfully"}

 

NS

GET All:

Returns a list of all NS records in the specified domain

Headers

Example Response

 

Content-Type     application/json

authorization   Bearer {{access_token}}

 

[

   {

      "ns_domain_id":6,

      "zone_id":4,

      "domain_name":"nstest.zohocal.eu.",

      "domain_ttl":300,

      "domain_location_id":1,

      "records":[

         {

            "record_id":1,

            "host_fqdn":"testing.zohodns.net.",

                "disabled":false,

 

            "domain_id":6

         }

      ]

   },

   {

      "ns_domain_id":13,

      "zone_id":4,

      "domain_name":"ns2.zohocal.eu.",

      "domain_ttl":300,

      "domain_maxhost":1,

      "domain_closest":true,

      "domain_location_id":8,

      "record_mode":"standard",

      "records":[

         {

            "record_id":1,

            "host_fqdn":"testing.zohodns.net.",

                "disabled":false,

            "domain_id":6

         }

      ]

   }

]

 


POST Create:

Creates one or more new NS record(s) in a specified domain

 

Headers

Form Data

Example Response

 

Content-Type     application/json

authorization Bearer {{access_token}}

 

 

config: [

   {

      "zone_id":4,

      "domain_name":"nstest.zohocal.eu.",

      "domain_ttl":300,

      "domain_location_id":1,

      "records":[

         {

         "host_fqdn":"testing.zohodns.net."         }

      ]

   }

]

 

{"message" : "Record created successfully"}



GET Specific:

 Returns a specified NS record in the specified domain

  

Headers

Example Response

 

Content-Type                     application/json

authorization Bearer {{access_token}}

 

[

   {

      "ns_domain_id":6,

      "zone_id":4,

      "domain_name":"nstest.zohocal.eu.",

      "domain_ttl":300,

      "domain_location_id":1,

      "records":[

         {

            "record_id":1,

            "host_fqdn":"testing.zohodns.net.",

                "disabled":false,

            "domain_id":6

         }

      ]

   }

]

 

 

 


PUT Update:

Update an existing NS record in the specified domain

 

Headers

Form Data

Example Response

 

Content-Type   application/json

authorization  Bearer {{access_token}}

 

config: [

   {

      "ns_domain_id":6,

      "zone_id":4,

      "domain_name":"nstest.zohocal.eu.",

      "domain_ttl":300,

      "domain_location_id":1,

      "records":[

         {

            "record_id":1,

            "host_fqdn":"testing.zohodns.net.",

                "disabled":false,

            "domain_id":6

         }

   }

]

 

 

{"message" : "Record updated successfully"}


DEL Delete:

Deletes an existing NS record in the specified domain

 

Headers

Example Response

 

Content-Type                 application/json

authorization Bearer {{access_token}}

 

 

{"message" : "Record deleted successfully"}

 

      



DS

GET All:

Returns a list of all DS records in the specified domain

Headers

Example Response

 

Content-Type     application/json

authorization   Bearer {{access_token}}

 

[

   {

      "ds_domain_id":6,

      "zone_id":4,

      "domain_name":"dstest.zohocal.eu.",

      "domain_ttl":300,

      "domain_location_id":1,

      "records":[

         {

            "record_id":1,

            "keyTag": 22,

               "algorithm": 2,

               "digestType": 1,

               "digest": "WESDEERRRRRSTYUJH",

                "disabled":false,

            "domain_id":6

         }

      ]

   },

   {

      "ds_domain_id":13,

      "zone_id":4,

      "domain_name":"ds2.zohocal.eu.",

      "domain_ttl":300,

      "domain_maxhost":1,

     

      "domain_location_id":1,

     

      "records":[

         {

               "record_id":1,

               "keyTag": 22,

               "algorithm": 2,

               "digestType": 1,

               "digest": "WESDEERRRRR3455QAAA",

                "disabled":false,

            "domain_id":6

         }

      ]

   }

]

 


POST Create:

Creates one or more new DS record(s) in a specified domain

Headers

Form Data

Example Response

 

Content-Type     application/json

authorization Bearer {{access_token}}

 

 

config: [

   {

      "zone_id":4,

      "domain_name":"dstest.zohocal.eu.",

      "domain_ttl":300,

      "domain_location_id":1,

      "records":[

         {

              "keyTag": 22,

               "algorithm": 2,

               "digestType": 1,

               "digest": "WESDEERRRRR3455QAAA"

         }

      ]

   }

]

 

{"message" : "Record created successfully"}


GET Specific:

 Returns a specified DS record in the specified domain

Headers

Example Response

 

Content-Type                     application/json

authorization Bearer {{access_token}}

 

[

   {

      "ds_domain_id":6,

      "zone_id":4,

      "domain_name":"dstest.zohocal.eu.",

      "domain_ttl":300,

      "domain_location_id":1,

      "records":[

         {

            "record_id":1,

           "keyTag": 22,

               "algorithm": 2,

               "digestType": 1,

               "digest": "WESDEERRRRR3455QAAA",

                "disabled":false,

            "domain_id":6

         }

      ]

   }

]

 

 

 


PUT Update:

Update an existing DS record in the specified domain

 

Headers

Form Data

Example Response

 

Content-Type   application/json

authorization  Bearer {{access_token}}

 

config: [

   {

      "ds_domain_id":6,

      "zone_id":4,

      "domain_name":"dstest.zohocal.eu.",

      "domain_ttl":300,

      "domain_location_id":1,

      "records":[

         {

            "record_id":1,

             "keyTag": 22,

               "algorithm": 2,

               "digestType": 1,

               "digest": "WESDEERRRRR3455QAAA",

                "disabled":false,

            "domain_id":6

         }

      ]

   }

]

 

 

{"message" : "Record updated successfully"}


DEL Delete:


Deletes an existing DS record in the specified domain

 

Headers

Example Response

 

Content-Type                 application/json

authorization Bearer {{access_token}}

 

 

{"message" : "Record deleted successfully"}

 

SPF/TXT

GET All:

Returns a list of all SPF/TXT records in the specified domain


Headers

Example Response

 

Content-Type     application/json

authorization   Bearer {{access_token}}

 

[

   {

      "spf_txt_domain_id":6,

      "zone_id":4,

      "domain_name":"spftest.zohocal.eu.",

      "domain_ttl":300,

      "domain_location_id":1,

      "record_type": "SPF",

       "records":[

         {

            "record_id":1,

             "value": ["necwcltpwxbz-noelget3jush-vop2xxvapot3eyq_0"],

                "disabled":false,

              "domain_id":6

         }

      ]

   },

   {

      "spf_txt_domain_id":13,

      "zone_id":4,

      "domain_name":"txt.zohocal.eu.",

      "domain_ttl":300,

      "domain_maxhost":1,

      "domain_location_id":1,

     "record_type": "TXT",

       "records":[

         {

            "record_id":1,

               "value": "["v=spf1include:transmail.netinclude:zoho.com~all",

"c-68e3oc4trm8w7piplscg7vgojmtkjrnrabr4king8"],

                "disabled":false,

              "domain_id":13,

         }

      ]

   }

]

 


POST Create:

Creates one or more new SPF/TXT record(s) in a specified domain

 

Headers

Form Data

Example Response

 

Content-Type     application/json

authorization Bearer {{access_token}}

 














For adding multiple strings with maximum 255 characters

 

config: [

   {

      "zone_id":4,

      "domain_name":"spftest.zohocal.eu.",

      "domain_ttl":300,

      "domain_location_id":1,

      "record_type": "SPF",

       "records":[

         {

             "value": ["necwcltpwxbz-noelget3jush-vop2xxvapot3eyq_0"]

            

         }

      ]

   }

]


 
config: [
    {
        "spf_txt_domain_id": 256,
        "zone_id": 348,
        "domain_name": "1testapi.3contactzone.com.",
        "domain_ttl": 300,
        "record_type": "SPF",
        "domain_location_id": 1,
        "records": [
            {
                "record_id": 485,
                "value": [
                    [
                        "v=spf1 include:spf1.test.com include:test.com include:zcsend.net ip4:12.13.12.11/32 ip4:12.42.32.62/32 ip4:63.3.3.3/32 ip4:4.4.4.4/32 ip4:5.5.5.5/32 ip4:6.6.6.6/32 ip4:7.7.7.7/32 ip4:8.8.8.8/32 ip4:9.9.9.9/3",
                        "dataset"
                    ]
                ],
                "disabled": false,
                "domain_id": 256
            }
        ]
    }
]

















{"message" : "Record created successfully"}















{"message" : "Record created successfully"}

GET Specific:

  Returns a specified SPF/TXT record in the specified domain


Headers

Example Response

 

Content-Type                     application/json

authorization Bearer {{access_token}}

 

[

   {

      "spf_txt_domain_id":6,

      "zone_id":4,

      "domain_name":"spftest.zohocal.eu.",

      "domain_ttl":300,

      "domain_location_id":1,

     "record_type": "SPF",

       "records":[

         {

            "record_id":1,

             "value": ["necwcltpwxbz-noelget3jush-vop2xxvapot3eyq_0"],

                "disabled":false,

              "domain_id":6

         }

      ]

 

   }

]

 

 


 



PUT Update:

Update an existing SPF/TXT record in the specified domain

 

Headers

Form Data

Example Response

 

Content-Type   application/json

authorization  Bearer {{access_token}}

 

config: [

   {

      "spf_txt_domain_id":6,

      "zone_id":4,

      "domain_name":"spftest.zohocal.eu.",

      "domain_ttl":300,

      "domain_location_id":1,

   "record_type": "SPF",

       "records":[

         {

            "record_id":1,

             "value": ["necwcltpwxbz-noelget3jush-vop2xxvapot3eyq_0"],

                "disabled":false,

              "domain_id":6

         }

      ]

   }

]

 

 

{"message" : "Record updated successfully"}


For adding multiple strings with a maximum of 255 characters, refer to the POST Create call above.

DEL Delete:

Deletes an existing SPF/TXT record in the specified domain


Headers

Example Response

Content-Type                 application/json

authorization Bearer {{access_token}}

 

 

{"message" : "Record deleted successfully"}

 


SRV

GET All:

Returns a list of all SRV records in the specified domain

Headers

Example Response

 

Content-Type     application/json

authorization   Bearer {{access_token}}

 

[

   {

      "srv_domain_id":6,

      "zone_id":4,

      "domain_name":"srvtest.zohocal.eu.",

      "domain_ttl":300,

      "domain_location_id":1,

      "records":[

         {

            "record_id":1,

              "port": 443,

             "srv_weight": 10,

             "priority": 1,

             "target": "www.sample.com.",

                "disabled":false,

 

            "domain_id":6

         }

      ]

   },

   {

      "srv_domain_id":13,

      "zone_id":4,

      "domain_name":"srv2.zohocal.eu.",

      "domain_ttl":300,

      "domain_maxhost":1,

     

      "domain_location_id":1,

     

      "records":[

         {

               "record_id":1,

               "port": 443,

             "srv_weight": 10,

             "priority": 1,

             "target": "www.eg.com.",

                "disabled":false,

 

            "domain_id":6

         }

      ]

   }

]

 

POST Create:

 Creates one or more new SRV record(s) in a specified domain

Headers

Form Data

Example Response

 

Content-Type     application/json

authorization Bearer {{access_token}}

 

 

config: [

   {

      "zone_id":4,

      "domain_name":"srvtest.zohocal.eu.",

      "domain_ttl":300,

      "domain_location_id":1,

      "records":[

         {

            "port": 443,

             "srv_weight": 10,

             "priority": 1,

             "target": "www.sample.com."

 

         }

      ]

   }

]

 

{"message" : "Record created successfully"}


GET Specific:


 Returns a specified SRV record in the specified domain

  

Headers

Example Response

 

Content-Type                     application/json

authorization Bearer {{access_token}}

 

[

   {

      "srv_domain_id":6,

      "zone_id":4,

      "domain_name":"srvtest.zohocal.eu.",

      "domain_ttl":300,

      "domain_location_id":1,

      "records":[

         {

            "record_id":1,

           "port": 443,

             "srv_weight": 10,

             "priority": 1,

             "target": "www.sample.com.",

                "disabled":false,

            "domain_id":6

         }

      ]

   }

]

 

 

 

 PUT Update:

Update an existing SRV record in the specified domain

 

Headers

Form Data

Example Response

 

Content-Type   application/json

authorization  Bearer {{access_token}}

 

config: [

   {

      "srv_domain_id":6,

      "zone_id":4,

      "domain_name":"srvtest.zohocal.eu.",

      "domain_ttl":300,

      "domain_location_id":1,

      "records":[

         {

            "record_id":1,

            "port": 443,

             "srv_weight": 10,

             "priority": 1,

             "target": "www.sample.com.",

 

                "disabled":false,

             "domain_id":6

         }

      ]

   }

]

 

 

{"message" : "Record updated successfully"}


DEL Delete:

Deletes an existing SRV record in the specified domain  

Headers

Example Response

 

Content-Type                 application/json

authorization Bearer {{access_token}}

 

 

{"message" : "Record deleted successfully"}

 



TLSA

GET All:


                           Headers

                  Formdata

Content-Type                     application/json

authorization Bearer {{access_token}}

 

[

{

        "tlsa_domain_id": 6,

        "zone_id": 241,

        "domain_name": "yes.brigh10.com.",

        "domain_ttl": 200,

        "domain_location_id": 1,

        "records": [

            {

                "record_id": 19,

                "usage": 3,

                "selector": 0,

                "matching_type": 0,

                "certificate": "C20F63322348FF8BE88D7F55750FFDD4E3D3DC2586BA121B67D6E257B94C3DC0",

                "domain_id": 6,

                "disabled": false

            },

            {

                "record_id": 18,

                "usage": 2,

                "selector": 0,

                "matching_type": 0,

                "certificate": "C20F63322348FF8BE88D7F55750FFDD4E3D3DC2586BA121B67D6E257B94C3DC0",

                "domain_id": 6,

                "disabled": false

            },

            {

                "record_id": 17,

                "usage": 1,

                "selector": 0,

                "matching_type": 0,

                "certificate": "C20F63322348FF8BE88D7F55750FFDD4E3D3DC2586BA121B67D6E257B94C3DC0",

                "domain_id": 6,

                "disabled": false

            },

            {

                "record_id": 16,

                "usage": 0,

                "selector": 0,

                "matching_type": 0,

                "certificate": "abcdef123",

                "domain_id": 6,

                "disabled": false

            }

        ]

]

 

POST Create:

 

                Headers

             Formdata

      Example Response

Content-Type     application/json

authorization Bearer {{access_token}}

 

config: [

    {

        "zone_id": 241,

        "domain_name": "north.brigh10.com.",

        "domain_ttl": 1800,

        "domain_location_id": 1,

        "records": [

            {

                "record_id": 20,

                "usage": 0,

                "selector": 0,

                "matching_type": 0,

                "certificate": "C20F63322348FF8BE88D7F55750FFDD4E3D3DC2586BA121B67D6E257B94C3DC0",

                "disabled": false

            }

 

    ]

}

]

 

{

    "message": "Record Created Successfully."

}

 

 

 

GET Specific:


 

 

        Headers

                 Formdata

 

Content-Type                     application/json

authorization Bearer {{access_token}}

 

 

[

    {

        "tlsa_domain_id": 8,

        "zone_id": 241,

        "domain_name": "north.brigh10.com.",

        "domain_ttl": 1800,

        "domain_location_id": 1,

        "records": [

            {

                "record_id": 26,

                "usage": 0,

                "selector": 0,

                "matching_type": 0,

                "certificate": "C20F63322348FF8BE88D7F55750FFDD4E3D3DC2586BA121B67D6E257B94C3DC0",

                "domain_id": 8,

                "disabled": false

            }

        ]

    }

]

 

 

 

PUT Update:


  

          Headers

               Formdata

         Example Response

Content-Type     application/json

authorization Bearer {{access_token}}

 

config: [

    {

        "zone_id": 241,

        "domain_name": "north.brigh10.com.",

        "domain_ttl": 1800,

        "domain_location_id": 1,

        "records": [

            {

                "record_id": 20,

                "usage": 0,

                "selector": 0,

                "matching_type": 0,

                "certificate": "C20F63322348FF8BE88D7F55750FFDD4E3D3DC2586BA121B67D6E257B94C3DC0",

                "disabled": false

            }

 

    ]

}

]

{

    "message": "Record Updated Successfully."

}

 

DEL Delete:


 

           Headers

                             Example Response

Content-Type                     application/json

authorization Bearer {{access_token}}

 

{

    "message": "Record Deleted Successfully."

}


CAA

GET All:

Returns a list of all CAA records in the specified domain


Headers

Example Response

 

Content-Type     application/json

authorization   Bearer {{access_token}}

 

[

   {

      "caa_domain_id":6,

      "zone_id":4,

      "domain_name":"caatest.zohocal.eu.",

      "domain_ttl":300,

      "domain_location_id":1,

      "records":[

         {

            "record_id":1,

            "flag": 1,

              "tag": "issue",

              "value": "www.sample.com.",

                "disabled":false,

 

            "domain_id":6

         }

      ]

   },

   {

      "caa_domain_id":13,

      "zone_id":4,

      "domain_name":"caa2.zohocal.eu.",

      "domain_ttl":300,

      "domain_maxhost":1,

     

      "domain_location_id":1,

     

      "records":[

         {

               "record_id":1,

             "flag": 0,

              "tag": "issue",

              "value": "www.eg.com.",

                "disabled":false,

 

 

            "domain_id":6

         }

      ]

   }

]

 


POST Create:

Creates one or more new CAA record(s) in a specified domain

 

Headers

Form Data

Example Response

 

Content-Type     application/json

authorization Bearer {{access_token}}

 

 

config: [

   {

      "zone_id":4,

      "domain_name":"caatest.zohocal.eu.",

      "domain_ttl":300,

      "domain_location_id":1,

      "records":[

         {

            "flag": 1,

              "tag": "issue",

              "value": "www.sample.com."

 

 

         }

      ]

   }

]

 

{"message" : "Record created successfully"}


GET Specific:

 Returns a specified CAA record in the specified domain

  

Headers

Example Response

 

Content-Type                     application/json

authorization Bearer {{access_token}}

 

[

   {

      "caa_domain_id":6,

      "zone_id":4,

      "domain_name":"caatest.zohocal.eu.",

      "domain_ttl":300,

      "domain_location_id":1,

      "records":[

         {

            "record_id":1,

           "flag": 1,

              "tag": "issue",

              "value": "www.sample.com.",

                "disabled":false,

            "domain_id":6

         }

      ]

   }

]

 

 

 


PUT Update:

Update an existing SRV record in the specified domain

 

Headers

Form Data

Example Response

 

Content-Type   application/json

authorization  Bearer {{access_token}}

 

config: [

   {

      "caa_domain_id":6,

      "zone_id":4,

      "domain_name":"caatest.zohocal.eu.",

      "domain_ttl":300,

      "domain_location_id":1,

      "records":[

         {

            "record_id":1,

              "flag": 1,

              "tag": "issue",

              "value": "www.sample.com.",

                "disabled":false,

             "domain_id":6

         }

      ]

   }

]

 

 

{"message" : "Record updated successfully"}

 DEL Delete:

Deletes an existing CAA record in the specified domain


Headers

Example Response

 

Content-Type                 application/json

authorization Bearer {{access_token}}

 

 

{"message" : "Record deleted successfully"}

 

PTR

GET All:

Returns a list of all PTR records in the specified domain

Headers

Example Response

 

Content-Type     application/json

authorization   Bearer {{access_token}}

 

[

   {

      "ptr_domain_id":6,

      "zone_id":4,

      "domain_name":"ptrtest.zohocal.eu.",

      "domain_ttl":300,

      "domain_location_id":1,

      "records":[

         {

         "record_id":1,

              "name": "www.sample.com.",

                "disabled":false,

             "domain_id":6

 

         }

      ]

   },

   {

      "ptr_domain_id":13,

      "zone_id":4,

      "domain_name":"ptr2.zohocal.eu.",

      "domain_ttl":300,

      "domain_maxhost":1,

     

      "domain_location_id":1,

     

      "records":[

         {

              "record_id":1,

              "name": "www.eg.com.",

                "disabled":false,

             "domain_id":13

         }

      ]

   }

]

 

  

POST Create:

https://clouddns.manageengine.com/v1/dns/domain/4/records/PTR

Creates one or more new PTR record(s) in a specified domain


Headers

Form Data

Example Response

 

Content-Type     application/json

authorization Bearer {{access_token}}

 

 

config: [

   {

      "zone_id":4,

      "domain_name":"ptrtest.zohocal.eu.",

      "domain_ttl":300,

      "domain_location_id":1,

      "records":[

         {

      

        "name":"www.sample.com."

    

   }

      ]

   }

]

 

{"message" : "Record created successfully"}

GET Specific:

Returns a specified PTR record in the specified domain

  

Headers

Example Response

 

Content-Type                     application/json

authorization Bearer {{access_token}}

 

[

   {

      "ptr_domain_id":6,

      "zone_id":4,

      "domain_name":"ptrtest.zohocal.eu.",

      "domain_ttl":300,

      "domain_location_id":1,

      "records":[

         {

          "record_id":1,

              "name": "www.sample.com.",

                "disabled":false,

             "domain_id":6

 

         }

      ]

   }

]

 

 

 

  

PUT Update: 

https://clouddns.manageengine.com/v1/dns/domain/4/records/PTR/6/

Update an existing PTR record in the specified domain

 

Headers

Form Data

Example Response

 

Content-Type   application/json

authorization  Bearer {{access_token}}

 

config: [

   {

      "ptr_domain_id":6,

      "zone_id":4,

      "domain_name":"ptrtest.zohocal.eu.",

      "domain_ttl":300,

      "domain_location_id":1,

      "records":[

         {

            "record_id":1,

              "name": "www.sample.com.",

                "disabled":false,

             "domain_id":6

         }

      ]

   }

]

 

 

{"message" : "Record updated successfully"}

 DEL Delete:

https://clouddns.manageengine.com/v1/dns/domain/4/records/PTR/6/

Deletes an existing PTR record in the specified domain

 

Headers

Example Response

 

Content-Type                 application/json

authorization Bearer {{access_token}}

 

 

{"message" : "Record deleted successfully"}

 

 


TSIG template

 

GET All:

 

 

Headers

Example Response

 

Content-Type     application/json

authorization Bearer {{access_token}}

 

[

    {

        "tsig_id": 1,

        "key_name": "test",

        "algorithm": "HMAC-SHA256",

        "secret_key": "ZRIvFMibTlb2r4F7QeBz0oOQAn+Jldyq5MW9fvYGvbg=",

        "zone_associated": []

    },

    {

        "tsig_id": 3,

        "key_name": "test_key",

        "algorithm": "HMAC-SHA256",

        "secret_key": "gYdATewY3wy0moBFrAw0jeNjWqdOCiPOQInPB+elkAM=",

        "zone_associated": []

    }

]

 

 

 

 

 

POST Create:

 

Headers

Form Data

Example Response

 

Content-Type     application/json

authorization Bearer {{access_token}}

 

 

config:
   {

        "key_name": "test",

        "algorithm": "HMAC-SHA256",

        "secret_key": "ZRIvFMibTlb2r4F7QeBz0oOQAn+Jldyq5MW9fvYGvbg="

       

    }

 

 

{

        "tsig_id": 1,

        "key_name": "test",

        "algorithm": "HMAC-SHA256",

        "secret_key": "ZRIvFMibTlb2r4F7QeBz0oOQAn+Jldyq5MW9fvYGvbg="

 

    }

 

 

 


GET Specific:

 

 

Headers

Example Response

 

Content-Type     application/json

authorization Bearer {{access_token}}

 

 

    {

        "tsig_id": 1,

        "key_name": "test",

        "algorithm": "HMAC-SHA256",

        "secret_key": "ZRIvFMibTlb2r4F7QeBz0oOQAn+Jldyq5MW9fvYGvbg=",

        "zone_associated": []

    }

 

 

 

 


PUT Update: 



 Keyname cannot be updated.

Headers

Form Data

Example Response

 

Content-Type     application/json

authorization Bearer {{access_token}}

 

 

config:
   {

         "tsig_id": 1,

        "key_name": "test",

        "algorithm": "HMAC-SHA256",

        "secret_key": "ZRIvFMibTlb2r4F7QeBz0oOQAn+Jldyq5ML9fvYGvbg="

       

    }

 

 

{

        "key_name": "test",

        "algorithm": "HMAC-SHA256",

        "secret_key": "ZRIvFMibTlb2r4F7QeBz0oOQAn+Jldyq5ML9fvYGvbg="

 

    }

 

 

 

 

DEL Delete:


 

Headers

Example Response

 

Content-Type                     application/json

authorization Bearer {{access_token}}

 

 

{"message" : "deleted successfully"}

 

 

  

 

Configuring AXFR :

GET All:

 

Headers

Example Response

 

Content-Type     application/json

authorization Bearer {{access_token}}

 

[

     {

        "id": 16,

        "zone_name": "sec.com.",

        "primary_servers": "14.5.4.5"

    },

    {

        "id": 19,

        "zone_name": "sec.com.",

        "primary_servers": "14.1.4.5,9.44.3.2"

    }

]

 

 

 

 

 

POST Create:

 

Configuring AXFR with TSIG for a secondary zone:

 

Headers

Form Data

Example Response

 

Content-Type     application/json

authorization Bearer {{access_token}}

 

 

config:
    {

"zone_name":"sec.com.",

"tsig_keyname": "test",

"primary_servers":"41.5.4.5,11.2.2.2"  

}

 

 

 

{

        "id": 1,

        "tsig_keyname": "test",

        "zone_name": "sec.com.",

"zone_id":12,

        "primary_servers": "41.5.4.5,11.2.2.2"

    }

 

 

Configuring AXFR without TSIG for a secondary zone: 


 

Headers

Form Data

Example Response

 

Content-Type     application/json

authorization Bearer {{access_token}}

 

 

config:
    {

"zone_name":"sec.com.",

"primary_servers":"41.5.4.5,11.2.2.2"  

}

 

 

 

{

        "id": 1,

        "zone_name": "sec.com.",

"zone_id":12,

        "primary_servers": "41.5.4.5,11.2.2.2"

    }

 

 

 

 GET Specific:


 

Headers

Example Response

 

Content-Type     application/json

authorization Bearer {{access_token}}

 

 

     {

        "id": 16,

        "zone_name": "sec.com.",

        "primary_servers": "14.5.4.5"

    }

 

 

 

 

 

 

PUT Update: 

 

 

 

Configuring AXFR with TSIG for a secondary zone:


 

Headers

Form Data

Example Response

 

Content-Type     application/json

authorization Bearer {{access_token}}