@opusdns/api 0.93.0 → 0.94.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/src/openapi.yaml CHANGED
@@ -1540,28 +1540,31 @@ components:
1540
1540
  format: date-time
1541
1541
  title: Created On
1542
1542
  type: string
1543
- redirects:
1544
- items:
1545
- $ref: '#/components/schemas/HttpRedirect'
1546
- title: Redirects
1547
- type: array
1548
- request_protocol:
1549
- $ref: '#/components/schemas/HttpProtocol'
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
- - redirects
1563
- - zone_name
1564
- - request_protocol
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/HttpRedirect'
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,52 +1594,126 @@ components:
1598
1594
  - ops
1599
1595
  title: DomainForwardPatchOps
1600
1596
  type: object
1601
- DomainForwardProtocols:
1597
+ DomainForwardProtocolSetRequest:
1602
1598
  properties:
1603
- http:
1599
+ created_on:
1604
1600
  anyOf:
1605
- - $ref: '#/components/schemas/ProtocolRedirects'
1601
+ - format: date-time
1602
+ type: string
1606
1603
  - type: 'null'
1607
- https:
1604
+ title: Created On
1605
+ redirects:
1606
+ items:
1607
+ anyOf:
1608
+ - $ref: '#/components/schemas/HttpRedirectRequest'
1609
+ - $ref: '#/components/schemas/WildcardHttpRedirectRequest'
1610
+ title: Redirects
1611
+ type: array
1612
+ updated_on:
1613
+ anyOf:
1614
+ - format: date-time
1615
+ type: string
1616
+ - type: 'null'
1617
+ title: Updated On
1618
+ wildcard:
1608
1619
  anyOf:
1609
- - $ref: '#/components/schemas/ProtocolRedirects'
1620
+ - type: boolean
1610
1621
  - type: 'null'
1611
- title: DomainForwardProtocols
1622
+ title: Wildcard
1623
+ required:
1624
+ - redirects
1625
+ title: DomainForwardProtocolSetRequest
1612
1626
  type: object
1613
- DomainForwardRequest:
1627
+ DomainForwardProtocolSetResponse:
1614
1628
  properties:
1629
+ created_on:
1630
+ format: date-time
1631
+ title: Created On
1632
+ type: string
1615
1633
  redirects:
1616
1634
  items:
1617
- $ref: '#/components/schemas/HttpRedirect'
1635
+ $ref: '#/components/schemas/HttpRedirectListResponse'
1618
1636
  title: Redirects
1619
1637
  type: array
1638
+ updated_on:
1639
+ format: date-time
1640
+ title: Updated On
1641
+ type: string
1620
1642
  wildcard:
1621
- default: false
1622
1643
  title: Wildcard
1623
1644
  type: boolean
1624
1645
  required:
1646
+ - wildcard
1625
1647
  - redirects
1626
- title: DomainForwardRequest
1648
+ - updated_on
1649
+ - created_on
1650
+ title: DomainForwardProtocolSetResponse
1627
1651
  type: object
1628
- DomainForwardZone:
1652
+ DomainForwardRequest:
1629
1653
  properties:
1630
1654
  enabled:
1655
+ default: false
1631
1656
  title: Enabled
1632
1657
  type: boolean
1633
- protocols:
1634
- $ref: '#/components/schemas/DomainForwardProtocols'
1658
+ http:
1659
+ anyOf:
1660
+ - $ref: '#/components/schemas/DomainForwardProtocolSetRequest'
1661
+ - type: 'null'
1662
+ https:
1663
+ anyOf:
1664
+ - $ref: '#/components/schemas/DomainForwardProtocolSetRequest'
1665
+ - type: 'null'
1635
1666
  wildcard:
1667
+ anyOf:
1668
+ - type: boolean
1669
+ - type: 'null'
1636
1670
  title: Wildcard
1637
- type: boolean
1638
- zone_name:
1639
- title: Zone Name
1671
+ title: DomainForwardRequest
1672
+ type: object
1673
+ DomainForwardSetRequest:
1674
+ properties:
1675
+ redirects:
1676
+ items:
1677
+ anyOf:
1678
+ - $ref: '#/components/schemas/HttpRedirectRequest'
1679
+ - $ref: '#/components/schemas/WildcardHttpRedirectRequest'
1680
+ title: Redirects
1681
+ type: array
1682
+ required:
1683
+ - redirects
1684
+ title: DomainForwardSetRequest
1685
+ type: object
1686
+ DomainForwardSetResponse:
1687
+ properties:
1688
+ created_on:
1689
+ format: date-time
1690
+ title: Created On
1691
+ type: string
1692
+ hostname:
1693
+ title: Hostname
1694
+ type: string
1695
+ protocol:
1696
+ $ref: '#/components/schemas/HttpProtocol'
1697
+ redirects:
1698
+ items:
1699
+ $ref: '#/components/schemas/HttpRedirectListResponse'
1700
+ title: Redirects
1701
+ type: array
1702
+ updated_on:
1703
+ format: date-time
1704
+ title: Updated On
1640
1705
  type: string
1706
+ wildcard:
1707
+ title: Wildcard
1708
+ type: boolean
1641
1709
  required:
1642
- - zone_name
1710
+ - hostname
1711
+ - protocol
1643
1712
  - wildcard
