@opusdns/api 0.121.0 → 0.123.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
@@ -1575,6 +1575,27 @@ components:
1575
1575
  - created_on
1576
1576
  title: DomainForward
1577
1577
  type: object
1578
+ DomainForwardCreateRequest:
1579
+ properties:
1580
+ enabled:
1581
+ default: false
1582
+ title: Enabled
1583
+ type: boolean
1584
+ hostname:
1585
+ title: Hostname
1586
+ type: string
1587
+ http:
1588
+ anyOf:
1589
+ - $ref: '#/components/schemas/DomainForwardProtocolSetRequest'
1590
+ - type: 'null'
1591
+ https:
1592
+ anyOf:
1593
+ - $ref: '#/components/schemas/DomainForwardProtocolSetRequest'
1594
+ - type: 'null'
1595
+ required:
1596
+ - hostname
1597
+ title: DomainForwardCreateRequest
1598
+ type: object
1578
1599
  DomainForwardPatchOp:
1579
1600
  properties:
1580
1601
  op:
@@ -4797,27 +4818,6 @@ components:
4797
4818
  - delete
4798
4819
  title: RenewalMode
4799
4820
  type: string
4800
- RequestAuthcodeResponse:
4801
- properties:
4802
- detail:
4803
- anyOf:
4804
- - type: string
4805
- - type: 'null'
4806
- description: Additional information about the result in case of failure
4807
- title: Detail
4808
- name:
4809
- description: The domain name that had the auth code requested
4810
- title: Name
4811
- type: string
4812
- success:
4813
- description: Whether the request had a successful result from DNS Belgium
4814
- title: Success
4815
- type: boolean
4816
- required:
4817
- - name
4818
- - success
4819
- title: RequestAuthcodeResponse
4820
- type: object
4821
4821
  RequestHistory:
4822
4822
  properties:
4823
4823
  client_ip:
@@ -5812,6 +5812,61 @@ components:
5812
5812
  - dnssec_status
5813
5813
  title: ZoneSortField
5814
5814
  type: string
5815
+ api__domain__tld_specific__be__models__RequestAuthcodeResponse:
5816
+ properties:
5817
+ detail:
5818
+ anyOf:
5819
+ - type: string
5820
+ - type: 'null'
5821
+ description: Additional information about the result in case of failure
5822
+ title: Detail
5823
+ name:
5824
+ description: The domain name that had the auth code requested
5825
+ title: Name
5826
+ type: string
5827
+ success:
5828
+ description: Whether the request had a successful result from DNS Belgium
5829
+ title: Success
5830
+ type: boolean
5831
+ required:
5832
+ - name
5833
+ - success
5834
+ title: RequestAuthcodeResponse
5835
+ type: object
5836
+ api__domain__tld_specific__eu__models__RequestAuthcodeResponse:
5837
+ properties:
5838
+ auth_code:
5839
+ anyOf:
5840
+ - type: string
5841
+ - type: 'null'
5842
+ description: The auth code returned by EURid
5843
+ title: Auth Code
5844
+ auth_code_expires_on:
5845
+ anyOf:
5846
+ - format: date-time
5847
+ type: string
5848
+ - type: 'null'
5849
+ description: The expiry date of the auth code
5850
+ title: Auth Code Expires On
5851
+ detail:
5852
+ anyOf:
5853
+ - type: string
5854
+ - type: 'null'
5855
+ description: Additional information about the result in case of failure
5856
+ title: Detail
5857
+ name:
5858
+ description: The domain name that had the auth code requested
5859
+ title: Name
5860
+ type: string
5861
+ success:
5862
+ description: Whether the request had a successful result from EURid
5863
+ title: Success
5864
+ type: boolean
5865
+ required:
5866
+ - name
5867
+ - success
5868
+ title: RequestAuthcodeResponse
5869
+ type: object
5815
5870
  common__models__availability__datasource__DomainAvailabilityResponse:
5816
5871
  properties:
5817
5872
  meta:
@@ -5923,7 +5978,7 @@ info:
5923
5978
  '
