@opusdns/api 1.215.0 → 1.216.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/constants.ts +11 -0
- package/src/helpers/endpoints.ts +2 -0
- package/src/helpers/keys.ts +15 -0
- package/src/helpers/permissions.ts +8 -0
- package/src/helpers/requests.d.ts +5 -0
- package/src/helpers/responses.d.ts +9 -0
- package/src/helpers/schemas.d.ts +2 -0
- package/src/openapi.yaml +214 -19
- package/src/schema.d.ts +206 -9
package/package.json
CHANGED
package/src/helpers/constants.ts
CHANGED
|
@@ -3,6 +3,7 @@ import type {
|
|
|
3
3
|
AllocationMethodType,
|
|
4
4
|
AssignablePublicRole,
|
|
5
5
|
AttributeType,
|
|
6
|
+
AuthCodeDelivery,
|
|
6
7
|
BatchSortField,
|
|
7
8
|
BatchStatus,
|
|
8
9
|
BillingMode,
|
|
@@ -206,6 +207,16 @@ export const ATTRIBUTE_TYPE_VALUES = [
|
|
|
206
207
|
'uri_template',
|
|
207
208
|
] as const satisfies ReadonlyArray<AttributeType>;
|
|
208
209
|
|
|
210
|
+
export const AUTH_CODE_DELIVERY = {
|
|
211
|
+
RESPONSE: "response",
|
|
212
|
+
REGISTRANT_EMAIL: "registrant_email",
|
|
213
|
+
} as const satisfies Record<string, AuthCodeDelivery>;
|
|
214
|
+
|
|
215
|
+
export const AUTH_CODE_DELIVERY_VALUES = [
|
|
216
|
+
'response',
|
|
217
|
+
'registrant_email',
|
|
218
|
+
] as const satisfies ReadonlyArray<AuthCodeDelivery>;
|
|
219
|
+
|
|
209
220
|
export const BATCH_SORT_FIELD = {
|
|
210
221
|
CREATED_ON: "created_on",
|
|
211
222
|
STARTED_AT: "started_at",
|
package/src/helpers/endpoints.ts
CHANGED
|
@@ -74,6 +74,7 @@ export const DOMAINS_TLD_SPECIFIC_SE_BY_DOMAIN_REFERENCE_AUTH_CODE_REQUEST_ENDPO
|
|
|
74
74
|
export const DOMAINS_TLD_SPECIFIC_WALES_BY_DOMAIN_REFERENCE_AUTH_CODE_REQUEST_ENDPOINT = '/v1/domains/tld-specific/wales/{domain_reference}/auth_code/request';
|
|
75
75
|
export const DOMAINS_TRANSFER_ENDPOINT = '/v1/domains/transfer';
|
|
76
76
|
export const DOMAINS_BY_DOMAIN_REFERENCE_ENDPOINT = '/v1/domains/{domain_reference}';
|
|
77
|
+
export const DOMAINS_BY_DOMAIN_REFERENCE_AUTH_CODE_ENDPOINT = '/v1/domains/{domain_reference}/auth-code';
|
|
77
78
|
export const DOMAINS_BY_DOMAIN_REFERENCE_DNSSEC_ENDPOINT = '/v1/domains/{domain_reference}/dnssec';
|
|
78
79
|
export const DOMAINS_BY_DOMAIN_REFERENCE_DNSSEC_DISABLE_ENDPOINT = '/v1/domains/{domain_reference}/dnssec/disable';
|
|
79
80
|
export const DOMAINS_BY_DOMAIN_REFERENCE_DNSSEC_ENABLE_ENDPOINT = '/v1/domains/{domain_reference}/dnssec/enable';
|
|
@@ -236,6 +237,7 @@ export type Endpoint =
|
|
|
236
237
|
| typeof DOMAINS_TLD_SPECIFIC_WALES_BY_DOMAIN_REFERENCE_AUTH_CODE_REQUEST_ENDPOINT
|
|
237
238
|
| typeof DOMAINS_TRANSFER_ENDPOINT
|
|
238
239
|
| typeof DOMAINS_BY_DOMAIN_REFERENCE_ENDPOINT
|
|
240
|
+
| typeof DOMAINS_BY_DOMAIN_REFERENCE_AUTH_CODE_ENDPOINT
|
|
239
241
|
| typeof DOMAINS_BY_DOMAIN_REFERENCE_DNSSEC_ENDPOINT
|
|
240
242
|
| typeof DOMAINS_BY_DOMAIN_REFERENCE_DNSSEC_DISABLE_ENDPOINT
|
|
241
243
|
| typeof DOMAINS_BY_DOMAIN_REFERENCE_DNSSEC_ENABLE_ENDPOINT
|
package/src/helpers/keys.ts
CHANGED
|
@@ -131,6 +131,7 @@ import type {
|
|
|
131
131
|
DnsZoneUpdatePayloadData,
|
|
132
132
|
DnsZoneUpdateWorkerPayload,
|
|
133
133
|
DnsZoneVanitySetUpdateRes,
|
|
134
|
+
DomainAuthCode,
|
|
134
135
|
DomainAvailability,
|
|
135
136
|
DomainAvailabilityError,
|
|
136
137
|
DomainAvailabilityMeta,
|
|
@@ -2106,6 +2107,20 @@ export const KEYS_DNS_ZONE_VANITY_SET_UPDATE_RES = [
|
|
|
2106
2107
|
KEY_DNS_ZONE_VANITY_SET_UPDATE_RES_ZONE,
|
|
2107
2108
|
] as const satisfies (keyof DnsZoneVanitySetUpdateRes)[];
|
|
2108
2109
|
|
|
2110
|
+
export const KEY_DOMAIN_AUTH_CODE_AUTH_CODE = 'auth_code' satisfies keyof DomainAuthCode;
|
|
2111
|
+
export const KEY_DOMAIN_AUTH_CODE_AUTH_CODE_EXPIRES_ON = 'auth_code_expires_on' satisfies keyof DomainAuthCode;
|
|
2112
|
+
export const KEY_DOMAIN_AUTH_CODE_DELIVERY = 'delivery' satisfies keyof DomainAuthCode;
|
|
2113
|
+
export const KEY_DOMAIN_AUTH_CODE_NAME = 'name' satisfies keyof DomainAuthCode;
|
|
2114
|
+
export const KEY_DOMAIN_AUTH_CODE_RECIPIENTS = 'recipients' satisfies keyof DomainAuthCode;
|
|
2115
|
+
|
|
2116
|
+
export const KEYS_DOMAIN_AUTH_CODE = [
|
|
2117
|
+
KEY_DOMAIN_AUTH_CODE_AUTH_CODE,
|
|
2118
|
+
KEY_DOMAIN_AUTH_CODE_AUTH_CODE_EXPIRES_ON,
|
|
2119
|
+
KEY_DOMAIN_AUTH_CODE_DELIVERY,
|
|
2120
|
+
KEY_DOMAIN_AUTH_CODE_NAME,
|
|
2121
|
+
KEY_DOMAIN_AUTH_CODE_RECIPIENTS,
|
|
2122
|
+
] as const satisfies (keyof DomainAuthCode)[];
|
|
2123
|
+
|
|
2109
2124
|
export const KEY_DOMAIN_AVAILABILITY_DOMAIN = 'domain' satisfies keyof DomainAvailability;
|
|
2110
2125
|
export const KEY_DOMAIN_AVAILABILITY_ERROR = 'error' satisfies keyof DomainAvailability;
|
|
2111
2126
|
export const KEY_DOMAIN_AVAILABILITY_STATUS = 'status' satisfies keyof DomainAvailability;
|
|
@@ -57,6 +57,7 @@ import {
|
|
|
57
57
|
DOMAIN_FORWARDS_METRICS_USER_AGENT_ENDPOINT,
|
|
58
58
|
DOMAIN_FORWARDS_METRICS_VISITS_BY_KEY_ENDPOINT,
|
|
59
59
|
DOMAIN_SEARCH_SUGGEST_ENDPOINT,
|
|
60
|
+
DOMAINS_BY_DOMAIN_REFERENCE_AUTH_CODE_ENDPOINT,
|
|
60
61
|
DOMAINS_BY_DOMAIN_REFERENCE_DNSSEC_DISABLE_ENDPOINT,
|
|
61
62
|
DOMAINS_BY_DOMAIN_REFERENCE_DNSSEC_ENABLE_ENDPOINT,
|
|
62
63
|
DOMAINS_BY_DOMAIN_REFERENCE_DNSSEC_ENDPOINT,
|
|
@@ -618,6 +619,13 @@ export const REQUIRED_PERMISSIONS = {
|
|
|
618
619
|
patch: [],
|
|
619
620
|
delete: [],
|
|
620
621
|
},
|
|
622
|
+
[DOMAINS_BY_DOMAIN_REFERENCE_AUTH_CODE_ENDPOINT]: {
|
|
623
|
+
get: [],
|
|
624
|
+
post: [PUBLIC_PERMISSION.DOMAINS_MANAGE],
|
|
625
|
+
put: [],
|
|
626
|
+
patch: [],
|
|
627
|
+
delete: [],
|
|
628
|
+
},
|
|
621
629
|
[DOMAINS_BY_DOMAIN_REFERENCE_DNSSEC_DISABLE_ENDPOINT]: {
|
|
622
630
|
get: [],
|
|
623
631
|
post: [PUBLIC_PERMISSION.DOMAINS_MANAGE],
|
|
@@ -518,6 +518,11 @@ export type PATCH_DomainsByDomainReference_Request = {
|
|
|
518
518
|
export type PATCH_DomainsByDomainReference_Request_Path = PATCH_DomainsByDomainReference_Request['parameters']['path'];
|
|
519
519
|
export type PATCH_DomainsByDomainReference_Request_Body = PATCH_DomainsByDomainReference_Request['requestBody'];
|
|
520
520
|
|
|
521
|
+
export type POST_DomainsByDomainReferenceAuthCode_Request = {
|
|
522
|
+
parameters: operations['request_domain_auth_code_v1_domains__domain_reference__auth_code_post']['parameters'];
|
|
523
|
+
};
|
|
524
|
+
export type POST_DomainsByDomainReferenceAuthCode_Request_Path = POST_DomainsByDomainReferenceAuthCode_Request['parameters']['path'];
|
|
525
|
+
|
|
521
526
|
export type DELETE_DomainsByDomainReferenceDnssec_Request = {
|
|
522
527
|
parameters: operations['delete_dnssec_v1_domains__domain_reference__dnssec_delete']['parameters'];
|
|
523
528
|
};
|
|
@@ -20,6 +20,7 @@ import type {
|
|
|
20
20
|
DnsZoneSummary,
|
|
21
21
|
DnsZoneVanitySetUpdateRes,
|
|
22
22
|
Domain,
|
|
23
|
+
DomainAuthCode,
|
|
23
24
|
DomainAvailabilityList,
|
|
24
25
|
DomainCheck,
|
|
25
26
|
DomainDnssecData,
|
|
@@ -1190,6 +1191,14 @@ export type POST_Domains_Response_409 = Problem;
|
|
|
1190
1191
|
export type POST_Domains_Response_422 = Problem;
|
|
1191
1192
|
export type POST_Domains_Response_503 = Problem;
|
|
1192
1193
|
|
|
1194
|
+
export type POST_DomainsByDomainReferenceAuthCode_Response = POST_DomainsByDomainReferenceAuthCode_Response_200 | POST_DomainsByDomainReferenceAuthCode_Response_400 | POST_DomainsByDomainReferenceAuthCode_Response_404 | POST_DomainsByDomainReferenceAuthCode_Response_422 | POST_DomainsByDomainReferenceAuthCode_Response_502;
|
|
1195
|
+
|
|
1196
|
+
export type POST_DomainsByDomainReferenceAuthCode_Response_200 = DomainAuthCode;
|
|
1197
|
+
export type POST_DomainsByDomainReferenceAuthCode_Response_400 = Problem;
|
|
1198
|
+
export type POST_DomainsByDomainReferenceAuthCode_Response_404 = Problem;
|
|
1199
|
+
export type POST_DomainsByDomainReferenceAuthCode_Response_422 = Problem;
|
|
1200
|
+
export type POST_DomainsByDomainReferenceAuthCode_Response_502 = Problem;
|
|
1201
|
+
|
|
1193
1202
|
export type POST_DomainsByDomainReferenceDnssecDisable_Response = POST_DomainsByDomainReferenceDnssecDisable_Response_404 | POST_DomainsByDomainReferenceDnssecDisable_Response_422;
|
|
1194
1203
|
|
|
1195
1204
|
export type POST_DomainsByDomainReferenceDnssecDisable_Response_404 = Problem;
|
package/src/helpers/schemas.d.ts
CHANGED
|
@@ -16,6 +16,7 @@ export type AssignablePublicRole = components['schemas']['AssignablePublicRole']
|
|
|
16
16
|
export type AttributeCondition = components['schemas']['AttributeCondition'];
|
|
17
17
|
export type AttributeType = components['schemas']['AttributeType'];
|
|
18
18
|
export type Auth = components['schemas']['Auth'];
|
|
19
|
+
export type AuthCodeDelivery = components['schemas']['AuthCodeDelivery'];
|
|
19
20
|
export type BatchSortField = components['schemas']['BatchSortField'];
|
|
20
21
|
export type BatchStatus = components['schemas']['BatchStatus'];
|
|
21
22
|
export type BillingMetadata = components['schemas']['BillingMetadata'];
|
|
@@ -171,6 +172,7 @@ export type DnssecRecordType = components['schemas']['DnssecRecordType'];
|
|
|
171
172
|
export type DnssecRegistryPublishOutcome = components['schemas']['DnssecRegistryPublishOutcome'];
|
|
172
173
|
export type DnssecStatus = components['schemas']['DnssecStatus'];
|
|
173
174
|
export type DomainAttributeKey = components['schemas']['DomainAttributeKey'];
|
|
175
|
+
export type DomainAuthCode = components['schemas']['DomainAuthCodeResponse'];
|
|
174
176
|
export type DomainAvailability = components['schemas']['DomainAvailability'];
|
|
175
177
|
export type DomainAvailabilityError = components['schemas']['DomainAvailabilityError'];
|
|
176
178
|
export type DomainAvailabilityMeta = components['schemas']['DomainAvailabilityMeta'];
|
package/src/openapi.yaml
CHANGED
|
@@ -356,6 +356,12 @@ components:
|
|
|
356
356
|
title: Client Id
|
|
357
357
|
title: Auth
|
|
358
358
|
type: object
|
|
359
|
+
AuthCodeDelivery:
|
|
360
|
+
enum:
|
|
361
|
+
- response
|
|
362
|
+
- registrant_email
|
|
363
|
+
title: AuthCodeDelivery
|
|
364
|
+
type: string
|
|
359
365
|
BatchSortField:
|
|
360
366
|
enum:
|
|
361
367
|
- created_on
|
|
@@ -6616,6 +6622,37 @@ components:
|
|
|
6616
6622
|
- operationId
|
|
6617
6623
|
title: request_auth_code_v1_domains_tld_specific_wales__domain_reference__auth_code_request_post
|
|
6618
6624
|
type: object
|
|
6625
|
+
- properties:
|
|
6626
|
+
data:
|
|
6627
|
+
anyOf:
|
|
6628
|
+
- $ref: '#/components/schemas/DomainAuthCodeResponse'
|
|
6629
|
+
- type: string
|
|
6630
|
+
headers:
|
|
6631
|
+
additionalProperties:
|
|
6632
|
+
type: string
|
|
6633
|
+
description: Selected response headers
|
|
6634
|
+
title: Headers
|
|
6635
|
+
type: object
|
|
6636
|
+
httpStatus:
|
|
6637
|
+
anyOf:
|
|
6638
|
+
- type: integer
|
|
6639
|
+
- type: 'null'
|
|
6640
|
+
description: HTTP status returned by the underlying API
|
|
6641
|
+
title: Httpstatus
|
|
6642
|
+
operationId:
|
|
6643
|
+
const: request_domain_auth_code_v1_domains__domain_reference__auth_code_post
|
|
6644
|
+
status:
|
|
6645
|
+
const: ok
|
|
6646
|
+
truncated:
|
|
6647
|
+
default: false
|
|
6648
|
+
description: True when the gateway capped an oversized payload
|
|
6649
|
+
title: Truncated
|
|
6650
|
+
type: boolean
|
|
6651
|
+
required:
|
|
6652
|
+
- status
|
|
6653
|
+
- operationId
|
|
6654
|
+
title: request_domain_auth_code_v1_domains__domain_reference__auth_code_post
|
|
6655
|
+
type: object
|
|
6619
6656
|
- properties:
|
|
6620
6657
|
data:
|
|
6621
6658
|
anyOf:
|
|
@@ -11387,6 +11424,45 @@ components:
|
|
|
11387
11424
|
- registry_reseller_id
|
|
11388
11425
|
title: DomainAttributeKey
|
|
11389
11426
|
type: string
|
|
11427
|
+
DomainAuthCodeResponse:
|
|
11428
|
+
properties:
|
|
11429
|
+
auth_code:
|
|
11430
|
+
anyOf:
|
|
11431
|
+
- type: string
|
|
11432
|
+
- type: 'null'
|
|
11433
|
+
description: The auth code, when `delivery` is `response`. Hidden when the
|
|
11434
|
+
caller cannot view the domain's auth codes
|
|
11435
|
+
title: Auth Code
|
|
11436
|
+
auth_code_expires_on:
|
|
11437
|
+
anyOf:
|
|
11438
|
+
- format: date-time
|
|
11439
|
+
type: string
|
|
11440
|
+
- type: 'null'
|
|
11441
|
+
description: When the auth code expires, if the registry limits its validity
|
|
11442
|
+
title: Auth Code Expires On
|
|
11443
|
+
delivery:
|
|
11444
|
+
$ref: '#/components/schemas/AuthCodeDelivery'
|
|
11445
|
+
description: 'Where the auth code ends up: `response` returns it in `auth_code`,
|
|
11446
|
+
`registrant_email` means the registry emails it to the registrant and
|
|
11447
|
+
it never reaches us'
|
|
11448
|
+
name:
|
|
11449
|
+
description: The domain name the auth code belongs to
|
|
11450
|
+
title: Name
|
|
11451
|
+
type: string
|
|
11452
|
+
recipients:
|
|
11453
|
+
anyOf:
|
|
11454
|
+
- items:
|
|
11455
|
+
type: string
|
|
11456
|
+
type: array
|
|
11457
|
+
- type: 'null'
|
|
11458
|
+
description: The addresses the registry sent the auth code to, when it reports
|
|
11459
|
+
them
|
|
11460
|
+
title: Recipients
|
|
11461
|
+
required:
|
|
11462
|
+
- name
|
|
11463
|
+
- delivery
|
|
11464
|
+
title: DomainAuthCodeResponse
|
|
11465
|
+
type: object
|
|
11390
11466
|
DomainAvailability:
|
|
11391
11467
|
properties:
|
|
11392
11468
|
domain:
|
|
@@ -24882,7 +24958,7 @@ info:
|
|
|
24882
24958
|
\n\n"
|
|
24883
24959
|
summary: OpusDNS - your gateway to a seamless domain management experience.
|
|
24884
24960
|
title: OpusDNS API
|
|
24885
|
-
version: 2026-10-
|
|
24961
|
+
version: 2026-10-09-182429
|
|
24886
24962
|
x-logo:
|
|
24887
24963
|
altText: OpusDNS API Reference
|
|
24888
24964
|
url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
|
|
@@ -34101,6 +34177,9 @@ paths:
|
|
|
34101
34177
|
- domains:manage
|
|
34102
34178
|
/v1/domains/tld-specific/be/{domain_reference}/auth_code/request:
|
|
34103
34179
|
post:
|
|
34180
|
+
deprecated: true
|
|
34181
|
+
description: 'Deprecated: use `POST /v1/domains/{domain_reference}/auth-code`,
|
|
34182
|
+
which handles every TLD.'
|
|
34104
34183
|
operationId: request_auth_code_v1_domains_tld_specific_be__domain_reference__auth_code_request_post
|
|
34105
34184
|
parameters:
|
|
34106
34185
|
- in: path
|
|
@@ -34168,11 +34247,13 @@ paths:
|
|
|
34168
34247
|
- domains:manage
|
|
34169
34248
|
/v1/domains/tld-specific/cymru/{domain_reference}/auth_code/request:
|
|
34170
34249
|
post:
|
|
34171
|
-
|
|
34172
|
-
|
|
34173
|
-
|
|
34174
|
-
|
|
34175
|
-
code
|
|
34250
|
+
deprecated: true
|
|
34251
|
+
description: 'Deprecated: use `POST /v1/domains/{domain_reference}/auth-code`,
|
|
34252
|
+
which handles every TLD. Nominet expires a Transfer Authorisation Code after
|
|
34253
|
+
14 days or on use in a transfer, and enforces complexity requirements on it.
|
|
34254
|
+
This endpoint mints a compliant code, sets it through a `domain:update` and
|
|
34255
|
+
returns it, invalidating any previous one. It is the only way to change a
|
|
34256
|
+
`.cymru` auth code.'
|
|
34176
34257
|
operationId: request_auth_code_v1_domains_tld_specific_cymru__domain_reference__auth_code_request_post
|
|
34177
34258
|
parameters:
|
|
34178
34259
|
- in: path
|
|
@@ -34240,6 +34321,9 @@ paths:
|
|
|
34240
34321
|
- domains:manage
|
|
34241
34322
|
/v1/domains/tld-specific/cz/{domain_reference}/auth_code/request:
|
|
34242
34323
|
post:
|
|
34324
|
+
deprecated: true
|
|
34325
|
+
description: 'Deprecated: use `POST /v1/domains/{domain_reference}/auth-code`,
|
|
34326
|
+
which handles every TLD.'
|
|
34243
34327
|
operationId: request_auth_code_v1_domains_tld_specific_cz__domain_reference__auth_code_request_post
|
|
34244
34328
|
parameters:
|
|
34245
34329
|
- in: path
|
|
@@ -34366,6 +34450,9 @@ paths:
|
|
|
34366
34450
|
- domains:manage
|
|
34367
34451
|
/v1/domains/tld-specific/dk/{domain_reference}/auth_code/request:
|
|
34368
34452
|
post:
|
|
34453
|
+
deprecated: true
|
|
34454
|
+
description: 'Deprecated: use `POST /v1/domains/{domain_reference}/auth-code`,
|
|
34455
|
+
which handles every TLD.'
|
|
34369
34456
|
operationId: request_auth_code_v1_domains_tld_specific_dk__domain_reference__auth_code_request_post
|
|
34370
34457
|
parameters:
|
|
34371
34458
|
- in: path
|
|
@@ -34433,6 +34520,9 @@ paths:
|
|
|
34433
34520
|
- domains:manage
|
|
34434
34521
|
/v1/domains/tld-specific/eu/{domain_reference}/auth_code/request:
|
|
34435
34522
|
post:
|
|
34523
|
+
deprecated: true
|
|
34524
|
+
description: 'Deprecated: use `POST /v1/domains/{domain_reference}/auth-code`,
|
|
34525
|
+
which handles every TLD.'
|
|
34436
34526
|
operationId: request_auth_code_v1_domains_tld_specific_eu__domain_reference__auth_code_request_post
|
|
34437
34527
|
parameters:
|
|
34438
34528
|
- in: path
|
|
@@ -34500,6 +34590,9 @@ paths:
|
|
|
34500
34590
|
- domains:manage
|
|
34501
34591
|
/v1/domains/tld-specific/lt/{domain_reference}/auth_code/request:
|
|
34502
34592
|
post:
|
|
34593
|
+
deprecated: true
|
|
34594
|
+
description: 'Deprecated: use `POST /v1/domains/{domain_reference}/auth-code`,
|
|
34595
|
+
which handles every TLD.'
|
|
34503
34596
|
operationId: request_auth_code_v1_domains_tld_specific_lt__domain_reference__auth_code_request_post
|
|
34504
34597
|
parameters:
|
|
34505
34598
|
- in: path
|
|
@@ -34828,10 +34921,12 @@ paths:
|
|
|
34828
34921
|
- domains:manage
|
|
34829
34922
|
/v1/domains/tld-specific/nu/{domain_reference}/auth_code/request:
|
|
34830
34923
|
post:
|
|
34831
|
-
|
|
34832
|
-
|
|
34833
|
-
|
|
34834
|
-
the
|
|
34924
|
+
deprecated: true
|
|
34925
|
+
description: 'Deprecated: use `POST /v1/domains/{domain_reference}/auth-code`,
|
|
34926
|
+
which handles every TLD. `.nu` auth codes are owned by the registry: registrars
|
|
34927
|
+
can only send the literal `auto`, and the generated code is returned in the
|
|
34928
|
+
`iis:updData` extension of a `domain:update`. This endpoint runs that update
|
|
34929
|
+
and stores the fresh code, invalidating any previous one.'
|
|
34835
34930
|
operationId: request_auth_code_v1_domains_tld_specific_nu__domain_reference__auth_code_request_post
|
|
34836
34931
|
parameters:
|
|
34837
34932
|
- in: path
|
|
@@ -34899,10 +34994,12 @@ paths:
|
|
|
34899
34994
|
- domains:manage
|
|
34900
34995
|
/v1/domains/tld-specific/se/{domain_reference}/auth_code/request:
|
|
34901
34996
|
post:
|
|
34902
|
-
|
|
34903
|
-
|
|
34904
|
-
|
|
34905
|
-
the
|
|
34997
|
+
deprecated: true
|
|
34998
|
+
description: 'Deprecated: use `POST /v1/domains/{domain_reference}/auth-code`,
|
|
34999
|
+
which handles every TLD. `.se` auth codes are owned by the registry: registrars
|
|
35000
|
+
can only send the literal `auto`, and the generated code is returned in the
|
|
35001
|
+
`iis:updData` extension of a `domain:update`. This endpoint runs that update
|
|
35002
|
+
and stores the fresh code, invalidating any previous one.'
|
|
34906
35003
|
operationId: request_auth_code_v1_domains_tld_specific_se__domain_reference__auth_code_request_post
|
|
34907
35004
|
parameters:
|
|
34908
35005
|
- in: path
|
|
@@ -34970,11 +35067,13 @@ paths:
|
|
|
34970
35067
|
- domains:manage
|
|
34971
35068
|
/v1/domains/tld-specific/wales/{domain_reference}/auth_code/request:
|
|
34972
35069
|
post:
|
|
34973
|
-
|
|
34974
|
-
|
|
34975
|
-
|
|
34976
|
-
|
|
34977
|
-
code
|
|
35070
|
+
deprecated: true
|
|
35071
|
+
description: 'Deprecated: use `POST /v1/domains/{domain_reference}/auth-code`,
|
|
35072
|
+
which handles every TLD. Nominet expires a Transfer Authorisation Code after
|
|
35073
|
+
14 days or on use in a transfer, and enforces complexity requirements on it.
|
|
35074
|
+
This endpoint mints a compliant code, sets it through a `domain:update` and
|
|
35075
|
+
returns it, invalidating any previous one. It is the only way to change a
|
|
35076
|
+
`.wales` auth code.'
|
|
34978
35077
|
operationId: request_auth_code_v1_domains_tld_specific_wales__domain_reference__auth_code_request_post
|
|
34979
35078
|
parameters:
|
|
34980
35079
|
- in: path
|
|
@@ -35407,6 +35506,102 @@ paths:
|
|
|
35407
35506
|
- domain
|
|
35408
35507
|
x-required-permissions:
|
|
35409
35508
|
- domains:manage
|
|
35509
|
+
/v1/domains/{domain_reference}/auth-code:
|
|
35510
|
+
post:
|
|
35511
|
+
description: Gets the domain a fresh auth code, whatever the registry's model.
|
|
35512
|
+
Where the registrar sets the code, one is generated, set at the registry and
|
|
35513
|
+
returned, invalidating the previous one. Where the registry generates it,
|
|
35514
|
+
it is requested there and returned, or, for registries that only send it to
|
|
35515
|
+
the registrant (`.be`, `.cz`), `delivery` is `registrant_email` and no code
|
|
35516
|
+
is returned. TLDs without auth codes answer 422. `auth_code` is hidden when
|
|
35517
|
+
the caller cannot view the domain's auth codes.
|
|
35518
|
+
operationId: request_domain_auth_code_v1_domains__domain_reference__auth_code_post
|
|
35519
|
+
parameters:
|
|
35520
|
+
- in: path
|
|
35521
|
+
name: domain_reference
|
|
35522
|
+
required: true
|
|
35523
|
+
schema:
|
|
35524
|
+
anyOf:
|
|
35525
|
+
- examples:
|
|
35526
|
+
- domain_01h45ytscbebyvny4gc8cr8ma2
|
|
35527
|
+
format: typeid
|
|
35528
|
+
pattern: ^domain_[0-7][0-9a-hjkmnpq-tv-z]{25}$
|
|
35529
|
+
type: string
|
|
35530
|
+
x-typeid-prefix: domain
|
|
35531
|
+
- type: string
|
|
35532
|
+
title: Domain Reference
|
|
35533
|
+
- $ref: '#/components/parameters/DatetimeFormatHeader'
|
|
35534
|
+
responses:
|
|
35535
|
+
'200':
|
|
35536
|
+
content:
|
|
35537
|
+
application/json:
|
|
35538
|
+
schema:
|
|
35539
|
+
$ref: '#/components/schemas/DomainAuthCodeResponse'
|
|
35540
|
+
description: Successful Response
|
|
35541
|
+
'400':
|
|
35542
|
+
content:
|
|
35543
|
+
application/problem+json:
|
|
35544
|
+
example:
|
|
35545
|
+
code: ERROR_DOMAIN_TRANSFER
|
|
35546
|
+
detail: There was an error transferring the domain
|
|
35547
|
+
domain_name: Additional error context.
|
|
35548
|
+
reason: An unspecified error occurred
|
|
35549
|
+
status: 400
|
|
35550
|
+
title: Domain Transfer Error
|
|
35551
|
+
type: domain-transfer
|
|
35552
|
+
schema:
|
|
35553
|
+
$ref: '#/components/schemas/Problem'
|
|
35554
|
+
description: Bad Request
|
|
35555
|
+
'404':
|
|
35556
|
+
content:
|
|
35557
|
+
application/problem+json:
|
|
35558
|
+
example:
|
|
35559
|
+
code: ERROR_DOMAIN_NOT_FOUND
|
|
35560
|
+
detail: Domain not found
|
|
35561
|
+
domain_name: Additional error context.
|
|
35562
|
+
status: 404
|
|
35563
|
+
title: Domain Management Error
|
|
35564
|
+
type: domain-not-found
|
|
35565
|
+
schema:
|
|
35566
|
+
$ref: '#/components/schemas/Problem'
|
|
35567
|
+
description: Not Found
|
|
35568
|
+
'422':
|
|
35569
|
+
content:
|
|
35570
|
+
application/problem+json:
|
|
35571
|
+
example:
|
|
35572
|
+
code: ERROR_DOMAIN_AUTH_CODE_NOT_SUPPORTED
|
|
35573
|
+
detail: Auth codes are not used
|
|
35574
|
+
domain_name: example.lu
|
|
35575
|
+
status: 422
|
|
35576
|
+
title: Domain Management Error
|
|
35577
|
+
tld: lu
|
|
35578
|
+
type: domain-auth-code-not-supported
|
|
35579
|
+
schema:
|
|
35580
|
+
$ref: '#/components/schemas/Problem'
|
|
35581
|
+
description: Unprocessable Content
|
|
35582
|
+
'502':
|
|
35583
|
+
content:
|
|
35584
|
+
application/problem+json:
|
|
35585
|
+
example:
|
|
35586
|
+
code: ERROR_AUTH_CODE
|
|
35587
|
+
detail: The registry did not return an auth code
|
|
35588
|
+
domain_name: example.eu
|
|
35589
|
+
reason: No auth code returned
|
|
35590
|
+
status: 502
|
|
35591
|
+
title: Domain Management Error
|
|
35592
|
+
type: domain-auth-code-unavailable
|
|
35593
|
+
schema:
|
|
35594
|
+
$ref: '#/components/schemas/Problem'
|
|
35595
|
+
description: Bad Gateway
|
|
35596
|
+
security:
|
|
35597
|
+
- OAuth2PasswordBearer: []
|
|
35598
|
+
- APIKeyHeader: []
|
|
35599
|
+
summary: Request a fresh auth code
|
|
35600
|
+
tags:
|
|
35601
|
+
- domain
|
|
35602
|
+
- domain
|
|
35603
|
+
x-required-permissions:
|
|
35604
|
+
- domains:manage
|
|
35410
35605
|
/v1/domains/{domain_reference}/dnssec:
|
|
35411
35606
|
delete:
|
|
35412
35607
|
description: Removes all DNSSEC data for a domain
|
package/src/schema.d.ts
CHANGED
|
@@ -1249,7 +1249,11 @@ export interface paths {
|
|
|
1249
1249
|
};
|
|
1250
1250
|
get?: never;
|
|
1251
1251
|
put?: never;
|
|
1252
|
-
/**
|
|
1252
|
+
/**
|
|
1253
|
+
* Requests your auth code directly from DNS Belgium (registry)
|
|
1254
|
+
* @deprecated
|
|
1255
|
+
* @description Deprecated: use `POST /v1/domains/{domain_reference}/auth-code`, which handles every TLD.
|
|
1256
|
+
*/
|
|
1253
1257
|
post: operations["request_auth_code_v1_domains_tld_specific_be__domain_reference__auth_code_request_post"];
|
|
1254
1258
|
delete?: never;
|
|
1255
1259
|
options?: never;
|
|
@@ -1268,7 +1272,8 @@ export interface paths {
|
|
|
1268
1272
|
put?: never;
|
|
1269
1273
|
/**
|
|
1270
1274
|
* Generates a fresh auth code at Nominet (.cymru)
|
|
1271
|
-
* @
|
|
1275
|
+
* @deprecated
|
|
1276
|
+
* @description Deprecated: use `POST /v1/domains/{domain_reference}/auth-code`, which handles every TLD. Nominet expires a Transfer Authorisation Code after 14 days or on use in a transfer, and enforces complexity requirements on it. This endpoint mints a compliant code, sets it through a `domain:update` and returns it, invalidating any previous one. It is the only way to change a `.cymru` auth code.
|
|
1272
1277
|
*/
|
|
1273
1278
|
post: operations["request_auth_code_v1_domains_tld_specific_cymru__domain_reference__auth_code_request_post"];
|
|
1274
1279
|
delete?: never;
|
|
@@ -1286,7 +1291,11 @@ export interface paths {
|
|
|
1286
1291
|
};
|
|
1287
1292
|
get?: never;
|
|
1288
1293
|
put?: never;
|
|
1289
|
-
/**
|
|
1294
|
+
/**
|
|
1295
|
+
* Requests your auth code directly from CZ.NIC (registry)
|
|
1296
|
+
* @deprecated
|
|
1297
|
+
* @description Deprecated: use `POST /v1/domains/{domain_reference}/auth-code`, which handles every TLD.
|
|
1298
|
+
*/
|
|
1290
1299
|
post: operations["request_auth_code_v1_domains_tld_specific_cz__domain_reference__auth_code_request_post"];
|
|
1291
1300
|
delete?: never;
|
|
1292
1301
|
options?: never;
|
|
@@ -1320,7 +1329,11 @@ export interface paths {
|
|
|
1320
1329
|
};
|
|
1321
1330
|
get?: never;
|
|
1322
1331
|
put?: never;
|
|
1323
|
-
/**
|
|
1332
|
+
/**
|
|
1333
|
+
* Requests your auth code directly from Punktum dk (registry)
|
|
1334
|
+
* @deprecated
|
|
1335
|
+
* @description Deprecated: use `POST /v1/domains/{domain_reference}/auth-code`, which handles every TLD.
|
|
1336
|
+
*/
|
|
1324
1337
|
post: operations["request_auth_code_v1_domains_tld_specific_dk__domain_reference__auth_code_request_post"];
|
|
1325
1338
|
delete?: never;
|
|
1326
1339
|
options?: never;
|
|
@@ -1337,7 +1350,11 @@ export interface paths {
|
|
|
1337
1350
|
};
|
|
1338
1351
|
get?: never;
|
|
1339
1352
|
put?: never;
|
|
1340
|
-
/**
|
|
1353
|
+
/**
|
|
1354
|
+
* Requests your auth code directly from EURid (registry)
|
|
1355
|
+
* @deprecated
|
|
1356
|
+
* @description Deprecated: use `POST /v1/domains/{domain_reference}/auth-code`, which handles every TLD.
|
|
1357
|
+
*/
|
|
1341
1358
|
post: operations["request_auth_code_v1_domains_tld_specific_eu__domain_reference__auth_code_request_post"];
|
|
1342
1359
|
delete?: never;
|
|
1343
1360
|
options?: never;
|
|
@@ -1354,7 +1371,11 @@ export interface paths {
|
|
|
1354
1371
|
};
|
|
1355
1372
|
get?: never;
|
|
1356
1373
|
put?: never;
|
|
1357
|
-
/**
|
|
1374
|
+
/**
|
|
1375
|
+
* Requests your auth code directly from DOMREG (registry)
|
|
1376
|
+
* @deprecated
|
|
1377
|
+
* @description Deprecated: use `POST /v1/domains/{domain_reference}/auth-code`, which handles every TLD.
|
|
1378
|
+
*/
|
|
1358
1379
|
post: operations["request_auth_code_v1_domains_tld_specific_lt__domain_reference__auth_code_request_post"];
|
|
1359
1380
|
delete?: never;
|
|
1360
1381
|
options?: never;
|
|
@@ -1431,7 +1452,8 @@ export interface paths {
|
|
|
1431
1452
|
put?: never;
|
|
1432
1453
|
/**
|
|
1433
1454
|
* Generates a fresh auth code at Internetstiftelsen (.nu)
|
|
1434
|
-
* @
|
|
1455
|
+
* @deprecated
|
|
1456
|
+
* @description Deprecated: use `POST /v1/domains/{domain_reference}/auth-code`, which handles every TLD. `.nu` auth codes are owned by the registry: registrars can only send the literal `auto`, and the generated code is returned in the `iis:updData` extension of a `domain:update`. This endpoint runs that update and stores the fresh code, invalidating any previous one.
|
|
1435
1457
|
*/
|
|
1436
1458
|
post: operations["request_auth_code_v1_domains_tld_specific_nu__domain_reference__auth_code_request_post"];
|
|
1437
1459
|
delete?: never;
|
|
@@ -1451,7 +1473,8 @@ export interface paths {
|
|
|
1451
1473
|
put?: never;
|
|
1452
1474
|
/**
|
|
1453
1475
|
* Generates a fresh auth code at Internetstiftelsen (.se)
|
|
1454
|
-
* @
|
|
1476
|
+
* @deprecated
|
|
1477
|
+
* @description Deprecated: use `POST /v1/domains/{domain_reference}/auth-code`, which handles every TLD. `.se` auth codes are owned by the registry: registrars can only send the literal `auto`, and the generated code is returned in the `iis:updData` extension of a `domain:update`. This endpoint runs that update and stores the fresh code, invalidating any previous one.
|
|
1455
1478
|
*/
|
|
1456
1479
|
post: operations["request_auth_code_v1_domains_tld_specific_se__domain_reference__auth_code_request_post"];
|
|
1457
1480
|
delete?: never;
|
|
@@ -1471,7 +1494,8 @@ export interface paths {
|
|
|
1471
1494
|
put?: never;
|
|
1472
1495
|
/**
|
|
1473
1496
|
* Generates a fresh auth code at Nominet (.wales)
|
|
1474
|
-
* @
|
|
1497
|
+
* @deprecated
|
|
1498
|
+
* @description Deprecated: use `POST /v1/domains/{domain_reference}/auth-code`, which handles every TLD. Nominet expires a Transfer Authorisation Code after 14 days or on use in a transfer, and enforces complexity requirements on it. This endpoint mints a compliant code, sets it through a `domain:update` and returns it, invalidating any previous one. It is the only way to change a `.wales` auth code.
|
|
1475
1499
|
*/
|
|
1476
1500
|
post: operations["request_auth_code_v1_domains_tld_specific_wales__domain_reference__auth_code_request_post"];
|
|
1477
1501
|
delete?: never;
|
|
@@ -1537,6 +1561,26 @@ export interface paths {
|
|
|
1537
1561
|
patch: operations["update_domain_v1_domains__domain_reference__patch"];
|
|
1538
1562
|
trace?: never;
|
|
1539
1563
|
};
|
|
1564
|
+
"/v1/domains/{domain_reference}/auth-code": {
|
|
1565
|
+
parameters: {
|
|
1566
|
+
query?: never;
|
|
1567
|
+
header?: never;
|
|
1568
|
+
path?: never;
|
|
1569
|
+
cookie?: never;
|
|
1570
|
+
};
|
|
1571
|
+
get?: never;
|
|
1572
|
+
put?: never;
|
|
1573
|
+
/**
|
|
1574
|
+
* Request a fresh auth code
|
|
1575
|
+
* @description Gets the domain a fresh auth code, whatever the registry's model. Where the registrar sets the code, one is generated, set at the registry and returned, invalidating the previous one. Where the registry generates it, it is requested there and returned, or, for registries that only send it to the registrant (`.be`, `.cz`), `delivery` is `registrant_email` and no code is returned. TLDs without auth codes answer 422. `auth_code` is hidden when the caller cannot view the domain's auth codes.
|
|
1576
|
+
*/
|
|
1577
|
+
post: operations["request_domain_auth_code_v1_domains__domain_reference__auth_code_post"];
|
|
1578
|
+
delete?: never;
|
|
1579
|
+
options?: never;
|
|
1580
|
+
head?: never;
|
|
1581
|
+
patch?: never;
|
|
1582
|
+
trace?: never;
|
|
1583
|
+
};
|
|
1540
1584
|
"/v1/domains/{domain_reference}/dnssec": {
|
|
1541
1585
|
parameters: {
|
|
1542
1586
|
query?: never;
|
|
@@ -3459,6 +3503,11 @@ export interface components {
|
|
|
3459
3503
|
/** Client Id */
|
|
3460
3504
|
client_id?: string | null;
|
|
3461
3505
|
};
|
|
3506
|
+
/**
|
|
3507
|
+
* AuthCodeDelivery
|
|
3508
|
+
* @enum {string}
|
|
3509
|
+
*/
|
|
3510
|
+
AuthCodeDelivery: "response" | "registrant_email";
|
|
3462
3511
|
/**
|
|
3463
3512
|
* BatchSortField
|
|
3464
3513
|
* @enum {string}
|
|
@@ -8154,6 +8203,30 @@ export interface components {
|
|
|
8154
8203
|
* @default false
|
|
8155
8204
|
*/
|
|
8156
8205
|
truncated: boolean;
|
|
8206
|
+
} | {
|
|
8207
|
+
data?: components["schemas"]["DomainAuthCodeResponse"] | string;
|
|
8208
|
+
/**
|
|
8209
|
+
* Headers
|
|
8210
|
+
* @description Selected response headers
|
|
8211
|
+
*/
|
|
8212
|
+
headers?: {
|
|
8213
|
+
[key: string]: string;
|
|
8214
|
+
};
|
|
8215
|
+
/**
|
|
8216
|
+
* Httpstatus
|
|
8217
|
+
* @description HTTP status returned by the underlying API
|
|
8218
|
+
*/
|
|
8219
|
+
httpStatus?: number | null;
|
|
8220
|
+
/** @constant */
|
|
8221
|
+
operationId: "request_domain_auth_code_v1_domains__domain_reference__auth_code_post";
|
|
8222
|
+
/** @constant */
|
|
8223
|
+
status: "ok";
|
|
8224
|
+
/**
|
|
8225
|
+
* Truncated
|
|
8226
|
+
* @description True when the gateway capped an oversized payload
|
|
8227
|
+
* @default false
|
|
8228
|
+
*/
|
|
8229
|
+
truncated: boolean;
|
|
8157
8230
|
} | {
|
|
8158
8231
|
data?: string;
|
|
8159
8232
|
/**
|
|
@@ -11397,6 +11470,31 @@ export interface components {
|
|
|
11397
11470
|
* @enum {string}
|
|
11398
11471
|
*/
|
|
11399
11472
|
DomainAttributeKey: "auto_renew_period" | "music_registrant_attestation" | "nic_it_compliance_confirmation" | "travel_industry_acknowledgement" | "verification_required" | "de_general_request_contact" | "de_abuse_contact" | "nor_id_applicant_version" | "nor_id_applicant_accept_name" | "nor_id_applicant_accept_date" | "nor_id_declaration" | "nor_id_declaration_token" | "punktum_dk_terms_acceptance" | "punktum_dk_tracking_no" | "internet_ee_registrant_agreement" | "promotion" | "promotion_eligibility" | "domain_contact_attributes" | "registry_reseller_id";
|
|
11473
|
+
/** DomainAuthCodeResponse */
|
|
11474
|
+
DomainAuthCodeResponse: {
|
|
11475
|
+
/**
|
|
11476
|
+
* Auth Code
|
|
11477
|
+
* @description The auth code, when `delivery` is `response`. Hidden when the caller cannot view the domain's auth codes
|
|
11478
|
+
*/
|
|
11479
|
+
auth_code?: string | null;
|
|
11480
|
+
/**
|
|
11481
|
+
* Auth Code Expires On
|
|
11482
|
+
* @description When the auth code expires, if the registry limits its validity
|
|
11483
|
+
*/
|
|
11484
|
+
auth_code_expires_on?: Date | null;
|
|
11485
|
+
/** @description Where the auth code ends up: `response` returns it in `auth_code`, `registrant_email` means the registry emails it to the registrant and it never reaches us */
|
|
11486
|
+
delivery: components["schemas"]["AuthCodeDelivery"];
|
|
11487
|
+
/**
|
|
11488
|
+
* Name
|
|
11489
|
+
* @description The domain name the auth code belongs to
|
|
11490
|
+
*/
|
|
11491
|
+
name: string;
|
|
11492
|
+
/**
|
|
11493
|
+
* Recipients
|
|
11494
|
+
* @description The addresses the registry sent the auth code to, when it reports them
|
|
11495
|
+
*/
|
|
11496
|
+
recipients?: string[] | null;
|
|
11497
|
+
};
|
|
11400
11498
|
/** DomainAvailability */
|
|
11401
11499
|
DomainAvailability: {
|
|
11402
11500
|
/** Domain */
|
|
@@ -28373,6 +28471,105 @@ export interface operations {
|
|
|
28373
28471
|
};
|
|
28374
28472
|
};
|
|
28375
28473
|
};
|
|
28474
|
+
request_domain_auth_code_v1_domains__domain_reference__auth_code_post: {
|
|
28475
|
+
parameters: {
|
|
28476
|
+
query?: never;
|
|
28477
|
+
header?: {
|
|
28478
|
+
/**
|
|
28479
|
+
* @description Accepted for backwards compatibility; has no effect. Response datetimes are always normalized to UTC and serialized as RFC 3339 with a `Z` suffix, whether or not this header is sent.
|
|
28480
|
+
* @example rfc3339
|
|
28481
|
+
*/
|
|
28482
|
+
"X-Datetime-Format"?: components["parameters"]["DatetimeFormatHeader"];
|
|
28483
|
+
};
|
|
28484
|
+
path: {
|
|
28485
|
+
domain_reference: TypeId<"domain"> | string;
|
|
28486
|
+
};
|
|
28487
|
+
cookie?: never;
|
|
28488
|
+
};
|
|
28489
|
+
requestBody?: never;
|
|
28490
|
+
responses: {
|
|
28491
|
+
/** @description Successful Response */
|
|
28492
|
+
200: {
|
|
28493
|
+
headers: {
|
|
28494
|
+
[name: string]: unknown;
|
|
28495
|
+
};
|
|
28496
|
+
content: {
|
|
28497
|
+
"application/json": components["schemas"]["DomainAuthCodeResponse"];
|
|
28498
|
+
};
|
|
28499
|
+
};
|
|
28500
|
+
/** @description Bad Request */
|
|
28501
|
+
400: {
|
|
28502
|
+
headers: {
|
|
28503
|
+
[name: string]: unknown;
|
|
28504
|
+
};
|
|
28505
|
+
content: {
|
|
28506
|
+
/** @example {
|
|
28507
|
+
* "code": "ERROR_DOMAIN_TRANSFER",
|
|
28508
|
+
* "detail": "There was an error transferring the domain",
|
|
28509
|
+
* "domain_name": "Additional error context.",
|
|
28510
|
+
* "reason": "An unspecified error occurred",
|
|
28511
|
+
* "status": 400,
|
|
28512
|
+
* "title": "Domain Transfer Error",
|
|
28513
|
+
* "type": "domain-transfer"
|
|
28514
|
+
* } */
|
|
28515
|
+
"application/problem+json": components["schemas"]["Problem"];
|
|
28516
|
+
};
|
|
28517
|
+
};
|
|
28518
|
+
/** @description Not Found */
|
|
28519
|
+
404: {
|
|
28520
|
+
headers: {
|
|
28521
|
+
[name: string]: unknown;
|
|
28522
|
+
};
|
|
28523
|
+
content: {
|
|
28524
|
+
/** @example {
|
|
28525
|
+
* "code": "ERROR_DOMAIN_NOT_FOUND",
|
|
28526
|
+
* "detail": "Domain not found",
|
|
28527
|
+
* "domain_name": "Additional error context.",
|
|
28528
|
+
* "status": 404,
|
|
28529
|
+
* "title": "Domain Management Error",
|
|
28530
|
+
* "type": "domain-not-found"
|
|
28531
|
+
* } */
|
|
28532
|
+
"application/problem+json": components["schemas"]["Problem"];
|
|
28533
|
+
};
|
|
28534
|
+
};
|
|
28535
|
+
/** @description Unprocessable Content */
|
|
28536
|
+
422: {
|
|
28537
|
+
headers: {
|
|
28538
|
+
[name: string]: unknown;
|
|
28539
|
+
};
|
|
28540
|
+
content: {
|
|
28541
|
+
/** @example {
|
|
28542
|
+
* "code": "ERROR_DOMAIN_AUTH_CODE_NOT_SUPPORTED",
|
|
28543
|
+
* "detail": "Auth codes are not used",
|
|
28544
|
+
* "domain_name": "example.lu",
|
|
28545
|
+
* "status": 422,
|
|
28546
|
+
* "title": "Domain Management Error",
|
|
28547
|
+
* "tld": "lu",
|
|
28548
|
+
* "type": "domain-auth-code-not-supported"
|
|
28549
|
+
* } */
|
|
28550
|
+
"application/problem+json": components["schemas"]["Problem"];
|
|
28551
|
+
};
|
|
28552
|
+
};
|
|
28553
|
+
/** @description Bad Gateway */
|
|
28554
|
+
502: {
|
|
28555
|
+
headers: {
|
|
28556
|
+
[name: string]: unknown;
|
|
28557
|
+
};
|
|
28558
|
+
content: {
|
|
28559
|
+
/** @example {
|
|
28560
|
+
* "code": "ERROR_AUTH_CODE",
|
|
28561
|
+
* "detail": "The registry did not return an auth code",
|
|
28562
|
+
* "domain_name": "example.eu",
|
|
28563
|
+
* "reason": "No auth code returned",
|
|
28564
|
+
* "status": 502,
|
|
28565
|
+
* "title": "Domain Management Error",
|
|
28566
|
+
* "type": "domain-auth-code-unavailable"
|
|
28567
|
+
* } */
|
|
28568
|
+
"application/problem+json": components["schemas"]["Problem"];
|
|
28569
|
+
};
|
|
28570
|
+
};
|
|
28571
|
+
};
|
|
28572
|
+
};
|
|
28376
28573
|
get_dnssec_v1_domains__domain_reference__dnssec_get: {
|
|
28377
28574
|
parameters: {
|
|
28378
28575
|
query?: never;
|