1644
- - enabled
1645
- - protocols
1646
- title: DomainForwardZone
1713
+ - redirects
1714
+ - updated_on
1715
+ - created_on
1716
+ title: DomainForwardSetResponse
1647
1717
  type: object
1648
1718
  DomainLifecycleBase:
1649
1719
  properties:
@@ -2579,52 +2649,120 @@ components:
2579
2649
  - https
2580
2650
  title: HttpProtocol
2581
2651
  type: string
2582
- HttpRedirect:
2652
+ HttpRedirectListResponse:
2583
2653
  properties:
2584
2654
  redirect_code:
2585
2655
  $ref: '#/components/schemas/RedirectCode'
2656
+ request_hostname:
2657
+ title: Request Hostname
2658
+ type: string
2586
2659
  request_path:
2587
2660
  title: Request Path
2588
2661
  type: string
2662
+ request_protocol:
2663
+ $ref: '#/components/schemas/HttpProtocol'
2589
2664
  request_subdomain:
2590
2665
  anyOf:
2591
2666
  - type: string
2592
2667
  - type: 'null'
2593
2668
  title: Request Subdomain
2594
- target_domain:
2595
- title: Target Domain
2669
+ target_hostname:
2670
+ title: Target Hostname
2596
2671
  type: string
2597
2672
  target_path:
2598
2673
  title: Target Path
2599
2674
  type: string
2600
2675
  target_protocol:
2601
2676
  $ref: '#/components/schemas/HttpProtocol'
2602
- target_subdomain:
2677
+ required:
2678
+ - request_path
2679
+ - target_protocol
2680
+ - target_hostname
2681
+ - target_path
2682
+ - redirect_code
2683
+ - request_protocol
2684
+ - request_hostname
2685
+ title: HttpRedirectListResponse
2686
+ type: object
2687
+ HttpRedirectRemove:
2688
+ properties:
2689
+ request_hostname:
2690
+ title: Request Hostname
2691
+ type: string
2692
+ request_path:
2693
+ title: Request Path
2694
+ type: string
2695
+ request_protocol:
2696
+ $ref: '#/components/schemas/HttpProtocol'
2697
+ request_subdomain:
2603
2698
  anyOf:
2604
2699
  - type: string
2605
2700
  - type: 'null'
2606
- title: Target Subdomain
2701
+ title: Request Subdomain
2702
+ required:
2703
+ - request_protocol
2704
+ - request_hostname
2705
+ - request_path
2706
+ title: HttpRedirectRemove
2707
+ type: object
2708
+ HttpRedirectRequest:
2709
+ properties:
2710
+ redirect_code:
2711
+ $ref: '#/components/schemas/RedirectCode'
2712
+ request_path:
2713
+ title: Request Path
2714
+ type: string
2715
+ target_hostname:
2716
+ title: Target Hostname
2717
+ type: string
2718
+ target_path:
2719
+ title: Target Path
2720
+ type: string
2721
+ target_protocol:
2722
+ $ref: '#/components/schemas/HttpProtocol'
2607
2723
  required:
2608
2724
  - request_path
2609
2725
  - target_protocol
2610
- - target_domain
2726
+ - target_hostname
2611
2727
  - target_path
2612
2728
  - redirect_code
2613
- title: HttpRedirect
2729
+ title: HttpRedirectRequest
2614
2730
  type: object
2615
- HttpRedirectRemove:
2731
+ HttpRedirectUpsert:
2616
2732
  properties:
2733
+ redirect_code:
2734
+ $ref: '#/components/schemas/RedirectCode'
2735
+ request_hostname:
2736
+ title: Request Hostname
2737
+ type: string
2617
2738
  request_path:
2618
2739
  title: Request Path
2619
2740
  type: string
2741
+ request_protocol:
2742
+ anyOf:
2743
+ - $ref: '#/components/schemas/HttpProtocol'
2744
+ - type: 'null'
2620
2745
  request_subdomain:
2621
2746
  anyOf:
2622
2747
  - type: string
2623
2748
  - type: 'null'
2624
2749
  title: Request Subdomain
2750
+ target_hostname:
2751
+ title: Target Hostname
2752
+ type: string
2753
+ target_path:
2754
+ title: Target Path
2755
+ type: string
2756
+ target_protocol:
2757
+ $ref: '#/components/schemas/HttpProtocol'
2625
2758
  required:
2626
2759
  - request_path
2627
- title: HttpRedirectRemove
2760
+ - target_protocol
2761
+ - target_hostname
2762
+ - target_path
2763
+ - redirect_code
2764
+ - request_hostname
2765
+ title: HttpRedirectUpsert
2628
2766
  type: object
2629
2767
  IdnBase:
2630
2768
  properties:
@@ -3709,19 +3847,19 @@ components:
3709
3847
  - pagination
3710
3848
  title: Pagination[DnsZoneResponse]
3711
3849
  type: object
3712
- Pagination_DomainForwardZone_:
3850
+ Pagination_DomainForward_:
3713
3851
  properties:
3714
3852
  pagination:
3715
3853
  $ref: '#/components/schemas/PaginationMetadata'
3716
3854
  results:
3717
3855
  items:
3718
- $ref: '#/components/schemas/DomainForwardZone'
3856
+ $ref: '#/components/schemas/DomainForward'
3719
3857
  title: Results