5924
5979
  summary: OpusDNS - your gateway to a seamless domain management experience.
5925
5980
  title: OpusDNS API
5926
- version: 2025-12-10-161650
5981
+ version: 2025-12-11-092649
5927
5982
  x-logo:
5928
5983
  altText: OpusDNS API Reference
5929
5984
  url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
@@ -8800,6 +8855,178 @@ paths:
8800
8855
  summary: Patch domain forward redirects
8801
8856
  tags:
8802
8857
  - domain_forward
8858
+ post:
8859
+ description: Creates a new domain forward configuration. Wildcard forwards can
8860
+ be created by using *.hostname (e.g., *.example.com).
8861
+ operationId: create_domain_forward_v2_v1_domain_forwards_post
8862
+ requestBody:
8863
+ content:
8864
+ application/json:
8865
+ examples:
8866
+ domain_forward:
8867
+ description: Create a HTTP domain forward with redirect from HTTP
8868
+ to HTTPS and HTTPS to auth.example.com
8869
+ summary: HTTP domain forward
8870
+ value:
8871
+ enabled: false
8872
+ http:
8873
+ redirects:
8874
+ - redirect_code: 301
8875
+ request_path: /
8876
+ target_hostname: example.com
8877
+ target_path: /
8878
+ target_protocol: https
8879
+ wildcard: false
8880
+ https:
8881
+ redirects:
8882
+ - redirect_code: 302
8883
+ request_path: /
8884
+ target_hostname: auth.example.com
8885
+ target_path: /
8886
+ target_protocol: https
8887
+ wildcard: false
8888
+ wildcard: false
8889
+ http_to_https:
8890
+ description: Create a HTTP domain forward with redirect from HTTP
8891
+ to HTTPS
8892
+ summary: HTTP to HTTPS
8893
+ value:
8894
+ enabled: false
8895
+ https:
8896
+ redirects:
8897
+ - redirect_code: 301
8898
+ request_path: /
8899
+ target_hostname: example.com
8900
+ target_path: /
8901
+ target_protocol: https
8902
+ wildcard: false
8903
+ wildcard: false
8904
+ schema:
8905
+ $ref: '#/components/schemas/DomainForwardCreateRequest'
8906
+ required: true
8907
+ responses:
8908
+ '201':
8909
+ content:
8910
+ application/json:
8911
+ examples:
8912
+ http_domain_forward_response:
8913
+ description: Response when creating a HTTP domain forward with redirect
8914
+ from HTTP to HTTPS and HTTPS to auth.example.com
8915
+ summary: Response for HTTP domain forward
8916
+ value:
8917
+ created_on: '2025-11-14T09:01:38'
8918
+ enabled: false
8919
+ hostname: example.com.
8920
+ http:
8921
+ created_on: '2025-11-14T09:01:38'
8922
+ redirects:
8923
+ - redirect_code: 301
8924
+ request_hostname: example.com.
8925
+ request_path: /
8926
+ request_protocol: http
8927
+ target_hostname: example.com
8928
+ target_path: /
8929
+ target_protocol: https
8930
+ updated_on: '2025-11-14T09:01:38'
8931
+ wildcard: false
8932
+ https:
8933
+ created_on: '2025-11-14T09:01:38'
8934
+ redirects:
8935
+ - redirect_code: 302
8936
+ request_hostname: example.com.
8937
+ request_path: /
8938
+ request_protocol: https
8939
+ target_hostname: auth.example.com
8940
+ target_path: /
8941
+ target_protocol: https
8942
+ updated_on: '2025-11-14T09:01:38'
8943
+ wildcard: false
8944
+ updated_on: '2025-11-14T09:01:38'
8945
+ wildcard: false
8946
+ http_to_https_response:
8947
+ description: Response when creating a HTTP to HTTPS domain forward
8948
+ summary: Response for HTTP to HTTPS
8949
+ value:
8950
+ created_on: '2025-11-14T09:01:38'
8951
+ enabled: false
8952
+ hostname: example.com.
8953
+ http:
8954
+ created_on: '2025-11-14T09:01:38'
8955
+ redirects:
8956
+ - redirect_code: 301
8957
+ request_hostname: example.com.
8958
+ request_path: /
8959
+ request_protocol: http
8960
+ target_hostname: example.com
8961
+ target_path: /
8962
+ target_protocol: https
8963
+ updated_on: '2025-11-14T09:01:38'
8964
+ wildcard: false
8965
+ updated_on: '2025-11-14T09:01:38'
8966
+ wildcard: false
8967
+ schema:
8968
+ $ref: '#/components/schemas/DomainForward'
8969
+ description: Domain forward created successfully
8970
+ '401':
8971
+ content:
8972
+ application/problem+json:
8973
+ example:
8974
+ code: ERROR_AUTHENTICATION
8975
+ detail: Additional error context.
8976
+ status: 401
8977
+ title: Authentication Error
8978
+ type: authentication
8979
+ schema:
8980
+ $ref: '#/components/schemas/Problem'
8981
+ description: Unauthorized
8982
+ '403':
8983
+ content:
8984
+ application/problem+json:
8985
+ example:
8986
+ code: ERROR_PERMISSION_DENIED
8987
+ detail: Insufficient permissions to perform this action
8988
+ status: 403
8989
+ title: Permission Denied
8990
+ type: permission-denied
8991
+ schema:
8992
+ $ref: '#/components/schemas/Problem'
8993
+ description: Forbidden
8994
+ '404':
8995
+ content:
8996
+ application/problem+json:
8997
+ example:
8998
+ code: ERROR_ZONE_NOT_FOUND
8999
+ detail: Zone not found
9000
+ status: 404
9001
+ title: DNS Error
9002
+ type: dns-zone-not-found
9003
+ zone_name: Zone example.com. not found
9004
+ schema:
9005
+ $ref: '#/components/schemas/Problem'
9006
+ description: DNS zone was not found
9007
+ '409':
9008
+ content:
9009
+ application/problem+json:
9010
+ example:
9011
+ code: ERROR_DOMAIN_FORWARD_ALREADY_EXISTS
9012
+ detail: Domain forward already exists for example.com.
9013
+ status: 409
9014
+ title: Domain Forward Error
9015
+ type: domain-forward-already-exists
9016
+ schema:
9017
+ $ref: '#/components/schemas/Problem'
9018
+ description: Domain forward already exists
9019
+ '422':
9020
+ content:
9021
+ application/problem+json:
9022
+ schema:
9023
+ $ref: '#/components/schemas/HTTPValidationError'
9024
+ description: Validation Error
9025
+ security:
9026
+ - OAuth2PasswordBearer: []
9027
+ summary: Create a domain forward
9028
+ tags:
9029
+ - domain_forward
8803
9030
  /v1/domain-forwards/{hostname}:
