@opusdns/api 1.151.0 → 1.153.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 +2 -0
- package/src/openapi.yaml +248 -672
- package/src/schema.d.ts +221 -211
package/src/openapi.yaml
CHANGED
|
@@ -3981,71 +3981,28 @@ components:
|
|
|
3981
3981
|
$ref: '#/components/schemas/DomainAttributeKey'
|
|
3982
3982
|
type: object
|
|
3983
3983
|
- type: 'null'
|
|
3984
|
-
description:
|
|
3985
|
-
|
|
3986
|
-
|
|
3987
|
-
|
|
3988
|
-
|
|
3989
|
-
|
|
3990
|
-
|
|
3991
|
-
|
|
3992
|
-
|
|
3993
|
-
|
|
3994
|
-
|
|
3995
|
-
|
|
3996
|
-
|
|
3997
|
-
|
|
3998
|
-
|
|
3999
|
-
|
|
4000
|
-
|
|
4001
|
-
|
|
4002
|
-
|
|
4003
|
-
|
|
4004
|
-
|
|
4005
|
-
|
|
4006
|
-
|
|
4007
|
-
| `travel_industry_acknowledgement` | `true` (also `1`, `yes`) | .travel
|
|
4008
|
-
(registration) | input |
|
|
4009
|
-
|
|
4010
|
-
| `internet_ee_registrant_agreement` | `true` (also `1`, `yes`) | .ee
|
|
4011
|
-
(registration) | input |
|
|
4012
|
-
|
|
4013
|
-
| `punktum_dk_terms_acceptance` | `true` (also `1`, `yes`) | .dk (registration,
|
|
4014
|
-
registrant change) | input |
|
|
4015
|
-
|
|
4016
|
-
| `de_general_request_contact` | id of a contact whose `.de` attribute
|
|
4017
|
-
set has `DE_CONTACT_TYPE` = `REQUEST` | .de | input |
|
|
4018
|
-
|
|
4019
|
-
| `de_abuse_contact` | id of a contact whose `.de` attribute set has `DE_CONTACT_TYPE`
|
|
4020
|
-
= `REQUEST` | .de | input |
|
|
4021
|
-
|
|
4022
|
-
| `nor_id_applicant_version`, `nor_id_applicant_accept_name`, `nor_id_applicant_accept_date`
|
|
4023
|
-
| taken from the signed applicant declaration | .no | ignored |
|
|
4024
|
-
|
|
4025
|
-
| `nor_id_declaration`, `nor_id_declaration_token` | | .no | output |
|
|
4026
|
-
|
|
4027
|
-
| `punktum_dk_tracking_no` | registry-issued | .dk | output |
|
|
4028
|
-
|
|
4029
|
-
| `verification_required` | | all | output |
|
|
4030
|
-
|
|
4031
|
-
| `promotion`, `promotion_eligibility` | | all | output |
|
|
4032
|
-
|
|
4033
|
-
|
|
4034
|
-
`auto_renew_period`: on transfer-in without `period` it also sets the
|
|
4035
|
-
period added by the transfer; on create and update it
|
|
4036
|
-
|
|
4037
|
-
selects the period of the next renewal only and the current expiry date
|
|
4038
|
-
does not move. `monthly` is rejected on transfer-in
|
|
4039
|
-
|
|
4040
|
-
and ignored at renewal when the TLD''s renewal periods have no month unit.
|
|
4041
|
-
|
|
4042
|
-
On update, only `.de` stores attributes and an empty value removes the
|
|
4043
|
-
stored attribute; `.dk` reads
|
|
4044
|
-
|
|
4045
|
-
`punktum_dk_terms_acceptance` to confirm a registrant change and other
|
|
4046
|
-
registries ignore attributes.
|
|
4047
|
-
|
|
4048
|
-
'
|
|
3984
|
+
description: "Additional attributes of the domain, keyed by attribute name.\
|
|
3985
|
+
\ Values are strings.\n\nCustomer-settable keys:\n\n- `auto_renew_period`:\
|
|
3986
|
+
\ `monthly` or `yearly`. All TLDs on create and transfer-in, `.de` only\
|
|
3987
|
+
\ on update. Selects the\n period of the next renewal; the current expiry\
|
|
3988
|
+
\ date does not move. On transfer-in without `period` it also sets the\n\
|
|
3989
|
+
\ period added by the transfer. `monthly` is rejected on transfer-in\
|
|
3990
|
+
\ and ignored at renewal when the TLD has no\n month-unit renewal period.\n\
|
|
3991
|
+
- `music_registrant_attestation`: `true`. `.music` registration.\n- `nic_it_compliance_confirmation`:\
|
|
3992
|
+
\ `true`. `.it` registration and transfer.\n- `travel_industry_acknowledgement`:\
|
|
3993
|
+
\ `true`. `.travel` registration.\n- `internet_ee_registrant_agreement`:\
|
|
3994
|
+
\ `true`. `.ee` registration.\n- `punktum_dk_terms_acceptance`: `true`.\
|
|
3995
|
+
\ `.dk` registration and registrant change.\n- `de_general_request_contact`,\
|
|
3996
|
+
\ `de_abuse_contact`: id of a contact whose `.de` attribute set has `DE_CONTACT_TYPE`\
|
|
3997
|
+
\ =\n `REQUEST`. `.de` only.\n\nBoolean keys also accept `1` and `yes`.\n\
|
|
3998
|
+
\nWritten by the platform and rejected if supplied: `verification_required`,\
|
|
3999
|
+
\ `promotion`, `promotion_eligibility`,\n`nor_id_declaration`, `nor_id_declaration_token`,\
|
|
4000
|
+
\ `punktum_dk_tracking_no`. They are never returned under `attributes`.\n\
|
|
4001
|
+
\nDerived from the signed `.no` applicant declaration and ignored if supplied:\
|
|
4002
|
+
\ `nor_id_applicant_version`,\n`nor_id_applicant_accept_name`, `nor_id_applicant_accept_date`.\n\
|
|
4003
|
+
\nOn update, only `.de` stores attributes and an empty value removes the\
|
|
4004
|
+
\ stored attribute; `.dk` reads\n`punktum_dk_terms_acceptance` to confirm\
|
|
4005
|
+
\ a registrant change and other registries ignore attributes.\n"
|
|
4049
4006
|
examples:
|
|
4050
4007
|
- auto_renew_period: monthly
|
|
4051
4008
|
title: Attributes
|
|
@@ -4142,74 +4099,29 @@ components:
|
|
|
4142
4099
|
$ref: '#/components/schemas/DomainAttributeKey'
|
|
4143
4100
|
type: object
|
|
4144
4101
|
- type: 'null'
|
|
4145
|
-
description:
|
|
4146
|
-
|
|
4147
|
-
|
|
4148
|
-
|
|
4149
|
-
|
|
4150
|
-
|
|
4151
|
-
|
|
4152
|
-
|
|
4153
|
-
|
|
4154
|
-
|
|
4155
|
-
|
|
4156
|
-
|
|
4157
|
-
|
|
4158
|
-
|
|
4159
|
-
|
|
4160
|
-
|
|
4161
|
-
|
|
4162
|
-
|
|
4163
|
-
`.
|
|
4164
|
-
|
|
4165
|
-
|
|
4166
|
-
|
|
4167
|
-
|
|
4168
|
-
| `nic_it_compliance_confirmation` | `true` (also `1`, `yes`) | .it (registration,
|
|
4169
|
-
transfer) | input |
|
|
4170
|
-
|
|
4171
|
-
| `travel_industry_acknowledgement` | `true` (also `1`, `yes`) | .travel
|
|
4172
|
-
(registration) | input |
|
|
4173
|
-
|
|
4174
|
-
| `internet_ee_registrant_agreement` | `true` (also `1`, `yes`) | .ee
|
|
4175
|
-
(registration) | input |
|
|
4176
|
-
|
|
4177
|
-
| `punktum_dk_terms_acceptance` | `true` (also `1`, `yes`) | .dk (registration,
|
|
4178
|
-
registrant change) | input |
|
|
4179
|
-
|
|
4180
|
-
| `de_general_request_contact` | id of a contact whose `.de` attribute
|
|
4181
|
-
set has `DE_CONTACT_TYPE` = `REQUEST` | .de | input |
|
|
4182
|
-
|
|
4183
|
-
| `de_abuse_contact` | id of a contact whose `.de` attribute set has `DE_CONTACT_TYPE`
|
|
4184
|
-
= `REQUEST` | .de | input |
|
|
4185
|
-
|
|
4186
|
-
| `nor_id_applicant_version`, `nor_id_applicant_accept_name`, `nor_id_applicant_accept_date`
|
|
4187
|
-
| taken from the signed applicant declaration | .no | ignored |
|
|
4188
|
-
|
|
4189
|
-
| `nor_id_declaration`, `nor_id_declaration_token` | | .no | output |
|
|
4190
|
-
|
|
4191
|
-
| `punktum_dk_tracking_no` | registry-issued | .dk | output |
|
|
4192
|
-
|
|
4193
|
-
| `verification_required` | | all | output |
|
|
4194
|
-
|
|
4195
|
-
| `promotion`, `promotion_eligibility` | | all | output |
|
|
4196
|
-
|
|
4197
|
-
|
|
4198
|
-
`auto_renew_period`: on transfer-in without `period` it also sets the
|
|
4199
|
-
period added by the transfer; on create and update it
|
|
4200
|
-
|
|
4201
|
-
selects the period of the next renewal only and the current expiry date
|
|
4202
|
-
does not move. `monthly` is rejected on transfer-in
|
|
4203
|
-
|
|
4204
|
-
and ignored at renewal when the TLD''s renewal periods have no month unit.
|
|
4205
|
-
|
|
4206
|
-
On update, only `.de` stores attributes and an empty value removes the
|
|
4207
|
-
stored attribute; `.dk` reads
|
|
4208
|
-
|
|
4209
|
-
`punktum_dk_terms_acceptance` to confirm a registrant change and other
|
|
4210
|
-
registries ignore attributes.
|
|
4211
|
-
|
|
4212
|
-
'
|
|
4102
|
+
description: "Override attributes for this domain.\n\nAdditional attributes\
|
|
4103
|
+
\ of the domain, keyed by attribute name. Values are strings.\n\nCustomer-settable\
|
|
4104
|
+
\ keys:\n\n- `auto_renew_period`: `monthly` or `yearly`. All TLDs on create\
|
|
4105
|
+
\ and transfer-in, `.de` only on update. Selects the\n period of the\
|
|
4106
|
+
\ next renewal; the current expiry date does not move. On transfer-in\
|
|
4107
|
+
\ without `period` it also sets the\n period added by the transfer. `monthly`\
|
|
4108
|
+
\ is rejected on transfer-in and ignored at renewal when the TLD has no\n\
|
|
4109
|
+
\ month-unit renewal period.\n- `music_registrant_attestation`: `true`.\
|
|
4110
|
+
\ `.music` registration.\n- `nic_it_compliance_confirmation`: `true`.\
|
|
4111
|
+
\ `.it` registration and transfer.\n- `travel_industry_acknowledgement`:\
|
|
4112
|
+
\ `true`. `.travel` registration.\n- `internet_ee_registrant_agreement`:\
|
|
4113
|
+
\ `true`. `.ee` registration.\n- `punktum_dk_terms_acceptance`: `true`.\
|
|
4114
|
+
\ `.dk` registration and registrant change.\n- `de_general_request_contact`,\
|
|
4115
|
+
\ `de_abuse_contact`: id of a contact whose `.de` attribute set has `DE_CONTACT_TYPE`\
|
|
4116
|
+
\ =\n `REQUEST`. `.de` only.\n\nBoolean keys also accept `1` and `yes`.\n\
|
|
4117
|
+
\nWritten by the platform and rejected if supplied: `verification_required`,\
|
|
4118
|
+
\ `promotion`, `promotion_eligibility`,\n`nor_id_declaration`, `nor_id_declaration_token`,\
|
|
4119
|
+
\ `punktum_dk_tracking_no`. They are never returned under `attributes`.\n\
|
|
4120
|
+
\nDerived from the signed `.no` applicant declaration and ignored if supplied:\
|
|
4121
|
+
\ `nor_id_applicant_version`,\n`nor_id_applicant_accept_name`, `nor_id_applicant_accept_date`.\n\
|
|
4122
|
+
\nOn update, only `.de` stores attributes and an empty value removes the\
|
|
4123
|
+
\ stored attribute; `.dk` reads\n`punktum_dk_terms_acceptance` to confirm\
|
|
4124
|
+
\ a registrant change and other registries ignore attributes.\n"
|
|
4213
4125
|
title: Attributes
|
|
4214
4126
|
auth_code:
|
|
4215
4127
|
anyOf:
|
|
@@ -4291,71 +4203,28 @@ components:
|
|
|
4291
4203
|
$ref: '#/components/schemas/DomainAttributeKey'
|
|
4292
4204
|
type: object
|
|
4293
4205
|
- type: 'null'
|
|
4294
|
-
description:
|
|
4295
|
-
|
|
4296
|
-
|
|
4297
|
-
|
|
4298
|
-
|
|
4299
|
-
|
|
4300
|
-
|
|
4301
|
-
|
|
4302
|
-
|
|
4303
|
-
|
|
4304
|
-
|
|
4305
|
-
|
|
4306
|
-
|
|
4307
|
-
|
|
4308
|
-
|
|
4309
|
-
|
|
4310
|
-
|
|
4311
|
-
|
|
4312
|
-
|
|
4313
|
-
|
|
4314
|
-
|
|
4315
|
-
|
|
4316
|
-
|
|
4317
|
-
| `travel_industry_acknowledgement` | `true` (also `1`, `yes`) | .travel
|
|
4318
|
-
(registration) | input |
|
|
4319
|
-
|
|
4320
|
-
| `internet_ee_registrant_agreement` | `true` (also `1`, `yes`) | .ee
|
|
4321
|
-
(registration) | input |
|
|
4322
|
-
|
|
4323
|
-
| `punktum_dk_terms_acceptance` | `true` (also `1`, `yes`) | .dk (registration,
|
|
4324
|
-
registrant change) | input |
|
|
4325
|
-
|
|
4326
|
-
| `de_general_request_contact` | id of a contact whose `.de` attribute
|
|
4327
|
-
set has `DE_CONTACT_TYPE` = `REQUEST` | .de | input |
|
|
4328
|
-
|
|
4329
|
-
| `de_abuse_contact` | id of a contact whose `.de` attribute set has `DE_CONTACT_TYPE`
|
|
4330
|
-
= `REQUEST` | .de | input |
|
|
4331
|
-
|
|
4332
|
-
| `nor_id_applicant_version`, `nor_id_applicant_accept_name`, `nor_id_applicant_accept_date`
|
|
4333
|
-
| taken from the signed applicant declaration | .no | ignored |
|
|
4334
|
-
|
|
4335
|
-
| `nor_id_declaration`, `nor_id_declaration_token` | | .no | output |
|
|
4336
|
-
|
|
4337
|
-
| `punktum_dk_tracking_no` | registry-issued | .dk | output |
|
|
4338
|
-
|
|
4339
|
-
| `verification_required` | | all | output |
|
|
4340
|
-
|
|
4341
|
-
| `promotion`, `promotion_eligibility` | | all | output |
|
|
4342
|
-
|
|
4343
|
-
|
|
4344
|
-
`auto_renew_period`: on transfer-in without `period` it also sets the
|
|
4345
|
-
period added by the transfer; on create and update it
|
|
4346
|
-
|
|
4347
|
-
selects the period of the next renewal only and the current expiry date
|
|
4348
|
-
does not move. `monthly` is rejected on transfer-in
|
|
4349
|
-
|
|
4350
|
-
and ignored at renewal when the TLD''s renewal periods have no month unit.
|
|
4351
|
-
|
|
4352
|
-
On update, only `.de` stores attributes and an empty value removes the
|
|
4353
|
-
stored attribute; `.dk` reads
|
|
4354
|
-
|
|
4355
|
-
`punktum_dk_terms_acceptance` to confirm a registrant change and other
|
|
4356
|
-
registries ignore attributes.
|
|
4357
|
-
|
|
4358
|
-
'
|
|
4206
|
+
description: "Additional attributes of the domain, keyed by attribute name.\
|
|
4207
|
+
\ Values are strings.\n\nCustomer-settable keys:\n\n- `auto_renew_period`:\
|
|
4208
|
+
\ `monthly` or `yearly`. All TLDs on create and transfer-in, `.de` only\
|
|
4209
|
+
\ on update. Selects the\n period of the next renewal; the current expiry\
|
|
4210
|
+
\ date does not move. On transfer-in without `period` it also sets the\n\
|
|
4211
|
+
\ period added by the transfer. `monthly` is rejected on transfer-in\
|
|
4212
|
+
\ and ignored at renewal when the TLD has no\n month-unit renewal period.\n\
|
|
4213
|
+
- `music_registrant_attestation`: `true`. `.music` registration.\n- `nic_it_compliance_confirmation`:\
|
|
4214
|
+
\ `true`. `.it` registration and transfer.\n- `travel_industry_acknowledgement`:\
|
|
4215
|
+
\ `true`. `.travel` registration.\n- `internet_ee_registrant_agreement`:\
|
|
4216
|
+
\ `true`. `.ee` registration.\n- `punktum_dk_terms_acceptance`: `true`.\
|
|
4217
|
+
\ `.dk` registration and registrant change.\n- `de_general_request_contact`,\
|
|
4218
|
+
\ `de_abuse_contact`: id of a contact whose `.de` attribute set has `DE_CONTACT_TYPE`\
|
|
4219
|
+
\ =\n `REQUEST`. `.de` only.\n\nBoolean keys also accept `1` and `yes`.\n\
|
|
4220
|
+
\nWritten by the platform and rejected if supplied: `verification_required`,\
|
|
4221
|
+
\ `promotion`, `promotion_eligibility`,\n`nor_id_declaration`, `nor_id_declaration_token`,\
|
|
4222
|
+
\ `punktum_dk_tracking_no`. They are never returned under `attributes`.\n\
|
|
4223
|
+
\nDerived from the signed `.no` applicant declaration and ignored if supplied:\
|
|
4224
|
+
\ `nor_id_applicant_version`,\n`nor_id_applicant_accept_name`, `nor_id_applicant_accept_date`.\n\
|
|
4225
|
+
\nOn update, only `.de` stores attributes and an empty value removes the\
|
|
4226
|
+
\ stored attribute; `.dk` reads\n`punktum_dk_terms_acceptance` to confirm\
|
|
4227
|
+
\ a registrant change and other registries ignore attributes.\n"
|
|
4359
4228
|
title: Attributes
|
|
4360
4229
|
auth_code:
|
|
4361
4230
|
anyOf:
|
|
@@ -4427,71 +4296,28 @@ components:
|
|
|
4427
4296
|
$ref: '#/components/schemas/DomainAttributeKey'
|
|
4428
4297
|
type: object
|
|
4429
4298
|
- type: 'null'
|
|
4430
|
-
description:
|
|
4431
|
-
|
|
4432
|
-
|
|
4433
|
-
|
|
4434
|
-
|
|
4435
|
-
|
|
4436
|
-
|
|
4437
|
-
|
|
4438
|
-
|
|
4439
|
-
|
|
4440
|
-
|
|
4441
|
-
|
|
4442
|
-
|
|
4443
|
-
|
|
4444
|
-
|
|
4445
|
-
|
|
4446
|
-
|
|
4447
|
-
|
|
4448
|
-
|
|
4449
|
-
|
|
4450
|
-
|
|
4451
|
-
|
|
4452
|
-
|
|
4453
|
-
| `travel_industry_acknowledgement` | `true` (also `1`, `yes`) | .travel
|
|
4454
|
-
(registration) | input |
|
|
4455
|
-
|
|
4456
|
-
| `internet_ee_registrant_agreement` | `true` (also `1`, `yes`) | .ee
|
|
4457
|
-
(registration) | input |
|
|
4458
|
-
|
|
4459
|
-
| `punktum_dk_terms_acceptance` | `true` (also `1`, `yes`) | .dk (registration,
|
|
4460
|
-
registrant change) | input |
|
|
4461
|
-
|
|
4462
|
-
| `de_general_request_contact` | id of a contact whose `.de` attribute
|
|
4463
|
-
set has `DE_CONTACT_TYPE` = `REQUEST` | .de | input |
|
|
4464
|
-
|
|
4465
|
-
| `de_abuse_contact` | id of a contact whose `.de` attribute set has `DE_CONTACT_TYPE`
|
|
4466
|
-
= `REQUEST` | .de | input |
|
|
4467
|
-
|
|
4468
|
-
| `nor_id_applicant_version`, `nor_id_applicant_accept_name`, `nor_id_applicant_accept_date`
|
|
4469
|
-
| taken from the signed applicant declaration | .no | ignored |
|
|
4470
|
-
|
|
4471
|
-
| `nor_id_declaration`, `nor_id_declaration_token` | | .no | output |
|
|
4472
|
-
|
|
4473
|
-
| `punktum_dk_tracking_no` | registry-issued | .dk | output |
|
|
4474
|
-
|
|
4475
|
-
| `verification_required` | | all | output |
|
|
4476
|
-
|
|
4477
|
-
| `promotion`, `promotion_eligibility` | | all | output |
|
|
4478
|
-
|
|
4479
|
-
|
|
4480
|
-
`auto_renew_period`: on transfer-in without `period` it also sets the
|
|
4481
|
-
period added by the transfer; on create and update it
|
|
4482
|
-
|
|
4483
|
-
selects the period of the next renewal only and the current expiry date
|
|
4484
|
-
does not move. `monthly` is rejected on transfer-in
|
|
4485
|
-
|
|
4486
|
-
and ignored at renewal when the TLD''s renewal periods have no month unit.
|
|
4487
|
-
|
|
4488
|
-
On update, only `.de` stores attributes and an empty value removes the
|
|
4489
|
-
stored attribute; `.dk` reads
|
|
4490
|
-
|
|
4491
|
-
`punktum_dk_terms_acceptance` to confirm a registrant change and other
|
|
4492
|
-
registries ignore attributes.
|
|
4493
|
-
|
|
4494
|
-
'
|
|
4299
|
+
description: "Additional attributes of the domain, keyed by attribute name.\
|
|
4300
|
+
\ Values are strings.\n\nCustomer-settable keys:\n\n- `auto_renew_period`:\
|
|
4301
|
+
\ `monthly` or `yearly`. All TLDs on create and transfer-in, `.de` only\
|
|
4302
|
+
\ on update. Selects the\n period of the next renewal; the current expiry\
|
|
4303
|
+
\ date does not move. On transfer-in without `period` it also sets the\n\
|
|
4304
|
+
\ period added by the transfer. `monthly` is rejected on transfer-in\
|
|
4305
|
+
\ and ignored at renewal when the TLD has no\n month-unit renewal period.\n\
|
|
4306
|
+
- `music_registrant_attestation`: `true`. `.music` registration.\n- `nic_it_compliance_confirmation`:\
|
|
4307
|
+
\ `true`. `.it` registration and transfer.\n- `travel_industry_acknowledgement`:\
|
|
4308
|
+
\ `true`. `.travel` registration.\n- `internet_ee_registrant_agreement`:\
|
|
4309
|
+
\ `true`. `.ee` registration.\n- `punktum_dk_terms_acceptance`: `true`.\
|
|
4310
|
+
\ `.dk` registration and registrant change.\n- `de_general_request_contact`,\
|
|
4311
|
+
\ `de_abuse_contact`: id of a contact whose `.de` attribute set has `DE_CONTACT_TYPE`\
|
|
4312
|
+
\ =\n `REQUEST`. `.de` only.\n\nBoolean keys also accept `1` and `yes`.\n\
|
|
4313
|
+
\nWritten by the platform and rejected if supplied: `verification_required`,\
|
|
4314
|
+
\ `promotion`, `promotion_eligibility`,\n`nor_id_declaration`, `nor_id_declaration_token`,\
|
|
4315
|
+
\ `punktum_dk_tracking_no`. They are never returned under `attributes`.\n\
|
|
4316
|
+
\nDerived from the signed `.no` applicant declaration and ignored if supplied:\
|
|
4317
|
+
\ `nor_id_applicant_version`,\n`nor_id_applicant_accept_name`, `nor_id_applicant_accept_date`.\n\
|
|
4318
|
+
\nOn update, only `.de` stores attributes and an empty value removes the\
|
|
4319
|
+
\ stored attribute; `.dk` reads\n`punktum_dk_terms_acceptance` to confirm\
|
|
4320
|
+
\ a registrant change and other registries ignore attributes.\n"
|
|
4495
4321
|
examples:
|
|
4496
4322
|
- auto_renew_period: monthly
|
|
4497
4323
|
title: Attributes
|
|
@@ -6350,74 +6176,29 @@ components:
|
|
|
6350
6176
|
$ref: '#/components/schemas/DomainAttributeKey'
|
|
6351
6177
|
type: object
|
|
6352
6178
|
- type: 'null'
|
|
6353
|
-
description:
|
|
6354
|
-
|
|
6355
|
-
|
|
6356
|
-
|
|
6357
|
-
|
|
6358
|
-
|
|
6359
|
-
|
|
6360
|
-
|
|
6361
|
-
|
|
6362
|
-
|
|
6363
|
-
|
|
6364
|
-
|
|
6365
|
-
|
|
6366
|
-
|
|
6367
|
-
|
|
6368
|
-
|
|
6369
|
-
|
|
6370
|
-
|
|
6371
|
-
`.
|
|
6372
|
-
|
|
6373
|
-
|
|
6374
|
-
|
|
6375
|
-
|
|
6376
|
-
| `nic_it_compliance_confirmation` | `true` (also `1`, `yes`) | .it (registration,
|
|
6377
|
-
transfer) | input |
|
|
6378
|
-
|
|
6379
|
-
| `travel_industry_acknowledgement` | `true` (also `1`, `yes`) | .travel
|
|
6380
|
-
(registration) | input |
|
|
6381
|
-
|
|
6382
|
-
| `internet_ee_registrant_agreement` | `true` (also `1`, `yes`) | .ee
|
|
6383
|
-
(registration) | input |
|
|
6384
|
-
|
|
6385
|
-
| `punktum_dk_terms_acceptance` | `true` (also `1`, `yes`) | .dk (registration,
|
|
6386
|
-
registrant change) | input |
|
|
6387
|
-
|
|
6388
|
-
| `de_general_request_contact` | id of a contact whose `.de` attribute
|
|
6389
|
-
set has `DE_CONTACT_TYPE` = `REQUEST` | .de | input |
|
|
6390
|
-
|
|
6391
|
-
| `de_abuse_contact` | id of a contact whose `.de` attribute set has `DE_CONTACT_TYPE`
|
|
6392
|
-
= `REQUEST` | .de | input |
|
|
6393
|
-
|
|
6394
|
-
| `nor_id_applicant_version`, `nor_id_applicant_accept_name`, `nor_id_applicant_accept_date`
|
|
6395
|
-
| taken from the signed applicant declaration | .no | ignored |
|
|
6396
|
-
|
|
6397
|
-
| `nor_id_declaration`, `nor_id_declaration_token` | | .no | output |
|
|
6398
|
-
|
|
6399
|
-
| `punktum_dk_tracking_no` | registry-issued | .dk | output |
|
|
6400
|
-
|
|
6401
|
-
| `verification_required` | | all | output |
|
|
6402
|
-
|
|
6403
|
-
| `promotion`, `promotion_eligibility` | | all | output |
|
|
6404
|
-
|
|
6405
|
-
|
|
6406
|
-
`auto_renew_period`: on transfer-in without `period` it also sets the
|
|
6407
|
-
period added by the transfer; on create and update it
|
|
6408
|
-
|
|
6409
|
-
selects the period of the next renewal only and the current expiry date
|
|
6410
|
-
does not move. `monthly` is rejected on transfer-in
|
|
6411
|
-
|
|
6412
|
-
and ignored at renewal when the TLD''s renewal periods have no month unit.
|
|
6413
|
-
|
|
6414
|
-
On update, only `.de` stores attributes and an empty value removes the
|
|
6415
|
-
stored attribute; `.dk` reads
|
|
6416
|
-
|
|
6417
|
-
`punktum_dk_terms_acceptance` to confirm a registrant change and other
|
|
6418
|
-
registries ignore attributes.
|
|
6419
|
-
|
|
6420
|
-
'
|
|
6179
|
+
description: "Override attributes for this domain.\n\nAdditional attributes\
|
|
6180
|
+
\ of the domain, keyed by attribute name. Values are strings.\n\nCustomer-settable\
|
|
6181
|
+
\ keys:\n\n- `auto_renew_period`: `monthly` or `yearly`. All TLDs on create\
|
|
6182
|
+
\ and transfer-in, `.de` only on update. Selects the\n period of the\
|
|
6183
|
+
\ next renewal; the current expiry date does not move. On transfer-in\
|
|
6184
|
+
\ without `period` it also sets the\n period added by the transfer. `monthly`\
|
|
6185
|
+
\ is rejected on transfer-in and ignored at renewal when the TLD has no\n\
|
|
6186
|
+
\ month-unit renewal period.\n- `music_registrant_attestation`: `true`.\
|
|
6187
|
+
\ `.music` registration.\n- `nic_it_compliance_confirmation`: `true`.\
|
|
6188
|
+
\ `.it` registration and transfer.\n- `travel_industry_acknowledgement`:\
|
|
6189
|
+
\ `true`. `.travel` registration.\n- `internet_ee_registrant_agreement`:\
|
|
6190
|
+
\ `true`. `.ee` registration.\n- `punktum_dk_terms_acceptance`: `true`.\
|
|
6191
|
+
\ `.dk` registration and registrant change.\n- `de_general_request_contact`,\
|
|
6192
|
+
\ `de_abuse_contact`: id of a contact whose `.de` attribute set has `DE_CONTACT_TYPE`\
|
|
6193
|
+
\ =\n `REQUEST`. `.de` only.\n\nBoolean keys also accept `1` and `yes`.\n\
|
|
6194
|
+
\nWritten by the platform and rejected if supplied: `verification_required`,\
|
|
6195
|
+
\ `promotion`, `promotion_eligibility`,\n`nor_id_declaration`, `nor_id_declaration_token`,\
|
|
6196
|
+
\ `punktum_dk_tracking_no`. They are never returned under `attributes`.\n\
|
|
6197
|
+
\nDerived from the signed `.no` applicant declaration and ignored if supplied:\
|
|
6198
|
+
\ `nor_id_applicant_version`,\n`nor_id_applicant_accept_name`, `nor_id_applicant_accept_date`.\n\
|
|
6199
|
+
\nOn update, only `.de` stores attributes and an empty value removes the\
|
|
6200
|
+
\ stored attribute; `.dk` reads\n`punktum_dk_terms_acceptance` to confirm\
|
|
6201
|
+
\ a registrant change and other registries ignore attributes.\n"
|
|
6421
6202
|
title: Attributes
|
|
6422
6203
|
auth_code:
|
|
6423
6204
|
anyOf:
|
|
@@ -6499,71 +6280,28 @@ components:
|
|
|
6499
6280
|
$ref: '#/components/schemas/DomainAttributeKey'
|
|
6500
6281
|
type: object
|
|
6501
6282
|
- type: 'null'
|
|
6502
|
-
description:
|
|
6503
|
-
|
|
6504
|
-
|
|
6505
|
-
|
|
6506
|
-
|
|
6507
|
-
|
|
6508
|
-
|
|
6509
|
-
|
|
6510
|
-
|
|
6511
|
-
|
|
6512
|
-
|
|
6513
|
-
|
|
6514
|
-
|
|
6515
|
-
|
|
6516
|
-
|
|
6517
|
-
|
|
6518
|
-
|
|
6519
|
-
|
|
6520
|
-
|
|
6521
|
-
|
|
6522
|
-
|
|
6523
|
-
|
|
6524
|
-
|
|
6525
|
-
| `travel_industry_acknowledgement` | `true` (also `1`, `yes`) | .travel
|
|
6526
|
-
(registration) | input |
|
|
6527
|
-
|
|
6528
|
-
| `internet_ee_registrant_agreement` | `true` (also `1`, `yes`) | .ee
|
|
6529
|
-
(registration) | input |
|
|
6530
|
-
|
|
6531
|
-
| `punktum_dk_terms_acceptance` | `true` (also `1`, `yes`) | .dk (registration,
|
|
6532
|
-
registrant change) | input |
|
|
6533
|
-
|
|
6534
|
-
| `de_general_request_contact` | id of a contact whose `.de` attribute
|
|
6535
|
-
set has `DE_CONTACT_TYPE` = `REQUEST` | .de | input |
|
|
6536
|
-
|
|
6537
|
-
| `de_abuse_contact` | id of a contact whose `.de` attribute set has `DE_CONTACT_TYPE`
|
|
6538
|
-
= `REQUEST` | .de | input |
|
|
6539
|
-
|
|
6540
|
-
| `nor_id_applicant_version`, `nor_id_applicant_accept_name`, `nor_id_applicant_accept_date`
|
|
6541
|
-
| taken from the signed applicant declaration | .no | ignored |
|
|
6542
|
-
|
|
6543
|
-
| `nor_id_declaration`, `nor_id_declaration_token` | | .no | output |
|
|
6544
|
-
|
|
6545
|
-
| `punktum_dk_tracking_no` | registry-issued | .dk | output |
|
|
6546
|
-
|
|
6547
|
-
| `verification_required` | | all | output |
|
|
6548
|
-
|
|
6549
|
-
| `promotion`, `promotion_eligibility` | | all | output |
|
|
6550
|
-
|
|
6551
|
-
|
|
6552
|
-
`auto_renew_period`: on transfer-in without `period` it also sets the
|
|
6553
|
-
period added by the transfer; on create and update it
|
|
6554
|
-
|
|
6555
|
-
selects the period of the next renewal only and the current expiry date
|
|
6556
|
-
does not move. `monthly` is rejected on transfer-in
|
|
6557
|
-
|
|
6558
|
-
and ignored at renewal when the TLD''s renewal periods have no month unit.
|
|
6559
|
-
|
|
6560
|
-
On update, only `.de` stores attributes and an empty value removes the
|
|
6561
|
-
stored attribute; `.dk` reads
|
|
6562
|
-
|
|
6563
|
-
`punktum_dk_terms_acceptance` to confirm a registrant change and other
|
|
6564
|
-
registries ignore attributes.
|
|
6565
|
-
|
|
6566
|
-
'
|
|
6283
|
+
description: "Additional attributes of the domain, keyed by attribute name.\
|
|
6284
|
+
\ Values are strings.\n\nCustomer-settable keys:\n\n- `auto_renew_period`:\
|
|
6285
|
+
\ `monthly` or `yearly`. All TLDs on create and transfer-in, `.de` only\
|
|
6286
|
+
\ on update. Selects the\n period of the next renewal; the current expiry\
|
|
6287
|
+
\ date does not move. On transfer-in without `period` it also sets the\n\
|
|
6288
|
+
\ period added by the transfer. `monthly` is rejected on transfer-in\
|
|
6289
|
+
\ and ignored at renewal when the TLD has no\n month-unit renewal period.\n\
|
|
6290
|
+
- `music_registrant_attestation`: `true`. `.music` registration.\n- `nic_it_compliance_confirmation`:\
|
|
6291
|
+
\ `true`. `.it` registration and transfer.\n- `travel_industry_acknowledgement`:\
|
|
6292
|
+
\ `true`. `.travel` registration.\n- `internet_ee_registrant_agreement`:\
|
|
6293
|
+
\ `true`. `.ee` registration.\n- `punktum_dk_terms_acceptance`: `true`.\
|
|
6294
|
+
\ `.dk` registration and registrant change.\n- `de_general_request_contact`,\
|
|
6295
|
+
\ `de_abuse_contact`: id of a contact whose `.de` attribute set has `DE_CONTACT_TYPE`\
|
|
6296
|
+
\ =\n `REQUEST`. `.de` only.\n\nBoolean keys also accept `1` and `yes`.\n\
|
|
6297
|
+
\nWritten by the platform and rejected if supplied: `verification_required`,\
|
|
6298
|
+
\ `promotion`, `promotion_eligibility`,\n`nor_id_declaration`, `nor_id_declaration_token`,\
|
|
6299
|
+
\ `punktum_dk_tracking_no`. They are never returned under `attributes`.\n\
|
|
6300
|
+
\nDerived from the signed `.no` applicant declaration and ignored if supplied:\
|
|
6301
|
+
\ `nor_id_applicant_version`,\n`nor_id_applicant_accept_name`, `nor_id_applicant_accept_date`.\n\
|
|
6302
|
+
\nOn update, only `.de` stores attributes and an empty value removes the\
|
|
6303
|
+
\ stored attribute; `.dk` reads\n`punktum_dk_terms_acceptance` to confirm\
|
|
6304
|
+
\ a registrant change and other registries ignore attributes.\n"
|
|
6567
6305
|
title: Attributes
|
|
6568
6306
|
contacts:
|
|
6569
6307
|
$ref: '#/components/schemas/DomainContactHandles'
|
|
@@ -6629,71 +6367,28 @@ components:
|
|
|
6629
6367
|
$ref: '#/components/schemas/DomainAttributeKey'
|
|
6630
6368
|
type: object
|
|
6631
6369
|
- type: 'null'
|
|
6632
|
-
description:
|
|
6633
|
-
|
|
6634
|
-
|
|
6635
|
-
|
|
6636
|
-
|
|
6637
|
-
|
|
6638
|
-
|
|
6639
|
-
|
|
6640
|
-
|
|
6641
|
-
|
|
6642
|
-
|
|
6643
|
-
|
|
6644
|
-
|
|
6645
|
-
|
|
6646
|
-
|
|
6647
|
-
|
|
6648
|
-
|
|
6649
|
-
|
|
6650
|
-
|
|
6651
|
-
|
|
6652
|
-
|
|
6653
|
-
|
|
6654
|
-
|
|
6655
|
-
| `travel_industry_acknowledgement` | `true` (also `1`, `yes`) | .travel
|
|
6656
|
-
(registration) | input |
|
|
6657
|
-
|
|
6658
|
-
| `internet_ee_registrant_agreement` | `true` (also `1`, `yes`) | .ee
|
|
6659
|
-
(registration) | input |
|
|
6660
|
-
|
|
6661
|
-
| `punktum_dk_terms_acceptance` | `true` (also `1`, `yes`) | .dk (registration,
|
|
6662
|
-
registrant change) | input |
|
|
6663
|
-
|
|
6664
|
-
| `de_general_request_contact` | id of a contact whose `.de` attribute
|
|
6665
|
-
set has `DE_CONTACT_TYPE` = `REQUEST` | .de | input |
|
|
6666
|
-
|
|
6667
|
-
| `de_abuse_contact` | id of a contact whose `.de` attribute set has `DE_CONTACT_TYPE`
|
|
6668
|
-
= `REQUEST` | .de | input |
|
|
6669
|
-
|
|
6670
|
-
| `nor_id_applicant_version`, `nor_id_applicant_accept_name`, `nor_id_applicant_accept_date`
|
|
6671
|
-
| taken from the signed applicant declaration | .no | ignored |
|
|
6672
|
-
|
|
6673
|
-
| `nor_id_declaration`, `nor_id_declaration_token` | | .no | output |
|
|
6674
|
-
|
|
6675
|
-
| `punktum_dk_tracking_no` | registry-issued | .dk | output |
|
|
6676
|
-
|
|
6677
|
-
| `verification_required` | | all | output |
|
|
6678
|
-
|
|
6679
|
-
| `promotion`, `promotion_eligibility` | | all | output |
|
|
6680
|
-
|
|
6681
|
-
|
|
6682
|
-
`auto_renew_period`: on transfer-in without `period` it also sets the
|
|
6683
|
-
period added by the transfer; on create and update it
|
|
6684
|
-
|
|
6685
|
-
selects the period of the next renewal only and the current expiry date
|
|
6686
|
-
does not move. `monthly` is rejected on transfer-in
|
|
6687
|
-
|
|
6688
|
-
and ignored at renewal when the TLD''s renewal periods have no month unit.
|
|
6689
|
-
|
|
6690
|
-
On update, only `.de` stores attributes and an empty value removes the
|
|
6691
|
-
stored attribute; `.dk` reads
|
|
6692
|
-
|
|
6693
|
-
`punktum_dk_terms_acceptance` to confirm a registrant change and other
|
|
6694
|
-
registries ignore attributes.
|
|
6695
|
-
|
|
6696
|
-
'
|
|
6370
|
+
description: "Additional attributes of the domain, keyed by attribute name.\
|
|
6371
|
+
\ Values are strings.\n\nCustomer-settable keys:\n\n- `auto_renew_period`:\
|
|
6372
|
+
\ `monthly` or `yearly`. All TLDs on create and transfer-in, `.de` only\
|
|
6373
|
+
\ on update. Selects the\n period of the next renewal; the current expiry\
|
|
6374
|
+
\ date does not move. On transfer-in without `period` it also sets the\n\
|
|
6375
|
+
\ period added by the transfer. `monthly` is rejected on transfer-in\
|
|
6376
|
+
\ and ignored at renewal when the TLD has no\n month-unit renewal period.\n\
|
|
6377
|
+
- `music_registrant_attestation`: `true`. `.music` registration.\n- `nic_it_compliance_confirmation`:\
|
|
6378
|
+
\ `true`. `.it` registration and transfer.\n- `travel_industry_acknowledgement`:\
|
|
6379
|
+
\ `true`. `.travel` registration.\n- `internet_ee_registrant_agreement`:\
|
|
6380
|
+
\ `true`. `.ee` registration.\n- `punktum_dk_terms_acceptance`: `true`.\
|
|
6381
|
+
\ `.dk` registration and registrant change.\n- `de_general_request_contact`,\
|
|
6382
|
+
\ `de_abuse_contact`: id of a contact whose `.de` attribute set has `DE_CONTACT_TYPE`\
|
|
6383
|
+
\ =\n `REQUEST`. `.de` only.\n\nBoolean keys also accept `1` and `yes`.\n\
|
|
6384
|
+
\nWritten by the platform and rejected if supplied: `verification_required`,\
|
|
6385
|
+
\ `promotion`, `promotion_eligibility`,\n`nor_id_declaration`, `nor_id_declaration_token`,\
|
|
6386
|
+
\ `punktum_dk_tracking_no`. They are never returned under `attributes`.\n\
|
|
6387
|
+
\nDerived from the signed `.no` applicant declaration and ignored if supplied:\
|
|
6388
|
+
\ `nor_id_applicant_version`,\n`nor_id_applicant_accept_name`, `nor_id_applicant_accept_date`.\n\
|
|
6389
|
+
\nOn update, only `.de` stores attributes and an empty value removes the\
|
|
6390
|
+
\ stored attribute; `.dk` reads\n`punktum_dk_terms_acceptance` to confirm\
|
|
6391
|
+
\ a registrant change and other registries ignore attributes.\n"
|
|
6697
6392
|
examples:
|
|
6698
6393
|
- auto_renew_period: monthly
|
|
6699
6394
|
title: Attributes
|
|
@@ -6759,71 +6454,28 @@ components:
|
|
|
6759
6454
|
$ref: '#/components/schemas/DomainAttributeKey'
|
|
6760
6455
|
type: object
|
|
6761
6456
|
- type: 'null'
|
|
6762
|
-
description:
|
|
6763
|
-
|
|
6764
|
-
|
|
6765
|
-
|
|
6766
|
-
|
|
6767
|
-
|
|
6768
|
-
|
|
6769
|
-
|
|
6770
|
-
|
|
6771
|
-
|
|
6772
|
-
|
|
6773
|
-
|
|
6774
|
-
|
|
6775
|
-
|
|
6776
|
-
|
|
6777
|
-
|
|
6778
|
-
|
|
6779
|
-
|
|
6780
|
-
|
|
6781
|
-
|
|
6782
|
-
|
|
6783
|
-
|
|
6784
|
-
|
|
6785
|
-
| `travel_industry_acknowledgement` | `true` (also `1`, `yes`) | .travel
|
|
6786
|
-
(registration) | input |
|
|
6787
|
-
|
|
6788
|
-
| `internet_ee_registrant_agreement` | `true` (also `1`, `yes`) | .ee
|
|
6789
|
-
(registration) | input |
|
|
6790
|
-
|
|
6791
|
-
| `punktum_dk_terms_acceptance` | `true` (also `1`, `yes`) | .dk (registration,
|
|
6792
|
-
registrant change) | input |
|
|
6793
|
-
|
|
6794
|
-
| `de_general_request_contact` | id of a contact whose `.de` attribute
|
|
6795
|
-
set has `DE_CONTACT_TYPE` = `REQUEST` | .de | input |
|
|
6796
|
-
|
|
6797
|
-
| `de_abuse_contact` | id of a contact whose `.de` attribute set has `DE_CONTACT_TYPE`
|
|
6798
|
-
= `REQUEST` | .de | input |
|
|
6799
|
-
|
|
6800
|
-
| `nor_id_applicant_version`, `nor_id_applicant_accept_name`, `nor_id_applicant_accept_date`
|
|
6801
|
-
| taken from the signed applicant declaration | .no | ignored |
|
|
6802
|
-
|
|
6803
|
-
| `nor_id_declaration`, `nor_id_declaration_token` | | .no | output |
|
|
6804
|
-
|
|
6805
|
-
| `punktum_dk_tracking_no` | registry-issued | .dk | output |
|
|
6806
|
-
|
|
6807
|
-
| `verification_required` | | all | output |
|
|
6808
|
-
|
|
6809
|
-
| `promotion`, `promotion_eligibility` | | all | output |
|
|
6810
|
-
|
|
6811
|
-
|
|
6812
|
-
`auto_renew_period`: on transfer-in without `period` it also sets the
|
|
6813
|
-
period added by the transfer; on create and update it
|
|
6814
|
-
|
|
6815
|
-
selects the period of the next renewal only and the current expiry date
|
|
6816
|
-
does not move. `monthly` is rejected on transfer-in
|
|
6817
|
-
|
|
6818
|
-
and ignored at renewal when the TLD''s renewal periods have no month unit.
|
|
6819
|
-
|
|
6820
|
-
On update, only `.de` stores attributes and an empty value removes the
|
|
6821
|
-
stored attribute; `.dk` reads
|
|
6822
|
-
|
|
6823
|
-
`punktum_dk_terms_acceptance` to confirm a registrant change and other
|
|
6824
|
-
registries ignore attributes.
|
|
6825
|
-
|
|
6826
|
-
'
|
|
6457
|
+
description: "Additional attributes of the domain, keyed by attribute name.\
|
|
6458
|
+
\ Values are strings.\n\nCustomer-settable keys:\n\n- `auto_renew_period`:\
|
|
6459
|
+
\ `monthly` or `yearly`. All TLDs on create and transfer-in, `.de` only\
|
|
6460
|
+
\ on update. Selects the\n period of the next renewal; the current expiry\
|
|
6461
|
+
\ date does not move. On transfer-in without `period` it also sets the\n\
|
|
6462
|
+
\ period added by the transfer. `monthly` is rejected on transfer-in\
|
|
6463
|
+
\ and ignored at renewal when the TLD has no\n month-unit renewal period.\n\
|
|
6464
|
+
- `music_registrant_attestation`: `true`. `.music` registration.\n- `nic_it_compliance_confirmation`:\
|
|
6465
|
+
\ `true`. `.it` registration and transfer.\n- `travel_industry_acknowledgement`:\
|
|
6466
|
+
\ `true`. `.travel` registration.\n- `internet_ee_registrant_agreement`:\
|
|
6467
|
+
\ `true`. `.ee` registration.\n- `punktum_dk_terms_acceptance`: `true`.\
|
|
6468
|
+
\ `.dk` registration and registrant change.\n- `de_general_request_contact`,\
|
|
6469
|
+
\ `de_abuse_contact`: id of a contact whose `.de` attribute set has `DE_CONTACT_TYPE`\
|
|
6470
|
+
\ =\n `REQUEST`. `.de` only.\n\nBoolean keys also accept `1` and `yes`.\n\
|
|
6471
|
+
\nWritten by the platform and rejected if supplied: `verification_required`,\
|
|
6472
|
+
\ `promotion`, `promotion_eligibility`,\n`nor_id_declaration`, `nor_id_declaration_token`,\
|
|
6473
|
+
\ `punktum_dk_tracking_no`. They are never returned under `attributes`.\n\
|
|
6474
|
+
\nDerived from the signed `.no` applicant declaration and ignored if supplied:\
|
|
6475
|
+
\ `nor_id_applicant_version`,\n`nor_id_applicant_accept_name`, `nor_id_applicant_accept_date`.\n\
|
|
6476
|
+
\nOn update, only `.de` stores attributes and an empty value removes the\
|
|
6477
|
+
\ stored attribute; `.dk` reads\n`punktum_dk_terms_acceptance` to confirm\
|
|
6478
|
+
\ a registrant change and other registries ignore attributes.\n"
|
|
6827
6479
|
examples:
|
|
6828
6480
|
- auto_renew_period: monthly
|
|
6829
6481
|
title: Attributes
|
|
@@ -6934,71 +6586,28 @@ components:
|
|
|
6934
6586
|
$ref: '#/components/schemas/DomainAttributeKey'
|
|
6935
6587
|
type: object
|
|
6936
6588
|
- type: 'null'
|
|
6937
|
-
description:
|
|
6938
|
-
|
|
6939
|
-
|
|
6940
|
-
|
|
6941
|
-
|
|
6942
|
-
|
|
6943
|
-
|
|
6944
|
-
|
|
6945
|
-
|
|
6946
|
-
|
|
6947
|
-
|
|
6948
|
-
|
|
6949
|
-
|
|
6950
|
-
|
|
6951
|
-
|
|
6952
|
-
|
|
6953
|
-
|
|
6954
|
-
|
|
6955
|
-
|
|
6956
|
-
|
|
6957
|
-
|
|
6958
|
-
|
|
6959
|
-
|
|
6960
|
-
| `travel_industry_acknowledgement` | `true` (also `1`, `yes`) | .travel
|
|
6961
|
-
(registration) | input |
|
|
6962
|
-
|
|
6963
|
-
| `internet_ee_registrant_agreement` | `true` (also `1`, `yes`) | .ee
|
|
6964
|
-
(registration) | input |
|
|
6965
|
-
|
|
6966
|
-
| `punktum_dk_terms_acceptance` | `true` (also `1`, `yes`) | .dk (registration,
|
|
6967
|
-
registrant change) | input |
|
|
6968
|
-
|
|
6969
|
-
| `de_general_request_contact` | id of a contact whose `.de` attribute
|
|
6970
|
-
set has `DE_CONTACT_TYPE` = `REQUEST` | .de | input |
|
|
6971
|
-
|
|
6972
|
-
| `de_abuse_contact` | id of a contact whose `.de` attribute set has `DE_CONTACT_TYPE`
|
|
6973
|
-
= `REQUEST` | .de | input |
|
|
6974
|
-
|
|
6975
|
-
| `nor_id_applicant_version`, `nor_id_applicant_accept_name`, `nor_id_applicant_accept_date`
|
|
6976
|
-
| taken from the signed applicant declaration | .no | ignored |
|
|
6977
|
-
|
|
6978
|
-
| `nor_id_declaration`, `nor_id_declaration_token` | | .no | output |
|
|
6979
|
-
|
|
6980
|
-
| `punktum_dk_tracking_no` | registry-issued | .dk | output |
|
|
6981
|
-
|
|
6982
|
-
| `verification_required` | | all | output |
|
|
6983
|
-
|
|
6984
|
-
| `promotion`, `promotion_eligibility` | | all | output |
|
|
6985
|
-
|
|
6986
|
-
|
|
6987
|
-
`auto_renew_period`: on transfer-in without `period` it also sets the
|
|
6988
|
-
period added by the transfer; on create and update it
|
|
6989
|
-
|
|
6990
|
-
selects the period of the next renewal only and the current expiry date
|
|
6991
|
-
does not move. `monthly` is rejected on transfer-in
|
|
6992
|
-
|
|
6993
|
-
and ignored at renewal when the TLD''s renewal periods have no month unit.
|
|
6994
|
-
|
|
6995
|
-
On update, only `.de` stores attributes and an empty value removes the
|
|
6996
|
-
stored attribute; `.dk` reads
|
|
6997
|
-
|
|
6998
|
-
`punktum_dk_terms_acceptance` to confirm a registrant change and other
|
|
6999
|
-
registries ignore attributes.
|
|
7000
|
-
|
|
7001
|
-
'
|
|
6589
|
+
description: "Additional attributes of the domain, keyed by attribute name.\
|
|
6590
|
+
\ Values are strings.\n\nCustomer-settable keys:\n\n- `auto_renew_period`:\
|
|
6591
|
+
\ `monthly` or `yearly`. All TLDs on create and transfer-in, `.de` only\
|
|
6592
|
+
\ on update. Selects the\n period of the next renewal; the current expiry\
|
|
6593
|
+
\ date does not move. On transfer-in without `period` it also sets the\n\
|
|
6594
|
+
\ period added by the transfer. `monthly` is rejected on transfer-in\
|
|
6595
|
+
\ and ignored at renewal when the TLD has no\n month-unit renewal period.\n\
|
|
6596
|
+
- `music_registrant_attestation`: `true`. `.music` registration.\n- `nic_it_compliance_confirmation`:\
|
|
6597
|
+
\ `true`. `.it` registration and transfer.\n- `travel_industry_acknowledgement`:\
|
|
6598
|
+
\ `true`. `.travel` registration.\n- `internet_ee_registrant_agreement`:\
|
|
6599
|
+
\ `true`. `.ee` registration.\n- `punktum_dk_terms_acceptance`: `true`.\
|
|
6600
|
+
\ `.dk` registration and registrant change.\n- `de_general_request_contact`,\
|
|
6601
|
+
\ `de_abuse_contact`: id of a contact whose `.de` attribute set has `DE_CONTACT_TYPE`\
|
|
6602
|
+
\ =\n `REQUEST`. `.de` only.\n\nBoolean keys also accept `1` and `yes`.\n\
|
|
6603
|
+
\nWritten by the platform and rejected if supplied: `verification_required`,\
|
|
6604
|
+
\ `promotion`, `promotion_eligibility`,\n`nor_id_declaration`, `nor_id_declaration_token`,\
|
|
6605
|
+
\ `punktum_dk_tracking_no`. They are never returned under `attributes`.\n\
|
|
6606
|
+
\nDerived from the signed `.no` applicant declaration and ignored if supplied:\
|
|
6607
|
+
\ `nor_id_applicant_version`,\n`nor_id_applicant_accept_name`, `nor_id_applicant_accept_date`.\n\
|
|
6608
|
+
\nOn update, only `.de` stores attributes and an empty value removes the\
|
|
6609
|
+
\ stored attribute; `.dk` reads\n`punktum_dk_terms_acceptance` to confirm\
|
|
6610
|
+
\ a registrant change and other registries ignore attributes.\n"
|
|
7002
6611
|
examples:
|
|
7003
6612
|
- auto_renew_period: monthly
|
|
7004
6613
|
title: Attributes
|
|
@@ -7218,71 +6827,28 @@ components:
|
|
|
7218
6827
|
$ref: '#/components/schemas/DomainAttributeKey'
|
|
7219
6828
|
type: object
|
|
7220
6829
|
- type: 'null'
|
|
7221
|
-
description:
|
|
7222
|
-
|
|
7223
|
-
|
|
7224
|
-
|
|
7225
|
-
|
|
7226
|
-
|
|
7227
|
-
|
|
7228
|
-
|
|
7229
|
-
|
|
7230
|
-
|
|
7231
|
-
|
|
7232
|
-
|
|
7233
|
-
|
|
7234
|
-
|
|
7235
|
-
|
|
7236
|
-
|
|
7237
|
-
|
|
7238
|
-
|
|
7239
|
-
|
|
7240
|
-
|
|
7241
|
-
|
|
7242
|
-
|
|
7243
|
-
|
|
7244
|
-
| `travel_industry_acknowledgement` | `true` (also `1`, `yes`) | .travel
|
|
7245
|
-
(registration) | input |
|
|
7246
|
-
|
|
7247
|
-
| `internet_ee_registrant_agreement` | `true` (also `1`, `yes`) | .ee
|
|
7248
|
-
(registration) | input |
|
|
7249
|
-
|
|
7250
|
-
| `punktum_dk_terms_acceptance` | `true` (also `1`, `yes`) | .dk (registration,
|
|
7251
|
-
registrant change) | input |
|
|
7252
|
-
|
|
7253
|
-
| `de_general_request_contact` | id of a contact whose `.de` attribute
|
|
7254
|
-
set has `DE_CONTACT_TYPE` = `REQUEST` | .de | input |
|
|
7255
|
-
|
|
7256
|
-
| `de_abuse_contact` | id of a contact whose `.de` attribute set has `DE_CONTACT_TYPE`
|
|
7257
|
-
= `REQUEST` | .de | input |
|
|
7258
|
-
|
|
7259
|
-
| `nor_id_applicant_version`, `nor_id_applicant_accept_name`, `nor_id_applicant_accept_date`
|
|
7260
|
-
| taken from the signed applicant declaration | .no | ignored |
|
|
7261
|
-
|
|
7262
|
-
| `nor_id_declaration`, `nor_id_declaration_token` | | .no | output |
|
|
7263
|
-
|
|
7264
|
-
| `punktum_dk_tracking_no` | registry-issued | .dk | output |
|
|
7265
|
-
|
|
7266
|
-
| `verification_required` | | all | output |
|
|
7267
|
-
|
|
7268
|
-
| `promotion`, `promotion_eligibility` | | all | output |
|
|
7269
|
-
|
|
7270
|
-
|
|
7271
|
-
`auto_renew_period`: on transfer-in without `period` it also sets the
|
|
7272
|
-
period added by the transfer; on create and update it
|
|
7273
|
-
|
|
7274
|
-
selects the period of the next renewal only and the current expiry date
|
|
7275
|
-
does not move. `monthly` is rejected on transfer-in
|
|
7276
|
-
|
|
7277
|
-
and ignored at renewal when the TLD''s renewal periods have no month unit.
|
|
7278
|
-
|
|
7279
|
-
On update, only `.de` stores attributes and an empty value removes the
|
|
7280
|
-
stored attribute; `.dk` reads
|
|
7281
|
-
|
|
7282
|
-
`punktum_dk_terms_acceptance` to confirm a registrant change and other
|
|
7283
|
-
registries ignore attributes.
|
|
7284
|
-
|
|
7285
|
-
'
|
|
6830
|
+
description: "Additional attributes of the domain, keyed by attribute name.\
|
|
6831
|
+
\ Values are strings.\n\nCustomer-settable keys:\n\n- `auto_renew_period`:\
|
|
6832
|
+
\ `monthly` or `yearly`. All TLDs on create and transfer-in, `.de` only\
|
|
6833
|
+
\ on update. Selects the\n period of the next renewal; the current expiry\
|
|
6834
|
+
\ date does not move. On transfer-in without `period` it also sets the\n\
|
|
6835
|
+
\ period added by the transfer. `monthly` is rejected on transfer-in\
|
|
6836
|
+
\ and ignored at renewal when the TLD has no\n month-unit renewal period.\n\
|
|
6837
|
+
- `music_registrant_attestation`: `true`. `.music` registration.\n- `nic_it_compliance_confirmation`:\
|
|
6838
|
+
\ `true`. `.it` registration and transfer.\n- `travel_industry_acknowledgement`:\
|
|
6839
|
+
\ `true`. `.travel` registration.\n- `internet_ee_registrant_agreement`:\
|
|
6840
|
+
\ `true`. `.ee` registration.\n- `punktum_dk_terms_acceptance`: `true`.\
|
|
6841
|
+
\ `.dk` registration and registrant change.\n- `de_general_request_contact`,\
|
|
6842
|
+
\ `de_abuse_contact`: id of a contact whose `.de` attribute set has `DE_CONTACT_TYPE`\
|
|
6843
|
+
\ =\n `REQUEST`. `.de` only.\n\nBoolean keys also accept `1` and `yes`.\n\
|
|
6844
|
+
\nWritten by the platform and rejected if supplied: `verification_required`,\
|
|
6845
|
+
\ `promotion`, `promotion_eligibility`,\n`nor_id_declaration`, `nor_id_declaration_token`,\
|
|
6846
|
+
\ `punktum_dk_tracking_no`. They are never returned under `attributes`.\n\
|
|
6847
|
+
\nDerived from the signed `.no` applicant declaration and ignored if supplied:\
|
|
6848
|
+
\ `nor_id_applicant_version`,\n`nor_id_applicant_accept_name`, `nor_id_applicant_accept_date`.\n\
|
|
6849
|
+
\nOn update, only `.de` stores attributes and an empty value removes the\
|
|
6850
|
+
\ stored attribute; `.dk` reads\n`punktum_dk_terms_acceptance` to confirm\
|
|
6851
|
+
\ a registrant change and other registries ignore attributes.\n"
|
|
7286
6852
|
examples:
|
|
7287
6853
|
- auto_renew_period: monthly
|
|
7288
6854
|
title: Attributes
|
|
@@ -13343,6 +12909,7 @@ components:
|
|
|
13343
12909
|
- generating
|
|
13344
12910
|
- completed
|
|
13345
12911
|
- failed
|
|
12912
|
+
- empty
|
|
13346
12913
|
title: ReportStatus
|
|
13347
12914
|
type: string
|
|
13348
12915
|
ReportTriggerType:
|
|
@@ -16598,7 +16165,7 @@ info:
|
|
|
16598
16165
|
\n\n"
|
|
16599
16166
|
summary: OpusDNS - your gateway to a seamless domain management experience.
|
|
16600
16167
|
title: OpusDNS API
|
|
16601
|
-
version: 2026-09-
|
|
16168
|
+
version: 2026-09-03-091013
|
|
16602
16169
|
x-logo:
|
|
16603
16170
|
altText: OpusDNS API Reference
|
|
16604
16171
|
url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
|
|
@@ -35046,8 +34613,9 @@ tags:
|
|
|
35046
34613
|
\ the registrar-elements OpenSearch index, populated by the scheduled daily registrar\
|
|
35047
34614
|
\ syncs. Report generation does not trigger a sync; it uses the most recently\
|
|
35048
34615
|
\ synced data as-is. If the credential has no portfolio data yet (for example,\
|
|
35049
|
-
\ a credential created since the last sync),
|
|
35050
|
-
\
|
|
34616
|
+
\ a credential created since the last sync), the report ends as `empty` rather\
|
|
34617
|
+
\ than `failed`: there is nothing to report on yet, and the next run after a sync\
|
|
34618
|
+
\ produces the real report.\n\nThe downloaded ZIP contains `registrar-portfolio-{report_typeid}.pdf`.\
|
|
35051
34619
|
\ Before each PDF generation, the report service loads the organization's current\
|
|
35052
34620
|
\ available TLD list from the backend and uses it to mark TLDs in the portfolio\
|
|
35053
34621
|
\ as available or unavailable. The first version includes the sections backed\
|
|
@@ -35058,14 +34626,18 @@ tags:
|
|
|
35058
34626
|
\ through the following statuses:\n\n1. **pending** \u2014 Report has been queued\
|
|
35059
34627
|
\ for generation\n2. **generating** \u2014 Report is being built\n3. **completed**\
|
|
35060
34628
|
\ \u2014 Report is ready for download\n4. **failed** \u2014 Generation failed\n\
|
|
34629
|
+
5. **empty** \u2014 The organization had no data for this report type (for example\
|
|
34630
|
+
\ no domains, zones or forwards). No file is produced and download returns `409\
|
|
34631
|
+
\ Conflict`. `record_count` is `0`.\n\n`completed`, `failed` and `empty` are terminal.\n\
|
|
35061
34632
|
\n### Usage Pattern\n\n1. **Request a report** \u2014 `POST /v1/reports` with\
|
|
35062
34633
|
\ the desired `report_type`\n2. **Poll for completion** \u2014 `GET /v1/reports/{report_id}`\
|
|
35063
|
-
\ until `status` is `completed
|
|
35064
|
-
\ returns the report as a streamed
|
|
35065
|
-
\ /v1/reports/{report_id}/download
|
|
35066
|
-
\
|
|
35067
|
-
\
|
|
35068
|
-
\ `
|
|
34634
|
+
\ until `status` is terminal (`completed`, `empty` or `failed`)\n3. **Download**\
|
|
34635
|
+
\ \u2014 `GET /v1/reports/{report_id}/download` returns the report as a streamed\
|
|
34636
|
+
\ ZIP file\n\n### Downloading Reports\n\n`GET /v1/reports/{report_id}/download`\
|
|
34637
|
+
\ streams the report file directly to the client. The report **must** have status\
|
|
34638
|
+
\ `completed` before it can be downloaded \u2014 calling this endpoint on a report\
|
|
34639
|
+
\ that is still `pending` or `generating`, or that ended `empty`, returns `409\
|
|
34640
|
+
\ Conflict`.\n\n**Response details:**\n\n| Header | Value |\n|--------|-------|\n\
|
|
35069
34641
|
| `Content-Type` | `application/zip` |\n| `Content-Disposition` | `attachment;\
|
|
35070
34642
|
\ filename={report_type}-{report_id}.zip` |\n| `Content-Length` | File size in\
|
|
35071
34643
|
\ bytes (included when known) |\n\nThe response body is streamed in chunks, so\
|
|
@@ -35081,13 +34653,17 @@ tags:
|
|
|
35081
34653
|
\ per clock hour** (UTC) can be generated. Duplicate requests within the same\
|
|
35082
34654
|
\ hour will not produce an additional report.\n\n### Retention\n\nThe **30 most\
|
|
35083
34655
|
\ recent reports** of each type are kept per organization. Older reports and their\
|
|
35084
|
-
\ associated files are automatically deleted when a new report is generated
|
|
35085
|
-
\
|
|
35086
|
-
\
|
|
35087
|
-
\
|
|
35088
|
-
\
|
|
35089
|
-
\
|
|
35090
|
-
\
|
|
34656
|
+
\ associated files are automatically deleted when a new report is generated. Of\
|
|
34657
|
+
\ the `empty` reports of a type, only the most recent one is kept, so scheduled\
|
|
34658
|
+
\ runs for an organization without data do not fill the list with identical entries.\
|
|
34659
|
+
\ `registrar_portfolio_pdf` is exempt from that rule, because its reports are\
|
|
34660
|
+
\ per registrar credential and an `empty` result for one credential says nothing\
|
|
34661
|
+
\ about another.\n\n### Listing Reports\n\nUse `GET /v1/reports` to list reports\
|
|
34662
|
+
\ with optional filters:\n\n| Parameter | Description |\n|-----------|-------------|\n\
|
|
34663
|
+
| `report_type` | Filter by report type (repeatable) |\n| `status` | Filter by\
|
|
34664
|
+
\ report status (repeatable) |\n| `trigger_type` | Filter by trigger type |\n\
|
|
34665
|
+
| `created_after` | Only reports created after this timestamp |\n| `created_before`\
|
|
34666
|
+
\ | Only reports created before this timestamp |\n"
|
|
35091
34667
|
name: report
|
|
35092
34668
|
x-displayName: Reports
|
|
35093
34669
|
- description: Endpoints for creating new Tags
|