3720
3858
  type: array
3721
3859
  required:
3722
3860
  - results
3723
3861
  - pagination
3724
- title: Pagination[DomainForwardZone]
3862
+ title: Pagination[DomainForward]
3725
3863
  type: object
3726
3864
  Pagination_DomainResponse_:
3727
3865
  properties:
@@ -4017,17 +4155,6 @@ components:
4017
4155
  - status
4018
4156
  title: Problem
4019
4157
  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
4158
  PublicAuthRequestForm:
4032
4159
  properties:
4033
4160
  client_id:
@@ -5017,6 +5144,33 @@ components:
5017
5144
  title: Whois Server
5018
5145
  title: WhoisBase
5019
5146
  type: object
5147
+ WildcardHttpRedirectRequest:
5148
+ properties:
5149
+ redirect_code:
5150
+ $ref: '#/components/schemas/RedirectCode'
5151
+ request_path:
5152
+ title: Request Path
5153
+ type: string
5154
+ request_subdomain:
5155
+ title: Request Subdomain
5156
+ type: string
5157
+ target_hostname:
5158
+ title: Target Hostname
5159
+ type: string
5160
+ target_path:
5161
+ title: Target Path
5162
+ type: string
5163
+ target_protocol:
5164
+ $ref: '#/components/schemas/HttpProtocol'
5165
+ required:
5166
+ - request_path
5167
+ - target_protocol
5168
+ - target_hostname
5169
+ - target_path
5170
+ - redirect_code
5171
+ - request_subdomain
5172
+ title: WildcardHttpRedirectRequest
5173
+ type: object
5020
5174
  ZoneSortField:
5021
5175
  enum:
5022
5176
  - name
@@ -5111,7 +5265,7 @@ info:
5111
5265
  '
5112
5266
  summary: OpusDNS - your gateway to a seamless domain management experience.
5113
5267
  title: OpusDNS API
5114
- version: 2025-11-12-143559
5268
+ version: 2025-11-13-093836
5115
5269
  x-logo:
5116
5270
  altText: OpusDNS API Reference
5117
5271
  url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
@@ -6591,6 +6745,7 @@ paths:
6591
6745
  - dns
6592
6746
  /v1/domain-forwards:
6593
6747
  get:
6748
+ description: Retrieves a paginated list of domain forwards for the organization
6594
6749
  operationId: list_domain_forwards_v1_domain_forwards_get
6595
6750
  parameters:
6596
6751
  - in: query
@@ -6695,8 +6850,32 @@ paths:
6695
6850
  content:
6696
6851
  application/json:
6697
6852
  schema:
6698
- $ref: '#/components/schemas/Pagination_DomainForwardZone_'
6853
+ $ref: '#/components/schemas/Pagination_DomainForward_'
6699
6854
  description: Successful Response
6855
+ '401':
6856
+ content:
6857
+ application/problem+json:
6858
+ example:
6859
+ code: ERROR_AUTHENTICATION
6860
+ detail: Additional error context.
6861
+ status: 401
6862
+ title: Authentication Error
6863
+ type: authentication
6864
+ schema:
6865
+ $ref: '#/components/schemas/Problem'
6866
+ description: Unauthorized
6867
+ '403':
6868
+ content:
6869
+ application/problem+json:
6870
+ example:
6871
+ code: ERROR_PERMISSION_DENIED
6872
+ detail: Insufficient permissions to perform this action
6873
+ status: 403
6874
+ title: Permission Denied
6875
+ type: permission-denied
6876
+ schema:
6877
+ $ref: '#/components/schemas/Problem'
6878
+ description: Forbidden
6700
6879
  '422':
6701
6880
  content:
6702
6881
  application/problem+json:
@@ -6705,10 +6884,13 @@ paths:
6705
6884
  description: Validation Error
6706
6885
  security:
6707
6886
  - OAuth2PasswordBearer: []
6708
- summary: List Domain Forwards
6887
+ summary: List domain forwards
6709
6888
  tags:
6710
6889
  - domain_forward
6711
6890
  patch:
6891
+ description: Applies patch operations to update or remove redirects across hostnames
6892
+ and protocols. Raises an error if the domain forward or domain forward set
6893
+ does not exist.
6712
6894
  operationId: patch_redirects_v1_domain_forwards_patch
6713
6895
  requestBody:
6714
6896
  content:
@@ -6719,12 +6901,36 @@ paths:
6719
6901
  responses:
6720
6902
  '204':
6721
6903
  description: Successful Response
6904
+ '401':
6905
+ content:
6906
+ application/problem+json:
6907
+ example:
6908
+ code: ERROR_AUTHENTICATION
6909
+ detail: Additional error context.
6910
+ status: 401
6911
+ title: Authentication Error
6912
+ type: authentication
6913
+ schema:
6914
+ $ref: '#/components/schemas/Problem'
6915
+ description: Unauthorized
6916
+ '403':
6917
+ content:
6918
+ application/problem+json:
6919
+ example:
6920
+ code: ERROR_PERMISSION_DENIED
6921
+ detail: Insufficient permissions to perform this action
6922
+ status: 403
6923
+ title: Permission Denied
6924
+ type: permission-denied
6925
+ schema:
6926
+ $ref: '#/components/schemas/Problem'
6927
+ description: Forbidden
6722
6928
  '404':