8804
9031
  delete:
8805
9032
  description: Deletes the domain forward configuration for the specified hostname
@@ -8930,7 +9157,9 @@ paths:
8930
9157
  tags:
8931
9158
  - domain_forward
8932
9159
  post:
8933
- description: Creates a new domain forward configuration for the specified hostname
9160
+ deprecated: true
9161
+ description: '**DEPRECATED**: Use POST /v1/domain-forwards instead. Creates
9162
+ a new domain forward configuration for the specified hostname.'
8934
9163
  operationId: create_domain_forward_v1_domain_forwards__hostname__post
8935
9164
  parameters:
8936
9165
  - description: Hostname
@@ -9106,7 +9335,7 @@ paths:
9106
9335
  description: Validation Error
9107
9336
  security:
9108
9337
  - OAuth2PasswordBearer: []
9109
- summary: Create a domain forward
9338
+ summary: Create a domain forward (deprecated)
9110
9339
  tags:
9111
9340
  - domain_forward
9112
9341
  /v1/domain-forwards/{hostname}/disable:
@@ -9174,15 +9403,6 @@ paths:
9174
9403
  description: Hostname
9175
9404
  title: Hostname
9176
9405
  type: string
9177
- - description: Wildcard domain forwarding
9178
- in: query
9179
- name: wildcard
9180
- required: false
9181
- schema:
9182
- default: false
9183
- description: Wildcard domain forwarding
9184
- title: Wildcard
9185
- type: boolean
9186
9406
  responses:
