@opusdns/api 0.139.0 → 0.140.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 +28 -181
- package/src/helpers/requests.d.ts +8 -8
- package/src/helpers/responses.d.ts +6 -6
- package/src/helpers/schemas.d.ts +6 -6
- package/src/openapi.yaml +36 -166
- package/src/schema.d.ts +24 -39
package/package.json
CHANGED
package/src/helpers/keys.ts
CHANGED
|
@@ -75,7 +75,7 @@ import { DomainForwardPatchOp } from './schemas';
|
|
|
75
75
|
import { DomainForwardPatchOps } from './schemas';
|
|
76
76
|
import { DomainForwardProtocolSetRequest } from './schemas';
|
|
77
77
|
import { DomainForwardProtocolSet } from './schemas';
|
|
78
|
-
import {
|
|
78
|
+
import { DomainForwardSetCreateRequest } from './schemas';
|
|
79
79
|
import { DomainForwardSetRequest } from './schemas';
|
|
80
80
|
import { DomainForwardSet } from './schemas';
|
|
81
81
|
import { DomainForwardZone } from './schemas';
|
|
@@ -6590,31 +6590,6 @@ export const KEY_DOMAIN_FORWARD_HTTPS: keyof DomainForward = 'https';
|
|
|
6590
6590
|
* @see {@link KEYS_DOMAIN_FORWARD} - Array of all keys for this type
|
|
6591
6591
|
*/
|
|
6592
6592
|
export const KEY_DOMAIN_FORWARD_UPDATED_ON: keyof DomainForward = 'updated_on';
|
|
6593
|
-
/**
|
|
6594
|
-
* Wildcard
|
|
6595
|
-
*
|
|
6596
|
-
*
|
|
6597
|
-
* @type {boolean}
|
|
6598
|
-
*
|
|
6599
|
-
*
|
|
6600
|
-
* @remarks
|
|
6601
|
-
* This key constant provides type-safe access to the `wildcard` property of DomainForward objects.
|
|
6602
|
-
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
6603
|
-
*
|
|
6604
|
-
* @example
|
|
6605
|
-
* ```typescript
|
|
6606
|
-
* // Direct property access
|
|
6607
|
-
* const value = domainforward[KEY_DOMAIN_FORWARD_WILDCARD];
|
|
6608
|
-
*
|
|
6609
|
-
* // Dynamic property access
|
|
6610
|
-
* const propertyName = KEY_DOMAIN_FORWARD_WILDCARD;
|
|
6611
|
-
* const value = domainforward[propertyName];
|
|
6612
|
-
* ```
|
|
6613
|
-
*
|
|
6614
|
-
* @see {@link DomainForward} - The TypeScript type definition
|
|
6615
|
-
* @see {@link KEYS_DOMAIN_FORWARD} - Array of all keys for this type
|
|
6616
|
-
*/
|
|
6617
|
-
export const KEY_DOMAIN_FORWARD_WILDCARD: keyof DomainForward = 'wildcard';
|
|
6618
6593
|
|
|
6619
6594
|
/**
|
|
6620
6595
|
* Array of all DomainForward property keys
|
|
@@ -6643,7 +6618,6 @@ export const KEYS_DOMAIN_FORWARD = [
|
|
|
6643
6618
|
KEY_DOMAIN_FORWARD_HTTP,
|
|
6644
6619
|
KEY_DOMAIN_FORWARD_HTTPS,
|
|
6645
6620
|
KEY_DOMAIN_FORWARD_UPDATED_ON,
|
|
6646
|
-
KEY_DOMAIN_FORWARD_WILDCARD,
|
|
6647
6621
|
] as const satisfies (keyof DomainForward)[];
|
|
6648
6622
|
|
|
6649
6623
|
/**
|
|
@@ -6921,30 +6895,6 @@ export const KEYS_DOMAIN_FORWARD_PATCH_OPS = [
|
|
|
6921
6895
|
* @see {@link KEYS_DOMAIN_FORWARD_PROTOCOL_SET_REQUEST} - Array of all keys for this type
|
|
6922
6896
|
*/
|
|
6923
6897
|
export const KEY_DOMAIN_FORWARD_PROTOCOL_SET_REQUEST_REDIRECTS: keyof DomainForwardProtocolSetRequest = 'redirects';
|
|
6924
|
-
/**
|
|
6925
|
-
* Wildcard
|
|
6926
|
-
*
|
|
6927
|
-
*
|
|
6928
|
-
*
|
|
6929
|
-
*
|
|
6930
|
-
* @remarks
|
|
6931
|
-
* This key constant provides type-safe access to the `wildcard` property of DomainForwardProtocolSetRequest objects.
|
|
6932
|
-
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
6933
|
-
*
|
|
6934
|
-
* @example
|
|
6935
|
-
* ```typescript
|
|
6936
|
-
* // Direct property access
|
|
6937
|
-
* const value = domainforwardprotocolsetrequest[KEY_DOMAIN_FORWARD_PROTOCOL_SET_REQUEST_WILDCARD];
|
|
6938
|
-
*
|
|
6939
|
-
* // Dynamic property access
|
|
6940
|
-
* const propertyName = KEY_DOMAIN_FORWARD_PROTOCOL_SET_REQUEST_WILDCARD;
|
|
6941
|
-
* const value = domainforwardprotocolsetrequest[propertyName];
|
|
6942
|
-
* ```
|
|
6943
|
-
*
|
|
6944
|
-
* @see {@link DomainForwardProtocolSetRequest} - The TypeScript type definition
|
|
6945
|
-
* @see {@link KEYS_DOMAIN_FORWARD_PROTOCOL_SET_REQUEST} - Array of all keys for this type
|
|
6946
|
-
*/
|
|
6947
|
-
export const KEY_DOMAIN_FORWARD_PROTOCOL_SET_REQUEST_WILDCARD: keyof DomainForwardProtocolSetRequest = 'wildcard';
|
|
6948
6898
|
|
|
6949
6899
|
/**
|
|
6950
6900
|
* Array of all DomainForwardProtocolSetRequest property keys
|
|
@@ -6968,7 +6918,6 @@ export const KEY_DOMAIN_FORWARD_PROTOCOL_SET_REQUEST_WILDCARD: keyof DomainForwa
|
|
|
6968
6918
|
*/
|
|
6969
6919
|
export const KEYS_DOMAIN_FORWARD_PROTOCOL_SET_REQUEST = [
|
|
6970
6920
|
KEY_DOMAIN_FORWARD_PROTOCOL_SET_REQUEST_REDIRECTS,
|
|
6971
|
-
KEY_DOMAIN_FORWARD_PROTOCOL_SET_REQUEST_WILDCARD,
|
|
6972
6921
|
] as const satisfies (keyof DomainForwardProtocolSetRequest)[];
|
|
6973
6922
|
|
|
6974
6923
|
/**
|
|
@@ -7046,31 +6995,6 @@ export const KEY_DOMAIN_FORWARD_PROTOCOL_SET_REDIRECTS: keyof DomainForwardProto
|
|
|
7046
6995
|
* @see {@link KEYS_DOMAIN_FORWARD_PROTOCOL_SET} - Array of all keys for this type
|
|
7047
6996
|
*/
|
|
7048
6997
|
export const KEY_DOMAIN_FORWARD_PROTOCOL_SET_UPDATED_ON: keyof DomainForwardProtocolSet = 'updated_on';
|
|
7049
|
-
/**
|
|
7050
|
-
* Wildcard
|
|
7051
|
-
*
|
|
7052
|
-
*
|
|
7053
|
-
* @type {boolean}
|
|
7054
|
-
*
|
|
7055
|
-
*
|
|
7056
|
-
* @remarks
|
|
7057
|
-
* This key constant provides type-safe access to the `wildcard` property of DomainForwardProtocolSet objects.
|
|
7058
|
-
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
7059
|
-
*
|
|
7060
|
-
* @example
|
|
7061
|
-
* ```typescript
|
|
7062
|
-
* // Direct property access
|
|
7063
|
-
* const value = domainforwardprotocolset[KEY_DOMAIN_FORWARD_PROTOCOL_SET_WILDCARD];
|
|
7064
|
-
*
|
|
7065
|
-
* // Dynamic property access
|
|
7066
|
-
* const propertyName = KEY_DOMAIN_FORWARD_PROTOCOL_SET_WILDCARD;
|
|
7067
|
-
* const value = domainforwardprotocolset[propertyName];
|
|
7068
|
-
* ```
|
|
7069
|
-
*
|
|
7070
|
-
* @see {@link DomainForwardProtocolSet} - The TypeScript type definition
|
|
7071
|
-
* @see {@link KEYS_DOMAIN_FORWARD_PROTOCOL_SET} - Array of all keys for this type
|
|
7072
|
-
*/
|
|
7073
|
-
export const KEY_DOMAIN_FORWARD_PROTOCOL_SET_WILDCARD: keyof DomainForwardProtocolSet = 'wildcard';
|
|
7074
6998
|
|
|
7075
6999
|
/**
|
|
7076
7000
|
* Array of all DomainForwardProtocolSet property keys
|
|
@@ -7096,133 +7020,82 @@ export const KEYS_DOMAIN_FORWARD_PROTOCOL_SET = [
|
|
|
7096
7020
|
KEY_DOMAIN_FORWARD_PROTOCOL_SET_CREATED_ON,
|
|
7097
7021
|
KEY_DOMAIN_FORWARD_PROTOCOL_SET_REDIRECTS,
|
|
7098
7022
|
KEY_DOMAIN_FORWARD_PROTOCOL_SET_UPDATED_ON,
|
|
7099
|
-
KEY_DOMAIN_FORWARD_PROTOCOL_SET_WILDCARD,
|
|
7100
7023
|
] as const satisfies (keyof DomainForwardProtocolSet)[];
|
|
7101
7024
|
|
|
7102
7025
|
/**
|
|
7103
|
-
*
|
|
7104
|
-
*
|
|
7105
|
-
*
|
|
7106
|
-
* @type {boolean}
|
|
7107
|
-
*
|
|
7108
|
-
*
|
|
7109
|
-
* @remarks
|
|
7110
|
-
* This key constant provides type-safe access to the `enabled` property of DomainForwardRequest objects.
|
|
7111
|
-
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
7112
|
-
*
|
|
7113
|
-
* @example
|
|
7114
|
-
* ```typescript
|
|
7115
|
-
* // Direct property access
|
|
7116
|
-
* const value = domainforwardrequest[KEY_DOMAIN_FORWARD_REQUEST_ENABLED];
|
|
7117
|
-
*
|
|
7118
|
-
* // Dynamic property access
|
|
7119
|
-
* const propertyName = KEY_DOMAIN_FORWARD_REQUEST_ENABLED;
|
|
7120
|
-
* const value = domainforwardrequest[propertyName];
|
|
7121
|
-
* ```
|
|
7122
|
-
*
|
|
7123
|
-
* @see {@link DomainForwardRequest} - The TypeScript type definition
|
|
7124
|
-
* @see {@link KEYS_DOMAIN_FORWARD_REQUEST} - Array of all keys for this type
|
|
7125
|
-
*/
|
|
7126
|
-
export const KEY_DOMAIN_FORWARD_REQUEST_ENABLED: keyof DomainForwardRequest = 'enabled';
|
|
7127
|
-
/**
|
|
7128
|
-
* http property
|
|
7129
|
-
*
|
|
7130
|
-
*
|
|
7131
|
-
*
|
|
7132
|
-
*
|
|
7133
|
-
* @remarks
|
|
7134
|
-
* This key constant provides type-safe access to the `http` property of DomainForwardRequest objects.
|
|
7135
|
-
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
7136
|
-
*
|
|
7137
|
-
* @example
|
|
7138
|
-
* ```typescript
|
|
7139
|
-
* // Direct property access
|
|
7140
|
-
* const value = domainforwardrequest[KEY_DOMAIN_FORWARD_REQUEST_HTTP];
|
|
7141
|
-
*
|
|
7142
|
-
* // Dynamic property access
|
|
7143
|
-
* const propertyName = KEY_DOMAIN_FORWARD_REQUEST_HTTP;
|
|
7144
|
-
* const value = domainforwardrequest[propertyName];
|
|
7145
|
-
* ```
|
|
7146
|
-
*
|
|
7147
|
-
* @see {@link DomainForwardRequest} - The TypeScript type definition
|
|
7148
|
-
* @see {@link KEYS_DOMAIN_FORWARD_REQUEST} - Array of all keys for this type
|
|
7149
|
-
*/
|
|
7150
|
-
export const KEY_DOMAIN_FORWARD_REQUEST_HTTP: keyof DomainForwardRequest = 'http';
|
|
7151
|
-
/**
|
|
7152
|
-
* https property
|
|
7026
|
+
* protocol property
|
|
7153
7027
|
*
|
|
7154
7028
|
*
|
|
7155
7029
|
*
|
|
7156
7030
|
*
|
|
7157
7031
|
* @remarks
|
|
7158
|
-
* This key constant provides type-safe access to the `
|
|
7032
|
+
* This key constant provides type-safe access to the `protocol` property of DomainForwardSetCreateRequest objects.
|
|
7159
7033
|
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
7160
7034
|
*
|
|
7161
7035
|
* @example
|
|
7162
7036
|
* ```typescript
|
|
7163
7037
|
* // Direct property access
|
|
7164
|
-
* const value =
|
|
7038
|
+
* const value = domainforwardsetcreaterequest[KEY_DOMAIN_FORWARD_SET_CREATE_REQUEST_PROTOCOL];
|
|
7165
7039
|
*
|
|
7166
7040
|
* // Dynamic property access
|
|
7167
|
-
* const propertyName =
|
|
7168
|
-
* const value =
|
|
7041
|
+
* const propertyName = KEY_DOMAIN_FORWARD_SET_CREATE_REQUEST_PROTOCOL;
|
|
7042
|
+
* const value = domainforwardsetcreaterequest[propertyName];
|
|
7169
7043
|
* ```
|
|
7170
7044
|
*
|
|
7171
|
-
* @see {@link
|
|
7172
|
-
* @see {@link
|
|
7045
|
+
* @see {@link DomainForwardSetCreateRequest} - The TypeScript type definition
|
|
7046
|
+
* @see {@link KEYS_DOMAIN_FORWARD_SET_CREATE_REQUEST} - Array of all keys for this type
|
|
7173
7047
|
*/
|
|
7174
|
-
export const
|
|
7048
|
+
export const KEY_DOMAIN_FORWARD_SET_CREATE_REQUEST_PROTOCOL: keyof DomainForwardSetCreateRequest = 'protocol';
|
|
7175
7049
|
/**
|
|
7176
|
-
*
|
|
7050
|
+
* Redirects
|
|
7177
7051
|
*
|
|
7178
7052
|
*
|
|
7053
|
+
* @type {array}
|
|
7179
7054
|
*
|
|
7180
7055
|
*
|
|
7181
7056
|
* @remarks
|
|
7182
|
-
* This key constant provides type-safe access to the `
|
|
7057
|
+
* This key constant provides type-safe access to the `redirects` property of DomainForwardSetCreateRequest objects.
|
|
7183
7058
|
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
7184
7059
|
*
|
|
7185
7060
|
* @example
|
|
7186
7061
|
* ```typescript
|
|
7187
7062
|
* // Direct property access
|
|
7188
|
-
* const value =
|
|
7063
|
+
* const value = domainforwardsetcreaterequest[KEY_DOMAIN_FORWARD_SET_CREATE_REQUEST_REDIRECTS];
|
|
7189
7064
|
*
|
|
7190
7065
|
* // Dynamic property access
|
|
7191
|
-
* const propertyName =
|
|
7192
|
-
* const value =
|
|
7066
|
+
* const propertyName = KEY_DOMAIN_FORWARD_SET_CREATE_REQUEST_REDIRECTS;
|
|
7067
|
+
* const value = domainforwardsetcreaterequest[propertyName];
|
|
7193
7068
|
* ```
|
|
7194
7069
|
*
|
|
7195
|
-
* @see {@link
|
|
7196
|
-
* @see {@link
|
|
7070
|
+
* @see {@link DomainForwardSetCreateRequest} - The TypeScript type definition
|
|
7071
|
+
* @see {@link KEYS_DOMAIN_FORWARD_SET_CREATE_REQUEST} - Array of all keys for this type
|
|
7197
7072
|
*/
|
|
7198
|
-
export const
|
|
7073
|
+
export const KEY_DOMAIN_FORWARD_SET_CREATE_REQUEST_REDIRECTS: keyof DomainForwardSetCreateRequest = 'redirects';
|
|
7199
7074
|
|
|
7200
7075
|
/**
|
|
7201
|
-
* Array of all
|
|
7076
|
+
* Array of all DomainForwardSetCreateRequest property keys
|
|
7202
7077
|
*
|
|
7203
7078
|
* @remarks
|
|
7204
|
-
* This constant provides a readonly array containing all valid property keys for
|
|
7079
|
+
* This constant provides a readonly array containing all valid property keys for DomainForwardSetCreateRequest objects.
|
|
7205
7080
|
* Useful for iteration, validation, and generating dynamic UI components.
|
|
7206
7081
|
*
|
|
7207
7082
|
* @example
|
|
7208
7083
|
* ```typescript
|
|
7209
7084
|
* // Iterating through all keys
|
|
7210
|
-
* for (const key of
|
|
7211
|
-
* console.log(`Property: ${key}, Value: ${
|
|
7085
|
+
* for (const key of KEYS_DOMAIN_FORWARD_SET_CREATE_REQUEST) {
|
|
7086
|
+
* console.log(`Property: ${key}, Value: ${domainforwardsetcreaterequest[key]}`);
|
|
7212
7087
|
* }
|
|
7213
7088
|
*
|
|
7214
7089
|
* // Validation
|
|
7215
|
-
* const isValidKey =
|
|
7090
|
+
* const isValidKey = KEYS_DOMAIN_FORWARD_SET_CREATE_REQUEST.includes(someKey);
|
|
7216
7091
|
* ```
|
|
7217
7092
|
*
|
|
7218
|
-
* @see {@link
|
|
7093
|
+
* @see {@link DomainForwardSetCreateRequest} - The TypeScript type definition
|
|
7219
7094
|
*/
|
|
7220
|
-
export const
|
|
7221
|
-
|
|
7222
|
-
|
|
7223
|
-
|
|
7224
|
-
KEY_DOMAIN_FORWARD_REQUEST_WILDCARD,
|
|
7225
|
-
] as const satisfies (keyof DomainForwardRequest)[];
|
|
7095
|
+
export const KEYS_DOMAIN_FORWARD_SET_CREATE_REQUEST = [
|
|
7096
|
+
KEY_DOMAIN_FORWARD_SET_CREATE_REQUEST_PROTOCOL,
|
|
7097
|
+
KEY_DOMAIN_FORWARD_SET_CREATE_REQUEST_REDIRECTS,
|
|
7098
|
+
] as const satisfies (keyof DomainForwardSetCreateRequest)[];
|
|
7226
7099
|
|
|
7227
7100
|
/**
|
|
7228
7101
|
* Redirects
|
|
@@ -7398,31 +7271,6 @@ export const KEY_DOMAIN_FORWARD_SET_REDIRECTS: keyof DomainForwardSet = 'redirec
|
|
|
7398
7271
|
* @see {@link KEYS_DOMAIN_FORWARD_SET} - Array of all keys for this type
|
|
7399
7272
|
*/
|
|
7400
7273
|
export const KEY_DOMAIN_FORWARD_SET_UPDATED_ON: keyof DomainForwardSet = 'updated_on';
|
|
7401
|
-
/**
|
|
7402
|
-
* Wildcard
|
|
7403
|
-
*
|
|
7404
|
-
*
|
|
7405
|
-
* @type {boolean}
|
|
7406
|
-
*
|
|
7407
|
-
*
|
|
7408
|
-
* @remarks
|
|
7409
|
-
* This key constant provides type-safe access to the `wildcard` property of DomainForwardSet objects.
|
|
7410
|
-
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
7411
|
-
*
|
|
7412
|
-
* @example
|
|
7413
|
-
* ```typescript
|
|
7414
|
-
* // Direct property access
|
|
7415
|
-
* const value = domainforwardset[KEY_DOMAIN_FORWARD_SET_WILDCARD];
|
|
7416
|
-
*
|
|
7417
|
-
* // Dynamic property access
|
|
7418
|
-
* const propertyName = KEY_DOMAIN_FORWARD_SET_WILDCARD;
|
|
7419
|
-
* const value = domainforwardset[propertyName];
|
|
7420
|
-
* ```
|
|
7421
|
-
*
|
|
7422
|
-
* @see {@link DomainForwardSet} - The TypeScript type definition
|
|
7423
|
-
* @see {@link KEYS_DOMAIN_FORWARD_SET} - Array of all keys for this type
|
|
7424
|
-
*/
|
|
7425
|
-
export const KEY_DOMAIN_FORWARD_SET_WILDCARD: keyof DomainForwardSet = 'wildcard';
|
|
7426
7274
|
|
|
7427
7275
|
/**
|
|
7428
7276
|
* Array of all DomainForwardSet property keys
|
|
@@ -7450,7 +7298,6 @@ export const KEYS_DOMAIN_FORWARD_SET = [
|
|
|
7450
7298
|
KEY_DOMAIN_FORWARD_SET_PROTOCOL,
|
|
7451
7299
|
KEY_DOMAIN_FORWARD_SET_REDIRECTS,
|
|
7452
7300
|
KEY_DOMAIN_FORWARD_SET_UPDATED_ON,
|
|
7453
|
-
KEY_DOMAIN_FORWARD_SET_WILDCARD,
|
|
7454
7301
|
] as const satisfies (keyof DomainForwardSet)[];
|
|
7455
7302
|
|
|
7456
7303
|
/**
|
|
@@ -34,7 +34,7 @@ import { operations } from '../schema';
|
|
|
34
34
|
|
|
35
35
|
import { DomainDnssecDataCreateArray, OrganizationAttributeUpdateArray } from './schemas-arrays.d';
|
|
36
36
|
|
|
37
|
-
import { ContactCreate, DnsZoneCreate, DnsZoneRecordsPatchOps, DnsZoneRrsetsPatchOps, DnsZoneRrsetsCreate, DomainForwardPatchOps, DomainForwardCreateRequest,
|
|
37
|
+
import { ContactCreate, DnsZoneCreate, DnsZoneRecordsPatchOps, DnsZoneRrsetsPatchOps, DnsZoneRrsetsCreate, DomainForwardPatchOps, DomainForwardCreateRequest, DomainForwardSetCreateRequest, DomainForwardSetRequest, DomainCreate, DomainUpdate, DomainRenewRequest, DomainRestoreRequest, DomainWithdrawRequest, DomainTransitRequest, DomainTransferIn, EmailForwardCreate, EmailForwardAliasCreate, EmailForwardAliasUpdate, OrganizationCreate, IpRestrictionCreate, IpRestrictionUpdate, OrganizationUpdate, UserCreate, PasswordUpdate, UserUpdate, SpiceDbRelationshipUpdate } from './schemas.d';
|
|
38
38
|
|
|
39
39
|
/**
|
|
40
40
|
* Request type for GET ArchiveEmailForwardLogsAliasesEmailForwardAliasId endpoint
|
|
@@ -1609,8 +1609,8 @@ export type GET_DomainForwardsHostname_Request_Path = GET_DomainForwardsHostname
|
|
|
1609
1609
|
/**
|
|
1610
1610
|
* Request type for POST DomainForwardsHostname endpoint
|
|
1611
1611
|
*
|
|
1612
|
-
* Create
|
|
1613
|
-
*
|
|
1612
|
+
* Create domain forward set
|
|
1613
|
+
* Creates a new domain forward set for a specific protocol (HTTP or HTTPS). Raises an error if the set already exists.
|
|
1614
1614
|
*
|
|
1615
1615
|
* @remarks
|
|
1616
1616
|
* This type defines the complete request structure for the POST DomainForwardsHostname endpoint.
|
|
@@ -1629,9 +1629,9 @@ export type GET_DomainForwardsHostname_Request_Path = GET_DomainForwardsHostname
|
|
|
1629
1629
|
*/
|
|
1630
1630
|
export type POST_DomainForwardsHostname_Request = {
|
|
1631
1631
|
parameters: {
|
|
1632
|
-
path: operations['
|
|
1632
|
+
path: operations['create_domain_forward_set_v1_domain_forwards__hostname__post']['parameters']['path'];
|
|
1633
1633
|
};
|
|
1634
|
-
requestBody:
|
|
1634
|
+
requestBody: DomainForwardSetCreateRequest;
|
|
1635
1635
|
}
|
|
1636
1636
|
/**
|
|
1637
1637
|
* Path parameters for POST /v1/domain-forwards/{hostname}
|
|
@@ -1828,8 +1828,8 @@ export type GET_DomainForwardsHostnameProtocol_Request_Path = GET_DomainForwards
|
|
|
1828
1828
|
/**
|
|
1829
1829
|
* Request type for POST DomainForwardsHostnameProtocol endpoint
|
|
1830
1830
|
*
|
|
1831
|
-
* Create domain forward set
|
|
1832
|
-
* Creates a new domain forward set for a specific protocol (HTTP or HTTPS).
|
|
1831
|
+
* Create domain forward set (deprecated)
|
|
1832
|
+
* Deprecated: Use POST /{hostname} with protocol in body instead. Creates a new domain forward set for a specific protocol (HTTP or HTTPS).
|
|
1833
1833
|
*
|
|
1834
1834
|
* @remarks
|
|
1835
1835
|
* This type defines the complete request structure for the POST DomainForwardsHostnameProtocol endpoint.
|
|
@@ -1848,7 +1848,7 @@ export type GET_DomainForwardsHostnameProtocol_Request_Path = GET_DomainForwards
|
|
|
1848
1848
|
*/
|
|
1849
1849
|
export type POST_DomainForwardsHostnameProtocol_Request = {
|
|
1850
1850
|
parameters: {
|
|
1851
|
-
path: operations['
|
|
1851
|
+
path: operations['create_domain_forward_set_deprecated_v1_domain_forwards__hostname___protocol__post']['parameters']['path'];
|
|
1852
1852
|
};
|
|
1853
1853
|
requestBody: DomainForwardSetRequest;
|
|
1854
1854
|
}
|
|
@@ -2903,8 +2903,8 @@ export type GET_DomainForwardsByHostname_Response_422 = HTTPValidationError
|
|
|
2903
2903
|
/**
|
|
2904
2904
|
* Response types for POST DomainForwardsByHostname endpoint
|
|
2905
2905
|
*
|
|
2906
|
-
* Create
|
|
2907
|
-
*
|
|
2906
|
+
* Create domain forward set
|
|
2907
|
+
* Creates a new domain forward set for a specific protocol (HTTP or HTTPS). Raises an error if the set already exists.
|
|
2908
2908
|
*
|
|
2909
2909
|
* @remarks
|
|
2910
2910
|
* This type defines all possible response structures for the POST DomainForwardsByHostname endpoint.
|
|
@@ -2941,9 +2941,9 @@ export type POST_DomainForwardsByHostname_Response = POST_DomainForwardsByHostna
|
|
|
2941
2941
|
* @param hostname (path) - Hostname
|
|
2942
2942
|
*
|
|
2943
2943
|
* @see {@link POST_DomainForwardsByHostname_Response} - The main response type definition
|
|
2944
|
-
* @see {@link
|
|
2944
|
+
* @see {@link DomainForwardSet} - The actual schema type definition
|
|
2945
2945
|
*/
|
|
2946
|
-
export type POST_DomainForwardsByHostname_Response_201 =
|
|
2946
|
+
export type POST_DomainForwardsByHostname_Response_201 = DomainForwardSet
|
|
2947
2947
|
|
|
2948
2948
|
/**
|
|
2949
2949
|
* 401 response for POST DomainForwardsByHostname endpoint
|
|
@@ -3251,8 +3251,8 @@ export type GET_DomainForwardsByHostnameByProtocol_Response_422 = HTTPValidation
|
|
|
3251
3251
|
/**
|
|
3252
3252
|
* Response types for POST DomainForwardsByHostnameByProtocol endpoint
|
|
3253
3253
|
*
|
|
3254
|
-
* Create domain forward set
|
|
3255
|
-
* Creates a new domain forward set for a specific protocol (HTTP or HTTPS).
|
|
3254
|
+
* Create domain forward set (deprecated)
|
|
3255
|
+
* Deprecated: Use POST /{hostname} with protocol in body instead. Creates a new domain forward set for a specific protocol (HTTP or HTTPS).
|
|
3256
3256
|
*
|
|
3257
3257
|
* @remarks
|
|
3258
3258
|
* This type defines all possible response structures for the POST DomainForwardsByHostnameByProtocol endpoint.
|
package/src/helpers/schemas.d.ts
CHANGED
|
@@ -1115,21 +1115,21 @@ export type DomainForwardProtocolSetRequest = components['schemas']['DomainForwa
|
|
|
1115
1115
|
*/
|
|
1116
1116
|
export type DomainForwardProtocolSet = components['schemas']['DomainForwardProtocolSetResponse'];
|
|
1117
1117
|
/**
|
|
1118
|
-
*
|
|
1118
|
+
* DomainForwardSetCreateRequest
|
|
1119
1119
|
*
|
|
1120
1120
|
* @remarks
|
|
1121
|
-
* Type alias for the `
|
|
1122
|
-
* This type represents
|
|
1121
|
+
* Type alias for the `DomainForwardSetCreateRequest` OpenAPI schema.
|
|
1122
|
+
* This type represents domainforwardsetcreaterequest data structures used in API requests and responses.
|
|
1123
1123
|
*
|
|
1124
1124
|
* @example
|
|
1125
1125
|
* ```typescript
|
|
1126
|
-
* const response = await api.
|
|
1127
|
-
* const item:
|
|
1126
|
+
* const response = await api.getDomainForwardSetCreateRequest();
|
|
1127
|
+
* const item: DomainForwardSetCreateRequest = response.results;
|
|
1128
1128
|
* ```
|
|
1129
1129
|
*
|
|
1130
1130
|
* @see {@link components} - The OpenAPI components schema definition
|
|
1131
1131
|
*/
|
|
1132
|
-
export type
|
|
1132
|
+
export type DomainForwardSetCreateRequest = components['schemas']['DomainForwardSetCreateRequest'];
|
|
1133
1133
|
/**
|
|
1134
1134
|
* DomainForwardSetRequest
|
|
1135
1135
|
*
|
package/src/openapi.yaml
CHANGED
|
@@ -1571,12 +1571,8 @@ components:
|
|
|
1571
1571
|
format: date-time
|
|
1572
1572
|
title: Updated On
|
|
1573
1573
|
type: string
|
|
1574
|
-
wildcard:
|
|
1575
|
-
title: Wildcard
|
|
1576
|
-
type: boolean
|
|
1577
1574
|
required:
|
|
1578
1575
|
- hostname
|
|
1579
|
-
- wildcard
|
|
1580
1576
|
- enabled
|
|
1581
1577
|
- updated_on
|
|
1582
1578
|
- created_on
|
|
@@ -1637,11 +1633,6 @@ components:
|
|
|
1637
1633
|
- $ref: '#/components/schemas/WildcardHttpRedirectRequest'
|
|
1638
1634
|
title: Redirects
|
|
1639
1635
|
type: array
|
|
1640
|
-
wildcard:
|
|
1641
|
-
anyOf:
|
|
1642
|
-
- type: boolean
|
|
1643
|
-
- type: 'null'
|
|
1644
|
-
title: Wildcard
|
|
1645
1636
|
required:
|
|
1646
1637
|
- redirects
|
|
1647
1638
|
title: DomainForwardProtocolSetRequest
|
|
@@ -1661,36 +1652,27 @@ components:
|
|
|
1661
1652
|
format: date-time
|
|
1662
1653
|
title: Updated On
|
|
1663
1654
|
type: string
|
|
1664
|
-
wildcard:
|
|
1665
|
-
title: Wildcard
|
|
1666
|
-
type: boolean
|
|
1667
1655
|
required:
|
|
1668
|
-
- wildcard
|
|
1669
1656
|
- redirects
|
|
1670
1657
|
- updated_on
|
|
1671
1658
|
- created_on
|
|
1672
1659
|
title: DomainForwardProtocolSetResponse
|
|
1673
1660
|
type: object
|
|
1674
|
-
|
|
1661
|
+
DomainForwardSetCreateRequest:
|
|
1675
1662
|
properties:
|
|
1676
|
-
|
|
1677
|
-
|
|
1678
|
-
|
|
1679
|
-
|
|
1680
|
-
|
|
1681
|
-
|
|
1682
|
-
|
|
1683
|
-
|
|
1684
|
-
|
|
1685
|
-
|
|
1686
|
-
|
|
1687
|
-
|
|
1688
|
-
|
|
1689
|
-
anyOf:
|
|
1690
|
-
- type: boolean
|
|
1691
|
-
- type: 'null'
|
|
1692
|
-
title: Wildcard
|
|
1693
|
-
title: DomainForwardRequest
|
|
1663
|
+
protocol:
|
|
1664
|
+
$ref: '#/components/schemas/HttpProtocol'
|
|
1665
|
+
redirects:
|
|
1666
|
+
items:
|
|
1667
|
+
anyOf:
|
|
1668
|
+
- $ref: '#/components/schemas/HttpRedirectRequest'
|
|
1669
|
+
- $ref: '#/components/schemas/WildcardHttpRedirectRequest'
|
|
1670
|
+
title: Redirects
|
|
1671
|
+
type: array
|
|
1672
|
+
required:
|
|
1673
|
+
- protocol
|
|
1674
|
+
- redirects
|
|
1675
|
+
title: DomainForwardSetCreateRequest
|
|
1694
1676
|
type: object
|
|
1695
1677
|
DomainForwardSetRequest:
|
|
1696
1678
|
properties:
|
|
@@ -1725,13 +1707,9 @@ components:
|
|
|
1725
1707
|
format: date-time
|
|
1726
1708
|
title: Updated On
|
|
1727
1709
|
type: string
|
|
1728
|
-
wildcard:
|
|
1729
|
-
title: Wildcard
|
|
1730
|
-
type: boolean
|
|
1731
1710
|
required:
|
|
1732
1711
|
- hostname
|
|
1733
1712
|
- protocol
|
|
1734
|
-
- wildcard
|
|
1735
1713
|
- redirects
|
|
1736
1714
|
- updated_on
|
|
1737
1715
|
- created_on
|
|
@@ -6253,7 +6231,7 @@ info:
|
|
|
6253
6231
|
'
|
|
6254
6232
|
summary: OpusDNS - your gateway to a seamless domain management experience.
|
|
6255
6233
|
title: OpusDNS API
|
|
6256
|
-
version:
|
|
6234
|
+
version: 2026-01-05-134959
|
|
6257
6235
|
x-logo:
|
|
6258
6236
|
altText: OpusDNS API Reference
|
|
6259
6237
|
url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
|
|
@@ -8169,9 +8147,7 @@ paths:
|
|
|
8169
8147
|
target_path: /
|
|
8170
8148
|
target_protocol: https
|
|
8171
8149
|
updated_on: '2025-11-18T12:59:57Z'
|
|
8172
|
-
wildcard: false
|
|
8173
8150
|
updated_on: '2025-11-18T12:59:57Z'
|
|
8174
|
-
wildcard: false
|
|
8175
8151
|
zone_id: zone_01kabfvtysfqwv4dn89r3jepym
|
|
8176
8152
|
zone_name: example.com.
|
|
8177
8153
|
schema:
|
|
@@ -8590,9 +8566,7 @@ paths:
|
|
|
8590
8566
|
target_path: /
|
|
8591
8567
|
target_protocol: https
|
|
8592
8568
|
updated_on: '2025-11-18T12:59:57Z'
|
|
8593
|
-
wildcard: false
|
|
8594
8569
|
updated_on: '2025-11-18T12:59:57Z'
|
|
8595
|
-
wildcard: false
|
|
8596
8570
|
zone_id: zone_01kabfvtysfqwv4dn89r3jepym
|
|
8597
8571
|
zone_name: example.com.
|
|
8598
8572
|
schema:
|
|
@@ -9150,6 +9124,7 @@ paths:
|
|
|
9150
9124
|
summary: HTTP domain forward
|
|
9151
9125
|
value:
|
|
9152
9126
|
enabled: false
|
|
9127
|
+
hostname: example.com.
|
|
9153
9128
|
http:
|
|
9154
9129
|
redirects:
|
|
9155
9130
|
- redirect_code: 301
|
|
@@ -9157,7 +9132,6 @@ paths:
|
|
|
9157
9132
|
target_hostname: example.com
|
|
9158
9133
|
target_path: /
|
|
9159
9134
|
target_protocol: https
|
|
9160
|
-
wildcard: false
|
|
9161
9135
|
https:
|
|
9162
9136
|
redirects:
|
|
9163
9137
|
- redirect_code: 302
|
|
@@ -9165,14 +9139,13 @@ paths:
|
|
|
9165
9139
|
target_hostname: auth.example.com
|
|
9166
9140
|
target_path: /
|
|
9167
9141
|
target_protocol: https
|
|
9168
|
-
wildcard: false
|
|
9169
|
-
wildcard: false
|
|
9170
9142
|
http_to_https:
|
|
9171
9143
|
description: Create a HTTP domain forward with redirect from HTTP
|
|
9172
9144
|
to HTTPS
|
|
9173
9145
|
summary: HTTP to HTTPS
|
|
9174
9146
|
value:
|
|
9175
9147
|
enabled: false
|
|
9148
|
+
hostname: example.com.
|
|
9176
9149
|
https:
|
|
9177
9150
|
redirects:
|
|
9178
9151
|
- redirect_code: 301
|
|
@@ -9180,8 +9153,6 @@ paths:
|
|
|
9180
9153
|
target_hostname: example.com
|
|
9181
9154
|
target_path: /
|
|
9182
9155
|
target_protocol: https
|
|
9183
|
-
wildcard: false
|
|
9184
|
-
wildcard: false
|
|
9185
9156
|
schema:
|
|
9186
9157
|
$ref: '#/components/schemas/DomainForwardCreateRequest'
|
|
9187
9158
|
required: true
|
|
@@ -9209,7 +9180,6 @@ paths:
|
|
|
9209
9180
|
target_path: /
|
|
9210
9181
|
target_protocol: https
|
|
9211
9182
|
updated_on: '2025-11-14T09:01:38'
|
|
9212
|
-
wildcard: false
|
|
9213
9183
|
https:
|
|
9214
9184
|
created_on: '2025-11-14T09:01:38'
|
|
9215
9185
|
redirects:
|
|
@@ -9221,9 +9191,7 @@ paths:
|
|
|
9221
9191
|
target_path: /
|
|
9222
9192
|
target_protocol: https
|
|
9223
9193
|
updated_on: '2025-11-14T09:01:38'
|
|
9224
|
-
wildcard: false
|
|
9225
9194
|
updated_on: '2025-11-14T09:01:38'
|
|
9226
|
-
wildcard: false
|
|
9227
9195
|
http_to_https_response:
|
|
9228
9196
|
description: Response when creating a HTTP to HTTPS domain forward
|
|
9229
9197
|
summary: Response for HTTP to HTTPS
|
|
@@ -9242,9 +9210,7 @@ paths:
|
|
|
9242
9210
|
target_path: /
|
|
9243
9211
|
target_protocol: https
|
|
9244
9212
|
updated_on: '2025-11-14T09:01:38'
|
|
9245
|
-
wildcard: false
|
|
9246
9213
|
updated_on: '2025-11-14T09:01:38'
|
|
9247
|
-
wildcard: false
|
|
9248
9214
|
schema:
|
|
9249
9215
|
$ref: '#/components/schemas/DomainForward'
|
|
9250
9216
|
description: Domain forward created successfully
|
|
@@ -9438,10 +9404,9 @@ paths:
|
|
|
9438
9404
|
tags:
|
|
9439
9405
|
- domain_forward
|
|
9440
9406
|
post:
|
|
9441
|
-
|
|
9442
|
-
|
|
9443
|
-
|
|
9444
|
-
operationId: create_domain_forward_v1_domain_forwards__hostname__post
|
|
9407
|
+
description: Creates a new domain forward set for a specific protocol (HTTP
|
|
9408
|
+
or HTTPS). Raises an error if the set already exists.
|
|
9409
|
+
operationId: create_domain_forward_set_v1_domain_forwards__hostname__post
|
|
9445
9410
|
parameters:
|
|
9446
9411
|
- description: Hostname
|
|
9447
9412
|
in: path
|
|
@@ -9454,111 +9419,16 @@ paths:
|
|
|
9454
9419
|
requestBody:
|
|
9455
9420
|
content:
|
|
9456
9421
|
application/json:
|
|
9457
|
-
examples:
|
|
9458
|
-
domain_forward:
|
|
9459
|
-
description: Create a HTTP domain forward with redirect from HTTP
|
|
9460
|
-
to HTTPS and HTTPS to auth.example.com
|
|
9461
|
-
summary: HTTP domain forward
|
|
9462
|
-
value:
|
|
9463
|
-
enabled: false
|
|
9464
|
-
http:
|
|
9465
|
-
redirects:
|
|
9466
|
-
- redirect_code: 301
|
|
9467
|
-
request_path: /
|
|
9468
|
-
target_hostname: example.com
|
|
9469
|
-
target_path: /
|
|
9470
|
-
target_protocol: https
|
|
9471
|
-
wildcard: false
|
|
9472
|
-
https:
|
|
9473
|
-
redirects:
|
|
9474
|
-
- redirect_code: 302
|
|
9475
|
-
request_path: /
|
|
9476
|
-
target_hostname: auth.example.com
|
|
9477
|
-
target_path: /
|
|
9478
|
-
target_protocol: https
|
|
9479
|
-
wildcard: false
|
|
9480
|
-
wildcard: false
|
|
9481
|
-
http_to_https:
|
|
9482
|
-
description: Create a HTTP domain forward with redirect from HTTP
|
|
9483
|
-
to HTTPS
|
|
9484
|
-
summary: HTTP to HTTPS
|
|
9485
|
-
value:
|
|
9486
|
-
enabled: false
|
|
9487
|
-
https:
|
|
9488
|
-
redirects:
|
|
9489
|
-
- redirect_code: 301
|
|
9490
|
-
request_path: /
|
|
9491
|
-
target_hostname: example.com
|
|
9492
|
-
target_path: /
|
|
9493
|
-
target_protocol: https
|
|
9494
|
-
wildcard: false
|
|
9495
|
-
wildcard: false
|
|
9496
9422
|
schema:
|
|
9497
|
-
$ref: '#/components/schemas/
|
|
9423
|
+
$ref: '#/components/schemas/DomainForwardSetCreateRequest'
|
|
9498
9424
|
required: true
|
|
9499
9425
|
responses:
|
|
9500
9426
|
'201':
|
|
9501
9427
|
content:
|
|
9502
9428
|
application/json:
|
|
9503
|
-
examples:
|
|
9504
|
-
http_domain_forward_response:
|
|
9505
|
-
description: Response when creating a HTTP domain forward with redirect
|
|
9506
|
-
from HTTP to HTTPS and HTTPS to auth.example.com
|
|
9507
|
-
summary: Response for HTTP domain forward
|
|
9508
|
-
value:
|
|
9509
|
-
created_on: '2025-11-14T09:01:38'
|
|
9510
|
-
enabled: false
|
|
9511
|
-
hostname: example.com.
|
|
9512
|
-
http:
|
|
9513
|
-
created_on: '2025-11-14T09:01:38'
|
|
9514
|
-
redirects:
|
|
9515
|
-
- redirect_code: 301
|
|
9516
|
-
request_hostname: example.com.
|
|
9517
|
-
request_path: /
|
|
9518
|
-
request_protocol: http
|
|
9519
|
-
target_hostname: example.com
|
|
9520
|
-
target_path: /
|
|
9521
|
-
target_protocol: https
|
|
9522
|
-
updated_on: '2025-11-14T09:01:38'
|
|
9523
|
-
wildcard: false
|
|
9524
|
-
https:
|
|
9525
|
-
created_on: '2025-11-14T09:01:38'
|
|
9526
|
-
redirects:
|
|
9527
|
-
- redirect_code: 302
|
|
9528
|
-
request_hostname: example.com.
|
|
9529
|
-
request_path: /
|
|
9530
|
-
request_protocol: https
|
|
9531
|
-
target_hostname: auth.example.com
|
|
9532
|
-
target_path: /
|
|
9533
|
-
target_protocol: https
|
|
9534
|
-
updated_on: '2025-11-14T09:01:38'
|
|
9535
|
-
wildcard: false
|
|
9536
|
-
updated_on: '2025-11-14T09:01:38'
|
|
9537
|
-
wildcard: false
|
|
9538
|
-
http_to_https_response:
|
|
9539
|
-
description: Response when creating a HTTP to HTTPS domain forward
|
|
9540
|
-
summary: Response for HTTP to HTTPS
|
|
9541
|
-
value:
|
|
9542
|
-
created_on: '2025-11-14T09:01:38'
|
|
9543
|
-
enabled: false
|
|
9544
|
-
hostname: example.com.
|
|
9545
|
-
http:
|
|
9546
|
-
created_on: '2025-11-14T09:01:38'
|
|
9547
|
-
redirects:
|
|
9548
|
-
- redirect_code: 301
|
|
9549
|
-
request_hostname: example.com.
|
|
9550
|
-
request_path: /
|
|
9551
|
-
request_protocol: http
|
|
9552
|
-
target_hostname: example.com
|
|
9553
|
-
target_path: /
|
|
9554
|
-
target_protocol: https
|
|
9555
|
-
updated_on: '2025-11-14T09:01:38'
|
|
9556
|
-
wildcard: false
|
|
9557
|
-
updated_on: '2025-11-14T09:01:38'
|
|
9558
|
-
wildcard: false
|
|
9559
9429
|
schema:
|
|
9560
|
-
$ref: '#/components/schemas/
|
|
9561
|
-
description:
|
|
9430
|
+
$ref: '#/components/schemas/DomainForwardSetResponse'
|
|
9431
|
+
description: Successful Response
|
|
9562
9432
|
'401':
|
|
9563
9433
|
content:
|
|
9564
9434
|
application/problem+json:
|
|
@@ -9587,27 +9457,26 @@ paths:
|
|
|
9587
9457
|
content:
|
|
9588
9458
|
application/problem+json:
|
|
9589
9459
|
example:
|
|
9590
|
-
code:
|
|
9591
|
-
detail:
|
|
9460
|
+
code: ERROR_DOMAIN_FORWARD_NOT_EXISTS
|
|
9461
|
+
detail: Domain forward not found for Additional error context.
|
|
9592
9462
|
status: 404
|
|
9593
|
-
title:
|
|
9594
|
-
type:
|
|
9595
|
-
zone_name: Zone example.com. not found
|
|
9463
|
+
title: Domain Forward Error
|
|
9464
|
+
type: domain-forward-not-found
|
|
9596
9465
|
schema:
|
|
9597
9466
|
$ref: '#/components/schemas/Problem'
|
|
9598
|
-
description:
|
|
9467
|
+
description: Not Found
|
|
9599
9468
|
'409':
|
|
9600
9469
|
content:
|
|
9601
9470
|
application/problem+json:
|
|
9602
9471
|
example:
|
|
9603
9472
|
code: ERROR_DOMAIN_FORWARD_ALREADY_EXISTS
|
|
9604
|
-
detail: Domain forward already exists for
|
|
9473
|
+
detail: Domain forward already exists for Additional error context.
|
|
9605
9474
|
status: 409
|
|
9606
9475
|
title: Domain Forward Error
|
|
9607
9476
|
type: domain-forward-already-exists
|
|
9608
9477
|
schema:
|
|
9609
9478
|
$ref: '#/components/schemas/Problem'
|
|
9610
|
-
description:
|
|
9479
|
+
description: Conflict
|
|
9611
9480
|
'422':
|
|
9612
9481
|
content:
|
|
9613
9482
|
application/problem+json:
|
|
@@ -9616,7 +9485,7 @@ paths:
|
|
|
9616
9485
|
description: Validation Error
|
|
9617
9486
|
security:
|
|
9618
9487
|
- OAuth2PasswordBearer: []
|
|
9619
|
-
summary: Create
|
|
9488
|
+
summary: Create domain forward set
|
|
9620
9489
|
tags:
|
|
9621
9490
|
- domain_forward
|
|
9622
9491
|
/v1/domain-forwards/{hostname}/disable:
|
|
@@ -9875,9 +9744,10 @@ paths:
|
|
|
9875
9744
|
tags:
|
|
9876
9745
|
- domain_forward
|
|
9877
9746
|
post:
|
|
9878
|
-
|
|
9879
|
-
|
|
9880
|
-
|
|
9747
|
+
deprecated: true
|
|
9748
|
+
description: 'Deprecated: Use POST /{hostname} with protocol in body instead.
|
|
9749
|
+
Creates a new domain forward set for a specific protocol (HTTP or HTTPS).'
|
|
9750
|
+
operationId: create_domain_forward_set_deprecated_v1_domain_forwards__hostname___protocol__post
|
|
9881
9751
|
parameters:
|
|
9882
9752
|
- in: path
|
|
9883
9753
|
name: protocol
|
|
@@ -9961,7 +9831,7 @@ paths:
|
|
|
9961
9831
|
description: Validation Error
|
|
9962
9832
|
security:
|
|
9963
9833
|
- OAuth2PasswordBearer: []
|
|
9964
|
-
summary: Create domain forward set
|
|
9834
|
+
summary: Create domain forward set (deprecated)
|
|
9965
9835
|
tags:
|
|
9966
9836
|
- domain_forward
|
|
9967
9837
|
put:
|
package/src/schema.d.ts
CHANGED
|
@@ -504,11 +504,10 @@ export interface paths {
|
|
|
504
504
|
get: operations["get_domain_forward_v1_domain_forwards__hostname__get"];
|
|
505
505
|
put?: never;
|
|
506
506
|
/**
|
|
507
|
-
* Create
|
|
508
|
-
* @
|
|
509
|
-
* @description **DEPRECATED**: Use POST /v1/domain-forwards instead. Creates a new domain forward configuration for the specified hostname.
|
|
507
|
+
* Create domain forward set
|
|
508
|
+
* @description Creates a new domain forward set for a specific protocol (HTTP or HTTPS). Raises an error if the set already exists.
|
|
510
509
|
*/
|
|
511
|
-
post: operations["
|
|
510
|
+
post: operations["create_domain_forward_set_v1_domain_forwards__hostname__post"];
|
|
512
511
|
/**
|
|
513
512
|
* Delete a domain forward
|
|
514
513
|
* @description Deletes the domain forward configuration for the specified hostname
|
|
@@ -577,10 +576,11 @@ export interface paths {
|
|
|
577
576
|
*/
|
|
578
577
|
put: operations["update_domain_forward_set_v1_domain_forwards__hostname___protocol__put"];
|
|
579
578
|
/**
|
|
580
|
-
* Create domain forward set
|
|
581
|
-
* @
|
|
579
|
+
* Create domain forward set (deprecated)
|
|
580
|
+
* @deprecated
|
|
581
|
+
* @description Deprecated: Use POST /{hostname} with protocol in body instead. Creates a new domain forward set for a specific protocol (HTTP or HTTPS).
|
|
582
582
|
*/
|
|
583
|
-
post: operations["
|
|
583
|
+
post: operations["create_domain_forward_set_deprecated_v1_domain_forwards__hostname___protocol__post"];
|
|
584
584
|
/**
|
|
585
585
|
* Delete domain forward set
|
|
586
586
|
* @description Deletes a domain forward set for a specific protocol (HTTP or HTTPS).
|
|
@@ -2658,8 +2658,6 @@ export interface components {
|
|
|
2658
2658
|
* Format: date-time
|
|
2659
2659
|
*/
|
|
2660
2660
|
updated_on: Date;
|
|
2661
|
-
/** Wildcard */
|
|
2662
|
-
wildcard: boolean;
|
|
2663
2661
|
};
|
|
2664
2662
|
/** DomainForwardCreateRequest */
|
|
2665
2663
|
DomainForwardCreateRequest: {
|
|
@@ -2688,8 +2686,6 @@ export interface components {
|
|
|
2688
2686
|
DomainForwardProtocolSetRequest: {
|
|
2689
2687
|
/** Redirects */
|
|
2690
2688
|
redirects: (components["schemas"]["HttpRedirectRequest"] | components["schemas"]["WildcardHttpRedirectRequest"])[];
|
|
2691
|
-
/** Wildcard */
|
|
2692
|
-
wildcard?: boolean | null;
|
|
2693
2689
|
};
|
|
2694
2690
|
/** DomainForwardProtocolSetResponse */
|
|
2695
2691
|
DomainForwardProtocolSetResponse: {
|
|
@@ -2705,20 +2701,12 @@ export interface components {
|
|
|
2705
2701
|
* Format: date-time
|
|
2706
2702
|
*/
|
|
2707
2703
|
updated_on: Date;
|
|
2708
|
-
/** Wildcard */
|
|
2709
|
-
wildcard: boolean;
|
|
2710
2704
|
};
|
|
2711
|
-
/**
|
|
2712
|
-
|
|
2713
|
-
|
|
2714
|
-
|
|
2715
|
-
|
|
2716
|
-
*/
|
|
2717
|
-
enabled: boolean;
|
|
2718
|
-
http?: components["schemas"]["DomainForwardProtocolSetRequest"] | null;
|
|
2719
|
-
https?: components["schemas"]["DomainForwardProtocolSetRequest"] | null;
|
|
2720
|
-
/** Wildcard */
|
|
2721
|
-
wildcard?: boolean | null;
|
|
2705
|
+
/** DomainForwardSetCreateRequest */
|
|
2706
|
+
DomainForwardSetCreateRequest: {
|
|
2707
|
+
protocol: components["schemas"]["HttpProtocol"];
|
|
2708
|
+
/** Redirects */
|
|
2709
|
+
redirects: (components["schemas"]["HttpRedirectRequest"] | components["schemas"]["WildcardHttpRedirectRequest"])[];
|
|
2722
2710
|
};
|
|
2723
2711
|
/** DomainForwardSetRequest */
|
|
2724
2712
|
DomainForwardSetRequest: {
|
|
@@ -2742,8 +2730,6 @@ export interface components {
|
|
|
2742
2730
|
* Format: date-time
|
|
2743
2731
|
*/
|
|
2744
2732
|
updated_on: Date;
|
|
2745
|
-
/** Wildcard */
|
|
2746
|
-
wildcard: boolean;
|
|
2747
2733
|
};
|
|
2748
2734
|
/**
|
|
2749
2735
|
* DomainForwardSortField
|
|
@@ -7814,7 +7800,7 @@ export interface operations {
|
|
|
7814
7800
|
};
|
|
7815
7801
|
};
|
|
7816
7802
|
};
|
|
7817
|
-
|
|
7803
|
+
create_domain_forward_set_v1_domain_forwards__hostname__post: {
|
|
7818
7804
|
parameters: {
|
|
7819
7805
|
query?: never;
|
|
7820
7806
|
header?: never;
|
|
@@ -7826,17 +7812,17 @@ export interface operations {
|
|
|
7826
7812
|
};
|
|
7827
7813
|
requestBody: {
|
|
7828
7814
|
content: {
|
|
7829
|
-
"application/json": components["schemas"]["
|
|
7815
|
+
"application/json": components["schemas"]["DomainForwardSetCreateRequest"];
|
|
7830
7816
|
};
|
|
7831
7817
|
};
|
|
7832
7818
|
responses: {
|
|
7833
|
-
/** @description
|
|
7819
|
+
/** @description Successful Response */
|
|
7834
7820
|
201: {
|
|
7835
7821
|
headers: {
|
|
7836
7822
|
[name: string]: unknown;
|
|
7837
7823
|
};
|
|
7838
7824
|
content: {
|
|
7839
|
-
"application/json": components["schemas"]["
|
|
7825
|
+
"application/json": components["schemas"]["DomainForwardSetResponse"];
|
|
7840
7826
|
};
|
|
7841
7827
|
};
|
|
7842
7828
|
/** @description Unauthorized */
|
|
@@ -7871,24 +7857,23 @@ export interface operations {
|
|
|
7871
7857
|
"application/problem+json": components["schemas"]["Problem"];
|
|
7872
7858
|
};
|
|
7873
7859
|
};
|
|
7874
|
-
/** @description
|
|
7860
|
+
/** @description Not Found */
|
|
7875
7861
|
404: {
|
|
7876
7862
|
headers: {
|
|
7877
7863
|
[name: string]: unknown;
|
|
7878
7864
|
};
|
|
7879
7865
|
content: {
|
|
7880
7866
|
/** @example {
|
|
7881
|
-
* "code": "
|
|
7882
|
-
* "detail": "
|
|
7867
|
+
* "code": "ERROR_DOMAIN_FORWARD_NOT_EXISTS",
|
|
7868
|
+
* "detail": "Domain forward not found for Additional error context.",
|
|
7883
7869
|
* "status": 404,
|
|
7884
|
-
* "title": "
|
|
7885
|
-
* "type": "
|
|
7886
|
-
* "zone_name": "Zone example.com. not found"
|
|
7870
|
+
* "title": "Domain Forward Error",
|
|
7871
|
+
* "type": "domain-forward-not-found"
|
|
7887
7872
|
* } */
|
|
7888
7873
|
"application/problem+json": components["schemas"]["Problem"];
|
|
7889
7874
|
};
|
|
7890
7875
|
};
|
|
7891
|
-
/** @description
|
|
7876
|
+
/** @description Conflict */
|
|
7892
7877
|
409: {
|
|
7893
7878
|
headers: {
|
|
7894
7879
|
[name: string]: unknown;
|
|
@@ -7896,7 +7881,7 @@ export interface operations {
|
|
|
7896
7881
|
content: {
|
|
7897
7882
|
/** @example {
|
|
7898
7883
|
* "code": "ERROR_DOMAIN_FORWARD_ALREADY_EXISTS",
|
|
7899
|
-
* "detail": "Domain forward already exists for
|
|
7884
|
+
* "detail": "Domain forward already exists for Additional error context.",
|
|
7900
7885
|
* "status": 409,
|
|
7901
7886
|
* "title": "Domain Forward Error",
|
|
7902
7887
|
* "type": "domain-forward-already-exists"
|
|
@@ -8299,7 +8284,7 @@ export interface operations {
|
|
|
8299
8284
|
};
|
|
8300
8285
|
};
|
|
8301
8286
|
};
|
|
8302
|
-
|
|
8287
|
+
create_domain_forward_set_deprecated_v1_domain_forwards__hostname___protocol__post: {
|
|
8303
8288
|
parameters: {
|
|
8304
8289
|
query?: never;
|
|
8305
8290
|
header?: never;
|