Skip to content

Manage DNS Zones with KopiCloud AD API»

KopiCloud_AD_API

Manage Microsoft DNS Zones using the KopiCloud AD API.

Get DNS Zone by Zone Name»

GET /api/DnsCNameRecord/{ZoneName}

Parameters

Name Type Description Mandatory
ZoneName string DNS Zone Name Yes
Auth-Token string Bearer or Basic Authentication Token Yes

Return Schema 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
{
  "output": "string",
  "result": [
    {
      "distinguishedName": "string",
      "zoneName": "string",
      "zoneType": "string",
      "type": "string"
    }
  ]
}

Check If DNS Zone Exists»

GET /api/DnsZones/{ZoneName}/Exists

Parameters

Name Type Description Mandatory
ZoneName string DNS Zone Name Yes
Auth-Token string Bearer or Basic Authentication Token Yes

Return Schema

1
2
3
4
{
  "output": "string",
  "result": true
}

List All DNS Zones»

GET /api/DnsZones/All

Parameters

Name Type Description Mandatory
IgnoreSystemZones boolean Ignore System Zones (Default = true) Yes
Auth-Token string Bearer or Basic Authentication Token Yes

Return Schema

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
{
  "output": "string",
  "result": [
    {
      "distinguishedName": "string",
      "zoneName": "string",
      "zoneType": "string",
      "type": "string"
    }
  ]
}