Skip to content

Manage DNS CNAME Records with KopiCloud AD API»

KopiCloud_AD_API

Manage Microsoft DNS CNAME Records using the KopiCloud AD API.

Get DNS CNAME Record that match with DNS HostName and Alias»

GET /api/DnsCNameRecord

Parameters

Name Type Description Mandatory
DNS_HostName string DNS Host Name Yes
DNS_HostName_Alias string DNS Host Name Alias Yes
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
12
{
  "output": "string",
  "result": [
    {
      "name": "string",
      "type": "string",
      "data": "string",
      "zone": "string",
      "timestamp": "string"
    }
  ]
}

List All DNS CNAME Records in a DNS Zone»

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
12
{
  "output": "string",
  "result": [
    {
      "name": "string",
      "type": "string",
      "data": "string",
      "zone": "string",
      "timestamp": "string"
    }
  ]
}

List All DNS CNAME Records in All Zones»

GET /api/DnsCNameRecord/All

Parameters

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

Return Schema 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
{
  "output": "string",
  "result": [
    {
      "name": "string",
      "type": "string",
      "data": "string",
      "zone": "string",
      "timestamp": "string"
    }
  ]
}

List All DNS CNAME Records that match with DNS Hostname»

GET /api/DnsCNameRecord/HostName/{DNS_HostName}

Parameters

Name Type Description Mandatory
DNS_HostName string DNS Host Name Yes
Auth-Token string Bearer or Basic Authentication Token Yes

Return Schema

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
{
  "output": "string",
  "result": [
    {
      "name": "string",
      "type": "string",
      "data": "string",
      "zone": "string",
      "timestamp": "string"
    }
  ]
}

List All DNS CNAME Records that match with DNS HostName Alias»

GET /api/DnsCNameRecord/HostNameAlias/{DNS_HostName_Alias}

Parameters

Name Type Description Mandatory
DNS_HostName_Alias string DNS Host Name Alias Yes
Auth-Token string Bearer or Basic Authentication Token Yes

Return Schema

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
{
  "output": "string",
  "result": [
    {
      "name": "string",
      "type": "string",
      "data": "string",
      "zone": "string",
      "timestamp": "string"
    }
  ]
}

Create a DNS CNAME Record»

POST /api/DnsCNameRecord

Parameters

Name Type Description Mandatory
DNS_HostName string DNS Host Name Yes
DNS_HostName_Alias string DNS Host Name Alias Yes
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
12
{
  "output": "string",
  "result": [
    {
      "name": "string",
      "type": "string",
      "data": "string",
      "zone": "string",
      "timestamp": "string"
    }
  ]
}

Delete a DNS CNAME Record»

DELETE /api/DnsCNameRecord

Parameters

Name Type Description Mandatory
DNS_HostName string DNS Host Name Yes
DNS_HostName_Alias string DNS Host Name Alias Yes
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
12
{
  "output": "string",
  "result": [
    {
      "name": "string",
      "type": "string",
      "data": "string",
      "zone": "string",
      "timestamp": "string"
    }
  ]
}