@opusdns/api 0.93.0 → 0.95.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/package.json +1 -1
- package/src/helpers/keys.ts +1359 -413
- package/src/helpers/requests.d.ts +335 -108
- package/src/helpers/responses.d.ts +1067 -173
- package/src/helpers/schemas-arrays.d.ts +25 -11
- package/src/helpers/schemas.d.ts +124 -28
- package/src/openapi.yaml +993 -159
- package/src/schema.d.ts +1055 -188
package/src/openapi.yaml
CHANGED
|
@@ -1540,28 +1540,31 @@ components:
|
|
|
1540
1540
|
format: date-time
|
|
1541
1541
|
title: Created On
|
|
1542
1542
|
type: string
|
|
1543
|
-
|
|
1544
|
-
|
|
1545
|
-
|
|
1546
|
-
|
|
1547
|
-
|
|
1548
|
-
|
|
1549
|
-
|
|
1543
|
+
enabled:
|
|
1544
|
+
title: Enabled
|
|
1545
|
+
type: boolean
|
|
1546
|
+
hostname:
|
|
1547
|
+
title: Hostname
|
|
1548
|
+
type: string
|
|
1549
|
+
http:
|
|
1550
|
+
anyOf:
|
|
1551
|
+
- $ref: '#/components/schemas/DomainForwardProtocolSetResponse'
|
|
1552
|
+
- type: 'null'
|
|
1553
|
+
https:
|
|
1554
|
+
anyOf:
|
|
1555
|
+
- $ref: '#/components/schemas/DomainForwardProtocolSetResponse'
|
|
1556
|
+
- type: 'null'
|
|
1550
1557
|
updated_on:
|
|
1551
1558
|
format: date-time
|
|
1552
1559
|
title: Updated On
|
|
1553
1560
|
type: string
|
|
1554
1561
|
wildcard:
|
|
1555
|
-
default: false
|
|
1556
1562
|
title: Wildcard
|
|
1557
1563
|
type: boolean
|
|
1558
|
-
zone_name:
|
|
1559
|
-
title: Zone Name
|
|
1560
|
-
type: string
|
|
1561
1564
|
required:
|
|
1562
|
-
-
|
|
1563
|
-
-
|
|
1564
|
-
-
|
|
1565
|
+
- hostname
|
|
1566
|
+
- wildcard
|
|
1567
|
+
- enabled
|
|
1565
1568
|
- updated_on
|
|
1566
1569
|
- created_on
|
|
1567
1570
|
title: DomainForward
|
|
@@ -1572,18 +1575,11 @@ components:
|
|
|
1572
1575
|
$ref: '#/components/schemas/PatchOp'
|
|
1573
1576
|
redirect:
|
|
1574
1577
|
anyOf:
|
|
1575
|
-
- $ref: '#/components/schemas/
|
|
1578
|
+
- $ref: '#/components/schemas/HttpRedirectUpsert'
|
|
1576
1579
|
- $ref: '#/components/schemas/HttpRedirectRemove'
|
|
1577
1580
|
title: Redirect
|
|
1578
|
-
request_protocol:
|
|
1579
|
-
$ref: '#/components/schemas/HttpProtocol'
|
|
1580
|
-
zone_name:
|
|
1581
|
-
title: Zone Name
|
|
1582
|
-
type: string
|
|
1583
1581
|
required:
|
|
1584
1582
|
- op
|
|
1585
|
-
- zone_name
|
|
1586
|
-
- request_protocol
|
|
1587
1583
|
- redirect
|
|
1588
1584
|
title: DomainForwardPatchOp
|
|
1589
1585
|
type: object
|
|
@@ -1598,51 +1594,137 @@ components:
|
|
|
1598
1594
|
- ops
|
|
1599
1595
|
title: DomainForwardPatchOps
|
|
1600
1596
|
type: object
|
|
1601
|
-
|
|
1597
|
+
DomainForwardProtocolSetRequest:
|
|
1602
1598
|
properties:
|
|
1603
|
-
|
|
1604
|
-
|
|
1605
|
-
|
|
1606
|
-
|
|
1607
|
-
|
|
1599
|
+
redirects:
|
|
1600
|
+
items:
|
|
1601
|
+
anyOf:
|
|
1602
|
+
- $ref: '#/components/schemas/HttpRedirectRequest'
|
|
1603
|
+
- $ref: '#/components/schemas/WildcardHttpRedirectRequest'
|
|
1604
|
+
title: Redirects
|
|
1605
|
+
type: array
|
|
1606
|
+
wildcard:
|
|
1608
1607
|
anyOf:
|
|
1609
|
-
-
|
|
1608
|
+
- type: boolean
|
|
1610
1609
|
- type: 'null'
|
|
1611
|
-
|
|
1610
|
+
title: Wildcard
|
|
1611
|
+
required:
|
|
1612
|
+
- redirects
|
|
1613
|
+
title: DomainForwardProtocolSetRequest
|
|
1612
1614
|
type: object
|
|
1613
|
-
|
|
1615
|
+
DomainForwardProtocolSetResponse:
|
|
1614
1616
|
properties:
|
|
1617
|
+
created_on:
|
|
1618
|
+
format: date-time
|
|
1619
|
+
title: Created On
|
|
1620
|
+
type: string
|
|
1615
1621
|
redirects:
|
|
1616
1622
|
items:
|
|
1617
|
-
$ref: '#/components/schemas/
|
|
1623
|
+
$ref: '#/components/schemas/HttpRedirectListResponse'
|
|
1618
1624
|
title: Redirects
|
|
1619
1625
|
type: array
|
|
1626
|
+
updated_on:
|
|
1627
|
+
format: date-time
|
|
1628
|
+
title: Updated On
|
|
1629
|
+
type: string
|
|
1620
1630
|
wildcard:
|
|
1621
|
-
default: false
|
|
1622
1631
|
title: Wildcard
|
|
1623
1632
|
type: boolean
|
|
1624
1633
|
required:
|
|
1634
|
+
- wildcard
|
|
1625
1635
|
- redirects
|
|
1626
|
-
|
|
1636
|
+
- updated_on
|
|
1637
|
+
- created_on
|
|
1638
|
+
title: DomainForwardProtocolSetResponse
|
|
1627
1639
|
type: object
|
|
1628
|
-
|
|
1640
|
+
DomainForwardRequest:
|
|
1629
1641
|
properties:
|
|
1630
1642
|
enabled:
|
|
1643
|
+
default: false
|
|
1631
1644
|
title: Enabled
|
|
1632
1645
|
type: boolean
|
|
1633
|
-
|
|
1634
|
-
|
|
1646
|
+
http:
|
|
1647
|
+
anyOf:
|
|
1648
|
+
- $ref: '#/components/schemas/DomainForwardProtocolSetRequest'
|
|
1649
|
+
- type: 'null'
|
|
1650
|
+
https:
|
|
1651
|
+
anyOf:
|
|
1652
|
+
- $ref: '#/components/schemas/DomainForwardProtocolSetRequest'
|
|
1653
|
+
- type: 'null'
|
|
1654
|
+
wildcard:
|
|
1655
|
+
anyOf:
|
|
1656
|
+
- type: boolean
|
|
1657
|
+
- type: 'null'
|
|
1658
|
+
title: Wildcard
|
|
1659
|
+
title: DomainForwardRequest
|
|
1660
|
+
type: object
|
|
1661
|
+
DomainForwardSetRequest:
|
|
1662
|
+
properties:
|
|
1663
|
+
redirects:
|
|
1664
|
+
items:
|
|
1665
|
+
anyOf:
|
|
1666
|
+
- $ref: '#/components/schemas/HttpRedirectRequest'
|
|
1667
|
+
- $ref: '#/components/schemas/WildcardHttpRedirectRequest'
|
|
1668
|
+
title: Redirects
|
|
1669
|
+
type: array
|
|
1670
|
+
required:
|
|
1671
|
+
- redirects
|
|
1672
|
+
title: DomainForwardSetRequest
|
|
1673
|
+
type: object
|
|
1674
|
+
DomainForwardSetResponse:
|
|
1675
|
+
properties:
|
|
1676
|
+
created_on:
|
|
1677
|
+
format: date-time
|
|
1678
|
+
title: Created On
|
|
1679
|
+
type: string
|
|
1680
|
+
hostname:
|
|
1681
|
+
title: Hostname
|
|
1682
|
+
type: string
|
|
1683
|
+
protocol:
|
|
1684
|
+
$ref: '#/components/schemas/HttpProtocol'
|
|
1685
|
+
redirects:
|
|
1686
|
+
items:
|
|
1687
|
+
$ref: '#/components/schemas/HttpRedirectListResponse'
|
|
1688
|
+
title: Redirects
|
|
1689
|
+
type: array
|
|
1690
|
+
updated_on:
|
|
1691
|
+
format: date-time
|
|
1692
|
+
title: Updated On
|
|
1693
|
+
type: string
|
|
1635
1694
|
wildcard:
|
|
1636
1695
|
title: Wildcard
|
|
1637
1696
|
type: boolean
|
|
1697
|
+
required:
|
|
1698
|
+
- hostname
|
|
1699
|
+
- protocol
|
|
1700
|
+
- wildcard
|
|
1701
|
+
- redirects
|
|
1702
|
+
- updated_on
|
|
1703
|
+
- created_on
|
|
1704
|
+
title: DomainForwardSetResponse
|
|
1705
|
+
type: object
|
|
1706
|
+
DomainForwardZone:
|
|
1707
|
+
properties:
|
|
1708
|
+
domain_forwards:
|
|
1709
|
+
items:
|
|
1710
|
+
$ref: '#/components/schemas/DomainForward'
|
|
1711
|
+
title: Domain Forwards
|
|
1712
|
+
type: array
|
|
1713
|
+
zone_id:
|
|
1714
|
+
examples:
|
|
1715
|
+
- zone_01h45ytscbebyvny4gc8cr8ma2
|
|
1716
|
+
format: typeid
|
|
1717
|
+
pattern: ^zone_[0-7][0-9a-hjkmnpq-tv-z]{25}$
|
|
1718
|
+
title: Zone Id
|
|
1719
|
+
type: string
|
|
1720
|
+
x-typeid-prefix: zone
|
|
1638
1721
|
zone_name:
|
|
1639
1722
|
title: Zone Name
|
|
1640
1723
|
type: string
|
|
1641
1724
|
required:
|
|
1725
|
+
- zone_id
|
|
1642
1726
|
- zone_name
|
|
1643
|
-
-
|
|
1644
|
-
- enabled
|
|
1645
|
-
- protocols
|
|
1727
|
+
- domain_forwards
|
|
1646
1728
|
title: DomainForwardZone
|
|
1647
1729
|
type: object
|
|
1648
1730
|
DomainLifecycleBase:
|
|
@@ -2579,52 +2661,120 @@ components:
|
|
|
2579
2661
|
- https
|
|
2580
2662
|
title: HttpProtocol
|
|
2581
2663
|
type: string
|
|
2582
|
-
|
|
2664
|
+
HttpRedirectListResponse:
|
|
2583
2665
|
properties:
|
|
2584
2666
|
redirect_code:
|
|
2585
2667
|
$ref: '#/components/schemas/RedirectCode'
|
|
2668
|
+
request_hostname:
|
|
2669
|
+
title: Request Hostname
|
|
2670
|
+
type: string
|
|
2586
2671
|
request_path:
|
|
2587
2672
|
title: Request Path
|
|
2588
2673
|
type: string
|
|
2674
|
+
request_protocol:
|
|
2675
|
+
$ref: '#/components/schemas/HttpProtocol'
|
|
2589
2676
|
request_subdomain:
|
|
2590
2677
|
anyOf:
|
|
2591
2678
|
- type: string
|
|
2592
2679
|
- type: 'null'
|
|
2593
2680
|
title: Request Subdomain
|
|
2594
|
-
|
|
2595
|
-
title: Target
|
|
2681
|
+
target_hostname:
|
|
2682
|
+
title: Target Hostname
|
|
2596
2683
|
type: string
|
|
2597
2684
|
target_path:
|
|
2598
2685
|
title: Target Path
|
|
2599
2686
|
type: string
|
|
2600
2687
|
target_protocol:
|
|
2601
2688
|
$ref: '#/components/schemas/HttpProtocol'
|
|
2602
|
-
|
|
2689
|
+
required:
|
|
2690
|
+
- request_path
|
|
2691
|
+
- target_protocol
|
|
2692
|
+
- target_hostname
|
|
2693
|
+
- target_path
|
|
2694
|
+
- redirect_code
|
|
2695
|
+
- request_protocol
|
|
2696
|
+
- request_hostname
|
|
2697
|
+
title: HttpRedirectListResponse
|
|
2698
|
+
type: object
|
|
2699
|
+
HttpRedirectRemove:
|
|
2700
|
+
properties:
|
|
2701
|
+
request_hostname:
|
|
2702
|
+
title: Request Hostname
|
|
2703
|
+
type: string
|
|
2704
|
+
request_path:
|
|
2705
|
+
title: Request Path
|
|
2706
|
+
type: string
|
|
2707
|
+
request_protocol:
|
|
2708
|
+
$ref: '#/components/schemas/HttpProtocol'
|
|
2709
|
+
request_subdomain:
|
|
2603
2710
|
anyOf:
|
|
2604
2711
|
- type: string
|
|
2605
2712
|
- type: 'null'
|
|
2606
|
-
title:
|
|
2713
|
+
title: Request Subdomain
|
|
2714
|
+
required:
|
|
2715
|
+
- request_protocol
|
|
2716
|
+
- request_hostname
|
|
2717
|
+
- request_path
|
|
2718
|
+
title: HttpRedirectRemove
|
|
2719
|
+
type: object
|
|
2720
|
+
HttpRedirectRequest:
|
|
2721
|
+
properties:
|
|
2722
|
+
redirect_code:
|
|
2723
|
+
$ref: '#/components/schemas/RedirectCode'
|
|
2724
|
+
request_path:
|
|
2725
|
+
title: Request Path
|
|
2726
|
+
type: string
|
|
2727
|
+
target_hostname:
|
|
2728
|
+
title: Target Hostname
|
|
2729
|
+
type: string
|
|
2730
|
+
target_path:
|
|
2731
|
+
title: Target Path
|
|
2732
|
+
type: string
|
|
2733
|
+
target_protocol:
|
|
2734
|
+
$ref: '#/components/schemas/HttpProtocol'
|
|
2607
2735
|
required:
|
|
2608
2736
|
- request_path
|
|
2609
2737
|
- target_protocol
|
|
2610
|
-
-
|
|
2738
|
+
- target_hostname
|
|
2611
2739
|
- target_path
|
|
2612
2740
|
- redirect_code
|
|
2613
|
-
title:
|
|
2741
|
+
title: HttpRedirectRequest
|
|
2614
2742
|
type: object
|
|
2615
|
-
|
|
2743
|
+
HttpRedirectUpsert:
|
|
2616
2744
|
properties:
|
|
2745
|
+
redirect_code:
|
|
2746
|
+
$ref: '#/components/schemas/RedirectCode'
|
|
2747
|
+
request_hostname:
|
|
2748
|
+
title: Request Hostname
|
|
2749
|
+
type: string
|
|
2617
2750
|
request_path:
|
|
2618
2751
|
title: Request Path
|
|
2619
2752
|
type: string
|
|
2753
|
+
request_protocol:
|
|
2754
|
+
anyOf:
|
|
2755
|
+
- $ref: '#/components/schemas/HttpProtocol'
|
|
2756
|
+
- type: 'null'
|
|
2620
2757
|
request_subdomain:
|
|
2621
2758
|
anyOf:
|
|
2622
2759
|
- type: string
|
|
2623
2760
|
- type: 'null'
|
|
2624
2761
|
title: Request Subdomain
|
|
2762
|
+
target_hostname:
|
|
2763
|
+
title: Target Hostname
|
|
2764
|
+
type: string
|
|
2765
|
+
target_path:
|
|
2766
|
+
title: Target Path
|
|
2767
|
+
type: string
|
|
2768
|
+
target_protocol:
|
|
2769
|
+
$ref: '#/components/schemas/HttpProtocol'
|
|
2625
2770
|
required:
|
|
2626
2771
|
- request_path
|
|
2627
|
-
|
|
2772
|
+
- target_protocol
|
|
2773
|
+
- target_hostname
|
|
2774
|
+
- target_path
|
|
2775
|
+
- redirect_code
|
|
2776
|
+
- request_hostname
|
|
2777
|
+
title: HttpRedirectUpsert
|
|
2628
2778
|
type: object
|
|
2629
2779
|
IdnBase:
|
|
2630
2780
|
properties:
|
|
@@ -3723,6 +3873,20 @@ components:
|
|
|
3723
3873
|
- pagination
|
|
3724
3874
|
title: Pagination[DomainForwardZone]
|
|
3725
3875
|
type: object
|
|
3876
|
+
Pagination_DomainForward_:
|
|
3877
|
+
properties:
|
|
3878
|
+
pagination:
|
|
3879
|
+
$ref: '#/components/schemas/PaginationMetadata'
|
|
3880
|
+
results:
|
|
3881
|
+
items:
|
|
3882
|
+
$ref: '#/components/schemas/DomainForward'
|
|
3883
|
+
title: Results
|
|
3884
|
+
type: array
|
|
3885
|
+
required:
|
|
3886
|
+
- results
|
|
3887
|
+
- pagination
|
|
3888
|
+
title: Pagination[DomainForward]
|
|
3889
|
+
type: object
|
|
3726
3890
|
Pagination_DomainResponse_:
|
|
3727
3891
|
properties:
|
|
3728
3892
|
pagination:
|
|
@@ -4017,17 +4181,6 @@ components:
|
|
|
4017
4181
|
- status
|
|
4018
4182
|
title: Problem
|
|
4019
4183
|
type: object
|
|
4020
|
-
ProtocolRedirects:
|
|
4021
|
-
properties:
|
|
4022
|
-
redirects:
|
|
4023
|
-
items:
|
|
4024
|
-
$ref: '#/components/schemas/HttpRedirect'
|
|
4025
|
-
title: Redirects
|
|
4026
|
-
type: array
|
|
4027
|
-
required:
|
|
4028
|
-
- redirects
|
|
4029
|
-
title: ProtocolRedirects
|
|
4030
|
-
type: object
|
|
4031
4184
|
PublicAuthRequestForm:
|
|
4032
4185
|
properties:
|
|
4033
4186
|
client_id:
|
|
@@ -5017,6 +5170,33 @@ components:
|
|
|
5017
5170
|
title: Whois Server
|
|
5018
5171
|
title: WhoisBase
|
|
5019
5172
|
type: object
|
|
5173
|
+
WildcardHttpRedirectRequest:
|
|
5174
|
+
properties:
|
|
5175
|
+
redirect_code:
|
|
5176
|
+
$ref: '#/components/schemas/RedirectCode'
|
|
5177
|
+
request_path:
|
|
5178
|
+
title: Request Path
|
|
5179
|
+
type: string
|
|
5180
|
+
request_subdomain:
|
|
5181
|
+
title: Request Subdomain
|
|
5182
|
+
type: string
|
|
5183
|
+
target_hostname:
|
|
5184
|
+
title: Target Hostname
|
|
5185
|
+
type: string
|
|
5186
|
+
target_path:
|
|
5187
|
+
title: Target Path
|
|
5188
|
+
type: string
|
|
5189
|
+
target_protocol:
|
|
5190
|
+
$ref: '#/components/schemas/HttpProtocol'
|
|
5191
|
+
required:
|
|
5192
|
+
- request_path
|
|
5193
|
+
- target_protocol
|
|
5194
|
+
- target_hostname
|
|
5195
|
+
- target_path
|
|
5196
|
+
- redirect_code
|
|
5197
|
+
- request_subdomain
|
|
5198
|
+
title: WildcardHttpRedirectRequest
|
|
5199
|
+
type: object
|
|
5020
5200
|
ZoneSortField:
|
|
5021
5201
|
enum:
|
|
5022
5202
|
- name
|
|
@@ -5111,7 +5291,7 @@ info:
|
|
|
5111
5291
|
'
|
|
5112
5292
|
summary: OpusDNS - your gateway to a seamless domain management experience.
|
|
5113
5293
|
title: OpusDNS API
|
|
5114
|
-
version: 2025-11-
|
|
5294
|
+
version: 2025-11-13-112957
|
|
5115
5295
|
x-logo:
|
|
5116
5296
|
altText: OpusDNS API Reference
|
|
5117
5297
|
url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
|
|
@@ -6328,46 +6508,190 @@ paths:
|
|
|
6328
6508
|
summary: Create Zone
|
|
6329
6509
|
tags:
|
|
6330
6510
|
- dns
|
|
6331
|
-
/v1/dns/
|
|
6511
|
+
/v1/dns/domain-forwards:
|
|
6332
6512
|
get:
|
|
6333
|
-
|
|
6334
|
-
|
|
6335
|
-
'200':
|
|
6336
|
-
content:
|
|
6337
|
-
application/json:
|
|
6338
|
-
schema:
|
|
6339
|
-
$ref: '#/components/schemas/DnsZoneSummary'
|
|
6340
|
-
description: Successful Response
|
|
6341
|
-
security:
|
|
6342
|
-
- OAuth2PasswordBearer: []
|
|
6343
|
-
summary: Get Zones Summary
|
|
6344
|
-
tags:
|
|
6345
|
-
- dns
|
|
6346
|
-
/v1/dns/{zone_name}:
|
|
6347
|
-
delete:
|
|
6348
|
-
operationId: delete_zone_v1_dns__zone_name__delete
|
|
6513
|
+
description: Retrieves a paginated list of domain forwards grouped by DNS zones.
|
|
6514
|
+
operationId: list_domain_forwards_by_zone_v1_dns_domain_forwards_get
|
|
6349
6515
|
parameters:
|
|
6350
|
-
-
|
|
6351
|
-
|
|
6352
|
-
|
|
6353
|
-
required: true
|
|
6516
|
+
- in: query
|
|
6517
|
+
name: sort_by
|
|
6518
|
+
required: false
|
|
6354
6519
|
schema:
|
|
6355
|
-
|
|
6356
|
-
|
|
6357
|
-
|
|
6358
|
-
|
|
6359
|
-
|
|
6360
|
-
|
|
6361
|
-
|
|
6362
|
-
|
|
6363
|
-
|
|
6364
|
-
|
|
6365
|
-
|
|
6366
|
-
|
|
6367
|
-
|
|
6368
|
-
|
|
6369
|
-
|
|
6370
|
-
|
|
6520
|
+
$ref: '#/components/schemas/ZoneSortField'
|
|
6521
|
+
default: created_on
|
|
6522
|
+
- in: query
|
|
6523
|
+
name: sort_order
|
|
6524
|
+
required: false
|
|
6525
|
+
schema:
|
|
6526
|
+
$ref: '#/components/schemas/SortOrder'
|
|
6527
|
+
default: desc
|
|
6528
|
+
- in: query
|
|
6529
|
+
name: dnssec_status
|
|
6530
|
+
required: false
|
|
6531
|
+
schema:
|
|
6532
|
+
anyOf:
|
|
6533
|
+
- $ref: '#/components/schemas/DnssecStatus'
|
|
6534
|
+
- type: 'null'
|
|
6535
|
+
title: Dnssec Status
|
|
6536
|
+
- in: query
|
|
6537
|
+
name: name
|
|
6538
|
+
required: false
|
|
6539
|
+
schema:
|
|
6540
|
+
anyOf:
|
|
6541
|
+
- type: string
|
|
6542
|
+
- type: 'null'
|
|
6543
|
+
title: Name
|
|
6544
|
+
- in: query
|
|
6545
|
+
name: search
|
|
6546
|
+
required: false
|
|
6547
|
+
schema:
|
|
6548
|
+
anyOf:
|
|
6549
|
+
- type: string
|
|
6550
|
+
- type: 'null'
|
|
6551
|
+
title: Search
|
|
6552
|
+
- in: query
|
|
6553
|
+
name: suffix
|
|
6554
|
+
required: false
|
|
6555
|
+
schema:
|
|
6556
|
+
anyOf:
|
|
6557
|
+
- type: string
|
|
6558
|
+
- type: 'null'
|
|
6559
|
+
title: Suffix
|
|
6560
|
+
- in: query
|
|
6561
|
+
name: created_after
|
|
6562
|
+
required: false
|
|
6563
|
+
schema:
|
|
6564
|
+
anyOf:
|
|
6565
|
+
- format: date-time
|
|
6566
|
+
type: string
|
|
6567
|
+
- type: 'null'
|
|
6568
|
+
title: Created After
|
|
6569
|
+
- in: query
|
|
6570
|
+
name: created_before
|
|
6571
|
+
required: false
|
|
6572
|
+
schema:
|
|
6573
|
+
anyOf:
|
|
6574
|
+
- format: date-time
|
|
6575
|
+
type: string
|
|
6576
|
+
- type: 'null'
|
|
6577
|
+
title: Created Before
|
|
6578
|
+
- in: query
|
|
6579
|
+
name: updated_after
|
|
6580
|
+
required: false
|
|
6581
|
+
schema:
|
|
6582
|
+
anyOf:
|
|
6583
|
+
- format: date-time
|
|
6584
|
+
type: string
|
|
6585
|
+
- type: 'null'
|
|
6586
|
+
title: Updated After
|
|
6587
|
+
- in: query
|
|
6588
|
+
name: updated_before
|
|
6589
|
+
required: false
|
|
6590
|
+
schema:
|
|
6591
|
+
anyOf:
|
|
6592
|
+
- format: date-time
|
|
6593
|
+
type: string
|
|
6594
|
+
- type: 'null'
|
|
6595
|
+
title: Updated Before
|
|
6596
|
+
- in: query
|
|
6597
|
+
name: page
|
|
6598
|
+
required: false
|
|
6599
|
+
schema:
|
|
6600
|
+
default: 1
|
|
6601
|
+
minimum: 1
|
|
6602
|
+
title: Page
|
|
6603
|
+
type: integer
|
|
6604
|
+
- in: query
|
|
6605
|
+
name: page_size
|
|
6606
|
+
required: false
|
|
6607
|
+
schema:
|
|
6608
|
+
default: 10
|
|
6609
|
+
maximum: 100
|
|
6610
|
+
minimum: 1
|
|
6611
|
+
title: Page Size
|
|
6612
|
+
type: integer
|
|
6613
|
+
responses:
|
|
6614
|
+
'200':
|
|
6615
|
+
content:
|
|
6616
|
+
application/json:
|
|
6617
|
+
schema:
|
|
6618
|
+
$ref: '#/components/schemas/Pagination_DomainForwardZone_'
|
|
6619
|
+
description: Successful Response
|
|
6620
|
+
'401':
|
|
6621
|
+
content:
|
|
6622
|
+
application/problem+json:
|
|
6623
|
+
example:
|
|
6624
|
+
code: ERROR_AUTHENTICATION
|
|
6625
|
+
detail: Additional error context.
|
|
6626
|
+
status: 401
|
|
6627
|
+
title: Authentication Error
|
|
6628
|
+
type: authentication
|
|
6629
|
+
schema:
|
|
6630
|
+
$ref: '#/components/schemas/Problem'
|
|
6631
|
+
description: Unauthorized
|
|
6632
|
+
'403':
|
|
6633
|
+
content:
|
|
6634
|
+
application/problem+json:
|
|
6635
|
+
example:
|
|
6636
|
+
code: ERROR_PERMISSION_DENIED
|
|
6637
|
+
detail: Insufficient permissions to perform this action
|
|
6638
|
+
status: 403
|
|
6639
|
+
title: Permission Denied
|
|
6640
|
+
type: permission-denied
|
|
6641
|
+
schema:
|
|
6642
|
+
$ref: '#/components/schemas/Problem'
|
|
6643
|
+
description: Forbidden
|
|
6644
|
+
'422':
|
|
6645
|
+
content:
|
|
6646
|
+
application/problem+json:
|
|
6647
|
+
schema:
|
|
6648
|
+
$ref: '#/components/schemas/HTTPValidationError'
|
|
6649
|
+
description: Validation Error
|
|
6650
|
+
security:
|
|
6651
|
+
- OAuth2PasswordBearer: []
|
|
6652
|
+
summary: List domain forwards by zone
|
|
6653
|
+
tags:
|
|
6654
|
+
- dns
|
|
6655
|
+
/v1/dns/summary:
|
|
6656
|
+
get:
|
|
6657
|
+
operationId: get_zones_summary_v1_dns_summary_get
|
|
6658
|
+
responses:
|
|
6659
|
+
'200':
|
|
6660
|
+
content:
|
|
6661
|
+
application/json:
|
|
6662
|
+
schema:
|
|
6663
|
+
$ref: '#/components/schemas/DnsZoneSummary'
|
|
6664
|
+
description: Successful Response
|
|
6665
|
+
security:
|
|
6666
|
+
- OAuth2PasswordBearer: []
|
|
6667
|
+
summary: Get Zones Summary
|
|
6668
|
+
tags:
|
|
6669
|
+
- dns
|
|
6670
|
+
/v1/dns/{zone_name}:
|
|
6671
|
+
delete:
|
|
6672
|
+
operationId: delete_zone_v1_dns__zone_name__delete
|
|
6673
|
+
parameters:
|
|
6674
|
+
- description: DNS zone name (trailing dot optional)
|
|
6675
|
+
in: path
|
|
6676
|
+
name: zone_name
|
|
6677
|
+
required: true
|
|
6678
|
+
schema:
|
|
6679
|
+
description: DNS zone name (trailing dot optional)
|
|
6680
|
+
title: Zone Name
|
|
6681
|
+
type: string
|
|
6682
|
+
responses:
|
|
6683
|
+
'204':
|
|
6684
|
+
description: Successful Response
|
|
6685
|
+
'422':
|
|
6686
|
+
content:
|
|
6687
|
+
application/problem+json:
|
|
6688
|
+
schema:
|
|
6689
|
+
$ref: '#/components/schemas/HTTPValidationError'
|
|
6690
|
+
description: Validation Error
|
|
6691
|
+
security:
|
|
6692
|
+
- OAuth2PasswordBearer: []
|
|
6693
|
+
summary: Delete Zone
|
|
6694
|
+
tags:
|
|
6371
6695
|
- dns
|
|
6372
6696
|
get:
|
|
6373
6697
|
operationId: get_zone_v1_dns__zone_name__get
|
|
@@ -6458,6 +6782,62 @@ paths:
|
|
|
6458
6782
|
summary: Enable Dnssec
|
|
6459
6783
|
tags:
|
|
6460
6784
|
- dns
|
|
6785
|
+
/v1/dns/{zone_name}/domain-forwards:
|
|
6786
|
+
get:
|
|
6787
|
+
description: Retrieves all domain forwards configured for the specified DNS
|
|
6788
|
+
zone, including subdomains.
|
|
6789
|
+
operationId: list_zone_domain_forwards_v1_dns__zone_name__domain_forwards_get
|
|
6790
|
+
parameters:
|
|
6791
|
+
- description: DNS zone name (trailing dot optional)
|
|
6792
|
+
in: path
|
|
6793
|
+
name: zone_name
|
|
6794
|
+
required: true
|
|
6795
|
+
schema:
|
|
6796
|
+
description: DNS zone name (trailing dot optional)
|
|
6797
|
+
title: Zone Name
|
|
6798
|
+
type: string
|
|
6799
|
+
responses:
|
|
6800
|
+
'200':
|
|
6801
|
+
content:
|
|
6802
|
+
application/json:
|
|
6803
|
+
schema:
|
|
6804
|
+
$ref: '#/components/schemas/DomainForwardZone'
|
|
6805
|
+
description: Successful Response
|
|
6806
|
+
'401':
|
|
6807
|
+
content:
|
|
6808
|
+
application/problem+json:
|
|
6809
|
+
example:
|
|
6810
|
+
code: ERROR_AUTHENTICATION
|
|
6811
|
+
detail: Additional error context.
|
|
6812
|
+
status: 401
|
|
6813
|
+
title: Authentication Error
|
|
6814
|
+
type: authentication
|
|
6815
|
+
schema:
|
|
6816
|
+
$ref: '#/components/schemas/Problem'
|
|
6817
|
+
description: Unauthorized
|
|
6818
|
+
'403':
|
|
6819
|
+
content:
|
|
6820
|
+
application/problem+json:
|
|
6821
|
+
example:
|
|
6822
|
+
code: ERROR_PERMISSION_DENIED
|
|
6823
|
+
detail: Insufficient permissions to perform this action
|
|
6824
|
+
status: 403
|
|
6825
|
+
title: Permission Denied
|
|
6826
|
+
type: permission-denied
|
|
6827
|
+
schema:
|
|
6828
|
+
$ref: '#/components/schemas/Problem'
|
|
6829
|
+
description: Forbidden
|
|
6830
|
+
'422':
|
|
6831
|
+
content:
|
|
6832
|
+
application/problem+json:
|
|
6833
|
+
schema:
|
|
6834
|
+
$ref: '#/components/schemas/HTTPValidationError'
|
|
6835
|
+
description: Validation Error
|
|
6836
|
+
security:
|
|
6837
|
+
- OAuth2PasswordBearer: []
|
|
6838
|
+
summary: List domain forwards for a zone
|
|
6839
|
+
tags:
|
|
6840
|
+
- dns
|
|
6461
6841
|
/v1/dns/{zone_name}/records:
|
|
6462
6842
|
patch:
|
|
6463
6843
|
operationId: patch_zone_records_v1_dns__zone_name__records_patch
|
|
@@ -6591,6 +6971,7 @@ paths:
|
|
|
6591
6971
|
- dns
|
|
6592
6972
|
/v1/domain-forwards:
|
|
6593
6973
|
get:
|
|
6974
|
+
description: Retrieves a paginated list of domain forwards for the organization
|
|
6594
6975
|
operationId: list_domain_forwards_v1_domain_forwards_get
|
|
6595
6976
|
parameters:
|
|
6596
6977
|
- in: query
|
|
@@ -6695,8 +7076,32 @@ paths:
|
|
|
6695
7076
|
content:
|
|
6696
7077
|
application/json:
|
|
6697
7078
|
schema:
|
|
6698
|
-
$ref: '#/components/schemas/
|
|
7079
|
+
$ref: '#/components/schemas/Pagination_DomainForward_'
|
|
6699
7080
|
description: Successful Response
|
|
7081
|
+
'401':
|
|
7082
|
+
content:
|
|
7083
|
+
application/problem+json:
|
|
7084
|
+
example:
|
|
7085
|
+
code: ERROR_AUTHENTICATION
|
|
7086
|
+
detail: Additional error context.
|
|
7087
|
+
status: 401
|
|
7088
|
+
title: Authentication Error
|
|
7089
|
+
type: authentication
|
|
7090
|
+
schema:
|
|
7091
|
+
$ref: '#/components/schemas/Problem'
|
|
7092
|
+
description: Unauthorized
|
|
7093
|
+
'403':
|
|
7094
|
+
content:
|
|
7095
|
+
application/problem+json:
|
|
7096
|
+
example:
|
|
7097
|
+
code: ERROR_PERMISSION_DENIED
|
|
7098
|
+
detail: Insufficient permissions to perform this action
|
|
7099
|
+
status: 403
|
|
7100
|
+
title: Permission Denied
|
|
7101
|
+
type: permission-denied
|
|
7102
|
+
schema:
|
|
7103
|
+
$ref: '#/components/schemas/Problem'
|
|
7104
|
+
description: Forbidden
|
|
6700
7105
|
'422':
|
|
6701
7106
|
content:
|
|
6702
7107
|
application/problem+json:
|
|
@@ -6705,10 +7110,13 @@ paths:
|
|
|
6705
7110
|
description: Validation Error
|
|
6706
7111
|
security:
|
|
6707
7112
|
- OAuth2PasswordBearer: []
|
|
6708
|
-
summary: List
|
|
7113
|
+
summary: List domain forwards
|
|
6709
7114
|
tags:
|
|
6710
7115
|
- domain_forward
|
|
6711
7116
|
patch:
|
|
7117
|
+
description: Applies patch operations to update or remove redirects across hostnames
|
|
7118
|
+
and protocols. Raises an error if the domain forward or domain forward set
|
|
7119
|
+
does not exist.
|
|
6712
7120
|
operationId: patch_redirects_v1_domain_forwards_patch
|
|
6713
7121
|
requestBody:
|
|
6714
7122
|
content:
|
|
@@ -6719,16 +7127,169 @@ paths:
|
|
|
6719
7127
|
responses:
|
|
6720
7128
|
'204':
|
|
6721
7129
|
description: Successful Response
|
|
6722
|
-
'
|
|
7130
|
+
'401':
|
|
6723
7131
|
content:
|
|
6724
7132
|
application/problem+json:
|
|
6725
7133
|
example:
|
|
6726
|
-
code:
|
|
6727
|
-
detail:
|
|
6728
|
-
status:
|
|
6729
|
-
title:
|
|
6730
|
-
type:
|
|
6731
|
-
schema:
|
|
7134
|
+
code: ERROR_AUTHENTICATION
|
|
7135
|
+
detail: Additional error context.
|
|
7136
|
+
status: 401
|
|
7137
|
+
title: Authentication Error
|
|
7138
|
+
type: authentication
|
|
7139
|
+
schema:
|
|
7140
|
+
$ref: '#/components/schemas/Problem'
|
|
7141
|
+
description: Unauthorized
|
|
7142
|
+
'403':
|
|
7143
|
+
content:
|
|
7144
|
+
application/problem+json:
|
|
7145
|
+
example:
|
|
7146
|
+
code: ERROR_PERMISSION_DENIED
|
|
7147
|
+
detail: Insufficient permissions to perform this action
|
|
7148
|
+
status: 403
|
|
7149
|
+
title: Permission Denied
|
|
7150
|
+
type: permission-denied
|
|
7151
|
+
schema:
|
|
7152
|
+
$ref: '#/components/schemas/Problem'
|
|
7153
|
+
description: Forbidden
|
|
7154
|
+
'404':
|
|
7155
|
+
content:
|
|
7156
|
+
application/problem+json:
|
|
7157
|
+
example:
|
|
7158
|
+
code: ERROR_DOMAIN_FORWARD_NOT_EXISTS
|
|
7159
|
+
detail: Domain forward not found for Additional error context.
|
|
7160
|
+
status: 404
|
|
7161
|
+
title: Domain Forward Error
|
|
7162
|
+
type: domain-forward-not-found
|
|
7163
|
+
schema:
|
|
7164
|
+
$ref: '#/components/schemas/Problem'
|
|
7165
|
+
description: Not Found
|
|
7166
|
+
'422':
|
|
7167
|
+
content:
|
|
7168
|
+
application/problem+json:
|
|
7169
|
+
schema:
|
|
7170
|
+
$ref: '#/components/schemas/HTTPValidationError'
|
|
7171
|
+
description: Validation Error
|
|
7172
|
+
security:
|
|
7173
|
+
- OAuth2PasswordBearer: []
|
|
7174
|
+
summary: Patch domain forward redirects
|
|
7175
|
+
tags:
|
|
7176
|
+
- domain_forward
|
|
7177
|
+
/v1/domain-forwards/{hostname}:
|
|
7178
|
+
delete:
|
|
7179
|
+
description: Deletes the domain forward configuration for the specified hostname
|
|
7180
|
+
operationId: delete_domain_forward_v1_domain_forwards__hostname__delete
|
|
7181
|
+
parameters:
|
|
7182
|
+
- description: Hostname (trailing dot optional)
|
|
7183
|
+
in: path
|
|
7184
|
+
name: hostname
|
|
7185
|
+
required: true
|
|
7186
|
+
schema:
|
|
7187
|
+
description: Hostname (trailing dot optional)
|
|
7188
|
+
title: Hostname
|
|
7189
|
+
type: string
|
|
7190
|
+
responses:
|
|
7191
|
+
'204':
|
|
7192
|
+
description: Successful Response
|
|
7193
|
+
'401':
|
|
7194
|
+
content:
|
|
7195
|
+
application/problem+json:
|
|
7196
|
+
example:
|
|
7197
|
+
code: ERROR_AUTHENTICATION
|
|
7198
|
+
detail: Additional error context.
|
|
7199
|
+
status: 401
|
|
7200
|
+
title: Authentication Error
|
|
7201
|
+
type: authentication
|
|
7202
|
+
schema:
|
|
7203
|
+
$ref: '#/components/schemas/Problem'
|
|
7204
|
+
description: Unauthorized
|
|
7205
|
+
'403':
|
|
7206
|
+
content:
|
|
7207
|
+
application/problem+json:
|
|
7208
|
+
example:
|
|
7209
|
+
code: ERROR_PERMISSION_DENIED
|
|
7210
|
+
detail: Insufficient permissions to perform this action
|
|
7211
|
+
status: 403
|
|
7212
|
+
title: Permission Denied
|
|
7213
|
+
type: permission-denied
|
|
7214
|
+
schema:
|
|
7215
|
+
$ref: '#/components/schemas/Problem'
|
|
7216
|
+
description: Forbidden
|
|
7217
|
+
'404':
|
|
7218
|
+
content:
|
|
7219
|
+
application/problem+json:
|
|
7220
|
+
example:
|
|
7221
|
+
code: ERROR_DOMAIN_FORWARD_NOT_EXISTS
|
|
7222
|
+
detail: Domain forward not found for Additional error context.
|
|
7223
|
+
status: 404
|
|
7224
|
+
title: Domain Forward Error
|
|
7225
|
+
type: domain-forward-not-found
|
|
7226
|
+
schema:
|
|
7227
|
+
$ref: '#/components/schemas/Problem'
|
|
7228
|
+
description: Not Found
|
|
7229
|
+
'422':
|
|
7230
|
+
content:
|
|
7231
|
+
application/problem+json:
|
|
7232
|
+
schema:
|
|
7233
|
+
$ref: '#/components/schemas/HTTPValidationError'
|
|
7234
|
+
description: Validation Error
|
|
7235
|
+
security:
|
|
7236
|
+
- OAuth2PasswordBearer: []
|
|
7237
|
+
summary: Delete a domain forward
|
|
7238
|
+
tags:
|
|
7239
|
+
- domain_forward
|
|
7240
|
+
get:
|
|
7241
|
+
description: Retrieves the domain forward configuration for the specified hostname
|
|
7242
|
+
operationId: get_domain_forward_v1_domain_forwards__hostname__get
|
|
7243
|
+
parameters:
|
|
7244
|
+
- description: Hostname (trailing dot optional)
|
|
7245
|
+
in: path
|
|
7246
|
+
name: hostname
|
|
7247
|
+
required: true
|
|
7248
|
+
schema:
|
|
7249
|
+
description: Hostname (trailing dot optional)
|
|
7250
|
+
title: Hostname
|
|
7251
|
+
type: string
|
|
7252
|
+
responses:
|
|
7253
|
+
'200':
|
|
7254
|
+
content:
|
|
7255
|
+
application/json:
|
|
7256
|
+
schema:
|
|
7257
|
+
$ref: '#/components/schemas/DomainForward'
|
|
7258
|
+
description: Successful Response
|
|
7259
|
+
'401':
|
|
7260
|
+
content:
|
|
7261
|
+
application/problem+json:
|
|
7262
|
+
example:
|
|
7263
|
+
code: ERROR_AUTHENTICATION
|
|
7264
|
+
detail: Additional error context.
|
|
7265
|
+
status: 401
|
|
7266
|
+
title: Authentication Error
|
|
7267
|
+
type: authentication
|
|
7268
|
+
schema:
|
|
7269
|
+
$ref: '#/components/schemas/Problem'
|
|
7270
|
+
description: Unauthorized
|
|
7271
|
+
'403':
|
|
7272
|
+
content:
|
|
7273
|
+
application/problem+json:
|
|
7274
|
+
example:
|
|
7275
|
+
code: ERROR_PERMISSION_DENIED
|
|
7276
|
+
detail: Insufficient permissions to perform this action
|
|
7277
|
+
status: 403
|
|
7278
|
+
title: Permission Denied
|
|
7279
|
+
type: permission-denied
|
|
7280
|
+
schema:
|
|
7281
|
+
$ref: '#/components/schemas/Problem'
|
|
7282
|
+
description: Forbidden
|
|
7283
|
+
'404':
|
|
7284
|
+
content:
|
|
7285
|
+
application/problem+json:
|
|
7286
|
+
example:
|
|
7287
|
+
code: ERROR_DOMAIN_FORWARD_NOT_EXISTS
|
|
7288
|
+
detail: Domain forward not found for Additional error context.
|
|
7289
|
+
status: 404
|
|
7290
|
+
title: Domain Forward Error
|
|
7291
|
+
type: domain-forward-not-found
|
|
7292
|
+
schema:
|
|
6732
7293
|
$ref: '#/components/schemas/Problem'
|
|
6733
7294
|
description: Not Found
|
|
6734
7295
|
'422':
|
|
@@ -6739,24 +7300,122 @@ paths:
|
|
|
6739
7300
|
description: Validation Error
|
|
6740
7301
|
security:
|
|
6741
7302
|
- OAuth2PasswordBearer: []
|
|
6742
|
-
summary:
|
|
7303
|
+
summary: Get a domain forward
|
|
7304
|
+
tags:
|
|
7305
|
+
- domain_forward
|
|
7306
|
+
post:
|
|
7307
|
+
description: Creates a new domain forward configuration for the specified hostname
|
|
7308
|
+
operationId: create_domain_forward_v1_domain_forwards__hostname__post
|
|
7309
|
+
parameters:
|
|
7310
|
+
- description: Hostname (trailing dot optional)
|
|
7311
|
+
in: path
|
|
7312
|
+
name: hostname
|
|
7313
|
+
required: true
|
|
7314
|
+
schema:
|
|
7315
|
+
description: Hostname (trailing dot optional)
|
|
7316
|
+
title: Hostname
|
|
7317
|
+
type: string
|
|
7318
|
+
requestBody:
|
|
7319
|
+
content:
|
|
7320
|
+
application/json:
|
|
7321
|
+
schema:
|
|
7322
|
+
$ref: '#/components/schemas/DomainForwardRequest'
|
|
7323
|
+
required: true
|
|
7324
|
+
responses:
|
|
7325
|
+
'201':
|
|
7326
|
+
content:
|
|
7327
|
+
application/json:
|
|
7328
|
+
schema:
|
|
7329
|
+
$ref: '#/components/schemas/DomainForward'
|
|
7330
|
+
description: Successful Response
|
|
7331
|
+
'401':
|
|
7332
|
+
content:
|
|
7333
|
+
application/problem+json:
|
|
7334
|
+
example:
|
|
7335
|
+
code: ERROR_AUTHENTICATION
|
|
7336
|
+
detail: Additional error context.
|
|
7337
|
+
status: 401
|
|
7338
|
+
title: Authentication Error
|
|
7339
|
+
type: authentication
|
|
7340
|
+
schema:
|
|
7341
|
+
$ref: '#/components/schemas/Problem'
|
|
7342
|
+
description: Unauthorized
|
|
7343
|
+
'403':
|
|
7344
|
+
content:
|
|
7345
|
+
application/problem+json:
|
|
7346
|
+
example:
|
|
7347
|
+
code: ERROR_PERMISSION_DENIED
|
|
7348
|
+
detail: Insufficient permissions to perform this action
|
|
7349
|
+
status: 403
|
|
7350
|
+
title: Permission Denied
|
|
7351
|
+
type: permission-denied
|
|
7352
|
+
schema:
|
|
7353
|
+
$ref: '#/components/schemas/Problem'
|
|
7354
|
+
description: Forbidden
|
|
7355
|
+
'409':
|
|
7356
|
+
content:
|
|
7357
|
+
application/problem+json:
|
|
7358
|
+
example:
|
|
7359
|
+
code: ERROR_DOMAIN_FORWARD_ALREADY_EXISTS
|
|
7360
|
+
detail: Domain forward already exists for Additional error context.
|
|
7361
|
+
status: 409
|
|
7362
|
+
title: Domain Forward Error
|
|
7363
|
+
type: domain-forward-already-exists
|
|
7364
|
+
schema:
|
|
7365
|
+
$ref: '#/components/schemas/Problem'
|
|
7366
|
+
description: Conflict
|
|
7367
|
+
'422':
|
|
7368
|
+
content:
|
|
7369
|
+
application/problem+json:
|
|
7370
|
+
schema:
|
|
7371
|
+
$ref: '#/components/schemas/HTTPValidationError'
|
|
7372
|
+
description: Validation Error
|
|
7373
|
+
security:
|
|
7374
|
+
- OAuth2PasswordBearer: []
|
|
7375
|
+
summary: Create a domain forward
|
|
6743
7376
|
tags:
|
|
6744
7377
|
- domain_forward
|
|
6745
|
-
/v1/domain-forwards/{
|
|
7378
|
+
/v1/domain-forwards/{hostname}/disable:
|
|
6746
7379
|
patch:
|
|
6747
|
-
|
|
7380
|
+
description: Disables domain forwarding by removing DNS records. The domain
|
|
7381
|
+
forward configuration is preserved but disabled.
|
|
7382
|
+
operationId: disable_domain_forward_v1_domain_forwards__hostname__disable_patch
|
|
6748
7383
|
parameters:
|
|
6749
|
-
- description:
|
|
7384
|
+
- description: Hostname (trailing dot optional)
|
|
6750
7385
|
in: path
|
|
6751
|
-
name:
|
|
7386
|
+
name: hostname
|
|
6752
7387
|
required: true
|
|
6753
7388
|
schema:
|
|
6754
|
-
description:
|
|
6755
|
-
title:
|
|
7389
|
+
description: Hostname (trailing dot optional)
|
|
7390
|
+
title: Hostname
|
|
6756
7391
|
type: string
|
|
6757
7392
|
responses:
|
|
6758
7393
|
'204':
|
|
6759
7394
|
description: Successful Response
|
|
7395
|
+
'401':
|
|
7396
|
+
content:
|
|
7397
|
+
application/problem+json:
|
|
7398
|
+
example:
|
|
7399
|
+
code: ERROR_AUTHENTICATION
|
|
7400
|
+
detail: Additional error context.
|
|
7401
|
+
status: 401
|
|
7402
|
+
title: Authentication Error
|
|
7403
|
+
type: authentication
|
|
7404
|
+
schema:
|
|
7405
|
+
$ref: '#/components/schemas/Problem'
|
|
7406
|
+
description: Unauthorized
|
|
7407
|
+
'403':
|
|
7408
|
+
content:
|
|
7409
|
+
application/problem+json:
|
|
7410
|
+
example:
|
|
7411
|
+
code: ERROR_PERMISSION_DENIED
|
|
7412
|
+
detail: Insufficient permissions to perform this action
|
|
7413
|
+
status: 403
|
|
7414
|
+
title: Permission Denied
|
|
7415
|
+
type: permission-denied
|
|
7416
|
+
schema:
|
|
7417
|
+
$ref: '#/components/schemas/Problem'
|
|
7418
|
+
description: Forbidden
|
|
6760
7419
|
'422':
|
|
6761
7420
|
content:
|
|
6762
7421
|
application/problem+json:
|
|
@@ -6765,20 +7424,22 @@ paths:
|
|
|
6765
7424
|
description: Validation Error
|
|
6766
7425
|
security:
|
|
6767
7426
|
- OAuth2PasswordBearer: []
|
|
6768
|
-
summary: Disable
|
|
7427
|
+
summary: Disable domain forward
|
|
6769
7428
|
tags:
|
|
6770
7429
|
- domain_forward
|
|
6771
|
-
/v1/domain-forwards/{
|
|
7430
|
+
/v1/domain-forwards/{hostname}/enable:
|
|
6772
7431
|
patch:
|
|
6773
|
-
|
|
7432
|
+
description: Enables domain forwarding by creating necessary DNS records. Optionally
|
|
7433
|
+
auto-creates the zone and domain forward if they don't exist.
|
|
7434
|
+
operationId: enable_domain_forward_v1_domain_forwards__hostname__enable_patch
|
|
6774
7435
|
parameters:
|
|
6775
|
-
- description:
|
|
7436
|
+
- description: Hostname (trailing dot optional)
|
|
6776
7437
|
in: path
|
|
6777
|
-
name:
|
|
7438
|
+
name: hostname
|
|
6778
7439
|
required: true
|
|
6779
7440
|
schema:
|
|
6780
|
-
description:
|
|
6781
|
-
title:
|
|
7441
|
+
description: Hostname (trailing dot optional)
|
|
7442
|
+
title: Hostname
|
|
6782
7443
|
type: string
|
|
6783
7444
|
- description: Auto create zone if it doesn't exist
|
|
6784
7445
|
in: query
|
|
@@ -6789,6 +7450,15 @@ paths:
|
|
|
6789
7450
|
description: Auto create zone if it doesn't exist
|
|
6790
7451
|
title: Auto Create Zone
|
|
6791
7452
|
type: boolean
|
|
7453
|
+
- description: Auto create domain forward if it doesn't exist
|
|
7454
|
+
in: query
|
|
7455
|
+
name: auto_create_domain_forward
|
|
7456
|
+
required: false
|
|
7457
|
+
schema:
|
|
7458
|
+
default: false
|
|
7459
|
+
description: Auto create domain forward if it doesn't exist
|
|
7460
|
+
title: Auto Create Domain Forward
|
|
7461
|
+
type: boolean
|
|
6792
7462
|
- description: Wildcard domain forwarding
|
|
6793
7463
|
in: query
|
|
6794
7464
|
name: wildcard
|
|
@@ -6801,6 +7471,42 @@ paths:
|
|
|
6801
7471
|
responses:
|
|
6802
7472
|
'204':
|
|
6803
7473
|
description: Successful Response
|
|
7474
|
+
'400':
|
|
7475
|
+
content:
|
|
7476
|
+
application/problem+json:
|
|
7477
|
+
example:
|
|
7478
|
+
code: ERROR_DOMAIN_FORWARD_WILDCARD_NOT_SUPPORTED
|
|
7479
|
+
detail: Additional error context.
|
|
7480
|
+
status: 400
|
|
7481
|
+
title: Wildcard Not Supported
|
|
7482
|
+
type: domain-forward-wildcard-not-supported
|
|
7483
|
+
schema:
|
|
7484
|
+
$ref: '#/components/schemas/Problem'
|
|
7485
|
+
description: Bad Request
|
|
7486
|
+
'401':
|
|
7487
|
+
content:
|
|
7488
|
+
application/problem+json:
|
|
7489
|
+
example:
|
|
7490
|
+
code: ERROR_AUTHENTICATION
|
|
7491
|
+
detail: Additional error context.
|
|
7492
|
+
status: 401
|
|
7493
|
+
title: Authentication Error
|
|
7494
|
+
type: authentication
|
|
7495
|
+
schema:
|
|
7496
|
+
$ref: '#/components/schemas/Problem'
|
|
7497
|
+
description: Unauthorized
|
|
7498
|
+
'403':
|
|
7499
|
+
content:
|
|
7500
|
+
application/problem+json:
|
|
7501
|
+
example:
|
|
7502
|
+
code: ERROR_PERMISSION_DENIED
|
|
7503
|
+
detail: Insufficient permissions to perform this action
|
|
7504
|
+
status: 403
|
|
7505
|
+
title: Permission Denied
|
|
7506
|
+
type: permission-denied
|
|
7507
|
+
schema:
|
|
7508
|
+
$ref: '#/components/schemas/Problem'
|
|
7509
|
+
description: Forbidden
|
|
6804
7510
|
'422':
|
|
6805
7511
|
content:
|
|
6806
7512
|
application/problem+json:
|
|
@@ -6809,35 +7515,60 @@ paths:
|
|
|
6809
7515
|
description: Validation Error
|
|
6810
7516
|
security:
|
|
6811
7517
|
- OAuth2PasswordBearer: []
|
|
6812
|
-
summary: Enable
|
|
7518
|
+
summary: Enable domain forward
|
|
6813
7519
|
tags:
|
|
6814
7520
|
- domain_forward
|
|
6815
|
-
/v1/domain-forwards/{
|
|
7521
|
+
/v1/domain-forwards/{hostname}/{protocol}:
|
|
6816
7522
|
delete:
|
|
6817
|
-
|
|
7523
|
+
description: Deletes a domain forward set for a specific protocol (HTTP or HTTPS).
|
|
7524
|
+
operationId: delete_domain_forward_set_v1_domain_forwards__hostname___protocol__delete
|
|
6818
7525
|
parameters:
|
|
6819
7526
|
- in: path
|
|
6820
|
-
name:
|
|
7527
|
+
name: protocol
|
|
6821
7528
|
required: true
|
|
6822
7529
|
schema:
|
|
6823
7530
|
$ref: '#/components/schemas/HttpProtocol'
|
|
6824
|
-
- description:
|
|
7531
|
+
- description: Hostname (trailing dot optional)
|
|
6825
7532
|
in: path
|
|
6826
|
-
name:
|
|
7533
|
+
name: hostname
|
|
6827
7534
|
required: true
|
|
6828
7535
|
schema:
|
|
6829
|
-
description:
|
|
6830
|
-
title:
|
|
7536
|
+
description: Hostname (trailing dot optional)
|
|
7537
|
+
title: Hostname
|
|
6831
7538
|
type: string
|
|
6832
7539
|
responses:
|
|
6833
7540
|
'204':
|
|
6834
7541
|
description: Successful Response
|
|
7542
|
+
'401':
|
|
7543
|
+
content:
|
|
7544
|
+
application/problem+json:
|
|
7545
|
+
example:
|
|
7546
|
+
code: ERROR_AUTHENTICATION
|
|
7547
|
+
detail: Additional error context.
|
|
7548
|
+
status: 401
|
|
7549
|
+
title: Authentication Error
|
|
7550
|
+
type: authentication
|
|
7551
|
+
schema:
|
|
7552
|
+
$ref: '#/components/schemas/Problem'
|
|
7553
|
+
description: Unauthorized
|
|
7554
|
+
'403':
|
|
7555
|
+
content:
|
|
7556
|
+
application/problem+json:
|
|
7557
|
+
example:
|
|
7558
|
+
code: ERROR_PERMISSION_DENIED
|
|
7559
|
+
detail: Insufficient permissions to perform this action
|
|
7560
|
+
status: 403
|
|
7561
|
+
title: Permission Denied
|
|
7562
|
+
type: permission-denied
|
|
7563
|
+
schema:
|
|
7564
|
+
$ref: '#/components/schemas/Problem'
|
|
7565
|
+
description: Forbidden
|
|
6835
7566
|
'404':
|
|
6836
7567
|
content:
|
|
6837
7568
|
application/problem+json:
|
|
6838
7569
|
example:
|
|
6839
7570
|
code: ERROR_DOMAIN_FORWARD_NOT_EXISTS
|
|
6840
|
-
detail: Domain forward not found
|
|
7571
|
+
detail: Domain forward not found for Additional error context.
|
|
6841
7572
|
status: 404
|
|
6842
7573
|
title: Domain Forward Error
|
|
6843
7574
|
type: domain-forward-not-found
|
|
@@ -6852,32 +7583,70 @@ paths:
|
|
|
6852
7583
|
description: Validation Error
|
|
6853
7584
|
security:
|
|
6854
7585
|
- OAuth2PasswordBearer: []
|
|
6855
|
-
summary: Delete
|
|
7586
|
+
summary: Delete domain forward set
|
|
6856
7587
|
tags:
|
|
6857
7588
|
- domain_forward
|
|
6858
7589
|
get:
|
|
6859
|
-
|
|
7590
|
+
description: Retrieves all redirects for a specific protocol (HTTP or HTTPS)
|
|
7591
|
+
for the specified hostname
|
|
7592
|
+
operationId: get_domain_forward_set_v1_domain_forwards__hostname___protocol__get
|
|
6860
7593
|
parameters:
|
|
6861
7594
|
- in: path
|
|
6862
|
-
name:
|
|
7595
|
+
name: protocol
|
|
6863
7596
|
required: true
|
|
6864
7597
|
schema:
|
|
6865
7598
|
$ref: '#/components/schemas/HttpProtocol'
|
|
6866
|
-
- description:
|
|
7599
|
+
- description: Hostname (trailing dot optional)
|
|
6867
7600
|
in: path
|
|
6868
|
-
name:
|
|
7601
|
+
name: hostname
|
|
6869
7602
|
required: true
|
|
6870
7603
|
schema:
|
|
6871
|
-
description:
|
|
6872
|
-
title:
|
|
7604
|
+
description: Hostname (trailing dot optional)
|
|
7605
|
+
title: Hostname
|
|
6873
7606
|
type: string
|
|
6874
7607
|
responses:
|
|
6875
7608
|
'200':
|
|
6876
7609
|
content:
|
|
6877
7610
|
application/json:
|
|
6878
7611
|
schema:
|
|
6879
|
-
$ref: '#/components/schemas/
|
|
7612
|
+
$ref: '#/components/schemas/DomainForwardSetResponse'
|
|
6880
7613
|
description: Successful Response
|
|
7614
|
+
'401':
|
|
7615
|
+
content:
|
|
7616
|
+
application/problem+json:
|
|
7617
|
+
example:
|
|
7618
|
+
code: ERROR_AUTHENTICATION
|
|
7619
|
+
detail: Additional error context.
|
|
7620
|
+
status: 401
|
|
7621
|
+
title: Authentication Error
|
|
7622
|
+
type: authentication
|
|
7623
|
+
schema:
|
|
7624
|
+
$ref: '#/components/schemas/Problem'
|
|
7625
|
+
description: Unauthorized
|
|
7626
|
+
'403':
|
|
7627
|
+
content:
|
|
7628
|
+
application/problem+json:
|
|
7629
|
+
example:
|
|
7630
|
+
code: ERROR_PERMISSION_DENIED
|
|
7631
|
+
detail: Insufficient permissions to perform this action
|
|
7632
|
+
status: 403
|
|
7633
|
+
title: Permission Denied
|
|
7634
|
+
type: permission-denied
|
|
7635
|
+
schema:
|
|
7636
|
+
$ref: '#/components/schemas/Problem'
|
|
7637
|
+
description: Forbidden
|
|
7638
|
+
'404':
|
|
7639
|
+
content:
|
|
7640
|
+
application/problem+json:
|
|
7641
|
+
example:
|
|
7642
|
+
code: ERROR_DOMAIN_FORWARD_NOT_EXISTS
|
|
7643
|
+
detail: Domain forward not found for Additional error context.
|
|
7644
|
+
status: 404
|
|
7645
|
+
title: Domain Forward Error
|
|
7646
|
+
type: domain-forward-not-found
|
|
7647
|
+
schema:
|
|
7648
|
+
$ref: '#/components/schemas/Problem'
|
|
7649
|
+
description: Not Found
|
|
6881
7650
|
'422':
|
|
6882
7651
|
content:
|
|
6883
7652
|
application/problem+json:
|
|
@@ -6886,44 +7655,82 @@ paths:
|
|
|
6886
7655
|
description: Validation Error
|
|
6887
7656
|
security:
|
|
6888
7657
|
- OAuth2PasswordBearer: []
|
|
6889
|
-
summary: Get
|
|
7658
|
+
summary: Get domain forward set
|
|
6890
7659
|
tags:
|
|
6891
7660
|
- domain_forward
|
|
6892
7661
|
post:
|
|
6893
|
-
|
|
7662
|
+
description: Creates a new domain forward set for a specific protocol (HTTP
|
|
7663
|
+
or HTTPS). Raises an error if the set already exists.
|
|
7664
|
+
operationId: create_domain_forward_set_v1_domain_forwards__hostname___protocol__post
|
|
6894
7665
|
parameters:
|
|
6895
7666
|
- in: path
|
|
6896
|
-
name:
|
|
7667
|
+
name: protocol
|
|
6897
7668
|
required: true
|
|
6898
7669
|
schema:
|
|
6899
7670
|
$ref: '#/components/schemas/HttpProtocol'
|
|
6900
|
-
- description:
|
|
7671
|
+
- description: Hostname (trailing dot optional)
|
|
6901
7672
|
in: path
|
|
6902
|
-
name:
|
|
7673
|
+
name: hostname
|
|
6903
7674
|
required: true
|
|
6904
7675
|
schema:
|
|
6905
|
-
description:
|
|
6906
|
-
title:
|
|
7676
|
+
description: Hostname (trailing dot optional)
|
|
7677
|
+
title: Hostname
|
|
6907
7678
|
type: string
|
|
6908
7679
|
requestBody:
|
|
6909
7680
|
content:
|
|
6910
7681
|
application/json:
|
|
6911
7682
|
schema:
|
|
6912
|
-
$ref: '#/components/schemas/
|
|
7683
|
+
$ref: '#/components/schemas/DomainForwardSetRequest'
|
|
6913
7684
|
required: true
|
|
6914
7685
|
responses:
|
|
6915
7686
|
'201':
|
|
6916
7687
|
content:
|
|
6917
7688
|
application/json:
|
|
6918
7689
|
schema:
|
|
6919
|
-
$ref: '#/components/schemas/
|
|
7690
|
+
$ref: '#/components/schemas/DomainForwardSetResponse'
|
|
6920
7691
|
description: Successful Response
|
|
7692
|
+
'401':
|
|
7693
|
+
content:
|
|
7694
|
+
application/problem+json:
|
|
7695
|
+
example:
|
|
7696
|
+
code: ERROR_AUTHENTICATION
|
|
7697
|
+
detail: Additional error context.
|
|
7698
|
+
status: 401
|
|
7699
|
+
title: Authentication Error
|
|
7700
|
+
type: authentication
|
|
7701
|
+
schema:
|
|
7702
|
+
$ref: '#/components/schemas/Problem'
|
|
7703
|
+
description: Unauthorized
|
|
7704
|
+
'403':
|
|
7705
|
+
content:
|
|
7706
|
+
application/problem+json:
|
|
7707
|
+
example:
|
|
7708
|
+
code: ERROR_PERMISSION_DENIED
|
|
7709
|
+
detail: Insufficient permissions to perform this action
|
|
7710
|
+
status: 403
|
|
7711
|
+
title: Permission Denied
|
|
7712
|
+
type: permission-denied
|
|
7713
|
+
schema:
|
|
7714
|
+
$ref: '#/components/schemas/Problem'
|
|
7715
|
+
description: Forbidden
|
|
7716
|
+
'404':
|
|
7717
|
+
content:
|
|
7718
|
+
application/problem+json:
|
|
7719
|
+
example:
|
|
7720
|
+
code: ERROR_DOMAIN_FORWARD_NOT_EXISTS
|
|
7721
|
+
detail: Domain forward not found for Additional error context.
|
|
7722
|
+
status: 404
|
|
7723
|
+
title: Domain Forward Error
|
|
7724
|
+
type: domain-forward-not-found
|
|
7725
|
+
schema:
|
|
7726
|
+
$ref: '#/components/schemas/Problem'
|
|
7727
|
+
description: Not Found
|
|
6921
7728
|
'409':
|
|
6922
7729
|
content:
|
|
6923
7730
|
application/problem+json:
|
|
6924
7731
|
example:
|
|
6925
7732
|
code: ERROR_DOMAIN_FORWARD_ALREADY_EXISTS
|
|
6926
|
-
detail: Domain forward already exists
|
|
7733
|
+
detail: Domain forward already exists for Additional error context.
|
|
6927
7734
|
status: 409
|
|
6928
7735
|
title: Domain Forward Error
|
|
6929
7736
|
type: domain-forward-already-exists
|
|
@@ -6938,44 +7745,71 @@ paths:
|
|
|
6938
7745
|
description: Validation Error
|
|
6939
7746
|
security:
|
|
6940
7747
|
- OAuth2PasswordBearer: []
|
|
6941
|
-
summary: Create
|
|
7748
|
+
summary: Create domain forward set
|
|
6942
7749
|
tags:
|
|
6943
7750
|
- domain_forward
|
|
6944
7751
|
put:
|
|
6945
|
-
|
|
7752
|
+
description: Updates an existing domain forward set for a specific protocol
|
|
7753
|
+
(HTTP or HTTPS). All existing redirects for this protocol are replaced with
|
|
7754
|
+
the provided redirects. Raises an error if the set does not exist.
|
|
7755
|
+
operationId: update_domain_forward_set_v1_domain_forwards__hostname___protocol__put
|
|
6946
7756
|
parameters:
|
|
6947
7757
|
- in: path
|
|
6948
|
-
name:
|
|
7758
|
+
name: protocol
|
|
6949
7759
|
required: true
|
|
6950
7760
|
schema:
|
|
6951
7761
|
$ref: '#/components/schemas/HttpProtocol'
|
|
6952
|
-
- description:
|
|
7762
|
+
- description: Hostname (trailing dot optional)
|
|
6953
7763
|
in: path
|
|
6954
|
-
name:
|
|
7764
|
+
name: hostname
|
|
6955
7765
|
required: true
|
|
6956
7766
|
schema:
|
|
6957
|
-
description:
|
|
6958
|
-
title:
|
|
7767
|
+
description: Hostname (trailing dot optional)
|
|
7768
|
+
title: Hostname
|
|
6959
7769
|
type: string
|
|
6960
7770
|
requestBody:
|
|
6961
7771
|
content:
|
|
6962
7772
|
application/json:
|
|
6963
7773
|
schema:
|
|
6964
|
-
$ref: '#/components/schemas/
|
|
7774
|
+
$ref: '#/components/schemas/DomainForwardSetRequest'
|
|
6965
7775
|
required: true
|
|
6966
7776
|
responses:
|
|
6967
7777
|
'200':
|
|
6968
7778
|
content:
|
|
6969
7779
|
application/json:
|
|
6970
7780
|
schema:
|
|
6971
|
-
$ref: '#/components/schemas/
|
|
7781
|
+
$ref: '#/components/schemas/DomainForwardSetResponse'
|
|
6972
7782
|
description: Successful Response
|
|
7783
|
+
'401':
|
|
7784
|
+
content:
|
|
7785
|
+
application/problem+json:
|
|
7786
|
+
example:
|
|
7787
|
+
code: ERROR_AUTHENTICATION
|
|
7788
|
+
detail: Additional error context.
|
|
7789
|
+
status: 401
|
|
7790
|
+
title: Authentication Error
|
|
7791
|
+
type: authentication
|
|
7792
|
+
schema:
|
|
7793
|
+
$ref: '#/components/schemas/Problem'
|
|
7794
|
+
description: Unauthorized
|
|
7795
|
+
'403':
|
|
7796
|
+
content:
|
|
7797
|
+
application/problem+json:
|
|
7798
|
+
example:
|
|
7799
|
+
code: ERROR_PERMISSION_DENIED
|
|
7800
|
+
detail: Insufficient permissions to perform this action
|
|
7801
|
+
status: 403
|
|
7802
|
+
title: Permission Denied
|
|
7803
|
+
type: permission-denied
|
|
7804
|
+
schema:
|
|
7805
|
+
$ref: '#/components/schemas/Problem'
|
|
7806
|
+
description: Forbidden
|
|
6973
7807
|
'404':
|
|
6974
7808
|
content:
|
|
6975
7809
|
application/problem+json:
|
|
6976
7810
|
example:
|
|
6977
7811
|
code: ERROR_DOMAIN_FORWARD_NOT_EXISTS
|
|
6978
|
-
detail: Domain forward not found
|
|
7812
|
+
detail: Domain forward not found for Additional error context.
|
|
6979
7813
|
status: 404
|
|
6980
7814
|
title: Domain Forward Error
|
|
6981
7815
|
type: domain-forward-not-found
|
|
@@ -6990,7 +7824,7 @@ paths:
|
|
|
6990
7824
|
description: Validation Error
|
|
6991
7825
|
security:
|
|
6992
7826
|
- OAuth2PasswordBearer: []
|
|
6993
|
-
summary: Update
|
|
7827
|
+
summary: Update domain forward set
|
|
6994
7828
|
tags:
|
|
6995
7829
|
- domain_forward
|
|
6996
7830
|
/v1/domain-search/suggest:
|