6723
6929
  content:
6724
6930
  application/problem+json:
6725
6931
  example:
6726
6932
  code: ERROR_DOMAIN_FORWARD_NOT_EXISTS
6727
- detail: Domain forward not found
6933
+ detail: Domain forward not found for Additional error context.
6728
6934
  status: 404
6729
6935
  title: Domain Forward Error
6730
6936
  type: domain-forward-not-found
@@ -6739,24 +6945,61 @@ paths:
6739
6945
  description: Validation Error
6740
6946
  security:
6741
6947
  - OAuth2PasswordBearer: []
6742
- summary: Patch Redirects
6948
+ summary: Patch domain forward redirects
6743
6949
  tags:
6744
6950
  - domain_forward
6745
- /v1/domain-forwards/{zone_name}/disable:
6746
- patch:
6747
- operationId: disable_domain_forward_v1_domain_forwards__zone_name__disable_patch
6951
+ /v1/domain-forwards/{hostname}:
6952
+ delete:
6953
+ description: Deletes the domain forward configuration for the specified hostname
6954
+ operationId: delete_domain_forward_v1_domain_forwards__hostname__delete
6748
6955
  parameters:
6749
- - description: DNS zone name (trailing dot optional)
6956
+ - description: Hostname (trailing dot optional)
6750
6957
  in: path
6751
- name: zone_name
6958
+ name: hostname
6752
6959
  required: true
6753
6960
  schema:
6754
- description: DNS zone name (trailing dot optional)
6755
- title: Zone Name
6961
+ description: Hostname (trailing dot optional)
6962
+ title: Hostname
6756
6963
  type: string
6757
6964
  responses:
6758
6965
  '204':
6759
6966
  description: Successful Response
6967
+ '401':
6968
+ content:
6969
+ application/problem+json:
6970
+ example:
6971
+ code: ERROR_AUTHENTICATION
6972
+ detail: Additional error context.
6973
+ status: 401
6974
+ title: Authentication Error
6975
+ type: authentication
6976
+ schema:
6977
+ $ref: '#/components/schemas/Problem'
6978
+ description: Unauthorized
6979
+ '403':
6980
+ content:
6981
+ application/problem+json:
6982
+ example:
6983
+ code: ERROR_PERMISSION_DENIED
6984
+ detail: Insufficient permissions to perform this action
6985
+ status: 403
6986
+ title: Permission Denied
6987
+ type: permission-denied
6988
+ schema:
6989
+ $ref: '#/components/schemas/Problem'
6990
+ description: Forbidden
6991
+ '404':
6992
+ content:
6993
+ application/problem+json:
6994
+ example:
6995
+ code: ERROR_DOMAIN_FORWARD_NOT_EXISTS
6996
+ detail: Domain forward not found for Additional error context.
6997
+ status: 404
6998
+ title: Domain Forward Error
6999
+ type: domain-forward-not-found
7000
+ schema:
7001
+ $ref: '#/components/schemas/Problem'
7002
+ description: Not Found
6760
7003
  '422':
6761
7004
  content:
6762
7005
  application/problem+json:
@@ -6765,20 +7008,212 @@ paths:
6765
7008
  description: Validation Error
6766
7009
  security:
6767
7010
  - OAuth2PasswordBearer: []
6768
- summary: Disable Domain Forward
7011
+ summary: Delete a domain forward
6769
7012
  tags:
6770
7013
  - domain_forward
