-
Notifications
You must be signed in to change notification settings - Fork 40
/
openapi.yml
6271 lines (6248 loc) · 198 KB
/
openapi.yml
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
openapi: 3.0.3
info:
title: DNSimple API
version: 2.0.0
contact:
name: DNSimple Support
email: [email protected]
url: 'https://dnsimple.com/contact'
description: '[DNSimple](https://dnsimple.com) provides DNS hosting and domain registration that is simple and friendly. We provide an extensive API and an easy-to-use web interface so you can get your domain registered and set up with a minimal amount of effort.'
termsOfService: 'https://dnsimple.com/terms'
externalDocs:
url: 'https://developer.dnsimple.com'
security:
- basicAuth: [ ]
- bearerAuth: [ ]
servers:
- url: 'https://api.dnsimple.com/v2'
description: DNSimple Production API
variables: { }
- url: 'https://api.sandbox.dnsimple.com/v2'
description: 'DNSimple Sandbox API used for testing'
tags:
- name: accounts
- name: billing
- name: contacts
- name: domain certificates
- name: domain collaborators
- name: domain dnssec
- name: domain emailforwards
- name: domain pushes
- name: domain services
- name: domains
- name: identity
- name: registrant changes
- name: registrar
- name: registrar delegation
- name: registrar privacy
- name: registrar registration
- name: registrar renewal
- name: registrar restore
- name: registrar transfer
- name: secondary dns
- name: templates
- name: tlds
- name: vanity name servers
- name: webhooks
- name: zones
paths:
/accounts:
get:
description: Lists the accounts the current authenticated entity has access to.
parameters: [ ]
operationId: listAccounts
tags:
- accounts
responses:
'200':
description: Depending on how you are authenticated you will see all the accounts you have access to or the account you used to authenticate.
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/Account'
summary: List accounts
/whoami:
get:
description: Retrieves the details about the current authenticated entity used to access the API.
parameters: [ ]
operationId: whoami
tags:
- identity
responses:
'200':
description: Successful response with user or account.
content:
application/json:
schema:
type: object
properties:
data:
type: object
properties:
account:
$ref: '#/components/schemas/Account'
user:
$ref: '#/components/schemas/User'
'401':
$ref: '#/components/responses/401'
'429':
$ref: '#/components/responses/429'
default:
$ref: '#/components/responses/Error'
summary: Whoami
'/{account}/billing/charges':
get:
description: Lists the billing charges for the account.
parameters:
- $ref: '#/components/parameters/Account'
- $ref: '#/components/parameters/FilterStartDate'
- $ref: '#/components/parameters/FilterEndDate'
- $ref: '#/components/parameters/SortCharges'
operationId: listCharges
tags:
- billing
summary: List billing charges
responses:
'200':
content:
application/json:
schema:
properties:
data:
type: array
items:
$ref: '#/components/schemas/Charge'
pagination:
$ref: '#/components/schemas/Pagination'
type: object
description: Billing charges listing.
'401':
$ref: '#/components/responses/401'
'429':
$ref: '#/components/responses/429'
'/{account}/domains':
get:
description: Lists the domains in the account.
parameters:
- $ref: '#/components/parameters/Account'
- $ref: '#/components/parameters/FilterNameLike'
- $ref: '#/components/parameters/FilterRegistrantId'
- $ref: '#/components/parameters/SortDomains'
operationId: listDomains
tags:
- domains
summary: List domains
responses:
'200':
content:
application/json:
schema:
properties:
data:
type: array
items:
$ref: '#/components/schemas/Domain'
pagination:
$ref: '#/components/schemas/Pagination'
type: object
description: Domain listing.
post:
summary: Create a domain
description: |-
Creates a domain and the corresponding zone into the account.
When creating a domain using Solo or Teams subscription, the DNS services
for the zone will be automatically enabled and this will be charged on your
following subscription renewal invoices.
parameters:
- $ref: '#/components/parameters/Account'
operationId: createDomain
tags:
- domains
requestBody:
$ref: '#/components/requestBodies/DomainCreate'
responses:
'201':
description: Domain created.
content:
application/json:
schema:
type: object
properties:
data:
$ref: '#/components/schemas/Domain'
'400':
$ref: '#/components/responses/400'
'/{account}/domains/{domain}':
get:
description: Retrieves the details of an existing domain.
parameters:
- $ref: '#/components/parameters/Account'
- $ref: '#/components/parameters/Domain'
operationId: getDomain
tags:
- domains
responses:
'200':
description: Domain retrieved.
content:
application/json:
schema:
type: object
properties:
data:
$ref: '#/components/schemas/Domain'
'400':
$ref: '#/components/responses/400'
'404':
$ref: '#/components/responses/404'
summary: Retrieve a domain
delete:
description: Permanently deletes a domain from the account.
parameters:
- $ref: '#/components/parameters/Account'
- $ref: '#/components/parameters/Domain'
operationId: deleteDomain
tags:
- domains
responses:
'204':
description: Domain deleted.
'400':
$ref: '#/components/responses/400'
'404':
$ref: '#/components/responses/404'
summary: Delete a domain
'/{account}/domains/{domain}/collaborators':
get:
description: Lists collaborators for the domain.
parameters:
- $ref: '#/components/parameters/Account'
- $ref: '#/components/parameters/Domain'
operationId: listDomainCollaborators
tags:
- domain collaborators
responses:
'200':
description: Successfully retrieved the collaborator list.
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/Collaborator'
pagination:
$ref: '#/components/schemas/Pagination'
'400':
$ref: '#/components/responses/400'
'404':
$ref: '#/components/responses/404'
summary: List collaborators
post:
description: |-
Adds a collaborator to the domain.
At the time of the add, a collaborator may or may not have a DNSimple account. In case the collaborator doesn't have a DNSimple account, the system will invite them to register to DNSimple first and then to accept the collaboration invitation. In the other case, they are automatically added to the domain as collaborator. They can decide to reject the invitation later.
parameters:
- $ref: '#/components/parameters/Account'
- $ref: '#/components/parameters/Domain'
operationId: addDomainCollaborator
tags:
- domain collaborators
requestBody:
$ref: '#/components/requestBodies/CollaboratorCreate'
responses:
'201':
description: Successfully added collaborator
content:
application/json:
schema:
type: object
properties:
data:
$ref: '#/components/schemas/Collaborator'
'400':
$ref: '#/components/responses/400'
'404':
$ref: '#/components/responses/404'
summary: Add a collaborator
'/{account}/domains/{domain}/dnssec':
get:
description: Gets the DNSSEC status for an existing domain.
parameters:
- $ref: '#/components/parameters/Account'
- $ref: '#/components/parameters/Domain'
operationId: getDomainDnssec
tags:
- domain dnssec
responses:
'200':
description: Successfully retrieved DNSSEC
content:
application/json:
schema:
type: object
properties:
data:
$ref: '#/components/schemas/DNSSEC'
'400':
$ref: '#/components/responses/400'
'404':
$ref: '#/components/responses/404'
summary: DNSSEC status
post:
description: |-
Enables DNSSEC for the domain.
It will enable signing of the zone. If the domain is registered with DNSimple, it will also add the DS record to the corresponding registry.
parameters:
- $ref: '#/components/parameters/Account'
- $ref: '#/components/parameters/Domain'
operationId: enableDomainDnssec
tags:
- domain dnssec
responses:
'201':
description: Successfully enabled DNSSEC
content:
application/json:
schema:
type: object
properties:
data:
$ref: '#/components/schemas/DNSSEC'
'400':
$ref: '#/components/responses/400'
'404':
$ref: '#/components/responses/404'
summary: Enable DNSSEC
delete:
description: |-
Disables DNSSEC for the domain.
It will disable signing of the zone. If the domain is registered with DNSimple, it will also remove the DS record at the registry corresponding to the disabled DNSSEC signing.
parameters:
- $ref: '#/components/parameters/Account'
- $ref: '#/components/parameters/Domain'
operationId: disableDomainDnssec
tags:
- domain dnssec
responses:
'204':
description: Successfully disabled DNSSEC
'400':
$ref: '#/components/responses/400'
'404':
$ref: '#/components/responses/404'
'428':
description: If DNSSEC is not enabled
summary: Disable DNSSEC
'/{account}/domains/{domain}/ds_records':
get:
description: Lists the DS records for the domain.
parameters:
- $ref: '#/components/parameters/Account'
- $ref: '#/components/parameters/Domain'
- $ref: '#/components/parameters/SortDelegationSignerRecords'
operationId: listDomainDelegationSignerRecords
tags:
- domain dnssec
responses:
'200':
description: Successfully retrieved delegation signer list
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/DelegationSigner'
pagination:
$ref: '#/components/schemas/Pagination'
'400':
$ref: '#/components/responses/400'
'404':
$ref: '#/components/responses/404'
summary: List delegation signer records
post:
description: Adds a DS record to the domain.
parameters:
- $ref: '#/components/parameters/Account'
- $ref: '#/components/parameters/Domain'
operationId: createDomainDelegationSignerRecord
tags:
- domain dnssec
requestBody:
$ref: '#/components/requestBodies/DelegationSignerCreate'
responses:
'201':
description: Successfully added delegation signer record
content:
application/json:
schema:
type: object
properties:
data:
$ref: '#/components/schemas/DelegationSigner'
'400':
$ref: '#/components/responses/400'
'404':
$ref: '#/components/responses/404'
summary: Create a delegation signer record
'/{account}/domains/{domain}/ds_records/{ds}':
get:
description: Retrieves the details of an existing DS record.
operationId: getDomainDelegationSignerRecord
parameters:
- $ref: '#/components/parameters/Account'
- $ref: '#/components/parameters/Domain'
- $ref: '#/components/parameters/DelegationSigner'
tags:
- domain dnssec
responses:
'200':
description: Successfully retrieved Delegation Signer record
content:
application/json:
schema:
type: object
properties:
data:
$ref: '#/components/schemas/DelegationSigner'
'400':
$ref: '#/components/responses/400'
'404':
$ref: '#/components/responses/404'
summary: Retrieve a delegation signer record
delete:
description: Removes a DS record from the domain.
operationId: deleteDomainDelegationSignerRecord
parameters:
- $ref: '#/components/parameters/Account'
- $ref: '#/components/parameters/Domain'
- $ref: '#/components/parameters/DelegationSigner'
tags:
- domain dnssec
responses:
'204':
description: Successfully removed the delegation signer record.
'400':
$ref: '#/components/responses/400'
'404':
$ref: '#/components/responses/404'
summary: Delete a delegation signer record
'/{account}/domains/{domain}/email_forwards':
get:
description: Lists email forwards for the domain.
parameters:
- $ref: '#/components/parameters/Account'
- $ref: '#/components/parameters/Domain'
- $ref: '#/components/parameters/SortEmailForwards'
operationId: listEmailForwards
tags:
- domain emailforwards
responses:
'200':
description: Successfully retrieved email forward list.
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/EmailForward'
pagination:
$ref: '#/components/schemas/Pagination'
'400':
$ref: '#/components/responses/400'
'404':
$ref: '#/components/responses/404'
summary: List email forwards
post:
description: Creates a new email forward for the domain.
parameters:
- $ref: '#/components/parameters/Account'
- $ref: '#/components/parameters/Domain'
operationId: createEmailForward
tags:
- domain emailforwards
requestBody:
$ref: '#/components/requestBodies/EmailForwardCreate'
responses:
'201':
description: Successfully created new email forward.
content:
application/json:
schema:
type: object
properties:
data:
$ref: '#/components/schemas/EmailForward'
'400':
$ref: '#/components/responses/400'
'404':
$ref: '#/components/responses/404'
summary: Create an email forward
'/{account}/domains/{domain}/email_forwards/{emailforward}':
get:
description: Retrieves the details of an existing email forward.
parameters:
- $ref: '#/components/parameters/Account'
- $ref: '#/components/parameters/Domain'
- $ref: '#/components/parameters/EmailForward'
operationId: getEmailForward
tags:
- domain emailforwards
responses:
'200':
description: Successfully retrieved email forward.
content:
application/json:
schema:
type: object
properties:
data:
$ref: '#/components/schemas/EmailForward'
'400':
$ref: '#/components/responses/400'
'404':
$ref: '#/components/responses/404'
summary: Retrieve an email forward
delete:
description: Permanently deletes an email forward.
parameters:
- $ref: '#/components/parameters/Account'
- $ref: '#/components/parameters/Domain'
- $ref: '#/components/parameters/EmailForward'
operationId: deleteEmailForward
tags:
- domain emailforwards
responses:
'204':
description: Successfully deleted email forward.
'404':
$ref: '#/components/responses/404'
summary: Delete an email forward
'/{account}/domains/{domain}/pushes':
post:
description: Initiates a pust of a domain to another DNSimple account.
parameters:
- $ref: '#/components/parameters/Account'
- $ref: '#/components/parameters/Domain'
operationId: initiateDomainPush
tags:
- domain pushes
requestBody:
$ref: '#/components/requestBodies/PushInitiate'
responses:
'201':
description: Successfully initiated the push.
content:
application/json:
schema:
type: object
properties:
data:
$ref: '#/components/schemas/Push'
'400':
$ref: '#/components/responses/400'
'404':
$ref: '#/components/responses/404'
summary: Initiate a push
'/{account}/pushes':
get:
description: List pending pushes for the target account.
parameters:
- $ref: '#/components/parameters/Account'
operationId: listPushes
tags:
- domain pushes
responses:
'200':
description: Successfully retrieved pushes for the account.
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/Push'
pagination:
$ref: '#/components/schemas/Pagination'
summary: List pushes
'/{account}/pushes/{push}':
post:
description: Accepts a push to the target account.
parameters:
- $ref: '#/components/parameters/Account'
- $ref: '#/components/parameters/Push'
operationId: acceptPush
tags:
- domain pushes
requestBody:
$ref: '#/components/requestBodies/PushAccept'
responses:
'204':
description: Successfully accept a push.
'400':
$ref: '#/components/responses/400'
'404':
$ref: '#/components/responses/404'
summary: Accept a push
delete:
description: Rejects a push to the target account.
parameters:
- $ref: '#/components/parameters/Account'
- $ref: '#/components/parameters/Push'
operationId: rejectPush
tags:
- domain pushes
responses:
'204':
description: Successfully reject a push.
'400':
$ref: '#/components/responses/400'
'404':
$ref: '#/components/responses/404'
summary: Reject a push
'/{account}/domains/{domain}/certificates':
get:
description: Lists the certificates for a domain.
parameters:
- $ref: '#/components/parameters/Account'
- $ref: '#/components/parameters/Domain'
- $ref: '#/components/parameters/SortCertificates'
operationId: listCertificates
tags:
- domain certificates
responses:
'200':
description: Successfully retrieved certificates for a domain.
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/Certificate'
pagination:
$ref: '#/components/schemas/Pagination'
'404':
$ref: '#/components/responses/404'
summary: List certificates
'/{account}/domains/{domain}/certificates/{certificate}':
get:
description: Retrieves the details of an existing certificate.
parameters:
- $ref: '#/components/parameters/Account'
- $ref: '#/components/parameters/Domain'
- $ref: '#/components/parameters/Certificate'
operationId: getCertificate
tags:
- domain certificates
responses:
'200':
description: Successfully retrieved a certificate for a domain.
content:
application/json:
schema:
type: object
properties:
data:
$ref: '#/components/schemas/Certificate'
'404':
$ref: '#/components/responses/404'
summary: Retrieve a certificate
'/{account}/domains/{domain}/certificates/{certificate}/download':
get:
description: 'Gets the PEM-encoded certificate, along with the root certificate and intermediate chain.'
parameters:
- $ref: '#/components/parameters/Account'
- $ref: '#/components/parameters/Domain'
- $ref: '#/components/parameters/Certificate'
operationId: downloadCertificate
tags:
- domain certificates
responses:
'200':
description: Successfully retrieved the certificate.
content:
application/json:
schema:
type: object
properties:
data:
$ref: '#/components/schemas/CertificateDownload'
'404':
$ref: '#/components/responses/404'
summary: Download a certificate
'/{account}/domains/{domain}/certificates/{certificate}/private_key':
get:
description: Gets the PEM-encoded certificate private key.
parameters:
- $ref: '#/components/parameters/Account'
- $ref: '#/components/parameters/Domain'
- $ref: '#/components/parameters/Certificate'
operationId: getCertificatePrivateKey
tags:
- domain certificates
responses:
'200':
description: Successfully retrieved the private key for an issued certificate.
content:
application/json:
schema:
type: object
properties:
data:
$ref: '#/components/schemas/CertificatePrivateKey'
'404':
$ref: '#/components/responses/404'
summary: Retrieve a certificate private key
'/{account}/domains/{domain}/certificates/letsencrypt':
post:
description: 'Orders a [Let''s Encrypt](https://dnsimple.com/letsencrypt) certificate with DNSimple.'
parameters:
- $ref: '#/components/parameters/Account'
- $ref: '#/components/parameters/Domain'
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
auto_renew:
description: 'Enable the auto-renewal of the certificate'
type: boolean
default: false
name:
description: 'The certificate name'
type: string
default: 'www'
alternate_names:
description: 'The certificate alternate names'
type: array
items:
type: string
default: [ ]
example: [ 'docs.example.com', 'status.example.com' ]
signature_algorithm:
description: 'Optional string to determine the signature algorithm to be used. Either `ECDSA` or `RSA`'
type: string
default: 'ECDSA'
operationId: purchaseLetsencryptCertificate
tags:
- domain certificates
responses:
'201':
description: Successfully created the certificate purchase order.
content:
application/json:
schema:
type: object
properties:
data:
$ref: '#/components/schemas/LetsencryptCertificatePurchase'
'404':
$ref: '#/components/responses/404'
summary: "Let's Encrypt: Order a certificate"
'/{account}/domains/{domain}/certificates/letsencrypt/{purchaseId}/issue':
post:
description: "Issues a [Let's Encrypt](https://dnsimple.com/letsencrypt) certificate ordered with DNSimple."
parameters:
- $ref: '#/components/parameters/Account'
- $ref: '#/components/parameters/Domain'
- name: purchaseId
in: path
required: true
description: The certificate purchase order id received by `purchaseLetsencryptCertificate`.
schema:
type: integer
operationId: issueLetsencryptCertificate
tags:
- domain certificates
responses:
'202':
description: Successfully requested the issuance of the certificate.
content:
application/json:
schema:
type: object
properties:
data:
$ref: '#/components/schemas/Certificate'
'404':
$ref: '#/components/responses/404'
summary: "Let's Encrypt: Issue a certificate"
'/{account}/domains/{domain}/certificates/letsencrypt/{certificate}/renewals':
post:
description: "Renews a [Let's Encrypt](https://dnsimple.com/letsencrypt) certificate ordered with DNSimple."
parameters:
- $ref: '#/components/parameters/Account'
- $ref: '#/components/parameters/Domain'
- $ref: '#/components/parameters/Certificate'
operationId: purchaseRenewalLetsencryptCertificate
tags:
- domain certificates
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
auto_renew:
description: 'Enable the auto-renewal of the certificate'
type: boolean
default: false
signature_algorithm:
description: 'Optional string to determine the signature algorithm to be used. Either `ECDSA` or `RSA`'
type: string
default: 'ECDSA'
responses:
'201':
description: Successfully created the certificate renewal order.
content:
application/json:
schema:
type: object
properties:
data:
$ref: '#/components/schemas/LetsencryptCertificateRenewal'
'404':
$ref: '#/components/responses/404'
summary: "Let's Encrypt: Order a certificate renewal"
'/{account}/domains/{domain}/certificates/letsencrypt/{certificate}/renewals/{renewalId}/issue':
post:
description: "Issues a [Let's Encrypt](https://dnsimple.com/letsencrypt) certificate renewal ordered with DNSimple."
parameters:
- $ref: '#/components/parameters/Account'
- $ref: '#/components/parameters/Domain'
- $ref: '#/components/parameters/Certificate'
- name: renewalId
in: path
required: true
description: The certificate renewal order id received by `purchaseRenewalLetsencryptCertificate`.
schema:
type: integer
operationId: issueRenewalLetsencryptCertificate
tags:
- domain certificates
responses:
'202':
description: Successfully requested the issuance of the certificate renewal.
content:
application/json:
schema:
type: object
properties:
data:
$ref: '#/components/schemas/Certificate'
'404':
$ref: '#/components/responses/404'
summary: "Let's Encrypt: Issue a certificate renewal"
/tlds:
get:
description: Lists TLDs supported for registration or transfer.
parameters:
- $ref: '#/components/parameters/SortTLDs'
operationId: listTlds
tags:
- tlds
responses:
'200':
description: Successfully retrieved the TLDs.
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/TLD'
pagination:
$ref: '#/components/schemas/Pagination'
summary: List TLDs
'/tlds/{tld}':
get:
description: Retrieves the details of a TLD.
parameters:
- $ref: '#/components/parameters/TLD'
operationId: getTld
tags:
- tlds
responses:
'200':
description: Successfully retrieved the TLD details.
content:
application/json:
schema:
type: object
properties:
data:
$ref: '#/components/schemas/TLD'
'404':
$ref: '#/components/responses/404'
summary: Retrieve the TLD
'/tlds/{tld}/extended_attributes':
get:
description: |-
Lists a TLD extended attributes.
Some TLDs require extended attributes when registering or transferring a domain. This API interface provides information on the extended attributes for any particular TLD. Extended attributes are extra TLD-specific attributes, required by the TLD registry to collect extra information about the registrant or legal agreements.
parameters:
- $ref: '#/components/parameters/TLD'
operationId: getTldExtendedAttributes
tags:
- tlds
responses:
'200':
description: Successfully retrieved the extended attributes for the TLD.
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/ExtendedAttribute'
'404':
$ref: '#/components/responses/404'
summary: List TLD extended attributes
'/{account}/registrar/domains/{domain}/check':
get:
description: Checks a domain name for availability.
parameters:
- $ref: '#/components/parameters/Account'
- $ref: '#/components/parameters/Domain'
operationId: checkDomain
tags:
- registrar
responses:
'200':
description: 'The check was successfully executed. Check the result data to determine if it is available for registration. If the domain is premium, please check the premium price before trying to register, renew, transfer.'
content:
application/json:
schema:
type: object
properties:
data:
$ref: '#/components/schemas/DomainCheckResult'
summary: Check domain
'/{account}/registrar/domains/{domain}/premium_price':
get:
deprecated: true
description: |-
Deprecated in favor of getDomainPrices.
Retrieves the premium price for a premium domain.
Please note that a premium price can be different for registration, renewal, transfer. By default this endpoint returns the premium price for registration. If you need to check a different price, you should specify it with the action param.
parameters:
- $ref: '#/components/parameters/Account'
- $ref: '#/components/parameters/Domain'
- $ref: '#/components/parameters/DomainPremiumPriceAction'
operationId: getDomainPremiumPrice
tags:
- registrar
responses:
'200':
description: Successfully retrieved the premium price
content:
application/json:
schema:
type: object
properties:
data:
$ref: '#/components/schemas/DomainPremiumPrice'
'400':
$ref: '#/components/responses/400'
summary: Get domain premium price
'/{account}/registrar/domains/{domain}/prices':
get:
description: Retrieve domain prices.
summary: Get prices for a domain
parameters:
- $ref: '#/components/parameters/Account'
- $ref: '#/components/parameters/Domain'
operationId: getDomainPrices
tags:
- registrar
responses:
'200':
description: Successfully retrieved the domain pricing data
content:
application/json:
schema:
type: object
properties:
data:
$ref: '#/components/schemas/DomainPrices'
'400':