-
Notifications
You must be signed in to change notification settings - Fork 1
/
authoritative-api-swagger.yaml
1081 lines (1042 loc) · 31 KB
/
authoritative-api-swagger.yaml
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
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
swagger: '2.0'
info:
version: "0.0.13"
title: PowerDNS Authoritative HTTP API
license:
name: MIT
host: localhost:8081
basePath: /api/v1
schemes:
- http
consumes:
- application/json
produces:
- application/json
securityDefinitions:
# X-API-Key: abcdef12345
APIKeyHeader:
type: apiKey
in: header
name: X-API-Key
security:
- APIKeyHeader: []
# Overall TODOS:
# TODO: Return types are not consistent across documentation
# We need to look at the code and figure out the default HTTP response
# codes and adjust docs accordingly.
paths:
'/servers':
get:
summary: List all servers
operationId: listServers
tags:
- servers
responses:
'200':
description: An array of servers
schema:
type: array
items:
$ref: '#/definitions/Server'
'/servers/{server_id}':
get:
summary: List a server
operationId: listServer
tags:
- servers
parameters:
- name: server_id
in: path
required: true
description: The id of the server to retrieve
type: string
responses:
'200':
description: An server
schema:
$ref: '#/definitions/Server'
'/servers/{server_id}/zones':
get:
summary: List all Zones in a server
operationId: listZones
tags:
- zones
parameters:
- name: server_id
in: path
required: true
description: The id of the server to retrieve
type: string
responses:
'200':
description: An array of Zones
schema:
type: array
items:
$ref: '#/definitions/Zone'
post:
summary: Creates a new domain, returns the Zone on creation.
operationId: createZone
tags:
- zones
parameters:
- name: server_id
in: path
required: true
description: The id of the server to retrieve
type: string
- name: rrsets
in: query
description: '“true” (default) or “false”, whether to include the “rrsets” in the response Zone object.'
type: boolean
default: true
- name: zone_struct
description: The zone struct to patch with
required: true
in: body
schema:
$ref: '#/definitions/Zone'
responses:
'201':
description: A zone
schema:
$ref: '#/definitions/Zone'
'/servers/{server_id}/zones/{zone_id}':
get:
summary: zone managed by a server
operationId: listZone
tags:
- zones
parameters:
- name: server_id
in: path
required: true
description: The id of the server to retrieve
type: string
- name: zone_id
type: string
in: path
required: true
description: The id of the zone to retrieve
responses:
'200':
description: A Zone
schema:
$ref: '#/definitions/Zone'
delete:
summary: Deletes this zone, all attached metadata and rrsets.
operationId: deleteZone
tags:
- zones
parameters:
- name: server_id
in: path
required: true
description: The id of the server to retrieve
type: string
- name: zone_id
type: string
in: path
required: true
description: The id of the zone to retrieve
responses:
'200':
description: OK
patch:
summary: 'Creates/modifies/deletes RRsets present in the payload and their comments. Returns 204 No Content on success.'
operationId: patchZone
tags:
- zones
parameters:
- name: server_id
in: path
required: true
description: The id of the server to retrieve
type: string
- name: zone_id
type: string
in: path
required: true
- name: zone_struct
description: The zone struct to patch with
required: true
in: body
schema:
$ref: '#/definitions/Zone'
responses:
'204':
description: 'Returns 204 No Content on success.'
put:
summary: Modifies basic zone data (metadata).
description: 'Allowed fields in client body: all except id, url and name. Returns 204 No Content on success.'
operationId: putZone
tags:
- zones
parameters:
- name: server_id
in: path
required: true
description: The id of the server to retrieve
type: string
- name: zone_id
type: string
in: path
required: true
- name: zone_struct
description: The zone struct to patch with
required: true
in: body
schema:
$ref: '#/definitions/Zone'
responses:
'204':
description: 'Returns 204 No Content on success.'
'/servers/{server_id}/zones/{zone_id}/notify':
put:
summary: Send a DNS NOTIFY to all slaves.
description: 'Fails when zone kind is not Master or Slave, or master and slave are disabled in the configuration. Only works for Slave if renotify is on. Clients MUST NOT send a body.'
operationId: notifyZone
tags:
- zones
parameters:
- name: server_id
in: path
required: true
description: The id of the server to retrieve
type: string
- name: zone_id
type: string
in: path
required: true
description: The id of the zone to retrieve
responses:
'200':
description: OK
'/servers/{server_id}/zones/{zone_id}/axfr-retrieve':
put:
summary: Send a DNS NOTIFY to all slaves.
description: 'Fails when zone kind is not Master or Slave, or master and slave are disabled in the configuration. Only works for Slave if renotify is on. Clients MUST NOT send a body.'
operationId: axfrRetrieveZone
tags:
- zones
parameters:
- name: server_id
in: path
required: true
description: The id of the server to retrieve
type: string
- name: zone_id
type: string
in: path
required: true
description: The id of the zone to retrieve
responses:
'200':
description: OK
'/servers/{server_id}/zones/{zone_id}/export':
get:
summary: 'Returns the zone in AXFR format.'
operationId: axfrExportZone
tags:
- zones
parameters:
- name: server_id
in: path
required: true
description: The id of the server to retrieve
type: string
- name: zone_id
type: string
in: path
required: true
description: The id of the zone to retrieve
responses:
'200':
description: OK
schema:
type: string
'/servers/{server_id}/zones/{zone_id}/check':
get:
summary: 'Verify zone contents/configuration.'
operationId: checkZone
tags:
- zones
parameters:
- name: server_id
in: path
required: true
description: The id of the server to retrieve
type: string
- name: zone_id
type: string
in: path
required: true
description: The id of the zone to retrieve
responses:
'200':
description: OK
schema:
type: string
'/servers/{server_id}/zones/{zone_id}/rectify':
put:
summary: 'Rectify the zone data.'
description: 'This does not take into account the API-RECTIFY metadata. Fails on slave zones and zones that do not have DNSSEC.'
operationId: rectifyZone
tags:
- zones
parameters:
- name: server_id
in: path
required: true
description: The id of the server to retrieve
type: string
- name: zone_id
type: string
in: path
required: true
description: The id of the zone to retrieve
responses:
'200':
description: OK
schema:
type: string
'/servers/{server_id}/config':
get:
summary: 'Returns all ConfigSettings for a single server'
operationId: getConfig
tags:
- config
parameters:
- name: server_id
in: path
required: true
description: The id of the server to retrieve
type: string
responses:
'200':
description: List of config values
schema:
type: array
items:
$ref: '#/definitions/ConfigSetting'
'/servers/{server_id}/config/{config_setting_name}':
get:
summary: 'Returns a specific ConfigSetting for a single server'
description: 'NOT IMPLEMENTED'
operationId: getConfigSetting
tags:
- config
parameters:
- name: server_id
in: path
required: true
description: The id of the server to retrieve
type: string
- name: config_setting_name
in: path
required: true
description: The name of the setting to retrieve
type: string
responses:
'200':
description: List of config values
schema:
$ref: '#/definitions/ConfigSetting'
'/servers/{server_id}/statistics':
get:
summary: 'Query statistics.'
description: 'Query PowerDNS internal statistics. Returns a list of BaseStatisticItem derived elements.'
operationId: getStats
tags:
- stats
parameters:
- name: server_id
in: path
required: true
description: The id of the server to retrieve
type: string
responses:
'200':
description: List of Statistic Items
schema:
type: array
items:
type: string
# - $ref: '#/definitions/StatisticItem'
# - $ref: '#/definitions/MapStatisticItem'
# - $ref: '#/definitions/RingStatisticItem'
'/servers/{server_id}/search-log':
get:
summary: 'Query the log, filtered by search_term.'
operationId: searchLog
tags:
- search
parameters:
- name: server_id
in: path
required: true
description: The id of the server to retrieve
type: string
- name: q
in: query
required: true
description: 'The string to search for'
type: string
responses:
'200':
description: Returns a single JSON object with a single array of strings.
schema:
type: array
items:
type: string
'/servers/{server_id}/search-data':
get:
summary: 'Search the data inside PowerDNS'
description: 'Search the data inside PowerDNS for search_term and return at most max_results. This includes zones, records and comments. The * character can be used in search_term as a wildcard character and the ? character can be used as a wildcard for a single character.'
operationId: searchData
tags:
- search
parameters:
- name: server_id
in: path
required: true
description: The id of the server to retrieve
type: string
- name: q
in: query
required: true
description: 'The string to search for'
type: string
- name: max
in: query
required: true
description: 'Maximum number of entries to return'
type: integer
responses:
'200':
description: Returns a JSON array with results
schema:
$ref: '#/definitions/SearchResults'
'/servers/{server_id}/zones/{zone_id}/metadata':
get:
summary: Get all the MetaData associated with the zone.
operationId: listMetadata
tags:
- zonemetadata
parameters:
- name: server_id
in: path
required: true
description: The id of the server to retrieve
type: string
- name: zone_id
type: string
in: path
required: true
description: The id of the zone to retrieve
responses:
'200':
description: List of Metadata objects
schema:
type: array
items:
$ref: '#/definitions/Metadata'
post:
summary: 'Creates a set of metadata entries'
description: 'Creates a set of metadata entries of given kind for the zone. Existing metadata entries for the zone with the same kind are not overwritten.'
operationId: createMetadata
tags:
- zonemetadata
parameters:
- name: server_id
in: path
required: true
description: The id of the server to retrieve
type: string
- name: zone_id
type: string
in: path
required: true
- name: metadata
description: List of metadata to add/create
required: true
in: body
schema:
type: array
items:
$ref: '#/definitions/Metadata'
responses:
'204':
description: OK
'/servers/{server_id}/zones/{zone_id}/metadata/{metadata_kind}':
get:
summary: Get the content of a single kind of domain metadata as a list of MetaData objects.
operationId: getMetadata
tags:
- zonemetadata
parameters:
- name: server_id
in: path
required: true
description: The id of the server to retrieve
type: string
- name: zone_id
type: string
in: path
required: true
description: The id of the zone to retrieve
- name: metadata_kind
type: string
in: path
required: true
description: '???'
responses:
'200':
description: List of Metadata objects
schema:
$ref: '#/definitions/Metadata'
put:
summary: 'Modify the content of a single kind of domain metadata.'
operationId: modifyMetadata
tags:
- zonemetadata
parameters:
- name: server_id
in: path
required: true
description: The id of the server to retrieve
type: string
- name: zone_id
type: string
in: path
required: true
- name: metadata_kind
description: The kind of metadata
required: true
type: string
in: path
- name: metadata
description: metadata to add/create
required: true
in: body
schema:
$ref: '#/definitions/Metadata'
responses:
'204':
description: OK
delete:
summary: 'Delete all items of a single kind of domain metadata.'
operationId: deleteMetadata
tags:
- zonemetadata
parameters:
- name: server_id
in: path
required: true
description: The id of the server to retrieve
type: string
- name: zone_id
type: string
in: path
required: true
description: The id of the zone to retrieve
- name: metadata_kind
type: string
in: path
required: true
description: '???'
responses:
'204':
description: OK
'/servers/{server_id}/zones/{zone_id}/cryptokeys':
get:
summary: 'Get all CryptoKeys for a zone, except the privatekey'
operationId: listCryptokeys
tags:
- zonecryptokey
parameters:
- name: server_id
in: path
required: true
description: The id of the server to retrieve
type: string
- name: zone_id
type: string
in: path
required: true
description: The id of the zone to retrieve
responses:
'200':
description: List of Cryptokey objects
schema:
type: array
items:
$ref: '#/definitions/Cryptokey'
post:
summary: 'Creates a Cryptokey'
description: 'This method adds a new key to a zone. The key can either be generated or imported by supplying the content parameter. if content, bits and algo are null, a key will be generated based on the default-ksk-algorithm and default-ksk-size settings for a KSK and the default-zsk-algorithm and default-zsk-size options for a ZSK.'
operationId: createCryptokey
tags:
- zonecryptokey
parameters:
- name: server_id
in: path
required: true
description: The id of the server to retrieve
type: string
- name: zone_id
type: string
in: path
required: true
- name: cryptokey
description: Add a Cryptokey
required: true
in: body
schema:
$ref: '#/definitions/Cryptokey'
responses:
'201':
description: Created
schema:
$ref: '#/definitions/Cryptokey'
'/servers/{server_id}/zones/{zone_id}/cryptokeys/{cryptokey_id}':
get:
summary: 'Returns all data about the CryptoKey, including the privatekey.'
operationId: getCryptokey
tags:
- zonecryptokey
parameters:
- name: server_id
in: path
required: true
description: The id of the server to retrieve
type: string
- name: zone_id
type: string
in: path
required: true
description: The id of the zone to retrieve
- name: cryptokey_id
type: string
in: path
required: true
description: 'The id value of the CryptoKey'
responses:
'200':
description: Cryptokey
schema:
$ref: '#/definitions/Cryptokey'
put:
summary: 'This method (de)activates a key from zone_name specified by cryptokey_id'
operationId: modifyCryptokey
tags:
- zonecryptokey
parameters:
- name: server_id
in: path
required: true
description: The id of the server to retrieve
type: string
- name: zone_id
type: string
in: path
required: true
- name: cryptokey_id
description: Cryptokey to manipulate
required: true
in: path
type: string
- name: cryptokey
description: the Cryptokey
required: true
in: body
schema:
$ref: '#/definitions/Cryptokey'
responses:
'204':
description: OK
'422':
description: 'Returned when something is wrong with the content of the request. Contains an error message'
delete:
summary: 'This method deletes a key specified by cryptokey_id.'
operationId: deleteCryptokey
tags:
- zonecryptokey
parameters:
- name: server_id
in: path
required: true
description: The id of the server to retrieve
type: string
- name: zone_id
type: string
in: path
required: true
description: The id of the zone to retrieve
- name: cryptokey_id
type: string
in: path
required: true
description: 'The id value of the Cryptokey'
responses:
'204':
description: OK
'422':
description: 'Returned when something is wrong with the content of the request. Contains an error message'
definitions:
Server:
title: Server
properties:
type:
type: string
description: 'Set to “Server”'
id:
type: string
description: 'The id of the server, “localhost”'
daemon_type:
type: string
description: '“recursor” for the PowerDNS Recursor and “authoritative” for the Authoritative Server'
version:
type: string
description: 'The version of the server software'
url:
type: string
description: 'The API endpoint for this server'
config_url:
type: string
description: 'The API endpoint for this server’s configuration'
zones_url:
type: string
description: 'The API endpoint for this server’s zones'
Servers:
type: array
items:
$ref: '#/definitions/Server'
Zone:
title: Zone
description: This represents an authoritative DNS Zone.
properties:
id:
type: string
description: 'Opaque zone id (string), assigned by the server, should not be interpreted by the application. Guaranteed to be safe for embedding in URLs.'
name:
type: string
description: 'Name of the zone (e.g. “example.com.”) MUST have a trailing dot'
type:
type: string
description: 'Set to “Zone”'
url:
type: string
description: 'API endpoint for this zone'
kind:
type: string
enum:
- 'Native'
- 'Master'
- 'Slave'
description: 'Zone kind, one of “Native”, “Master”, “Slave”'
rrsets:
type: array
items:
$ref: '#/definitions/RRSet'
description: 'RRSets in this zone'
serial:
type: integer
description: 'The SOA serial number'
notified_serial:
type: integer
description: 'The SOA serial notifications have been sent out for'
masters:
type: array
items:
type: string
description: ' List of IP addresses configured as a master for this zone (“Slave” type zones only)'
dnssec:
type: boolean
description: 'Whether or not this zone is DNSSEC signed (inferred from presigned being true XOR presence of at least one cryptokey with active being true)'
nsec3param:
type: string
description: 'The NSEC3PARAM record'
nsec3narrow:
type: boolean
description: 'Whether or not the zone uses NSEC3 narrow'
presigned:
type: boolean
description: 'Whether or not the zone is pre-signed'
soa_edit:
type: string
description: 'The SOA-EDIT metadata item'
soa_edit_api:
type: string
description: 'The SOA-EDIT-API metadata item'
api_rectify:
type: boolean
description: ' Whether or not the zone will be rectified on data changes via the API'
zone:
type: string
description: 'MAY contain a BIND-style zone file when creating a zone'
account:
type: string
description: 'MAY be set. Its value is defined by local policy'
nameservers:
type: array
items:
type: string
description: 'MAY be sent in client bodies during creation, and MUST NOT be sent by the server. Simple list of strings of nameserver names, including the trailing dot. Not required for slave zones.'
Zones:
type: array
items:
$ref: '#/definitions/Zone'
RRSet:
title: RRSet
description: This represents a Resource Record Set (all records with the same name and type).
required:
- name
- type
- ttl
- changetype
- records
properties:
name:
type: string
description: 'Name for record set (e.g. “www.powerdns.com.”)'
type:
type: string
description: 'Type of this record (e.g. “A”, “PTR”, “MX”)'
ttl:
type: integer
description: 'DNS TTL of the records, in seconds. MUST NOT be included when changetype is set to “DELETE”.'
changetype:
type: string
description: 'MUST be added when updating the RRSet. Must be REPLACE or DELETE. With DELETE, all existing RRs matching name and type will be deleted, including all comments. With REPLACE: when records is present, all existing RRs matching name and type will be deleted, and then new records given in records will be created. If no records are left, any existing comments will be deleted as well. When comments is present, all existing comments for the RRs matching name and type will be deleted, and then new comments given in comments will be created.'
records:
type: array
description: 'All records in this RRSet. When updating Records, this is the list of new records (replacing the old ones). Must be empty when changetype is set to DELETE. An empty list results in deletion of all records (and comments).'
items:
$ref: '#/definitions/Record'
comments:
type: array
description: 'List of Comment. Must be empty when changetype is set to DELETE. An empty list results in deletion of all comments. modified_at is optional and defaults to the current server time.'
items:
$ref: '#/definitions/Comment'
Record:
title: Record
description: The RREntry object represents a single record.
required:
- content
- disabled # PatchZone endpoint complains if this is missing
properties:
content:
type: string
description: 'The content of this record'
disabled:
type: boolean
description: 'Whether or not this record is disabled'
set-ptr:
type: boolean
description: 'If set to true, the server will find the matching reverse zone and create a PTR there. Existing PTR records are replaced. If no matching reverse Zone, an error is thrown. Only valid in client bodies, only valid for A and AAAA types. Not returned by the server.'
Comment:
title: Comment
description: A comment about an RRSet.
properties:
content:
type: string
description: 'The actual comment'
account:
type: string
description: 'Name of an account that added the comment'
modifided_at:
type: integer
description: 'Timestamp of the last change to the comment'
ConfigSetting:
title: ConfigSetting
properties:
name:
type: string
description: 'set to "ConfigSetting"'
type:
type: string
description: 'The name of this setting (e.g. ‘webserver-port’)'
value:
type: string
description: 'The value of setting name'
BaseStatisticItem:
title: BaseStatisticItem
properties:
name:
type: string
description: 'The name of this item (e.g. ‘uptime’)'
StatisticItem:
title: StatisticItem
allOf:
- $ref: "#/definitions/BaseStatisticItem"
- properties:
type:
enum: [StatisticItem]
description: 'set to "StatisticItem"'
value:
type: string
description: 'The value of item'
MapStatisticItem:
title: MapStatisticItem
allOf:
- $ref: "#/definitions/BaseStatisticItem"
- properties:
type:
enum: [MapStatisticItem]
description: 'set to "MapStatisticItem"'
value:
type: array
description: 'named statistic values'
items:
type: array
properties:
name:
type: string
description: 'item name'
value:
type: string
description: 'item value'
RingStatisticItem:
title: RingStatisticItem
allOf:
- $ref: "#/definitions/BaseStatisticItem"
- properties:
type:
enum: [RingStatisticItem]
description: 'set to "RingStatisticItem"'
size:
type: integer
description: 'for RingStatisticItem objects, the size of the ring'
value:
type: array
description: 'named ring statistic values'
items:
type: array
properties:
name:
type: string
description: 'item name'
value:
type: string
description: 'item value'
SearchResultZone:
title: SearchResultZone
properties:
name:
type: string
object_type:
type: string
description: 'set to "zone"'
zone_id:
type: string
SearchResultRecord:
title: SearchResultRecord
properties:
content:
type: string
disabled:
type: boolean
name:
type: string
object_type:
type: string
description: 'set to "record"'
zone_id:
type: string
zone:
type: string
type:
type: string
ttl:
type: integer
SearchResultComment:
title: SearchResultComment
properties:
content:
type: string
name:
type: string
object_type:
type: string
description: 'set to "comment"'
zone_id:
type: string
zone:
type: string