6771
- /v1/domain-forwards/{zone_name}/enable:
7014
+ get:
7015
+ description: Retrieves the domain forward configuration for the specified hostname
7016
+ operationId: get_domain_forward_v1_domain_forwards__hostname__get
7017
+ parameters:
7018
+ - description: Hostname (trailing dot optional)
7019
+ in: path
7020
+ name: hostname
7021
+ required: true
7022
+ schema:
7023
+ description: Hostname (trailing dot optional)
7024
+ title: Hostname
7025
+ type: string
7026
+ responses:
7027
+ '200':
7028
+ content:
7029
+ application/json:
7030
+ schema:
7031
+ $ref: '#/components/schemas/DomainForward'
7032
+ description: Successful Response
7033
+ '401':
7034
+ content:
7035
+ application/problem+json:
7036
+ example:
7037
+ code: ERROR_AUTHENTICATION
7038
+ detail: Additional error context.
7039
+ status: 401
7040
+ title: Authentication Error
7041
+ type: authentication
7042
+ schema:
7043
+ $ref: '#/components/schemas/Problem'
7044
+ description: Unauthorized
7045
+ '403':
7046
+ content:
7047
+ application/problem+json:
7048
+ example:
7049
+ code: ERROR_PERMISSION_DENIED
7050
+ detail: Insufficient permissions to perform this action
7051
+ status: 403
7052
+ title: Permission Denied
7053
+ type: permission-denied
7054
+ schema:
7055
+ $ref: '#/components/schemas/Problem'
7056
+ description: Forbidden
7057
+ '404':
7058
+ content:
7059
+ application/problem+json:
7060
+ example:
7061
+ code: ERROR_DOMAIN_FORWARD_NOT_EXISTS
7062
+ detail: Domain forward not found for Additional error context.
7063
+ status: 404
7064
+ title: Domain Forward Error
7065
+ type: domain-forward-not-found
7066
+ schema:
7067
+ $ref: '#/components/schemas/Problem'
7068
+ description: Not Found
7069
+ '422':
7070
+ content:
7071
+ application/problem+json:
7072
+ schema:
7073
+ $ref: '#/components/schemas/HTTPValidationError'
7074
+ description: Validation Error
7075
+ security:
7076
+ - OAuth2PasswordBearer: []
7077
+ summary: Get a domain forward
7078
+ tags:
7079
+ - domain_forward
7080
+ post:
7081
+ description: Creates a new domain forward configuration for the specified hostname
7082
+ operationId: create_domain_forward_v1_domain_forwards__hostname__post
7083
+ parameters:
7084
+ - description: Hostname (trailing dot optional)
7085
+ in: path
7086
+ name: hostname
7087
+ required: true
7088
+ schema:
7089
+ description: Hostname (trailing dot optional)
7090
+ title: Hostname
7091
+ type: string
7092
+ requestBody:
7093
+ content:
7094
+ application/json:
7095
+ schema:
7096
+ $ref: '#/components/schemas/DomainForwardRequest'
7097
+ required: true
7098
+ responses:
7099
+ '201':
7100
+ content:
7101
+ application/json:
7102
+ schema:
7103
+ $ref: '#/components/schemas/DomainForward'
7104
+ description: Successful Response
7105
+ '401':
7106
+ content:
7107
+ application/problem+json:
7108
+ example:
7109
+ code: ERROR_AUTHENTICATION
7110
+ detail: Additional error context.
7111
+ status: 401
7112
+ title: Authentication Error
7113
+ type: authentication
7114
+ schema:
7115
+ $ref: '#/components/schemas/Problem'
7116
+ description: Unauthorized
7117
+ '403':
7118
+ content:
7119
+ application/problem+json:
7120
+ example:
7121
+ code: ERROR_PERMISSION_DENIED
7122
+ detail: Insufficient permissions to perform this action
7123
+ status: 403
7124
+ title: Permission Denied
7125
+ type: permission-denied
7126
+ schema:
7127
+ $ref: '#/components/schemas/Problem'
7128
+ description: Forbidden
7129
+ '409':
7130
+ content:
7131
+ application/problem+json:
7132
+ example:
7133
+ code: ERROR_DOMAIN_FORWARD_ALREADY_EXISTS
7134
+ detail: Domain forward already exists for Additional error context.
7135
+ status: 409
7136
+ title: Domain Forward Error
7137
+ type: domain-forward-already-exists
7138
+ schema:
7139
+ $ref: '#/components/schemas/Problem'
7140
+ description: Conflict
7141
+ '422':
7142
+ content:
7143
+ application/problem+json:
7144
+ schema:
7145
+ $ref: '#/components/schemas/HTTPValidationError'
7146
+ description: Validation Error
7147
+ security:
7148
+ - OAuth2PasswordBearer: []
7149
+ summary: Create a domain forward
7150
+ tags:
7151
+ - domain_forward
7152
+ /v1/domain-forwards/{hostname}/disable:
6772
7153
  patch:
6773
- operationId: enable_domain_forward_v1_domain_forwards__zone_name__enable_patch
7154
+ description: Disables domain forwarding by removing DNS records. The domain
7155
+ forward configuration is preserved but disabled.
7156
+ operationId: disable_domain_forward_v1_domain_forwards__hostname__disable_patch
6774
7157
  parameters:
6775
- - description: DNS zone name (trailing dot optional)
7158
+ - description: Hostname (trailing dot optional)
6776
7159
  in: path
6777
- name: zone_name
7160
+ name: hostname
6778
7161
  required: true
6779
7162
  schema:
6780
- description: DNS zone name (trailing dot optional)
6781
- title: Zone Name
7163
+ description: Hostname (trailing dot optional)
7164
+ title: Hostname
7165
+ type: string
7166
+ responses:
7167
+ '204':
7168
+ description: Successful Response
7169
+ '401':
7170
+ content:
7171
+ application/problem+json:
7172
+ example:
7173
+ code: ERROR_AUTHENTICATION
7174
+ detail: Additional error context.
7175
+ status: 401
7176
+ title: Authentication Error
7177
+ type: authentication
7178
+ schema:
7179
+ $ref: '#/components/schemas/Problem'
7180
+ description: Unauthorized
7181
+ '403':
7182
+ content:
7183
+ application/problem+json:
7184
+ example:
7185
+ code: ERROR_PERMISSION_DENIED
7186
+ detail: Insufficient permissions to perform this action
7187
+ status: 403
7188
+ title: Permission Denied
7189
+ type: permission-denied
7190
+ schema:
7191
+ $ref: '#/components/schemas/Problem'
7192
+ description: Forbidden
7193
+ '422':
7194
+ content:
7195
+ application/problem+json:
7196
+ schema:
7197
+ $ref: '#/components/schemas/HTTPValidationError'
7198
+ description: Validation Error
7199
+ security:
7200
+ - OAuth2PasswordBearer: []
7201
+ summary: Disable domain forward
7202
+ tags:
7203
+ - domain_forward
7204
+ /v1/domain-forwards/{hostname}/enable:
7205
+ patch:
7206
+ description: Enables domain forwarding by creating necessary DNS records. Optionally
7207
+ auto-creates the zone and domain forward if they don't exist.
7208
+ operationId: enable_domain_forward_v1_domain_forwards__hostname__enable_patch
7209
+ parameters:
7210
+ - description: Hostname (trailing dot optional)
7211
+ in: path
7212
+ name: hostname
7213
+ required: true
7214
+ schema:
7215
+ description: Hostname (trailing dot optional)
7216
+ title: Hostname
6782
7217
  type: string
