Skip to content

Commit 677f598

Browse files
committed
add documentation for CAA domain record support
1 parent 9fd439c commit 677f598

File tree

2 files changed

+19
-4
lines changed

2 files changed

+19
-4
lines changed

docs/src/data/endpoints/domains.yaml

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -205,8 +205,8 @@ endpoints:
205205
optional: true
206206
description: >
207207
When Type=MX the hostname. When Type=CNAME the target of the
208-
alias. When Type=TXT the value of the record. When Type=A or
209-
AAAA the token of '[remote_addr]' will be substituted with the
208+
alias. When Type=TXT or CAA the value of the record. When Type=A
209+
or AAAA the token of '[remote_addr]' will be substituted with the
210210
IP address of the request.
211211
type: String
212212
priority:
@@ -235,6 +235,12 @@ endpoints:
235235
description: >
236236
The protocol to append to an SRV record.
237237
type: String
238+
tag:
239+
optional: true
240+
description: >
241+
The tag attribute for a CAA record. One of issue, issuewild,
242+
iodef. Ignored on other record types.
243+
type: String
238244
ttl:
239245
optional: true
240246
description: >

docs/src/data/objects/domainrecord.yaml

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ schema:
1212
type: String
1313
value: A
1414
description: >
15-
Type of record (A/AAAA, NS, MX, CNAME, TXT, SRV).
15+
Type of record (A/AAAA, NS, MX, CNAME, TXT, SRV or CAA).
1616
name:
1717
type: String
1818
value: sub.example.com
@@ -31,7 +31,7 @@ schema:
3131
filterable: true
3232
description: >
3333
When type=MX the hostname. When type=CNAME the target of the alias.
34-
When type=TXT the value of the record.
34+
When type=TXT or CAA the value of the record.
3535
When type=A or AAAA the token of '[remote_addr]' will be substituted
3636
with the IP address of the request.
3737
priority:
@@ -70,6 +70,14 @@ schema:
7070
optional: true
7171
description: >
7272
The protocol to append to an SRV record. Must conform to RFC2782 standards.
73+
tag:
74+
type: String
75+
value: issue
76+
editable: true
77+
optional: true
78+
description: >
79+
The tag attribute for a CAA record. One of issue, issuewild, iodef.
80+
Ignored on other record types.
7381
ttl_sec:
7482
type: Integer
7583
value: 86400
@@ -88,3 +96,4 @@ enums:
8896
CNAME: Canonical Name Record
8997
TXT: Text Record
9098
SRV: Service Record
99+
CAA: Certification Authority Authorization Record

0 commit comments

Comments
 (0)