@opusdns/api 0.109.0 → 0.111.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 +105 -0
- package/src/helpers/requests.d.ts +38 -0
- package/src/helpers/responses.d.ts +114 -3
- package/src/helpers/schemas.d.ts +16 -0
- package/src/openapi.yaml +541 -9
- package/src/schema.d.ts +122 -7
package/package.json
CHANGED
package/src/helpers/keys.ts
CHANGED
|
@@ -141,6 +141,7 @@ import { PublicAuthRequestForm } from './schemas';
|
|
|
141
141
|
import { RdapBase } from './schemas';
|
|
142
142
|
import { RegistryLockBase } from './schemas';
|
|
143
143
|
import { RelationSet } from './schemas';
|
|
144
|
+
import { RequestAuthcode } from './schemas';
|
|
144
145
|
import { RequestHistory } from './schemas';
|
|
145
146
|
import { ReservedDomainsBase } from './schemas';
|
|
146
147
|
import { RgpOperations } from './schemas';
|
|
@@ -17284,6 +17285,110 @@ export const KEYS_RELATION_SET = [
|
|
|
17284
17285
|
KEY_RELATION_SET_RELATIONS,
|
|
17285
17286
|
] as const satisfies (keyof RelationSet)[];
|
|
17286
17287
|
|
|
17288
|
+
/**
|
|
17289
|
+
* Detail
|
|
17290
|
+
*
|
|
17291
|
+
* Additional information about the result in case of failure
|
|
17292
|
+
*
|
|
17293
|
+
*
|
|
17294
|
+
*
|
|
17295
|
+
* @remarks
|
|
17296
|
+
* This key constant provides type-safe access to the `detail` property of RequestAuthcode objects.
|
|
17297
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
17298
|
+
*
|
|
17299
|
+
* @example
|
|
17300
|
+
* ```typescript
|
|
17301
|
+
* // Direct property access
|
|
17302
|
+
* const value = requestauthcode[KEY_REQUEST_AUTHCODE_DETAIL];
|
|
17303
|
+
*
|
|
17304
|
+
* // Dynamic property access
|
|
17305
|
+
* const propertyName = KEY_REQUEST_AUTHCODE_DETAIL;
|
|
17306
|
+
* const value = requestauthcode[propertyName];
|
|
17307
|
+
* ```
|
|
17308
|
+
*
|
|
17309
|
+
* @see {@link RequestAuthcode} - The TypeScript type definition
|
|
17310
|
+
* @see {@link KEYS_REQUEST_AUTHCODE} - Array of all keys for this type
|
|
17311
|
+
*/
|
|
17312
|
+
export const KEY_REQUEST_AUTHCODE_DETAIL = 'detail' as keyof RequestAuthcode;
|
|
17313
|
+
/**
|
|
17314
|
+
* Name
|
|
17315
|
+
*
|
|
17316
|
+
* The domain name that had the auth code requested
|
|
17317
|
+
*
|
|
17318
|
+
* @type {string}
|
|
17319
|
+
*
|
|
17320
|
+
*
|
|
17321
|
+
* @remarks
|
|
17322
|
+
* This key constant provides type-safe access to the `name` property of RequestAuthcode objects.
|
|
17323
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
17324
|
+
*
|
|
17325
|
+
* @example
|
|
17326
|
+
* ```typescript
|
|
17327
|
+
* // Direct property access
|
|
17328
|
+
* const value = requestauthcode[KEY_REQUEST_AUTHCODE_NAME];
|
|
17329
|
+
*
|
|
17330
|
+
* // Dynamic property access
|
|
17331
|
+
* const propertyName = KEY_REQUEST_AUTHCODE_NAME;
|
|
17332
|
+
* const value = requestauthcode[propertyName];
|
|
17333
|
+
* ```
|
|
17334
|
+
*
|
|
17335
|
+
* @see {@link RequestAuthcode} - The TypeScript type definition
|
|
17336
|
+
* @see {@link KEYS_REQUEST_AUTHCODE} - Array of all keys for this type
|
|
17337
|
+
*/
|
|
17338
|
+
export const KEY_REQUEST_AUTHCODE_NAME = 'name' as keyof RequestAuthcode;
|
|
17339
|
+
/**
|
|
17340
|
+
* Success
|
|
17341
|
+
*
|
|
17342
|
+
* Whether the request had a successful result from DNS Belgium
|
|
17343
|
+
*
|
|
17344
|
+
* @type {boolean}
|
|
17345
|
+
*
|
|
17346
|
+
*
|
|
17347
|
+
* @remarks
|
|
17348
|
+
* This key constant provides type-safe access to the `success` property of RequestAuthcode objects.
|
|
17349
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
17350
|
+
*
|
|
17351
|
+
* @example
|
|
17352
|
+
* ```typescript
|
|
17353
|
+
* // Direct property access
|
|
17354
|
+
* const value = requestauthcode[KEY_REQUEST_AUTHCODE_SUCCESS];
|
|
17355
|
+
*
|
|
17356
|
+
* // Dynamic property access
|
|
17357
|
+
* const propertyName = KEY_REQUEST_AUTHCODE_SUCCESS;
|
|
17358
|
+
* const value = requestauthcode[propertyName];
|
|
17359
|
+
* ```
|
|
17360
|
+
*
|
|
17361
|
+
* @see {@link RequestAuthcode} - The TypeScript type definition
|
|
17362
|
+
* @see {@link KEYS_REQUEST_AUTHCODE} - Array of all keys for this type
|
|
17363
|
+
*/
|
|
17364
|
+
export const KEY_REQUEST_AUTHCODE_SUCCESS = 'success' as keyof RequestAuthcode;
|
|
17365
|
+
|
|
17366
|
+
/**
|
|
17367
|
+
* Array of all RequestAuthcode property keys
|
|
17368
|
+
*
|
|
17369
|
+
* @remarks
|
|
17370
|
+
* This constant provides a readonly array containing all valid property keys for RequestAuthcode objects.
|
|
17371
|
+
* Useful for iteration, validation, and generating dynamic UI components.
|
|
17372
|
+
*
|
|
17373
|
+
* @example
|
|
17374
|
+
* ```typescript
|
|
17375
|
+
* // Iterating through all keys
|
|
17376
|
+
* for (const key of KEYS_REQUEST_AUTHCODE) {
|
|
17377
|
+
* console.log(`Property: ${key}, Value: ${requestauthcode[key]}`);
|
|
17378
|
+
* }
|
|
17379
|
+
*
|
|
17380
|
+
* // Validation
|
|
17381
|
+
* const isValidKey = KEYS_REQUEST_AUTHCODE.includes(someKey);
|
|
17382
|
+
* ```
|
|
17383
|
+
*
|
|
17384
|
+
* @see {@link RequestAuthcode} - The TypeScript type definition
|
|
17385
|
+
*/
|
|
17386
|
+
export const KEYS_REQUEST_AUTHCODE = [
|
|
17387
|
+
KEY_REQUEST_AUTHCODE_DETAIL,
|
|
17388
|
+
KEY_REQUEST_AUTHCODE_NAME,
|
|
17389
|
+
KEY_REQUEST_AUTHCODE_SUCCESS,
|
|
17390
|
+
] as const satisfies (keyof RequestAuthcode)[];
|
|
17391
|
+
|
|
17287
17392
|
/**
|
|
17288
17393
|
* Client Ip
|
|
17289
17394
|
*
|
|
@@ -2458,6 +2458,44 @@ export type POST_DomainsTldSpecificAtDomainReferenceWithdraw_Request_Path = POST
|
|
|
2458
2458
|
*/
|
|
2459
2459
|
export type POST_DomainsTldSpecificAtDomainReferenceWithdraw_Request_Body = POST_DomainsTldSpecificAtDomainReferenceWithdraw_Request['requestBody'];
|
|
2460
2460
|
|
|
2461
|
+
/**
|
|
2462
|
+
* Request type for POST DomainsTldSpecificBeDomainReferenceAuthCodeRequest endpoint
|
|
2463
|
+
*
|
|
2464
|
+
* Requests your auth code directly from DNS Belgium (registry)
|
|
2465
|
+
*
|
|
2466
|
+
* @remarks
|
|
2467
|
+
* This type defines the complete request structure for the POST DomainsTldSpecificBeDomainReferenceAuthCodeRequest endpoint.
|
|
2468
|
+
* It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
|
|
2469
|
+
* Use this type to ensure type safety when making API requests to this endpoint.
|
|
2470
|
+
*
|
|
2471
|
+
* @example
|
|
2472
|
+
* Use this type to ensure type safety when making API requests to this endpoint.
|
|
2473
|
+
*
|
|
2474
|
+
* @path /v1/domains/tld-specific/be/{domain_reference}/auth_code/request
|
|
2475
|
+
*
|
|
2476
|
+
* @see {@link POST_DomainsTldSpecificBeDomainReferenceAuthCodeRequest_Request_Query} - Query parameters type
|
|
2477
|
+
* @see {@link POST_DomainsTldSpecificBeDomainReferenceAuthCodeRequest_Request_Path} - Path parameters type
|
|
2478
|
+
* @see {@link POST_DomainsTldSpecificBeDomainReferenceAuthCodeRequest_Request_Body} - Request body type
|
|
2479
|
+
*/
|
|
2480
|
+
export type POST_DomainsTldSpecificBeDomainReferenceAuthCodeRequest_Request = {
|
|
2481
|
+
parameters: {
|
|
2482
|
+
path: operations['request_auth_code_v1_domains_tld_specific_be__domain_reference__auth_code_request_post']['parameters']['path'];
|
|
2483
|
+
};
|
|
2484
|
+
}
|
|
2485
|
+
/**
|
|
2486
|
+
* Path parameters for POST /v1/domains/tld-specific/be/{domain_reference}/auth_code/request
|
|
2487
|
+
*
|
|
2488
|
+
* @remarks
|
|
2489
|
+
* This type defines the path parameters for the POST /v1/domains/tld-specific/be/{domain_reference}/auth_code/request endpoint.
|
|
2490
|
+
* It provides type safety for all path parameters as defined in the OpenAPI specification.
|
|
2491
|
+
*
|
|
2492
|
+
* @example
|
|
2493
|
+
* Use this type to ensure type safety for path parameters.
|
|
2494
|
+
*
|
|
2495
|
+
* @path /v1/domains/tld-specific/be/{domain_reference}/auth_code/request
|
|
2496
|
+
*/
|
|
2497
|
+
export type POST_DomainsTldSpecificBeDomainReferenceAuthCodeRequest_Request_Path = POST_DomainsTldSpecificBeDomainReferenceAuthCodeRequest_Request['parameters']['path'];
|
|
2498
|
+
|
|
2461
2499
|
/**
|
|
2462
2500
|
* Request type for POST DomainsTldSpecificDeDomainReferenceTransit endpoint
|
|
2463
2501
|
*
|
|
@@ -34,7 +34,7 @@
|
|
|
34
34
|
|
|
35
35
|
import { DomainDnssecDataArray, OrganizationAttribute2Array, IpRestrictionArray, TldResponseShortArray } from './schemas-arrays.d';
|
|
36
36
|
|
|
37
|
-
import { Pagination_ObjectLog, HTTPValidationError, Pagination_RequestHistory, Problem, DomainAvailabilityList, Pagination_ContactSchema, ContactSchema, ContactVerification, Contact, Pagination_DnsZone, DnsZone, DnsChanges, DomainForwardZone, Pagination_DomainForwardZone, DnsZoneSummary, Pagination_DomainForward, DomainForward, DomainForwardSet, DomainSearch, Pagination_Domain, Domain, DomainRenew, DomainRestore, DomainCheck, DomainSummary, DomainWithdraw, DomainTransit, Pagination_EmailForwardAlias, EmailForwardAlias, Pagination_Event, EventSchema, Pagination_Organization, Organization, OrganizationWithBillingData, Pagination_Invoice, GetPrices, Pagination_BillingTransaction, BillingTransaction, IpRestriction, Pagination_User, TldSpecification, User, UserWithAttributes, PermissionSet, RelationSet, UserWithRelationPermissions } from './schemas.d';
|
|
37
|
+
import { Pagination_ObjectLog, HTTPValidationError, Pagination_RequestHistory, Problem, DomainAvailabilityList, Pagination_ContactSchema, ContactSchema, ContactVerification, Contact, Pagination_DnsZone, DnsZone, DnsChanges, DomainForwardZone, Pagination_DomainForwardZone, DnsZoneSummary, Pagination_DomainForward, DomainForward, DomainForwardSet, DomainSearch, Pagination_Domain, Domain, DomainRenew, DomainRestore, DomainCheck, DomainSummary, DomainWithdraw, RequestAuthcode, DomainTransit, Pagination_EmailForwardAlias, EmailForwardAlias, Pagination_Event, EventSchema, Pagination_Organization, Organization, OrganizationWithBillingData, Pagination_Invoice, GetPrices, Pagination_BillingTransaction, BillingTransaction, IpRestriction, Pagination_User, TldSpecification, User, UserWithAttributes, PermissionSet, RelationSet, UserWithRelationPermissions } from './schemas.d';
|
|
38
38
|
|
|
39
39
|
/**
|
|
40
40
|
* Response types for GET ArchiveObjectLogs endpoint
|
|
@@ -1518,11 +1518,12 @@ export type GET_DnsByZoneName_Response_422 = HTTPValidationError
|
|
|
1518
1518
|
* @param zone_name (path) - DNS zone name (trailing dot optional)
|
|
1519
1519
|
*
|
|
1520
1520
|
* @see {@link POST_DnsByZoneNameDnssecDisable_Response_200} - 200 response type
|
|
1521
|
+
* @see {@link POST_DnsByZoneNameDnssecDisable_Response_400} - 400 response type
|
|
1521
1522
|
* @see {@link POST_DnsByZoneNameDnssecDisable_Response_422} - 422 response type
|
|
1522
1523
|
*
|
|
1523
1524
|
|
|
1524
1525
|
*/
|
|
1525
|
-
export type POST_DnsByZoneNameDnssecDisable_Response = POST_DnsByZoneNameDnssecDisable_Response_200 | POST_DnsByZoneNameDnssecDisable_Response_422;
|
|
1526
|
+
export type POST_DnsByZoneNameDnssecDisable_Response = POST_DnsByZoneNameDnssecDisable_Response_200 | POST_DnsByZoneNameDnssecDisable_Response_400 | POST_DnsByZoneNameDnssecDisable_Response_422;
|
|
1526
1527
|
|
|
1527
1528
|
/**
|
|
1528
1529
|
* 200 response for POST DnsByZoneNameDnssecDisable endpoint
|
|
@@ -1542,6 +1543,24 @@ export type POST_DnsByZoneNameDnssecDisable_Response = POST_DnsByZoneNameDnssecD
|
|
|
1542
1543
|
*/
|
|
1543
1544
|
export type POST_DnsByZoneNameDnssecDisable_Response_200 = DnsChanges
|
|
1544
1545
|
|
|
1546
|
+
/**
|
|
1547
|
+
* 400 response for POST DnsByZoneNameDnssecDisable endpoint
|
|
1548
|
+
*
|
|
1549
|
+
* @remarks
|
|
1550
|
+
* This type defines the response structure for the 400 status code
|
|
1551
|
+
* of the POST DnsByZoneNameDnssecDisable endpoint.
|
|
1552
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
1553
|
+
*
|
|
1554
|
+
|
|
1555
|
+
*
|
|
1556
|
+
* @path /v1/dns/{zone_name}/dnssec/disable
|
|
1557
|
+
* @param zone_name (path) - DNS zone name (trailing dot optional)
|
|
1558
|
+
*
|
|
1559
|
+
* @see {@link POST_DnsByZoneNameDnssecDisable_Response} - The main response type definition
|
|
1560
|
+
* @see {@link Problem} - The actual schema type definition
|
|
1561
|
+
*/
|
|
1562
|
+
export type POST_DnsByZoneNameDnssecDisable_Response_400 = Problem
|
|
1563
|
+
|
|
1545
1564
|
/**
|
|
1546
1565
|
* 422 response for POST DnsByZoneNameDnssecDisable endpoint
|
|
1547
1566
|
*
|
|
@@ -1576,11 +1595,12 @@ export type POST_DnsByZoneNameDnssecDisable_Response_422 = HTTPValidationError
|
|
|
1576
1595
|
* @param zone_name (path) - DNS zone name (trailing dot optional)
|
|
1577
1596
|
*
|
|
1578
1597
|
* @see {@link POST_DnsByZoneNameDnssecEnable_Response_200} - 200 response type
|
|
1598
|
+
* @see {@link POST_DnsByZoneNameDnssecEnable_Response_400} - 400 response type
|
|
1579
1599
|
* @see {@link POST_DnsByZoneNameDnssecEnable_Response_422} - 422 response type
|
|
1580
1600
|
*
|
|
1581
1601
|
|
|
1582
1602
|
*/
|
|
1583
|
-
export type POST_DnsByZoneNameDnssecEnable_Response = POST_DnsByZoneNameDnssecEnable_Response_200 | POST_DnsByZoneNameDnssecEnable_Response_422;
|
|
1603
|
+
export type POST_DnsByZoneNameDnssecEnable_Response = POST_DnsByZoneNameDnssecEnable_Response_200 | POST_DnsByZoneNameDnssecEnable_Response_400 | POST_DnsByZoneNameDnssecEnable_Response_422;
|
|
1584
1604
|
|
|
1585
1605
|
/**
|
|
1586
1606
|
* 200 response for POST DnsByZoneNameDnssecEnable endpoint
|
|
@@ -1600,6 +1620,24 @@ export type POST_DnsByZoneNameDnssecEnable_Response = POST_DnsByZoneNameDnssecEn
|
|
|
1600
1620
|
*/
|
|
1601
1621
|
export type POST_DnsByZoneNameDnssecEnable_Response_200 = DnsChanges
|
|
1602
1622
|
|
|
1623
|
+
/**
|
|
1624
|
+
* 400 response for POST DnsByZoneNameDnssecEnable endpoint
|
|
1625
|
+
*
|
|
1626
|
+
* @remarks
|
|
1627
|
+
* This type defines the response structure for the 400 status code
|
|
1628
|
+
* of the POST DnsByZoneNameDnssecEnable endpoint.
|
|
1629
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
1630
|
+
*
|
|
1631
|
+
|
|
1632
|
+
*
|
|
1633
|
+
* @path /v1/dns/{zone_name}/dnssec/enable
|
|
1634
|
+
* @param zone_name (path) - DNS zone name (trailing dot optional)
|
|
1635
|
+
*
|
|
1636
|
+
* @see {@link POST_DnsByZoneNameDnssecEnable_Response} - The main response type definition
|
|
1637
|
+
* @see {@link Problem} - The actual schema type definition
|
|
1638
|
+
*/
|
|
1639
|
+
export type POST_DnsByZoneNameDnssecEnable_Response_400 = Problem
|
|
1640
|
+
|
|
1603
1641
|
/**
|
|
1604
1642
|
* 422 response for POST DnsByZoneNameDnssecEnable endpoint
|
|
1605
1643
|
*
|
|
@@ -4393,6 +4431,79 @@ export type POST_DomainsTldSpecificAtByDomainReferenceWithdraw_Response_404 = Pr
|
|
|
4393
4431
|
*/
|
|
4394
4432
|
export type POST_DomainsTldSpecificAtByDomainReferenceWithdraw_Response_422 = HTTPValidationError
|
|
4395
4433
|
|
|
4434
|
+
/**
|
|
4435
|
+
* Response types for POST DomainsTldSpecificBeByDomainReferenceAuthCodeRequest endpoint
|
|
4436
|
+
*
|
|
4437
|
+
* Requests your auth code directly from DNS Belgium (registry)
|
|
4438
|
+
*
|
|
4439
|
+
* @remarks
|
|
4440
|
+
* This type defines all possible response structures for the POST DomainsTldSpecificBeByDomainReferenceAuthCodeRequest endpoint.
|
|
4441
|
+
* Each response code maps to a specific response type as defined in the OpenAPI specification.
|
|
4442
|
+
* Use this type to ensure type safety when handling API responses from this endpoint.
|
|
4443
|
+
*
|
|
4444
|
+
|
|
4445
|
+
*
|
|
4446
|
+
* @path /v1/domains/tld-specific/be/{domain_reference}/auth_code/request
|
|
4447
|
+
*
|
|
4448
|
+
* @see {@link POST_DomainsTldSpecificBeByDomainReferenceAuthCodeRequest_Response_200} - 200 response type
|
|
4449
|
+
* @see {@link POST_DomainsTldSpecificBeByDomainReferenceAuthCodeRequest_Response_404} - 404 response type
|
|
4450
|
+
* @see {@link POST_DomainsTldSpecificBeByDomainReferenceAuthCodeRequest_Response_422} - 422 response type
|
|
4451
|
+
*
|
|
4452
|
+
|
|
4453
|
+
*/
|
|
4454
|
+
export type POST_DomainsTldSpecificBeByDomainReferenceAuthCodeRequest_Response = POST_DomainsTldSpecificBeByDomainReferenceAuthCodeRequest_Response_200 | POST_DomainsTldSpecificBeByDomainReferenceAuthCodeRequest_Response_404 | POST_DomainsTldSpecificBeByDomainReferenceAuthCodeRequest_Response_422;
|
|
4455
|
+
|
|
4456
|
+
/**
|
|
4457
|
+
* 200 response for POST DomainsTldSpecificBeByDomainReferenceAuthCodeRequest endpoint
|
|
4458
|
+
*
|
|
4459
|
+
* @remarks
|
|
4460
|
+
* This type defines the response structure for the 200 status code
|
|
4461
|
+
* of the POST DomainsTldSpecificBeByDomainReferenceAuthCodeRequest endpoint.
|
|
4462
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
4463
|
+
*
|
|
4464
|
+
|
|
4465
|
+
*
|
|
4466
|
+
* @path /v1/domains/tld-specific/be/{domain_reference}/auth_code/request
|
|
4467
|
+
*
|
|
4468
|
+
* @see {@link POST_DomainsTldSpecificBeByDomainReferenceAuthCodeRequest_Response} - The main response type definition
|
|
4469
|
+
* @see {@link RequestAuthcode} - The actual schema type definition
|
|
4470
|
+
*/
|
|
4471
|
+
export type POST_DomainsTldSpecificBeByDomainReferenceAuthCodeRequest_Response_200 = RequestAuthcode
|
|
4472
|
+
|
|
4473
|
+
/**
|
|
4474
|
+
* 404 response for POST DomainsTldSpecificBeByDomainReferenceAuthCodeRequest endpoint
|
|
4475
|
+
*
|
|
4476
|
+
* @remarks
|
|
4477
|
+
* This type defines the response structure for the 404 status code
|
|
4478
|
+
* of the POST DomainsTldSpecificBeByDomainReferenceAuthCodeRequest endpoint.
|
|
4479
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
4480
|
+
*
|
|
4481
|
+
|
|
4482
|
+
*
|
|
4483
|
+
* @path /v1/domains/tld-specific/be/{domain_reference}/auth_code/request
|
|
4484
|
+
*
|
|
4485
|
+
* @see {@link POST_DomainsTldSpecificBeByDomainReferenceAuthCodeRequest_Response} - The main response type definition
|
|
4486
|
+
* @see {@link Problem} - The actual schema type definition
|
|
4487
|
+
*/
|
|
4488
|
+
export type POST_DomainsTldSpecificBeByDomainReferenceAuthCodeRequest_Response_404 = Problem
|
|
4489
|
+
|
|
4490
|
+
/**
|
|
4491
|
+
* 422 response for POST DomainsTldSpecificBeByDomainReferenceAuthCodeRequest endpoint
|
|
4492
|
+
*
|
|
4493
|
+
* @remarks
|
|
4494
|
+
* This type defines the response structure for the 422 status code
|
|
4495
|
+
* of the POST DomainsTldSpecificBeByDomainReferenceAuthCodeRequest endpoint.
|
|
4496
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
4497
|
+
*
|
|
4498
|
+
|
|
4499
|
+
*
|
|
4500
|
+
* @path /v1/domains/tld-specific/be/{domain_reference}/auth_code/request
|
|
4501
|
+
*
|
|
4502
|
+
* @see {@link POST_DomainsTldSpecificBeByDomainReferenceAuthCodeRequest_Response} - The main response type definition
|
|
4503
|
+
* @see {@link HTTPValidationError} - The actual schema type definition
|
|
4504
|
+
*/
|
|
4505
|
+
export type POST_DomainsTldSpecificBeByDomainReferenceAuthCodeRequest_Response_422 = HTTPValidationError
|
|
4506
|
+
|
|
4396
4507
|
/**
|
|
4397
4508
|
* Response types for POST DomainsTldSpecificDeByDomainReferenceTransit endpoint
|
|
4398
4509
|
*
|
package/src/helpers/schemas.d.ts
CHANGED
|
@@ -2943,6 +2943,22 @@ export type RelationSet = components['schemas']['RelationSet'];
|
|
|
2943
2943
|
* @see {@link components} - The OpenAPI components schema definition
|
|
2944
2944
|
*/
|
|
2945
2945
|
export type RenewalMode = components['schemas']['RenewalMode'];
|
|
2946
|
+
/**
|
|
2947
|
+
* RequestAuthcodeResponse
|
|
2948
|
+
*
|
|
2949
|
+
* @remarks
|
|
2950
|
+
* Type alias for the `RequestAuthcodeResponse` OpenAPI schema.
|
|
2951
|
+
* This type represents requestauthcoderesponse data structures used in API requests and responses.
|
|
2952
|
+
*
|
|
2953
|
+
* @example
|
|
2954
|
+
* ```typescript
|
|
2955
|
+
* const response = await api.getRequestAuthcode();
|
|
2956
|
+
* const item: RequestAuthcode = response.results;
|
|
2957
|
+
* ```
|
|
2958
|
+
*
|
|
2959
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
2960
|
+
*/
|
|
2961
|
+
export type RequestAuthcode = components['schemas']['RequestAuthcodeResponse'];
|
|
2946
2962
|
/**
|
|
2947
2963
|
* RequestHistory
|
|
2948
2964
|
*
|
package/src/openapi.yaml
CHANGED
|
@@ -4503,6 +4503,27 @@ components:
|
|
|
4503
4503
|
- delete
|
|
4504
4504
|
title: RenewalMode
|
|
4505
4505
|
type: string
|
|
4506
|
+
RequestAuthcodeResponse:
|
|
4507
|
+
properties:
|
|
4508
|
+
detail:
|
|
4509
|
+
anyOf:
|
|
4510
|
+
- type: string
|
|
4511
|
+
- type: 'null'
|
|
4512
|
+
description: Additional information about the result in case of failure
|
|
4513
|
+
title: Detail
|
|
4514
|
+
name:
|
|
4515
|
+
description: The domain name that had the auth code requested
|
|
4516
|
+
title: Name
|
|
4517
|
+
type: string
|
|
4518
|
+
success:
|
|
4519
|
+
description: Whether the request had a successful result from DNS Belgium
|
|
4520
|
+
title: Success
|
|
4521
|
+
type: boolean
|
|
4522
|
+
required:
|
|
4523
|
+
- name
|
|
4524
|
+
- success
|
|
4525
|
+
title: RequestAuthcodeResponse
|
|
4526
|
+
type: object
|
|
4506
4527
|
RequestHistory:
|
|
4507
4528
|
properties:
|
|
4508
4529
|
client_ip:
|
|
@@ -5608,7 +5629,7 @@ info:
|
|
|
5608
5629
|
'
|
|
5609
5630
|
summary: OpusDNS - your gateway to a seamless domain management experience.
|
|
5610
5631
|
title: OpusDNS API
|
|
5611
|
-
version: 2025-12-04-
|
|
5632
|
+
version: 2025-12-04-142309
|
|
5612
5633
|
x-logo:
|
|
5613
5634
|
altText: OpusDNS API Reference
|
|
5614
5635
|
url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
|
|
@@ -7000,9 +7021,43 @@ paths:
|
|
|
7000
7021
|
'200':
|
|
7001
7022
|
content:
|
|
7002
7023
|
application/json:
|
|
7024
|
+
examples:
|
|
7025
|
+
zones_list:
|
|
7026
|
+
description: Paginated list of DNS zones with their RRsets
|
|
7027
|
+
summary: List of zones
|
|
7028
|
+
value:
|
|
7029
|
+
pagination:
|
|
7030
|
+
current_page: 1
|
|
7031
|
+
has_next_page: false
|
|
7032
|
+
has_previous_page: false
|
|
7033
|
+
page_size: 10
|
|
7034
|
+
total_items: 1
|
|
7035
|
+
total_pages: 1
|
|
7036
|
+
results:
|
|
7037
|
+
- created_on: '2025-11-18T12:43:35Z'
|
|
7038
|
+
dnssec_status: disabled
|
|
7039
|
+
domain_parts:
|
|
7040
|
+
domain: example
|
|
7041
|
+
subdomain: ''
|
|
7042
|
+
suffix: com
|
|
7043
|
+
name: example.com.
|
|
7044
|
+
rrsets:
|
|
7045
|
+
- name: example.com.
|
|
7046
|
+
records:
|
|
7047
|
+
- rdata: ns1.opusdns.com. hostmaster.opusdns.com. 2025111801
|
|
7048
|
+
10800 3600 604800 300
|
|
7049
|
+
ttl: 3600
|
|
7050
|
+
type: SOA
|
|
7051
|
+
- name: example.com.
|
|
7052
|
+
records:
|
|
7053
|
+
- rdata: ns1.opusdns.com.
|
|
7054
|
+
- rdata: ns2.opusdns.net.
|
|
7055
|
+
ttl: 3600
|
|
7056
|
+
type: NS
|
|
7057
|
+
updated_on: '2025-11-18T12:43:35Z'
|
|
7003
7058
|
schema:
|
|
7004
7059
|
$ref: '#/components/schemas/Pagination_DnsZoneResponse_'
|
|
7005
|
-
description:
|
|
7060
|
+
description: List of DNS zones retrieved successfully
|
|
7006
7061
|
'422':
|
|
7007
7062
|
content:
|
|
7008
7063
|
application/problem+json:
|
|
@@ -7182,7 +7237,7 @@ paths:
|
|
|
7182
7237
|
rrset_type: NS
|
|
7183
7238
|
ttl: 3600
|
|
7184
7239
|
- action: create_record
|
|
7185
|
-
record_data: ns2.opusdns.
|
|
7240
|
+
record_data: ns2.opusdns.net.
|
|
7186
7241
|
rrset_name: example.com.
|
|
7187
7242
|
rrset_type: NS
|
|
7188
7243
|
ttl: 3600
|
|
@@ -7280,9 +7335,43 @@ paths:
|
|
|
7280
7335
|
'200':
|
|
7281
7336
|
content:
|
|
7282
7337
|
application/json:
|
|
7338
|
+
examples:
|
|
7339
|
+
domain_forwards:
|
|
7340
|
+
description: Paginated list of domain forwards organized by DNS
|
|
7341
|
+
zones with redirect configurations
|
|
7342
|
+
summary: Domain forwards by zone
|
|
7343
|
+
value:
|
|
7344
|
+
pagination:
|
|
7345
|
+
current_page: 1
|
|
7346
|
+
has_next_page: false
|
|
7347
|
+
has_previous_page: false
|
|
7348
|
+
page_size: 10
|
|
7349
|
+
total_items: 1
|
|
7350
|
+
total_pages: 1
|
|
7351
|
+
results:
|
|
7352
|
+
- domain_forwards:
|
|
7353
|
+
- created_on: '2025-11-18T12:59:57Z'
|
|
7354
|
+
enabled: false
|
|
7355
|
+
hostname: example.com.
|
|
7356
|
+
https:
|
|
7357
|
+
created_on: '2025-11-18T12:59:57Z'
|
|
7358
|
+
redirects:
|
|
7359
|
+
- redirect_code: 302
|
|
7360
|
+
request_hostname: example.com.
|
|
7361
|
+
request_path: /
|
|
7362
|
+
request_protocol: https
|
|
7363
|
+
target_hostname: auth.example.com.
|
|
7364
|
+
target_path: /
|
|
7365
|
+
target_protocol: https
|
|
7366
|
+
updated_on: '2025-11-18T12:59:57Z'
|
|
7367
|
+
wildcard: false
|
|
7368
|
+
updated_on: '2025-11-18T12:59:57Z'
|
|
7369
|
+
wildcard: false
|
|
7370
|
+
zone_id: zone_01kabfvtysfqwv4dn89r3jepym
|
|
7371
|
+
zone_name: example.com.
|
|
7283
7372
|
schema:
|
|
7284
7373
|
$ref: '#/components/schemas/Pagination_DomainForwardZone_'
|
|
7285
|
-
description:
|
|
7374
|
+
description: List of domain forwards grouped by DNS zones
|
|
7286
7375
|
'401':
|
|
7287
7376
|
content:
|
|
7288
7377
|
application/problem+json:
|
|
@@ -7325,9 +7414,18 @@ paths:
|
|
|
7325
7414
|
'200':
|
|
7326
7415
|
content:
|
|
7327
7416
|
application/json:
|
|
7417
|
+
examples:
|
|
7418
|
+
summary:
|
|
7419
|
+
description: Summary of DNS zones showing total count and breakdown
|
|
7420
|
+
by DNSSEC status
|
|
7421
|
+
summary: Zones summary
|
|
7422
|
+
value:
|
|
7423
|
+
total_zones: 1
|
|
7424
|
+
zones_by_dnssec:
|
|
7425
|
+
disabled: 1
|
|
7328
7426
|
schema:
|
|
7329
7427
|
$ref: '#/components/schemas/DnsZoneSummary'
|
|
7330
|
-
description:
|
|
7428
|
+
description: DNS zones summary retrieved successfully
|
|
7331
7429
|
security:
|
|
7332
7430
|
- OAuth2PasswordBearer: []
|
|
7333
7431
|
summary: Get Zones Summary
|
|
@@ -7374,9 +7472,88 @@ paths:
|
|
|
7374
7472
|
'200':
|
|
7375
7473
|
content:
|
|
7376
7474
|
application/json:
|
|
7475
|
+
examples:
|
|
7476
|
+
basic_zone:
|
|
7477
|
+
description: A newly created zone with only SOA and NS records
|
|
7478
|
+
summary: Basic zone with default records
|
|
7479
|
+
value:
|
|
7480
|
+
created_on: '2025-11-18T12:43:35Z'
|
|
7481
|
+
dnssec_status: disabled
|
|
7482
|
+
domain_parts:
|
|
7483
|
+
domain: example
|
|
7484
|
+
subdomain: ''
|
|
7485
|
+
suffix: com
|
|
7486
|
+
name: example.com.
|
|
7487
|
+
rrsets:
|
|
7488
|
+
- name: example.com.
|
|
7489
|
+
records:
|
|
7490
|
+
- rdata: ns1.opusdns.com. hostmaster.opusdns.com. 2025111801
|
|
7491
|
+
10800 3600 604800 300
|
|
7492
|
+
ttl: 3600
|
|
7493
|
+
type: SOA
|
|
7494
|
+
- name: example.com.
|
|
7495
|
+
records:
|
|
7496
|
+
- rdata: ns1.opusdns.com.
|
|
7497
|
+
- rdata: ns2.opusdns.net.
|
|
7498
|
+
ttl: 3600
|
|
7499
|
+
type: NS
|
|
7500
|
+
updated_on: '2025-11-18T12:43:35Z'
|
|
7501
|
+
zone_with_records:
|
|
7502
|
+
description: A fully configured zone with A, CNAME, MX, TXT records
|
|
7503
|
+
and DNSSEC enabled
|
|
7504
|
+
summary: Zone with custom records and DNSSEC
|
|
7505
|
+
value:
|
|
7506
|
+
created_on: '2025-11-15T10:30:00Z'
|
|
7507
|
+
dnssec_status: enabled
|
|
7508
|
+
domain_parts:
|
|
7509
|
+
domain: example
|
|
7510
|
+
subdomain: ''
|
|
7511
|
+
suffix: com
|
|
7512
|
+
name: example.com.
|
|
7513
|
+
rrsets:
|
|
7514
|
+
- name: example.com.
|
|
7515
|
+
records:
|
|
7516
|
+
- rdata: ns1.opusdns.com. hostmaster.opusdns.com. 2025111701
|
|
7517
|
+
10800 3600 604800 300
|
|
7518
|
+
ttl: 3600
|
|
7519
|
+
type: SOA
|
|
7520
|
+
- name: example.com.
|
|
7521
|
+
records:
|
|
7522
|
+
- rdata: ns1.opusdns.com.
|
|
7523
|
+
- rdata: ns2.opusdns.com.
|
|
7524
|
+
ttl: 3600
|
|
7525
|
+
type: NS
|
|
7526
|
+
- name: example.com.
|
|
7527
|
+
records:
|
|
7528
|
+
- rdata: 203.0.113.10
|
|
7529
|
+
ttl: 300
|
|
7530
|
+
type: A
|
|
7531
|
+
- name: www.example.com.
|
|
7532
|
+
records:
|
|
7533
|
+
- rdata: example.com.
|
|
7534
|
+
ttl: 300
|
|
7535
|
+
type: CNAME
|
|
7536
|
+
- name: example.com.
|
|
7537
|
+
records:
|
|
7538
|
+
- rdata: 10 mail.example.com.
|
|
7539
|
+
- rdata: 20 backup-mail.example.com.
|
|
7540
|
+
ttl: 300
|
|
7541
|
+
type: MX
|
|
7542
|
+
- name: example.com.
|
|
7543
|
+
records:
|
|
7544
|
+
- rdata: '"v=spf1 include:_spf.google.com ~all"'
|
|
7545
|
+
ttl: 300
|
|
7546
|
+
type: TXT
|
|
7547
|
+
- name: example.com.
|
|
7548
|
+
records:
|
|
7549
|
+
- rdata: 256 3 13 4epAMhnUgbFbAmKI2zbTXXFHGlVeHamiWLPdwJ8ehE9NgmvDNraqYF/0YdDcoc2elyelvi72KJyQfIR02axEeQ==
|
|
7550
|
+
- rdata: 257 3 13 Wx1Wk8Sl+PyanAWPYsCPw9qFv2Nv0U/MXoJGgpmdqgbLgtvPlVM1/66j/MFTOjk4ONGKGZoWbZ86ud18lWvacw==
|
|
7551
|
+
ttl: 300
|
|
7552
|
+
type: DNSKEY
|
|
7553
|
+
updated_on: '2025-11-17T14:20:00Z'
|
|
7377
7554
|
schema:
|
|
7378
7555
|
$ref: '#/components/schemas/DnsZoneResponse'
|
|
7379
|
-
description:
|
|
7556
|
+
description: DNS zone retrieved successfully
|
|
7380
7557
|
'422':
|
|
7381
7558
|
content:
|
|
7382
7559
|
application/problem+json:
|
|
@@ -7404,9 +7581,64 @@ paths:
|
|
|
7404
7581
|
'200':
|
|
7405
7582
|
content:
|
|
7406
7583
|
application/json:
|
|
7584
|
+
examples:
|
|
7585
|
+
dnssec_disabled:
|
|
7586
|
+
description: Changeset response showing DNSSEC keys and DS records
|
|
7587
|
+
removed
|
|
7588
|
+
summary: DNSSEC disabled for zone
|
|
7589
|
+
value:
|
|
7590
|
+
changes:
|
|
7591
|
+
- action: delete_record
|
|
7592
|
+
record_data: 256 3 13 5OmhbRQw0+xlqw4iYjM9SojiKkpfReE8LoMzzb3uDSvfvaePyreODC0Pf0eMti2hz/q9by5G7jh5nqQBRp8qAA==
|
|
7593
|
+
rrset_name: example.com.
|
|
7594
|
+
rrset_type: DNSKEY
|
|
7595
|
+
ttl: 300
|
|
7596
|
+
- action: delete_record
|
|
7597
|
+
record_data: 257 3 13 4knSelKBhrAmgwkLMDbJGXmpdO2vkPf6uwGn52BQmlgWXjIXnGqv9CYPTwplRf4mRbFKFDkhU8dn9AsNOL+8EQ==
|
|
7598
|
+
rrset_name: example.com.
|
|
7599
|
+
rrset_type: DNSKEY
|
|
7600
|
+
ttl: 300
|
|
7601
|
+
- action: delete_record
|
|
7602
|
+
record_data: 41074 13 2 0f8ad1e9b0de2eb958ba571208951e71330e6d9e2afa3c84ec6bd16d77bfc718
|
|
7603
|
+
rrset_name: example.com.
|
|
7604
|
+
rrset_type: DS
|
|
7605
|
+
ttl: 300
|
|
7606
|
+
- action: delete_record
|
|
7607
|
+
record_data: 41074 13 4 f2fa86164e45235537238dd5b86a6a2533fd17b1e8216c1d66d18ccfc79be4dca77e3bc6d76eb136e193c2cee0a6ea85
|
|
7608
|
+
rrset_name: example.com.
|
|
7609
|
+
rrset_type: DS
|
|
7610
|
+
ttl: 300
|
|
7611
|
+
- action: delete_record
|
|
7612
|
+
record_data: ns1.opusdns.com. hostmaster.opusdns.com. 2025111802
|
|
7613
|
+
10800 3600 604800 300
|
|
7614
|
+
rrset_name: example.com.
|
|
7615
|
+
rrset_type: SOA
|
|
7616
|
+
ttl: 3600
|
|
7617
|
+
- action: create_record
|
|
7618
|
+
record_data: ns1.opusdns.com. hostmaster.opusdns.com. 2025111803
|
|
7619
|
+
10800 3600 604800 300
|
|
7620
|
+
rrset_name: example.com.
|
|
7621
|
+
rrset_type: SOA
|
|
7622
|
+
ttl: 3600
|
|
7623
|
+
- action: disable_dnssec
|
|
7624
|
+
changeset_id: a2a336e2-de44-4e54-b160-1e25b117b0e9
|
|
7625
|
+
num_changes: 7
|
|
7626
|
+
zone_name: example.com.
|
|
7407
7627
|
schema:
|
|
7408
7628
|
$ref: '#/components/schemas/DnsChangesResponse'
|
|
7409
|
-
description:
|
|
7629
|
+
description: DNSSEC disabled successfully
|
|
7630
|
+
'400':
|
|
7631
|
+
content:
|
|
7632
|
+
application/problem+json:
|
|
7633
|
+
example:
|
|
7634
|
+
code: ERROR_DNS
|
|
7635
|
+
detail: Additional error context.
|
|
7636
|
+
status: 400
|
|
7637
|
+
title: DNS Error
|
|
7638
|
+
type: dns
|
|
7639
|
+
schema:
|
|
7640
|
+
$ref: '#/components/schemas/Problem'
|
|
7641
|
+
description: Bad Request
|
|
7410
7642
|
'422':
|
|
7411
7643
|
content:
|
|
7412
7644
|
application/problem+json:
|
|
@@ -7434,9 +7666,64 @@ paths:
|
|
|
7434
7666
|
'200':
|
|
7435
7667
|
content:
|
|
7436
7668
|
application/json:
|
|
7669
|
+
examples:
|
|
7670
|
+
dnssec_enabled:
|
|
7671
|
+
description: Changeset response showing DNSSEC keys and DS records
|
|
7672
|
+
created
|
|
7673
|
+
summary: DNSSEC enabled for zone
|
|
7674
|
+
value:
|
|
7675
|
+
changes:
|
|
7676
|
+
- action: delete_record
|
|
7677
|
+
record_data: ns1.opusdns.com. hostmaster.opusdns.com. 2025111801
|
|
7678
|
+
10800 3600 604800 300
|
|
7679
|
+
rrset_name: example.com.
|
|
7680
|
+
rrset_type: SOA
|
|
7681
|
+
ttl: 3600
|
|
7682
|
+
- action: create_record
|
|
7683
|
+
record_data: ns1.opusdns.com. hostmaster.opusdns.com. 2025111802
|
|
7684
|
+
10800 3600 604800 300
|
|
7685
|
+
rrset_name: example.com.
|
|
7686
|
+
rrset_type: SOA
|
|
7687
|
+
ttl: 3600
|
|
7688
|
+
- action: create_record
|
|
7689
|
+
record_data: 256 3 13 5OmhbRQw0+xlqw4iYjM9SojiKkpfReE8LoMzzb3uDSvfvaePyreODC0Pf0eMti2hz/q9by5G7jh5nqQBRp8qAA==
|
|
7690
|
+
rrset_name: example.com.
|
|
7691
|
+
rrset_type: DNSKEY
|
|
7692
|
+
ttl: 300
|
|
7693
|
+
- action: create_record
|
|
7694
|
+
record_data: 257 3 13 4knSelKBhrAmgwkLMDbJGXmpdO2vkPf6uwGn52BQmlgWXjIXnGqv9CYPTwplRf4mRbFKFDkhU8dn9AsNOL+8EQ==
|
|
7695
|
+
rrset_name: example.com.
|
|
7696
|
+
rrset_type: DNSKEY
|
|
7697
|
+
ttl: 300
|
|
7698
|
+
- action: create_record
|
|
7699
|
+
record_data: 41074 13 2 0f8ad1e9b0de2eb958ba571208951e71330e6d9e2afa3c84ec6bd16d77bfc718
|
|
7700
|
+
rrset_name: example.com.
|
|
7701
|
+
rrset_type: DS
|
|
7702
|
+
ttl: 300
|
|
7703
|
+
- action: create_record
|
|
7704
|
+
record_data: 41074 13 4 f2fa86164e45235537238dd5b86a6a2533fd17b1e8216c1d66d18ccfc79be4dca77e3bc6d76eb136e193c2cee0a6ea85
|
|
7705
|
+
rrset_name: example.com.
|
|
7706
|
+
rrset_type: DS
|
|
7707
|
+
ttl: 300
|
|
7708
|
+
- action: enable_dnssec
|
|
7709
|
+
changeset_id: b89527a6-b46e-4d29-bd57-6a1b6b4915c7
|
|
7710
|
+
num_changes: 7
|
|
7711
|
+
zone_name: example.com.
|
|
7437
7712
|
schema:
|
|
7438
7713
|
$ref: '#/components/schemas/DnsChangesResponse'
|
|
7439
|
-
description:
|
|
7714
|
+
description: DNSSEC enabled successfully
|
|
7715
|
+
'400':
|
|
7716
|
+
content:
|
|
7717
|
+
application/problem+json:
|
|
7718
|
+
example:
|
|
7719
|
+
code: ERROR_DNS
|
|
7720
|
+
detail: Additional error context.
|
|
7721
|
+
status: 400
|
|
7722
|
+
title: DNS Error
|
|
7723
|
+
type: dns
|
|
7724
|
+
schema:
|
|
7725
|
+
$ref: '#/components/schemas/Problem'
|
|
7726
|
+
description: Bad Request
|
|
7440
7727
|
'422':
|
|
7441
7728
|
content:
|
|
7442
7729
|
application/problem+json:
|
|
@@ -7466,9 +7753,35 @@ paths:
|
|
|
7466
7753
|
'200':
|
|
7467
7754
|
content:
|
|
7468
7755
|
application/json:
|
|
7756
|
+
examples:
|
|
7757
|
+
zone_domain_forwards:
|
|
7758
|
+
description: All domain forwards configured for a specific DNS zone
|
|
7759
|
+
with redirect configurations
|
|
7760
|
+
summary: Domain forwards for a zone
|
|
7761
|
+
value:
|
|
7762
|
+
domain_forwards:
|
|
7763
|
+
- created_on: '2025-11-18T12:59:57Z'
|
|
7764
|
+
enabled: false
|
|
7765
|
+
hostname: example.com.
|
|
7766
|
+
https:
|
|
7767
|
+
created_on: '2025-11-18T12:59:57Z'
|
|
7768
|
+
redirects:
|
|
7769
|
+
- redirect_code: 302
|
|
7770
|
+
request_hostname: example.com.
|
|
7771
|
+
request_path: /
|
|
7772
|
+
request_protocol: https
|
|
7773
|
+
target_hostname: auth.example.com
|
|
7774
|
+
target_path: /
|
|
7775
|
+
target_protocol: https
|
|
7776
|
+
updated_on: '2025-11-18T12:59:57Z'
|
|
7777
|
+
wildcard: false
|
|
7778
|
+
updated_on: '2025-11-18T12:59:57Z'
|
|
7779
|
+
wildcard: false
|
|
7780
|
+
zone_id: zone_01kabfvtysfqwv4dn89r3jepym
|
|
7781
|
+
zone_name: example.com.
|
|
7469
7782
|
schema:
|
|
7470
7783
|
$ref: '#/components/schemas/DomainForwardZone'
|
|
7471
|
-
description:
|
|
7784
|
+
description: Domain forwards for the specified zone retrieved successfully
|
|
7472
7785
|
'401':
|
|
7473
7786
|
content:
|
|
7474
7787
|
application/problem+json:
|
|
@@ -7519,6 +7832,60 @@ paths:
|
|
|
7519
7832
|
requestBody:
|
|
7520
7833
|
content:
|
|
7521
7834
|
application/json:
|
|
7835
|
+
examples:
|
|
7836
|
+
manage_mx_records:
|
|
7837
|
+
description: Add a new mail server with higher priority and remove
|
|
7838
|
+
an old one
|
|
7839
|
+
summary: Add and remove MX records
|
|
7840
|
+
value:
|
|
7841
|
+
ops:
|
|
7842
|
+
- op: upsert
|
|
7843
|
+
record:
|
|
7844
|
+
name: '@'
|
|
7845
|
+
rdata: 5 new-mail.example.com.
|
|
7846
|
+
ttl: 300
|
|
7847
|
+
type: MX
|
|
7848
|
+
- op: remove
|
|
7849
|
+
record:
|
|
7850
|
+
name: '@'
|
|
7851
|
+
rdata: 10 old-mail.example.com.
|
|
7852
|
+
ttl: 300
|
|
7853
|
+
type: MX
|
|
7854
|
+
remove_single_record:
|
|
7855
|
+
description: Remove a specific record from an RRset
|
|
7856
|
+
summary: Remove a single record
|
|
7857
|
+
value:
|
|
7858
|
+
ops:
|
|
7859
|
+
- op: remove
|
|
7860
|
+
record:
|
|
7861
|
+
name: old-api
|
|
7862
|
+
rdata: 203.0.113.200
|
|
7863
|
+
ttl: 300
|
|
7864
|
+
type: A
|
|
7865
|
+
update_txt_record:
|
|
7866
|
+
description: Add or update a TXT record for SPF configuration
|
|
7867
|
+
summary: Update TXT record
|
|
7868
|
+
value:
|
|
7869
|
+
ops:
|
|
7870
|
+
- op: upsert
|
|
7871
|
+
record:
|
|
7872
|
+
name: '@'
|
|
7873
|
+
rdata: '"v=spf1 include:_spf.google.com include:mailgun.org
|
|
7874
|
+
~all"'
|
|
7875
|
+
ttl: 300
|
|
7876
|
+
type: TXT
|
|
7877
|
+
upsert_single_record:
|
|
7878
|
+
description: Upsert a single A record (creates if doesn't exist, updates
|
|
7879
|
+
if exists)
|
|
7880
|
+
summary: Add or update a single record
|
|
7881
|
+
value:
|
|
7882
|
+
ops:
|
|
7883
|
+
- op: upsert
|
|
7884
|
+
record:
|
|
7885
|
+
name: api
|
|
7886
|
+
rdata: 203.0.113.100
|
|
7887
|
+
ttl: 300
|
|
7888
|
+
type: A
|
|
7522
7889
|
schema:
|
|
7523
7890
|
$ref: '#/components/schemas/DnsZoneRecordsPatchOps'
|
|
7524
7891
|
required: true
|
|
@@ -7563,6 +7930,65 @@ paths:
|
|
|
7563
7930
|
requestBody:
|
|
7564
7931
|
content:
|
|
7565
7932
|
application/json:
|
|
7933
|
+
examples:
|
|
7934
|
+
remove_single_rrset:
|
|
7935
|
+
description: Remove all records for a specific name and type
|
|
7936
|
+
summary: Remove a single RRset
|
|
7937
|
+
value:
|
|
7938
|
+
ops:
|
|
7939
|
+
- op: remove
|
|
7940
|
+
rrset:
|
|
7941
|
+
name: old-service
|
|
7942
|
+
records: []
|
|
7943
|
+
ttl: 300
|
|
7944
|
+
type: A
|
|
7945
|
+
upsert_and_remove:
|
|
7946
|
+
description: Change www from CNAME to A record with multiple IPs (remove
|
|
7947
|
+
CNAME, add A records)
|
|
7948
|
+
summary: Multiple operations
|
|
7949
|
+
value:
|
|
7950
|
+
ops:
|
|
7951
|
+
- op: upsert
|
|
7952
|
+
rrset:
|
|
7953
|
+
name: www
|
|
7954
|
+
records:
|
|
7955
|
+
- rdata: 203.0.113.10
|
|
7956
|
+
- rdata: 203.0.113.11
|
|
7957
|
+
ttl: 300
|
|
7958
|
+
type: A
|
|
7959
|
+
- op: remove
|
|
7960
|
+
rrset:
|
|
7961
|
+
name: www
|
|
7962
|
+
records: []
|
|
7963
|
+
ttl: 300
|
|
7964
|
+
type: CNAME
|
|
7965
|
+
upsert_mx_records:
|
|
7966
|
+
description: Replace MX records with new mail server priorities
|
|
7967
|
+
summary: Update MX records
|
|
7968
|
+
value:
|
|
7969
|
+
ops:
|
|
7970
|
+
- op: upsert
|
|
7971
|
+
rrset:
|
|
7972
|
+
name: '@'
|
|
7973
|
+
records:
|
|
7974
|
+
- rdata: 10 mail1.example.com.
|
|
7975
|
+
- rdata: 20 mail2.example.com.
|
|
7976
|
+
- rdata: 30 mail3.example.com.
|
|
7977
|
+
ttl: 300
|
|
7978
|
+
type: MX
|
|
7979
|
+
upsert_single_rrset:
|
|
7980
|
+
description: Upsert an A record for a subdomain (creates if doesn't
|
|
7981
|
+
exist, updates if exists)
|
|
7982
|
+
summary: Add or update a single RRset
|
|
7983
|
+
value:
|
|
7984
|
+
ops:
|
|
7985
|
+
- op: upsert
|
|
7986
|
+
rrset:
|
|
7987
|
+
name: api
|
|
7988
|
+
records:
|
|
7989
|
+
- rdata: 203.0.113.50
|
|
7990
|
+
ttl: 300
|
|
7991
|
+
type: A
|
|
7566
7992
|
schema:
|
|
7567
7993
|
$ref: '#/components/schemas/DnsZoneRrsetsPatchOps'
|
|
7568
7994
|
required: true
|
|
@@ -7606,6 +8032,63 @@ paths:
|
|
|
7606
8032
|
requestBody:
|
|
7607
8033
|
content:
|
|
7608
8034
|
application/json:
|
|
8035
|
+
examples:
|
|
8036
|
+
update_a_record:
|
|
8037
|
+
description: Replace all RRsets with a single A record for the zone
|
|
8038
|
+
apex
|
|
8039
|
+
summary: Update A record
|
|
8040
|
+
value:
|
|
8041
|
+
rrsets:
|
|
8042
|
+
- name: '@'
|
|
8043
|
+
records:
|
|
8044
|
+
- rdata: 203.0.113.10
|
|
8045
|
+
ttl: 300
|
|
8046
|
+
type: A
|
|
8047
|
+
update_multiple_rrsets:
|
|
8048
|
+
description: Replace all RRsets with multiple record sets (A, CNAME,
|
|
8049
|
+
MX)
|
|
8050
|
+
summary: Update multiple RRsets
|
|
8051
|
+
value:
|
|
8052
|
+
rrsets:
|
|
8053
|
+
- name: '@'
|
|
8054
|
+
records:
|
|
8055
|
+
- rdata: 203.0.113.10
|
|
8056
|
+
ttl: 300
|
|
8057
|
+
type: A
|
|
8058
|
+
- name: www
|
|
8059
|
+
records:
|
|
8060
|
+
- rdata: example.com.
|
|
8061
|
+
ttl: 300
|
|
8062
|
+
type: CNAME
|
|
8063
|
+
- name: '@'
|
|
8064
|
+
records:
|
|
8065
|
+
- rdata: 10 mail.example.com.
|
|
8066
|
+
- rdata: 20 backup-mail.example.com.
|
|
8067
|
+
ttl: 300
|
|
8068
|
+
type: MX
|
|
8069
|
+
update_mx_records:
|
|
8070
|
+
description: Replace all RRsets with MX records for email forwarding
|
|
8071
|
+
(returns 204 No Content)
|
|
8072
|
+
summary: Update MX records
|
|
8073
|
+
value:
|
|
8074
|
+
rrsets:
|
|
8075
|
+
- name: '@'
|
|
8076
|
+
records:
|
|
8077
|
+
- rdata: 10 mx1.mxforward.opusdns.dev.
|
|
8078
|
+
- rdata: 20 mx2.mxforward.opusdns.dev.
|
|
8079
|
+
ttl: 600
|
|
8080
|
+
type: MX
|
|
8081
|
+
update_txt_records:
|
|
8082
|
+
description: Replace all RRsets with TXT records (SPF, verification)
|
|
8083
|
+
summary: Update TXT records
|
|
8084
|
+
value:
|
|
8085
|
+
rrsets:
|
|
8086
|
+
- name: '@'
|
|
8087
|
+
records:
|
|
8088
|
+
- rdata: '"v=spf1 include:_spf.google.com ~all"'
|
|
8089
|
+
- rdata: '"google-site-verification=abc123def456"'
|
|
8090
|
+
ttl: 300
|
|
8091
|
+
type: TXT
|
|
7609
8092
|
schema:
|
|
7610
8093
|
$ref: '#/components/schemas/DnsZoneRrsetsCreate'
|
|
7611
8094
|
required: true
|
|
@@ -9006,6 +9489,55 @@ paths:
|
|
|
9006
9489
|
tags:
|
|
9007
9490
|
- domain
|
|
9008
9491
|
- domain_tld_specific
|
|
9492
|
+
/v1/domains/tld-specific/be/{domain_reference}/auth_code/request:
|
|
9493
|
+
post:
|
|
9494
|
+
operationId: request_auth_code_v1_domains_tld_specific_be__domain_reference__auth_code_request_post
|
|
9495
|
+
parameters:
|
|
9496
|
+
- in: path
|
|
9497
|
+
name: domain_reference
|
|
9498
|
+
required: true
|
|
9499
|
+
schema:
|
|
9500
|
+
anyOf:
|
|
9501
|
+
- examples:
|
|
9502
|
+
- domain_01h45ytscbebyvny4gc8cr8ma2
|
|
9503
|
+
format: typeid
|
|
9504
|
+
pattern: ^domain_[0-7][0-9a-hjkmnpq-tv-z]{25}$
|
|
9505
|
+
type: string
|
|
9506
|
+
x-typeid-prefix: domain
|
|
9507
|
+
- type: string
|
|
9508
|
+
title: Domain Reference
|
|
9509
|
+
responses:
|
|
9510
|
+
'200':
|
|
9511
|
+
content:
|
|
9512
|
+
application/json:
|
|
9513
|
+
schema:
|
|
9514
|
+
$ref: '#/components/schemas/RequestAuthcodeResponse'
|
|
9515
|
+
description: Successful Response
|
|
9516
|
+
'404':
|
|
9517
|
+
content:
|
|
9518
|
+
application/problem+json:
|
|
9519
|
+
example:
|
|
9520
|
+
code: ERROR_DOMAIN_NOT_FOUND
|
|
9521
|
+
detail: Domain not found
|
|
9522
|
+
domain_name: Additional error context.
|
|
9523
|
+
status: 404
|
|
9524
|
+
title: Domain Management Error
|
|
9525
|
+
type: domain-not-found
|
|
9526
|
+
schema:
|
|
9527
|
+
$ref: '#/components/schemas/Problem'
|
|
9528
|
+
description: Not Found
|
|
9529
|
+
'422':
|
|
9530
|
+
content:
|
|
9531
|
+
application/problem+json:
|
|
9532
|
+
schema:
|
|
9533
|
+
$ref: '#/components/schemas/HTTPValidationError'
|
|
9534
|
+
description: Validation Error
|
|
9535
|
+
security:
|
|
9536
|
+
- OAuth2PasswordBearer: []
|
|
9537
|
+
summary: Requests your auth code directly from DNS Belgium (registry)
|
|
9538
|
+
tags:
|
|
9539
|
+
- domain
|
|
9540
|
+
- domain_tld_specific
|
|
9009
9541
|
/v1/domains/tld-specific/de/{domain_reference}/transit:
|
|
9010
9542
|
post:
|
|
9011
9543
|
operationId: transit_domain_v1_domains_tld_specific_de__domain_reference__transit_post
|
package/src/schema.d.ts
CHANGED
|
@@ -604,6 +604,23 @@ export interface paths {
|
|
|
604
604
|
patch?: never;
|
|
605
605
|
trace?: never;
|
|
606
606
|
};
|
|
607
|
+
"/v1/domains/tld-specific/be/{domain_reference}/auth_code/request": {
|
|
608
|
+
parameters: {
|
|
609
|
+
query?: never;
|
|
610
|
+
header?: never;
|
|
611
|
+
path?: never;
|
|
612
|
+
cookie?: never;
|
|
613
|
+
};
|
|
614
|
+
get?: never;
|
|
615
|
+
put?: never;
|
|
616
|
+
/** Requests your auth code directly from DNS Belgium (registry) */
|
|
617
|
+
post: operations["request_auth_code_v1_domains_tld_specific_be__domain_reference__auth_code_request_post"];
|
|
618
|
+
delete?: never;
|
|
619
|
+
options?: never;
|
|
620
|
+
head?: never;
|
|
621
|
+
patch?: never;
|
|
622
|
+
trace?: never;
|
|
623
|
+
};
|
|
607
624
|
"/v1/domains/tld-specific/de/{domain_reference}/transit": {
|
|
608
625
|
parameters: {
|
|
609
626
|
query?: never;
|
|
@@ -4352,6 +4369,24 @@ export interface components {
|
|
|
4352
4369
|
* @enum {string}
|
|
4353
4370
|
*/
|
|
4354
4371
|
RenewalMode: "renew" | "expire" | "delete";
|
|
4372
|
+
/** RequestAuthcodeResponse */
|
|
4373
|
+
RequestAuthcodeResponse: {
|
|
4374
|
+
/**
|
|
4375
|
+
* Detail
|
|
4376
|
+
* @description Additional information about the result in case of failure
|
|
4377
|
+
*/
|
|
4378
|
+
detail?: string | null;
|
|
4379
|
+
/**
|
|
4380
|
+
* Name
|
|
4381
|
+
* @description The domain name that had the auth code requested
|
|
4382
|
+
*/
|
|
4383
|
+
name: string;
|
|
4384
|
+
/**
|
|
4385
|
+
* Success
|
|
4386
|
+
* @description Whether the request had a successful result from DNS Belgium
|
|
4387
|
+
*/
|
|
4388
|
+
success: boolean;
|
|
4389
|
+
};
|
|
4355
4390
|
/** RequestHistory */
|
|
4356
4391
|
RequestHistory: {
|
|
4357
4392
|
/**
|
|
@@ -6102,7 +6137,7 @@ export interface operations {
|
|
|
6102
6137
|
};
|
|
6103
6138
|
requestBody?: never;
|
|
6104
6139
|
responses: {
|
|
6105
|
-
/** @description
|
|
6140
|
+
/** @description List of DNS zones retrieved successfully */
|
|
6106
6141
|
200: {
|
|
6107
6142
|
headers: {
|
|
6108
6143
|
[name: string]: unknown;
|
|
@@ -6186,7 +6221,7 @@ export interface operations {
|
|
|
6186
6221
|
};
|
|
6187
6222
|
requestBody?: never;
|
|
6188
6223
|
responses: {
|
|
6189
|
-
/** @description
|
|
6224
|
+
/** @description List of domain forwards grouped by DNS zones */
|
|
6190
6225
|
200: {
|
|
6191
6226
|
headers: {
|
|
6192
6227
|
[name: string]: unknown;
|
|
@@ -6247,7 +6282,7 @@ export interface operations {
|
|
|
6247
6282
|
};
|
|
6248
6283
|
requestBody?: never;
|
|
6249
6284
|
responses: {
|
|
6250
|
-
/** @description
|
|
6285
|
+
/** @description DNS zones summary retrieved successfully */
|
|
6251
6286
|
200: {
|
|
6252
6287
|
headers: {
|
|
6253
6288
|
[name: string]: unknown;
|
|
@@ -6270,7 +6305,7 @@ export interface operations {
|
|
|
6270
6305
|
};
|
|
6271
6306
|
requestBody?: never;
|
|
6272
6307
|
responses: {
|
|
6273
|
-
/** @description
|
|
6308
|
+
/** @description DNS zone retrieved successfully */
|
|
6274
6309
|
200: {
|
|
6275
6310
|
headers: {
|
|
6276
6311
|
[name: string]: unknown;
|
|
@@ -6332,7 +6367,7 @@ export interface operations {
|
|
|
6332
6367
|
};
|
|
6333
6368
|
requestBody?: never;
|
|
6334
6369
|
responses: {
|
|
6335
|
-
/** @description
|
|
6370
|
+
/** @description DNSSEC disabled successfully */
|
|
6336
6371
|
200: {
|
|
6337
6372
|
headers: {
|
|
6338
6373
|
[name: string]: unknown;
|
|
@@ -6341,6 +6376,22 @@ export interface operations {
|
|
|
6341
6376
|
"application/json": components["schemas"]["DnsChangesResponse"];
|
|
6342
6377
|
};
|
|
6343
6378
|
};
|
|
6379
|
+
/** @description Bad Request */
|
|
6380
|
+
400: {
|
|
6381
|
+
headers: {
|
|
6382
|
+
[name: string]: unknown;
|
|
6383
|
+
};
|
|
6384
|
+
content: {
|
|
6385
|
+
/** @example {
|
|
6386
|
+
* "code": "ERROR_DNS",
|
|
6387
|
+
* "detail": "Additional error context.",
|
|
6388
|
+
* "status": 400,
|
|
6389
|
+
* "title": "DNS Error",
|
|
6390
|
+
* "type": "dns"
|
|
6391
|
+
* } */
|
|
6392
|
+
"application/problem+json": components["schemas"]["Problem"];
|
|
6393
|
+
};
|
|
6394
|
+
};
|
|
6344
6395
|
/** @description Validation Error */
|
|
6345
6396
|
422: {
|
|
6346
6397
|
headers: {
|
|
@@ -6364,7 +6415,7 @@ export interface operations {
|
|
|
6364
6415
|
};
|
|
6365
6416
|
requestBody?: never;
|
|
6366
6417
|
responses: {
|
|
6367
|
-
/** @description
|
|
6418
|
+
/** @description DNSSEC enabled successfully */
|
|
6368
6419
|
200: {
|
|
6369
6420
|
headers: {
|
|
6370
6421
|
[name: string]: unknown;
|
|
@@ -6373,6 +6424,22 @@ export interface operations {
|
|
|
6373
6424
|
"application/json": components["schemas"]["DnsChangesResponse"];
|
|
6374
6425
|
};
|
|
6375
6426
|
};
|
|
6427
|
+
/** @description Bad Request */
|
|
6428
|
+
400: {
|
|
6429
|
+
headers: {
|
|
6430
|
+
[name: string]: unknown;
|
|
6431
|
+
};
|
|
6432
|
+
content: {
|
|
6433
|
+
/** @example {
|
|
6434
|
+
* "code": "ERROR_DNS",
|
|
6435
|
+
* "detail": "Additional error context.",
|
|
6436
|
+
* "status": 400,
|
|
6437
|
+
* "title": "DNS Error",
|
|
6438
|
+
* "type": "dns"
|
|
6439
|
+
* } */
|
|
6440
|
+
"application/problem+json": components["schemas"]["Problem"];
|
|
6441
|
+
};
|
|
6442
|
+
};
|
|
6376
6443
|
/** @description Validation Error */
|
|
6377
6444
|
422: {
|
|
6378
6445
|
headers: {
|
|
@@ -6396,7 +6463,7 @@ export interface operations {
|
|
|
6396
6463
|
};
|
|
6397
6464
|
requestBody?: never;
|
|
6398
6465
|
responses: {
|
|
6399
|
-
/** @description
|
|
6466
|
+
/** @description Domain forwards for the specified zone retrieved successfully */
|
|
6400
6467
|
200: {
|
|
6401
6468
|
headers: {
|
|
6402
6469
|
[name: string]: unknown;
|
|
@@ -7804,6 +7871,54 @@ export interface operations {
|
|
|
7804
7871
|
};
|
|
7805
7872
|
};
|
|
7806
7873
|
};
|
|
7874
|
+
request_auth_code_v1_domains_tld_specific_be__domain_reference__auth_code_request_post: {
|
|
7875
|
+
parameters: {
|
|
7876
|
+
query?: never;
|
|
7877
|
+
header?: never;
|
|
7878
|
+
path: {
|
|
7879
|
+
domain_reference: TypeId<"domain"> | string;
|
|
7880
|
+
};
|
|
7881
|
+
cookie?: never;
|
|
7882
|
+
};
|
|
7883
|
+
requestBody?: never;
|
|
7884
|
+
responses: {
|
|
7885
|
+
/** @description Successful Response */
|
|
7886
|
+
200: {
|
|
7887
|
+
headers: {
|
|
7888
|
+
[name: string]: unknown;
|
|
7889
|
+
};
|
|
7890
|
+
content: {
|
|
7891
|
+
"application/json": components["schemas"]["RequestAuthcodeResponse"];
|
|
7892
|
+
};
|
|
7893
|
+
};
|
|
7894
|
+
/** @description Not Found */
|
|
7895
|
+
404: {
|
|
7896
|
+
headers: {
|
|
7897
|
+
[name: string]: unknown;
|
|
7898
|
+
};
|
|
7899
|
+
content: {
|
|
7900
|
+
/** @example {
|
|
7901
|
+
* "code": "ERROR_DOMAIN_NOT_FOUND",
|
|
7902
|
+
* "detail": "Domain not found",
|
|
7903
|
+
* "domain_name": "Additional error context.",
|
|
7904
|
+
* "status": 404,
|
|
7905
|
+
* "title": "Domain Management Error",
|
|
7906
|
+
* "type": "domain-not-found"
|
|
7907
|
+
* } */
|
|
7908
|
+
"application/problem+json": components["schemas"]["Problem"];
|
|
7909
|
+
};
|
|
7910
|
+
};
|
|
7911
|
+
/** @description Validation Error */
|
|
7912
|
+
422: {
|
|
7913
|
+
headers: {
|
|
7914
|
+
[name: string]: unknown;
|
|
7915
|
+
};
|
|
7916
|
+
content: {
|
|
7917
|
+
"application/problem+json": components["schemas"]["HTTPValidationError"];
|
|
7918
|
+
};
|
|
7919
|
+
};
|
|
7920
|
+
};
|
|
7921
|
+
};
|
|
7807
7922
|
transit_domain_v1_domains_tld_specific_de__domain_reference__transit_post: {
|
|
7808
7923
|
parameters: {
|
|
7809
7924
|
query?: never;
|