6783
7218
  - description: Auto create zone if it doesn't exist
6784
7219
  in: query
@@ -6789,6 +7224,15 @@ paths:
6789
7224
  description: Auto create zone if it doesn't exist
6790
7225
  title: Auto Create Zone
6791
7226
  type: boolean
7227
+ - description: Auto create domain forward if it doesn't exist
7228
+ in: query
7229
+ name: auto_create_domain_forward
7230
+ required: false
7231
+ schema:
7232
+ default: false
7233
+ description: Auto create domain forward if it doesn't exist
7234
+ title: Auto Create Domain Forward
7235
+ type: boolean
6792
7236
  - description: Wildcard domain forwarding
6793
7237
  in: query
6794
7238
  name: wildcard
@@ -6801,6 +7245,42 @@ paths:
6801
7245
  responses:
6802
7246
  '204':
6803
7247
  description: Successful Response
7248
+ '400':
7249
+ content:
7250
+ application/problem+json:
7251
+ example:
7252
+ code: ERROR_DOMAIN_FORWARD_WILDCARD_NOT_SUPPORTED
7253
+ detail: Additional error context.
7254
+ status: 400
7255
+ title: Wildcard Not Supported
7256
+ type: domain-forward-wildcard-not-supported
7257
+ schema:
7258
+ $ref: '#/components/schemas/Problem'
7259
+ description: Bad Request
7260
+ '401':
7261
+ content:
7262
+ application/problem+json:
7263
+ example:
7264
+ code: ERROR_AUTHENTICATION
7265
+ detail: Additional error context.
7266
+ status: 401
7267
+ title: Authentication Error
7268
+ type: authentication
7269
+ schema:
7270
+ $ref: '#/components/schemas/Problem'
7271
+ description: Unauthorized
7272
+ '403':
7273
+ content:
7274
+ application/problem+json:
7275
+ example:
7276
+ code: ERROR_PERMISSION_DENIED
7277
+ detail: Insufficient permissions to perform this action
7278
+ status: 403
7279
+ title: Permission Denied
7280
+ type: permission-denied
7281
+ schema:
7282
+ $ref: '#/components/schemas/Problem'
7283
+ description: Forbidden
6804
7284
  '422':
6805
7285
  content:
6806
7286
  application/problem+json:
@@ -6809,35 +7289,60 @@ paths:
6809
7289
  description: Validation Error
6810
7290
  security:
6811
7291
  - OAuth2PasswordBearer: []
6812
- summary: Enable Domain Forward
7292
+ summary: Enable domain forward
6813
7293
  tags:
6814
7294
  - domain_forward
6815
- /v1/domain-forwards/{zone_name}/{request_protocol}:
7295
+ /v1/domain-forwards/{hostname}/{protocol}:
6816
7296
  delete:
6817
- operationId: delete_domain_forward_v1_domain_forwards__zone_name___request_protocol__delete
7297
+ description: Deletes a domain forward set for a specific protocol (HTTP or HTTPS).
7298
+ operationId: delete_domain_forward_set_v1_domain_forwards__hostname___protocol__delete
6818
7299
  parameters:
6819
7300
  - in: path
6820
- name: request_protocol
7301
+ name: protocol
6821
7302
  required: true
6822
7303
  schema:
6823
7304
  $ref: '#/components/schemas/HttpProtocol'
6824
- - description: DNS zone name (trailing dot optional)
7305
+ - description: Hostname (trailing dot optional)
6825
7306
  in: path
6826
- name: zone_name
7307
+ name: hostname
6827
7308
  required: true
6828
7309
  schema:
6829
- description: DNS zone name (trailing dot optional)
6830
- title: Zone Name
7310
+ description: Hostname (trailing dot optional)
7311
+ title: Hostname
6831
7312
  type: string
6832
7313
  responses:
6833
7314
  '204':
6834
7315
  description: Successful Response
7316
+ '401':
7317
+ content:
7318
+ application/problem+json:
7319
+ example:
7320
+ code: ERROR_AUTHENTICATION
7321
+ detail: Additional error context.
7322
+ status: 401
7323
+ title: Authentication Error
7324
+ type: authentication
7325
+ schema:
7326
+ $ref: '#/components/schemas/Problem'
7327
+ description: Unauthorized
7328
+ '403':
7329
+ content:
7330
+ application/problem+json:
7331
+ example:
7332
+ code: ERROR_PERMISSION_DENIED
7333
+ detail: Insufficient permissions to perform this action
7334
+ status: 403
7335
+ title: Permission Denied
7336
+ type: permission-denied
7337
+ schema:
7338
+ $ref: '#/components/schemas/Problem'
7339
+ description: Forbidden
6835
7340
  '404':
6836
7341
  content:
6837
7342
  application/problem+json:
6838
7343
  example:
6839
7344
  code: ERROR_DOMAIN_FORWARD_NOT_EXISTS
