DnsRule.schema.json 1.17 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
{
  "description": "This type represents the general information of a DNS rule.",
  "type": "object",
  "required": [
    "dnsRuleId",
    "domainName",
    "ipAddressType",
    "ipAddress",
    "state"
  ],
  "properties": {
    "dnsRuleId": {
      "description": "Identifies the DNS Rule",
      "type": "string",
      "example": "dnsRule1"
    },
    "domainName": {
      "description": "FQDN resolved by the DNS rule",
      "type": "string",
      "example": "www.example.com"
    },
    "ipAddressType": {
      "description": "IP address type",
      "type": "string",
      "enum": [
        "IP_V6",
        "IP_V4"
      ],
      "example": "IP_V6"
    },
    "ipAddress": {
      "description": "IP address associated with the FQDN resolved by the DNS rule",
      "type": "string",
      "example": "192.0.2.0"
    },
    "ttl": {
      "description": "Time to live value",
      "type": "integer",
      "format": "uint32",
      "example": "?"
    },
    "state": {
      "description": "DNS rule state. This attribute may be updated using HTTP PUT method",
      "type": "string",
      "enum": [
        "ACTIVE",
        "INACTIVE"
      ],
      "example": "ACTIVE"
    }
  }
}