9187
9407
  '204':
9188
9408
  description: Successful Response
@@ -9193,7 +9413,7 @@ paths:
9193
9413
  code: ERROR_DOMAIN_FORWARD_WILDCARD_NOT_SUPPORTED
9194
9414
  detail: Additional error context.
9195
9415
  status: 400
9196
- title: Wildcard Not Supported
9416
+ title: HTTPS Wildcard Not Supported
9197
9417
  type: domain-forward-wildcard-not-supported
9198
9418
  schema:
9199
9419
  $ref: '#/components/schemas/Problem'
@@ -10046,7 +10266,7 @@ paths:
10046
10266
  content:
10047
10267
  application/json:
10048
10268
  schema:
10049
- $ref: '#/components/schemas/RequestAuthcodeResponse'
10269
+ $ref: '#/components/schemas/api__domain__tld_specific__be__models__RequestAuthcodeResponse'
10050
10270
  description: Successful Response
10051
10271
  '400':
10052
10272
  content:
@@ -10142,6 +10362,69 @@ paths:
10142
10362
  tags:
10143
10363
  - domain
10144
10364
  - domain_tld_specific
10365
+ /v1/domains/tld-specific/eu/{domain_reference}/auth_code/request:
10366
+ post:
10367
+ operationId: request_auth_code_v1_domains_tld_specific_eu__domain_reference__auth_code_request_post
10368
+ parameters:
10369
+ - in: path
10370
+ name: domain_reference
10371
+ required: true
10372
+ schema:
10373
+ anyOf:
10374
+ - examples:
10375
+ - domain_01h45ytscbebyvny4gc8cr8ma2
10376
+ format: typeid
10377
+ pattern: ^domain_[0-7][0-9a-hjkmnpq-tv-z]{25}$
10378
+ type: string
10379
+ x-typeid-prefix: domain
10380
+ - type: string
10381
+ title: Domain Reference
10382
+ responses:
10383
+ '200':
10384
+ content:
10385
+ application/json:
10386
+ schema:
10387
+ $ref: '#/components/schemas/api__domain__tld_specific__eu__models__RequestAuthcodeResponse'
10388
+ description: Successful Response
10389
+ '400':
10390
+ content:
10391
+ application/problem+json:
10392
+ example:
10393
+ code: ERROR_DOMAIN_TRANSFER
10394
+ detail: There was an error transferring the domain
10395
+ domain_name: Additional error context.
10396
+ reason: An unspecified error occurred
10397
+ status: 400
10398
+ title: Domain Transfer Error
10399
+ type: domain-transfer
10400
+ schema:
10401
+ $ref: '#/components/schemas/Problem'
10402
+ description: Bad Request
10403
+ '404':
10404
+ content:
10405
+ application/problem+json:
10406
+ example:
10407
+ code: ERROR_DOMAIN_NOT_FOUND
10408
+ detail: Domain not found
10409
+ domain_name: Additional error context.
10410
+ status: 404
10411
+ title: Domain Management Error
10412
+ type: domain-not-found
10413
+ schema:
10414
+ $ref: '#/components/schemas/Problem'
10415
+ description: Not Found
10416
+ '422':
10417
+ content:
10418
+ application/problem+json:
10419
+ schema:
10420
+ $ref: '#/components/schemas/HTTPValidationError'
10421
+ description: Validation Error
10422
+ security:
10423
+ - OAuth2PasswordBearer: []
10424
+ summary: Requests your auth code directly from EURid (registry)
10425
+ tags:
10426
+ - domain
10427
+ - domain_tld_specific
10145
10428
  /v1/domains/transfer:
10146
10429
  post:
10147
10430
  description: 'Start the transfer process for a domain <br>