6840
- detail: Domain forward not found
7345
+ detail: Domain forward not found for Additional error context.
6841
7346
  status: 404
6842
7347
  title: Domain Forward Error
6843
7348
  type: domain-forward-not-found
@@ -6852,32 +7357,70 @@ paths:
6852
7357
  description: Validation Error
6853
7358
  security:
6854
7359
  - OAuth2PasswordBearer: []
6855
- summary: Delete Domain Forward
7360
+ summary: Delete domain forward set
6856
7361
  tags:
6857
7362
  - domain_forward
6858
7363
  get:
6859
- operationId: get_domain_forward_v1_domain_forwards__zone_name___request_protocol__get
7364
+ description: Retrieves all redirects for a specific protocol (HTTP or HTTPS)
7365
+ for the specified hostname
7366
+ operationId: get_domain_forward_set_v1_domain_forwards__hostname___protocol__get
6860
7367
  parameters:
6861
7368
  - in: path
6862
- name: request_protocol
7369
+ name: protocol
6863
7370
  required: true
6864
7371
  schema:
6865
7372
  $ref: '#/components/schemas/HttpProtocol'
6866
- - description: DNS zone name (trailing dot optional)
7373
+ - description: Hostname (trailing dot optional)
6867
7374
  in: path
6868
- name: zone_name
7375
+ name: hostname
6869
7376
  required: true
6870
7377
  schema:
6871
- description: DNS zone name (trailing dot optional)
6872
- title: Zone Name
7378
+ description: Hostname (trailing dot optional)
7379
+ title: Hostname
6873
7380
  type: string
6874
7381
  responses:
6875
7382
  '200':
6876
7383
  content:
6877
7384
  application/json:
6878
7385
  schema:
6879
- $ref: '#/components/schemas/DomainForward'
7386
+ $ref: '#/components/schemas/DomainForwardSetResponse'
6880
7387
  description: Successful Response
7388
+ '401':
7389
+ content:
7390
+ application/problem+json:
7391
+ example:
7392
+ code: ERROR_AUTHENTICATION
7393
+ detail: Additional error context.
7394
+ status: 401
7395
+ title: Authentication Error
7396
+ type: authentication
7397
+ schema:
7398
+ $ref: '#/components/schemas/Problem'
7399
+ description: Unauthorized
7400
+ '403':
7401
+ content:
7402
+ application/problem+json:
7403
+ example:
7404
+ code: ERROR_PERMISSION_DENIED
7405
+ detail: Insufficient permissions to perform this action
7406
+ status: 403
7407
+ title: Permission Denied
7408
+ type: permission-denied
7409
+ schema:
7410
+ $ref: '#/components/schemas/Problem'
7411
+ description: Forbidden
7412
+ '404':
7413
+ content:
7414
+ application/problem+json:
7415
+ example:
7416
+ code: ERROR_DOMAIN_FORWARD_NOT_EXISTS
7417
+ detail: Domain forward not found for Additional error context.
7418
+ status: 404
7419
+ title: Domain Forward Error
7420
+ type: domain-forward-not-found
7421
+ schema:
7422
+ $ref: '#/components/schemas/Problem'
7423
+ description: Not Found
6881
7424
  '422':
6882
7425
  content:
6883
7426
  application/problem+json:
@@ -6886,44 +7429,82 @@ paths:
6886
7429
  description: Validation Error
6887
7430
  security:
6888
7431
  - OAuth2PasswordBearer: []
6889
- summary: Get Domain Forward
7432
+ summary: Get domain forward set
6890
7433
  tags:
6891
7434
  - domain_forward
6892
7435
  post:
6893
- operationId: create_domain_forward_v1_domain_forwards__zone_name___request_protocol__post
7436
+ description: Creates a new domain forward set for a specific protocol (HTTP
7437
+ or HTTPS). Raises an error if the set already exists.
7438
+ operationId: create_domain_forward_set_v1_domain_forwards__hostname___protocol__post
6894
7439
  parameters:
6895
7440
  - in: path
6896
- name: request_protocol
7441
+ name: protocol
6897
7442
  required: true
6898
7443
  schema:
6899
7444
  $ref: '#/components/schemas/HttpProtocol'
6900
- - description: DNS zone name (trailing dot optional)
7445
+ - description: Hostname (trailing dot optional)
6901
7446
  in: path
6902
- name: zone_name
7447
+ name: hostname
6903
7448
  required: true
6904
7449
  schema:
6905
- description: DNS zone name (trailing dot optional)
6906
- title: Zone Name
7450
+ description: Hostname (trailing dot optional)
7451
+ title: Hostname
6907
7452
  type: string
6908
7453
  requestBody:
6909
7454
  content:
6910
7455
  application/json:
6911
7456
  schema:
6912
- $ref: '#/components/schemas/DomainForwardRequest'
7457
+ $ref: '#/components/schemas/DomainForwardSetRequest'
6913
7458
  required: true
6914
7459
  responses:
6915
7460
  '201':
6916
7461
  content:
6917
7462
  application/json:
6918
7463
  schema:
6919
- $ref: '#/components/schemas/DomainForward'
7464
+ $ref: '#/components/schemas/DomainForwardSetResponse'
6920
7465
  description: Successful Response
7466
+ '401':
7467
+ content:
7468
+ application/problem+json:
7469
+ example:
7470
+ code: ERROR_AUTHENTICATION
7471
+ detail: Additional error context.
7472
+ status: 401
7473
+ title: Authentication Error
7474
+ type: authentication
7475
+ schema:
7476
+ $ref: '#/components/schemas/Problem'
7477
+ description: Unauthorized
7478
+ '403':
7479
+ content:
7480
+ application/problem+json:
7481
+ example:
7482
+ code: ERROR_PERMISSION_DENIED
7483
+ detail: Insufficient permissions to perform this action
7484
+ status: 403
7485
+ title: Permission Denied
7486
+ type: permission-denied
7487
+ schema:
7488
+ $ref: '#/components/schemas/Problem'
7489
+ description: Forbidden
7490
+ '404':
7491
+ content:
7492
+ application/problem+json:
7493
+ example:
7494
+ code: ERROR_DOMAIN_FORWARD_NOT_EXISTS
7495
+ detail: Domain forward not found for Additional error context.
7496
+ status: 404
7497
+ title: Domain Forward Error
7498
+ type: domain-forward-not-found
7499
+ schema:
7500
+ $ref: '#/components/schemas/Problem'
7501
+ description: Not Found
6921
7502
  '409':
6922
7503
  content:
6923
7504
  application/problem+json:
6924
7505
  example:
6925
7506
  code: ERROR_DOMAIN_FORWARD_ALREADY_EXISTS
6926
- detail: Domain forward already exists
7507
+ detail: Domain forward already exists for Additional error context.
6927
7508
  status: 409
6928
7509
  title: Domain Forward Error
6929
7510
  type: domain-forward-already-exists
@@ -6938,44 +7519,71 @@ paths:
6938
7519
  description: Validation Error
6939
7520
  security:
6940
7521
  - OAuth2PasswordBearer: []
6941
- summary: Create Domain Forward
7522
+ summary: Create domain forward set
6942
7523
  tags:
6943
7524
  - domain_forward
6944
7525
  put:
6945
- operationId: update_domain_forward_v1_domain_forwards__zone_name___request_protocol__put
7526
+ description: Updates an existing domain forward set for a specific protocol
7527
+ (HTTP or HTTPS). All existing redirects for this protocol are replaced with
7528
+ the provided redirects. Raises an error if the set does not exist.
7529
+ operationId: update_domain_forward_set_v1_domain_forwards__hostname___protocol__put
6946
7530
  parameters:
6947
7531
  - in: path
6948
- name: request_protocol
7532
+ name: protocol
6949
7533
  required: true
6950
7534
  schema:
6951
7535
  $ref: '#/components/schemas/HttpProtocol'
6952
- - description: DNS zone name (trailing dot optional)
7536
+ - description: Hostname (trailing dot optional)
6953
7537
  in: path
6954
- name: zone_name
7538
+ name: hostname
6955
7539
  required: true
6956
7540
  schema:
6957
- description: DNS zone name (trailing dot optional)
6958
- title: Zone Name
7541
+ description: Hostname (trailing dot optional)
7542
+ title: Hostname
6959
7543
  type: string
6960
7544
  requestBody:
6961
7545
  content:
6962
7546
  application/json:
6963
7547
  schema:
6964
- $ref: '#/components/schemas/DomainForwardRequest'
7548
+ $ref: '#/components/schemas/DomainForwardSetRequest'
6965
7549
  required: true
6966
7550
  responses:
6967
7551
  '200':
6968
7552
  content:
6969
7553
  application/json:
6970
7554
  schema:
6971
- $ref: '#/components/schemas/DomainForward'
7555
+ $ref: '#/components/schemas/DomainForwardSetResponse'
6972
7556
  description: Successful Response
7557
+ '401':
7558
+ content:
7559
+ application/problem+json:
7560
+ example:
7561
+ code: ERROR_AUTHENTICATION
7562
+ detail: Additional error context.
7563
+ status: 401
7564
+ title: Authentication Error
7565
+ type: authentication
7566
+ schema:
7567
+ $ref: '#/components/schemas/Problem'
7568
+ description: Unauthorized
7569
+ '403':
7570
+ content:
7571
+ application/problem+json:
7572
+ example:
7573
+ code: ERROR_PERMISSION_DENIED
7574
+ detail: Insufficient permissions to perform this action
7575
+ status: 403
7576
+ title: Permission Denied
7577
+ type: permission-denied
7578
+ schema:
7579
+ $ref: '#/components/schemas/Problem'
7580
+ description: Forbidden
6973
7581
  '404':
6974
7582
  content:
6975
7583
  application/problem+json:
6976
7584
  example:
6977
7585
  code: ERROR_DOMAIN_FORWARD_NOT_EXISTS
6978
- detail: Domain forward not found
7586
+ detail: Domain forward not found for Additional error context.
6979
7587
  status: 404
6980
7588
  title: Domain Forward Error
6981
7589
  type: domain-forward-not-found
@@ -6990,7 +7598,7 @@ paths:
6990
7598
  description: Validation Error
6991
7599
  security:
6992
7600
  - OAuth2PasswordBearer: []
6993
- summary: Update Domain Forward
7601
+ summary: Update domain forward set
6994
7602
  tags:
6995
7603
  - domain_forward
6996
7604
  /v1/domain-search/suggest: