@opusdns/api 0.298.0 → 0.300.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 +79 -0
- package/src/helpers/requests.d.ts +96 -0
- package/src/helpers/responses.d.ts +178 -1
- package/src/helpers/schemas.d.ts +16 -0
- package/src/openapi.yaml +338 -67
- package/src/schema.d.ts +166 -0
package/src/openapi.yaml
CHANGED
|
@@ -188,7 +188,8 @@ components:
|
|
|
188
188
|
type: string
|
|
189
189
|
product_reference:
|
|
190
190
|
anyOf:
|
|
191
|
-
-
|
|
191
|
+
- maxLength: 255
|
|
192
|
+
minLength: 1
|
|
192
193
|
type: string
|
|
193
194
|
- type: 'null'
|
|
194
195
|
description: The reference of the product
|
|
@@ -729,6 +730,7 @@ components:
|
|
|
729
730
|
properties:
|
|
730
731
|
city:
|
|
731
732
|
description: The city of the contact
|
|
733
|
+
maxLength: 255
|
|
732
734
|
minLength: 1
|
|
733
735
|
title: City
|
|
734
736
|
type: string
|
|
@@ -757,17 +759,20 @@ components:
|
|
|
757
759
|
title: Fax
|
|
758
760
|
first_name:
|
|
759
761
|
description: The first name of the contact
|
|
762
|
+
maxLength: 255
|
|
760
763
|
minLength: 1
|
|
761
764
|
title: First Name
|
|
762
765
|
type: string
|
|
763
766
|
last_name:
|
|
764
767
|
description: The last name of the contact
|
|
768
|
+
maxLength: 255
|
|
765
769
|
minLength: 1
|
|
766
770
|
title: Last Name
|
|
767
771
|
type: string
|
|
768
772
|
org:
|
|
769
773
|
anyOf:
|
|
770
|
-
-
|
|
774
|
+
- maxLength: 255
|
|
775
|
+
minLength: 1
|
|
771
776
|
type: string
|
|
772
777
|
- type: 'null'
|
|
773
778
|
description: The organization of the contact
|
|
@@ -781,24 +786,28 @@ components:
|
|
|
781
786
|
type: string
|
|
782
787
|
postal_code:
|
|
783
788
|
description: The postal code of the contact
|
|
789
|
+
maxLength: 255
|
|
784
790
|
minLength: 1
|
|
785
791
|
title: Postal Code
|
|
786
792
|
type: string
|
|
787
793
|
state:
|
|
788
794
|
anyOf:
|
|
789
|
-
-
|
|
795
|
+
- maxLength: 255
|
|
796
|
+
minLength: 1
|
|
790
797
|
type: string
|
|
791
798
|
- type: 'null'
|
|
792
799
|
description: The state of the contact
|
|
793
800
|
title: State
|
|
794
801
|
street:
|
|
795
802
|
description: The address of the contact
|
|
803
|
+
maxLength: 255
|
|
796
804
|
minLength: 1
|
|
797
805
|
title: Street
|
|
798
806
|
type: string
|
|
799
807
|
title:
|
|
800
808
|
anyOf:
|
|
801
|
-
-
|
|
809
|
+
- maxLength: 255
|
|
810
|
+
minLength: 1
|
|
802
811
|
type: string
|
|
803
812
|
- type: 'null'
|
|
804
813
|
description: The title of the contact
|
|
@@ -844,6 +853,7 @@ components:
|
|
|
844
853
|
properties:
|
|
845
854
|
city:
|
|
846
855
|
description: City
|
|
856
|
+
maxLength: 255
|
|
847
857
|
minLength: 1
|
|
848
858
|
title: City
|
|
849
859
|
type: string
|
|
@@ -874,17 +884,20 @@ components:
|
|
|
874
884
|
title: Fax
|
|
875
885
|
first_name:
|
|
876
886
|
description: First name of the contact
|
|
887
|
+
maxLength: 255
|
|
877
888
|
minLength: 1
|
|
878
889
|
title: First Name
|
|
879
890
|
type: string
|
|
880
891
|
last_name:
|
|
881
892
|
description: Last name of the contact
|
|
893
|
+
maxLength: 255
|
|
882
894
|
minLength: 1
|
|
883
895
|
title: Last Name
|
|
884
896
|
type: string
|
|
885
897
|
org:
|
|
886
898
|
anyOf:
|
|
887
|
-
-
|
|
899
|
+
- maxLength: 255
|
|
900
|
+
minLength: 1
|
|
888
901
|
type: string
|
|
889
902
|
- type: 'null'
|
|
890
903
|
description: Override organization for this contact
|
|
@@ -896,24 +909,28 @@ components:
|
|
|
896
909
|
type: string
|
|
897
910
|
postal_code:
|
|
898
911
|
description: Postal code
|
|
912
|
+
maxLength: 255
|
|
899
913
|
minLength: 1
|
|
900
914
|
title: Postal Code
|
|
901
915
|
type: string
|
|
902
916
|
state:
|
|
903
917
|
anyOf:
|
|
904
|
-
-
|
|
918
|
+
- maxLength: 255
|
|
919
|
+
minLength: 1
|
|
905
920
|
type: string
|
|
906
921
|
- type: 'null'
|
|
907
922
|
description: Override state for this contact
|
|
908
923
|
title: State
|
|
909
924
|
street:
|
|
910
925
|
description: Street address
|
|
926
|
+
maxLength: 255
|
|
911
927
|
minLength: 1
|
|
912
928
|
title: Street
|
|
913
929
|
type: string
|
|
914
930
|
title:
|
|
915
931
|
anyOf:
|
|
916
|
-
-
|
|
932
|
+
- maxLength: 255
|
|
933
|
+
minLength: 1
|
|
917
934
|
type: string
|
|
918
935
|
- type: 'null'
|
|
919
936
|
description: Override title for this contact
|
|
@@ -959,21 +976,24 @@ components:
|
|
|
959
976
|
type: boolean
|
|
960
977
|
org:
|
|
961
978
|
anyOf:
|
|
962
|
-
-
|
|
979
|
+
- maxLength: 255
|
|
980
|
+
minLength: 1
|
|
963
981
|
type: string
|
|
964
982
|
- type: 'null'
|
|
965
983
|
description: Organization name
|
|
966
984
|
title: Org
|
|
967
985
|
state:
|
|
968
986
|
anyOf:
|
|
969
|
-
-
|
|
987
|
+
- maxLength: 255
|
|
988
|
+
minLength: 1
|
|
970
989
|
type: string
|
|
971
990
|
- type: 'null'
|
|
972
991
|
description: State/province
|
|
973
992
|
title: State
|
|
974
993
|
title:
|
|
975
994
|
anyOf:
|
|
976
|
-
-
|
|
995
|
+
- maxLength: 255
|
|
996
|
+
minLength: 1
|
|
977
997
|
type: string
|
|
978
998
|
- type: 'null'
|
|
979
999
|
description: Contact title
|
|
@@ -1012,6 +1032,7 @@ components:
|
|
|
1012
1032
|
properties:
|
|
1013
1033
|
city:
|
|
1014
1034
|
description: The city of the contact
|
|
1035
|
+
maxLength: 255
|
|
1015
1036
|
minLength: 1
|
|
1016
1037
|
title: City
|
|
1017
1038
|
type: string
|
|
@@ -1040,17 +1061,20 @@ components:
|
|
|
1040
1061
|
title: Fax
|
|
1041
1062
|
first_name:
|
|
1042
1063
|
description: The first name of the contact
|
|
1064
|
+
maxLength: 255
|
|
1043
1065
|
minLength: 1
|
|
1044
1066
|
title: First Name
|
|
1045
1067
|
type: string
|
|
1046
1068
|
last_name:
|
|
1047
1069
|
description: The last name of the contact
|
|
1070
|
+
maxLength: 255
|
|
1048
1071
|
minLength: 1
|
|
1049
1072
|
title: Last Name
|
|
1050
1073
|
type: string
|
|
1051
1074
|
org:
|
|
1052
1075
|
anyOf:
|
|
1053
|
-
-
|
|
1076
|
+
- maxLength: 255
|
|
1077
|
+
minLength: 1
|
|
1054
1078
|
type: string
|
|
1055
1079
|
- type: 'null'
|
|
1056
1080
|
description: The organization of the contact
|
|
@@ -1064,24 +1088,28 @@ components:
|
|
|
1064
1088
|
type: string
|
|
1065
1089
|
postal_code:
|
|
1066
1090
|
description: The postal code of the contact
|
|
1091
|
+
maxLength: 255
|
|
1067
1092
|
minLength: 1
|
|
1068
1093
|
title: Postal Code
|
|
1069
1094
|
type: string
|
|
1070
1095
|
state:
|
|
1071
1096
|
anyOf:
|
|
1072
|
-
-
|
|
1097
|
+
- maxLength: 255
|
|
1098
|
+
minLength: 1
|
|
1073
1099
|
type: string
|
|
1074
1100
|
- type: 'null'
|
|
1075
1101
|
description: The state of the contact
|
|
1076
1102
|
title: State
|
|
1077
1103
|
street:
|
|
1078
1104
|
description: The address of the contact
|
|
1105
|
+
maxLength: 255
|
|
1079
1106
|
minLength: 1
|
|
1080
1107
|
title: Street
|
|
1081
1108
|
type: string
|
|
1082
1109
|
title:
|
|
1083
1110
|
anyOf:
|
|
1084
|
-
-
|
|
1111
|
+
- maxLength: 255
|
|
1112
|
+
minLength: 1
|
|
1085
1113
|
type: string
|
|
1086
1114
|
- type: 'null'
|
|
1087
1115
|
description: The title of the contact
|
|
@@ -1185,6 +1213,7 @@ components:
|
|
|
1185
1213
|
type: array
|
|
1186
1214
|
city:
|
|
1187
1215
|
description: The city of the contact
|
|
1216
|
+
maxLength: 255
|
|
1188
1217
|
minLength: 1
|
|
1189
1218
|
title: City
|
|
1190
1219
|
type: string
|
|
@@ -1226,17 +1255,20 @@ components:
|
|
|
1226
1255
|
title: Fax
|
|
1227
1256
|
first_name:
|
|
1228
1257
|
description: The first name of the contact
|
|
1258
|
+
maxLength: 255
|
|
1229
1259
|
minLength: 1
|
|
1230
1260
|
title: First Name
|
|
1231
1261
|
type: string
|
|
1232
1262
|
last_name:
|
|
1233
1263
|
description: The last name of the contact
|
|
1264
|
+
maxLength: 255
|
|
1234
1265
|
minLength: 1
|
|
1235
1266
|
title: Last Name
|
|
1236
1267
|
type: string
|
|
1237
1268
|
org:
|
|
1238
1269
|
anyOf:
|
|
1239
|
-
-
|
|
1270
|
+
- maxLength: 255
|
|
1271
|
+
minLength: 1
|
|
1240
1272
|
type: string
|
|
1241
1273
|
- type: 'null'
|
|
1242
1274
|
description: The organization of the contact
|
|
@@ -1260,18 +1292,21 @@ components:
|
|
|
1260
1292
|
type: string
|
|
1261
1293
|
postal_code:
|
|
1262
1294
|
description: The postal code of the contact
|
|
1295
|
+
maxLength: 255
|
|
1263
1296
|
minLength: 1
|
|
1264
1297
|
title: Postal Code
|
|
1265
1298
|
type: string
|
|
1266
1299
|
state:
|
|
1267
1300
|
anyOf:
|
|
1268
|
-
-
|
|
1301
|
+
- maxLength: 255
|
|
1302
|
+
minLength: 1
|
|
1269
1303
|
type: string
|
|
1270
1304
|
- type: 'null'
|
|
1271
1305
|
description: The state of the contact
|
|
1272
1306
|
title: State
|
|
1273
1307
|
street:
|
|
1274
1308
|
description: The address of the contact
|
|
1309
|
+
maxLength: 255
|
|
1275
1310
|
minLength: 1
|
|
1276
1311
|
title: Street
|
|
1277
1312
|
type: string
|
|
@@ -1285,7 +1320,8 @@ components:
|
|
|
1285
1320
|
title: Tags
|
|
1286
1321
|
title:
|
|
1287
1322
|
anyOf:
|
|
1288
|
-
-
|
|
1323
|
+
- maxLength: 255
|
|
1324
|
+
minLength: 1
|
|
1289
1325
|
type: string
|
|
1290
1326
|
- type: 'null'
|
|
1291
1327
|
description: The title of the contact
|
|
@@ -1306,6 +1342,7 @@ components:
|
|
|
1306
1342
|
properties:
|
|
1307
1343
|
city:
|
|
1308
1344
|
description: The city of the contact
|
|
1345
|
+
maxLength: 255
|
|
1309
1346
|
minLength: 1
|
|
1310
1347
|
title: City
|
|
1311
1348
|
type: string
|
|
@@ -1347,17 +1384,20 @@ components:
|
|
|
1347
1384
|
title: Fax
|
|
1348
1385
|
first_name:
|
|
1349
1386
|
description: The first name of the contact
|
|
1387
|
+
maxLength: 255
|
|
1350
1388
|
minLength: 1
|
|
1351
1389
|
title: First Name
|
|
1352
1390
|
type: string
|
|
1353
1391
|
last_name:
|
|
1354
1392
|
description: The last name of the contact
|
|
1393
|
+
maxLength: 255
|
|
1355
1394
|
minLength: 1
|
|
1356
1395
|
title: Last Name
|
|
1357
1396
|
type: string
|
|
1358
1397
|
org:
|
|
1359
1398
|
anyOf:
|
|
1360
|
-
-
|
|
1399
|
+
- maxLength: 255
|
|
1400
|
+
minLength: 1
|
|
1361
1401
|
type: string
|
|
1362
1402
|
- type: 'null'
|
|
1363
1403
|
description: The organization of the contact
|
|
@@ -1381,24 +1421,28 @@ components:
|
|
|
1381
1421
|
type: string
|
|
1382
1422
|
postal_code:
|
|
1383
1423
|
description: The postal code of the contact
|
|
1424
|
+
maxLength: 255
|
|
1384
1425
|
minLength: 1
|
|
1385
1426
|
title: Postal Code
|
|
1386
1427
|
type: string
|
|
1387
1428
|
state:
|
|
1388
1429
|
anyOf:
|
|
1389
|
-
-
|
|
1430
|
+
- maxLength: 255
|
|
1431
|
+
minLength: 1
|
|
1390
1432
|
type: string
|
|
1391
1433
|
- type: 'null'
|
|
1392
1434
|
description: The state of the contact
|
|
1393
1435
|
title: State
|
|
1394
1436
|
street:
|
|
1395
1437
|
description: The address of the contact
|
|
1438
|
+
maxLength: 255
|
|
1396
1439
|
minLength: 1
|
|
1397
1440
|
title: Street
|
|
1398
1441
|
type: string
|
|
1399
1442
|
title:
|
|
1400
1443
|
anyOf:
|
|
1401
|
-
-
|
|
1444
|
+
- maxLength: 255
|
|
1445
|
+
minLength: 1
|
|
1402
1446
|
type: string
|
|
1403
1447
|
- type: 'null'
|
|
1404
1448
|
description: The title of the contact
|
|
@@ -4003,7 +4047,8 @@ components:
|
|
|
4003
4047
|
properties:
|
|
4004
4048
|
auth_code:
|
|
4005
4049
|
anyOf:
|
|
4006
|
-
-
|
|
4050
|
+
- maxLength: 255
|
|
4051
|
+
minLength: 1
|
|
4007
4052
|
type: string
|
|
4008
4053
|
- type: 'null'
|
|
4009
4054
|
description: The auth code for the domain
|
|
@@ -4123,6 +4168,7 @@ components:
|
|
|
4123
4168
|
description: The second level domain
|
|
4124
4169
|
examples:
|
|
4125
4170
|
- example
|
|
4171
|
+
maxLength: 255
|
|
4126
4172
|
minLength: 1
|
|
4127
4173
|
title: Sld
|
|
4128
4174
|
type: string
|
|
@@ -4148,6 +4194,7 @@ components:
|
|
|
4148
4194
|
description: The top level domain of the domain
|
|
4149
4195
|
examples:
|
|
4150
4196
|
- com
|
|
4197
|
+
maxLength: 255
|
|
4151
4198
|
minLength: 1
|
|
4152
4199
|
title: Tld
|
|
4153
4200
|
type: string
|
|
@@ -4766,7 +4813,8 @@ components:
|
|
|
4766
4813
|
properties:
|
|
4767
4814
|
auth_code:
|
|
4768
4815
|
anyOf:
|
|
4769
|
-
-
|
|
4816
|
+
- maxLength: 255
|
|
4817
|
+
minLength: 1
|
|
4770
4818
|
type: string
|
|
4771
4819
|
- type: 'null'
|
|
4772
4820
|
description: The new auth code for the domain
|
|
@@ -4840,7 +4888,8 @@ components:
|
|
|
4840
4888
|
properties:
|
|
4841
4889
|
auth_code:
|
|
4842
4890
|
anyOf:
|
|
4843
|
-
-
|
|
4891
|
+
- maxLength: 255
|
|
4892
|
+
minLength: 1
|
|
4844
4893
|
type: string
|
|
4845
4894
|
- type: 'null'
|
|
4846
4895
|
description: Override auth code for this domain
|
|
@@ -4972,7 +5021,8 @@ components:
|
|
|
4972
5021
|
properties:
|
|
4973
5022
|
auth_code:
|
|
4974
5023
|
anyOf:
|
|
4975
|
-
-
|
|
5024
|
+
- maxLength: 255
|
|
5025
|
+
minLength: 1
|
|
4976
5026
|
type: string
|
|
4977
5027
|
- type: 'null'
|
|
4978
5028
|
description: The new auth code for the domain
|
|
@@ -6349,6 +6399,26 @@ components:
|
|
|
6349
6399
|
- commands
|
|
6350
6400
|
title: JobBatchRequest
|
|
6351
6401
|
type: object
|
|
6402
|
+
JobBatchRetryResponse:
|
|
6403
|
+
properties:
|
|
6404
|
+
batch_id:
|
|
6405
|
+
description: TypeID identifying this batch
|
|
6406
|
+
examples:
|
|
6407
|
+
- batch_01h45ytscbebyvny4gc8cr8ma2
|
|
6408
|
+
format: typeid
|
|
6409
|
+
pattern: ^batch_[0-7][0-9a-hjkmnpq-tv-z]{25}$
|
|
6410
|
+
title: Batch Id
|
|
6411
|
+
type: string
|
|
6412
|
+
x-typeid-prefix: batch
|
|
6413
|
+
retried_count:
|
|
6414
|
+
description: Number of FAILED/DEAD_LETTER jobs reset to QUEUED for retry
|
|
6415
|
+
title: Retried Count
|
|
6416
|
+
type: integer
|
|
6417
|
+
required:
|
|
6418
|
+
- batch_id
|
|
6419
|
+
- retried_count
|
|
6420
|
+
title: JobBatchRetryResponse
|
|
6421
|
+
type: object
|
|
6352
6422
|
JobBatchStatusResponse:
|
|
6353
6423
|
properties:
|
|
6354
6424
|
batch_id:
|
|
@@ -7152,14 +7222,16 @@ components:
|
|
|
7152
7222
|
properties:
|
|
7153
7223
|
address_1:
|
|
7154
7224
|
anyOf:
|
|
7155
|
-
-
|
|
7225
|
+
- maxLength: 255
|
|
7226
|
+
minLength: 1
|
|
7156
7227
|
type: string
|
|
7157
7228
|
- type: 'null'
|
|
7158
7229
|
description: First line of the organization's address.
|
|
7159
7230
|
title: Address 1
|
|
7160
7231
|
address_2:
|
|
7161
7232
|
anyOf:
|
|
7162
|
-
-
|
|
7233
|
+
- maxLength: 255
|
|
7234
|
+
minLength: 1
|
|
7163
7235
|
type: string
|
|
7164
7236
|
- type: 'null'
|
|
7165
7237
|
description: Second line of the organization's address.
|
|
@@ -7180,7 +7252,8 @@ components:
|
|
|
7180
7252
|
title: Business Number
|
|
7181
7253
|
city:
|
|
7182
7254
|
anyOf:
|
|
7183
|
-
-
|
|
7255
|
+
- maxLength: 255
|
|
7256
|
+
minLength: 1
|
|
7184
7257
|
type: string
|
|
7185
7258
|
- type: 'null'
|
|
7186
7259
|
description: City of the organization's address.
|
|
@@ -7226,6 +7299,7 @@ components:
|
|
|
7226
7299
|
title: Keycloak Organization Id
|
|
7227
7300
|
name:
|
|
7228
7301
|
description: Name of the organization.
|
|
7302
|
+
maxLength: 255
|
|
7229
7303
|
minLength: 1
|
|
7230
7304
|
title: Name
|
|
7231
7305
|
type: string
|
|
@@ -7259,7 +7333,8 @@ components:
|
|
|
7259
7333
|
title: Postal Code
|
|
7260
7334
|
state:
|
|
7261
7335
|
anyOf:
|
|
7262
|
-
-
|
|
7336
|
+
- maxLength: 255
|
|
7337
|
+
minLength: 1
|
|
7263
7338
|
type: string
|
|
7264
7339
|
- type: 'null'
|
|
7265
7340
|
description: State or province of the organization's address.
|
|
@@ -7435,14 +7510,16 @@ components:
|
|
|
7435
7510
|
properties:
|
|
7436
7511
|
address_1:
|
|
7437
7512
|
anyOf:
|
|
7438
|
-
-
|
|
7513
|
+
- maxLength: 255
|
|
7514
|
+
minLength: 1
|
|
7439
7515
|
type: string
|
|
7440
7516
|
- type: 'null'
|
|
7441
7517
|
description: First line of the organization's address.
|
|
7442
7518
|
title: Address 1
|
|
7443
7519
|
address_2:
|
|
7444
7520
|
anyOf:
|
|
7445
|
-
-
|
|
7521
|
+
- maxLength: 255
|
|
7522
|
+
minLength: 1
|
|
7446
7523
|
type: string
|
|
7447
7524
|
- type: 'null'
|
|
7448
7525
|
description: Second line of the organization's address.
|
|
@@ -7464,7 +7541,8 @@ components:
|
|
|
7464
7541
|
title: Business Number
|
|
7465
7542
|
city:
|
|
7466
7543
|
anyOf:
|
|
7467
|
-
-
|
|
7544
|
+
- maxLength: 255
|
|
7545
|
+
minLength: 1
|
|
7468
7546
|
type: string
|
|
7469
7547
|
- type: 'null'
|
|
7470
7548
|
description: City of the organization's address.
|
|
@@ -7492,6 +7570,7 @@ components:
|
|
|
7492
7570
|
title: Default Locale
|
|
7493
7571
|
name:
|
|
7494
7572
|
description: Name of the organization.
|
|
7573
|
+
maxLength: 255
|
|
7495
7574
|
minLength: 1
|
|
7496
7575
|
title: Name
|
|
7497
7576
|
type: string
|
|
@@ -7516,7 +7595,8 @@ components:
|
|
|
7516
7595
|
title: Postal Code
|
|
7517
7596
|
state:
|
|
7518
7597
|
anyOf:
|
|
7519
|
-
-
|
|
7598
|
+
- maxLength: 255
|
|
7599
|
+
minLength: 1
|
|
7520
7600
|
type: string
|
|
7521
7601
|
- type: 'null'
|
|
7522
7602
|
description: State or province of the organization's address.
|
|
@@ -7595,14 +7675,16 @@ components:
|
|
|
7595
7675
|
properties:
|
|
7596
7676
|
address_1:
|
|
7597
7677
|
anyOf:
|
|
7598
|
-
-
|
|
7678
|
+
- maxLength: 255
|
|
7679
|
+
minLength: 1
|
|
7599
7680
|
type: string
|
|
7600
7681
|
- type: 'null'
|
|
7601
7682
|
description: First line of the organization's address.
|
|
7602
7683
|
title: Address 1
|
|
7603
7684
|
address_2:
|
|
7604
7685
|
anyOf:
|
|
7605
|
-
-
|
|
7686
|
+
- maxLength: 255
|
|
7687
|
+
minLength: 1
|
|
7606
7688
|
type: string
|
|
7607
7689
|
- type: 'null'
|
|
7608
7690
|
description: Second line of the organization's address.
|
|
@@ -7618,7 +7700,8 @@ components:
|
|
|
7618
7700
|
title: Business Number
|
|
7619
7701
|
city:
|
|
7620
7702
|
anyOf:
|
|
7621
|
-
-
|
|
7703
|
+
- maxLength: 255
|
|
7704
|
+
minLength: 1
|
|
7622
7705
|
type: string
|
|
7623
7706
|
- type: 'null'
|
|
7624
7707
|
description: City of the organization's address.
|
|
@@ -7642,35 +7725,40 @@ components:
|
|
|
7642
7725
|
title: Default Locale
|
|
7643
7726
|
name:
|
|
7644
7727
|
anyOf:
|
|
7645
|
-
-
|
|
7728
|
+
- maxLength: 255
|
|
7729
|
+
minLength: 1
|
|
7646
7730
|
type: string
|
|
7647
7731
|
- type: 'null'
|
|
7648
7732
|
description: Name of the organization.
|
|
7649
7733
|
title: Name
|
|
7650
7734
|
postal_code:
|
|
7651
7735
|
anyOf:
|
|
7652
|
-
-
|
|
7736
|
+
- maxLength: 255
|
|
7737
|
+
minLength: 1
|
|
7653
7738
|
type: string
|
|
7654
7739
|
- type: 'null'
|
|
7655
7740
|
description: Postal code of the organization's address.
|
|
7656
7741
|
title: Postal Code
|
|
7657
7742
|
state:
|
|
7658
7743
|
anyOf:
|
|
7659
|
-
-
|
|
7744
|
+
- maxLength: 255
|
|
7745
|
+
minLength: 1
|
|
7660
7746
|
type: string
|
|
7661
7747
|
- type: 'null'
|
|
7662
7748
|
description: State or province of the organization's address.
|
|
7663
7749
|
title: State
|
|
7664
7750
|
tax_id:
|
|
7665
7751
|
anyOf:
|
|
7666
|
-
-
|
|
7752
|
+
- maxLength: 255
|
|
7753
|
+
minLength: 1
|
|
7667
7754
|
type: string
|
|
7668
7755
|
- type: 'null'
|
|
7669
7756
|
description: Tax ID of the organization.
|
|
7670
7757
|
title: Tax Id
|
|
7671
7758
|
tax_id_type:
|
|
7672
7759
|
anyOf:
|
|
7673
|
-
-
|
|
7760
|
+
- maxLength: 255
|
|
7761
|
+
minLength: 1
|
|
7674
7762
|
type: string
|
|
7675
7763
|
- type: 'null'
|
|
7676
7764
|
description: Type of tax ID for the organization.
|
|
@@ -7697,14 +7785,16 @@ components:
|
|
|
7697
7785
|
$ref: '#/components/schemas/BillingPlan'
|
|
7698
7786
|
address_1:
|
|
7699
7787
|
anyOf:
|
|
7700
|
-
-
|
|
7788
|
+
- maxLength: 255
|
|
7789
|
+
minLength: 1
|
|
7701
7790
|
type: string
|
|
7702
7791
|
- type: 'null'
|
|
7703
7792
|
description: First line of the organization's address.
|
|
7704
7793
|
title: Address 1
|
|
7705
7794
|
address_2:
|
|
7706
7795
|
anyOf:
|
|
7707
|
-
-
|
|
7796
|
+
- maxLength: 255
|
|
7797
|
+
minLength: 1
|
|
7708
7798
|
type: string
|
|
7709
7799
|
- type: 'null'
|
|
7710
7800
|
description: Second line of the organization's address.
|
|
@@ -7727,7 +7817,8 @@ components:
|
|
|
7727
7817
|
title: Business Number
|
|
7728
7818
|
city:
|
|
7729
7819
|
anyOf:
|
|
7730
|
-
-
|
|
7820
|
+
- maxLength: 255
|
|
7821
|
+
minLength: 1
|
|
7731
7822
|
type: string
|
|
7732
7823
|
- type: 'null'
|
|
7733
7824
|
description: City of the organization's address.
|
|
@@ -7773,6 +7864,7 @@ components:
|
|
|
7773
7864
|
title: Keycloak Organization Id
|
|
7774
7865
|
name:
|
|
7775
7866
|
description: Name of the organization.
|
|
7867
|
+
maxLength: 255
|
|
7776
7868
|
minLength: 1
|
|
7777
7869
|
title: Name
|
|
7778
7870
|
type: string
|
|
@@ -7806,7 +7898,8 @@ components:
|
|
|
7806
7898
|
title: Postal Code
|
|
7807
7899
|
state:
|
|
7808
7900
|
anyOf:
|
|
7809
|
-
-
|
|
7901
|
+
- maxLength: 255
|
|
7902
|
+
minLength: 1
|
|
7810
7903
|
type: string
|
|
7811
7904
|
- type: 'null'
|
|
7812
7905
|
description: State or province of the organization's address.
|
|
@@ -9531,6 +9624,7 @@ components:
|
|
|
9531
9624
|
title: Description
|
|
9532
9625
|
label:
|
|
9533
9626
|
description: The label of the tag
|
|
9627
|
+
maxLength: 255
|
|
9534
9628
|
minLength: 1
|
|
9535
9629
|
title: Label
|
|
9536
9630
|
type: string
|
|
@@ -9616,6 +9710,7 @@ components:
|
|
|
9616
9710
|
description: The color of the tag
|
|
9617
9711
|
label:
|
|
9618
9712
|
description: The label of the tag
|
|
9713
|
+
maxLength: 255
|
|
9619
9714
|
minLength: 1
|
|
9620
9715
|
title: Label
|
|
9621
9716
|
type: string
|
|
@@ -9659,6 +9754,7 @@ components:
|
|
|
9659
9754
|
title: Description
|
|
9660
9755
|
label:
|
|
9661
9756
|
description: The label of the tag
|
|
9757
|
+
maxLength: 255
|
|
9662
9758
|
minLength: 1
|
|
9663
9759
|
title: Label
|
|
9664
9760
|
type: string
|
|
@@ -10329,6 +10425,7 @@ components:
|
|
|
10329
10425
|
type: string
|
|
10330
10426
|
first_name:
|
|
10331
10427
|
description: The user's first name
|
|
10428
|
+
maxLength: 255
|
|
10332
10429
|
minLength: 1
|
|
10333
10430
|
title: First Name
|
|
10334
10431
|
type: string
|
|
@@ -10340,6 +10437,7 @@ components:
|
|
|
10340
10437
|
title: Keycloak User Id
|
|
10341
10438
|
last_name:
|
|
10342
10439
|
description: The user's last name
|
|
10440
|
+
maxLength: 255
|
|
10343
10441
|
minLength: 1
|
|
10344
10442
|
title: Last Name
|
|
10345
10443
|
type: string
|
|
@@ -10457,11 +10555,13 @@ components:
|
|
|
10457
10555
|
type: string
|
|
10458
10556
|
first_name:
|
|
10459
10557
|
description: The user's first name
|
|
10558
|
+
maxLength: 255
|
|
10460
10559
|
minLength: 1
|
|
10461
10560
|
title: First Name
|
|
10462
10561
|
type: string
|
|
10463
10562
|
last_name:
|
|
10464
10563
|
description: The user's last name
|
|
10564
|
+
maxLength: 255
|
|
10465
10565
|
minLength: 1
|
|
10466
10566
|
title: Last Name
|
|
10467
10567
|
type: string
|
|
@@ -10531,11 +10631,13 @@ components:
|
|
|
10531
10631
|
type: string
|
|
10532
10632
|
first_name:
|
|
10533
10633
|
description: The user's first name
|
|
10634
|
+
maxLength: 255
|
|
10534
10635
|
minLength: 1
|
|
10535
10636
|
title: First Name
|
|
10536
10637
|
type: string
|
|
10537
10638
|
last_name:
|
|
10538
10639
|
description: The user's last name
|
|
10640
|
+
maxLength: 255
|
|
10539
10641
|
minLength: 1
|
|
10540
10642
|
title: Last Name
|
|
10541
10643
|
type: string
|
|
@@ -10616,11 +10718,13 @@ components:
|
|
|
10616
10718
|
type: string
|
|
10617
10719
|
first_name:
|
|
10618
10720
|
description: The user's first name
|
|
10721
|
+
maxLength: 255
|
|
10619
10722
|
minLength: 1
|
|
10620
10723
|
title: First Name
|
|
10621
10724
|
type: string
|
|
10622
10725
|
last_name:
|
|
10623
10726
|
description: The user's last name
|
|
10727
|
+
maxLength: 255
|
|
10624
10728
|
minLength: 1
|
|
10625
10729
|
title: Last Name
|
|
10626
10730
|
type: string
|
|
@@ -10753,14 +10857,16 @@ components:
|
|
|
10753
10857
|
title: Email
|
|
10754
10858
|
first_name:
|
|
10755
10859
|
anyOf:
|
|
10756
|
-
-
|
|
10860
|
+
- maxLength: 255
|
|
10861
|
+
minLength: 1
|
|
10757
10862
|
type: string
|
|
10758
10863
|
- type: 'null'
|
|
10759
10864
|
description: The user's first name
|
|
10760
10865
|
title: First Name
|
|
10761
10866
|
last_name:
|
|
10762
10867
|
anyOf:
|
|
10763
|
-
-
|
|
10868
|
+
- maxLength: 255
|
|
10869
|
+
minLength: 1
|
|
10764
10870
|
type: string
|
|
10765
10871
|
- type: 'null'
|
|
10766
10872
|
description: The user's last name
|
|
@@ -10790,7 +10896,8 @@ components:
|
|
|
10790
10896
|
title: User Attributes
|
|
10791
10897
|
username:
|
|
10792
10898
|
anyOf:
|
|
10793
|
-
-
|
|
10899
|
+
- maxLength: 255
|
|
10900
|
+
minLength: 1
|
|
10794
10901
|
type: string
|
|
10795
10902
|
- type: 'null'
|
|
10796
10903
|
description: The user's unique username
|
|
@@ -10818,11 +10925,13 @@ components:
|
|
|
10818
10925
|
type: string
|
|
10819
10926
|
first_name:
|
|
10820
10927
|
description: The user's first name
|
|
10928
|
+
maxLength: 255
|
|
10821
10929
|
minLength: 1
|
|
10822
10930
|
title: First Name
|
|
10823
10931
|
type: string
|
|
10824
10932
|
last_name:
|
|
10825
10933
|
description: The user's last name
|
|
10934
|
+
maxLength: 255
|
|
10826
10935
|
minLength: 1
|
|
10827
10936
|
title: Last Name
|
|
10828
10937
|
type: string
|
|
@@ -11216,7 +11325,7 @@ info:
|
|
|
11216
11325
|
\n\n"
|
|
11217
11326
|
summary: OpusDNS - your gateway to a seamless domain management experience.
|
|
11218
11327
|
title: OpusDNS API
|
|
11219
|
-
version: 2026-05-
|
|
11328
|
+
version: 2026-05-14-142832
|
|
11220
11329
|
x-logo:
|
|
11221
11330
|
altText: OpusDNS API Reference
|
|
11222
11331
|
url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
|
|
@@ -20978,6 +21087,66 @@ paths:
|
|
|
20978
21087
|
summary: Resume a paused job
|
|
20979
21088
|
tags:
|
|
20980
21089
|
- jobs
|
|
21090
|
+
/v1/job/{job_id}/retry:
|
|
21091
|
+
post:
|
|
21092
|
+
operationId: retry_job_v1_job__job_id__retry_post
|
|
21093
|
+
parameters:
|
|
21094
|
+
- description: Job ID
|
|
21095
|
+
in: path
|
|
21096
|
+
name: job_id
|
|
21097
|
+
required: true
|
|
21098
|
+
schema:
|
|
21099
|
+
examples:
|
|
21100
|
+
- job_01h45ytscbebyvny4gc8cr8ma2
|
|
21101
|
+
format: typeid
|
|
21102
|
+
pattern: ^job_[0-7][0-9a-hjkmnpq-tv-z]{25}$
|
|
21103
|
+
title: Job Id
|
|
21104
|
+
type: string
|
|
21105
|
+
x-typeid-prefix: job
|
|
21106
|
+
responses:
|
|
21107
|
+
'200':
|
|
21108
|
+
content:
|
|
21109
|
+
application/json:
|
|
21110
|
+
schema:
|
|
21111
|
+
$ref: '#/components/schemas/JobResponse'
|
|
21112
|
+
description: Successful Response
|
|
21113
|
+
'404':
|
|
21114
|
+
content:
|
|
21115
|
+
application/problem+json:
|
|
21116
|
+
example:
|
|
21117
|
+
code: ERROR_JOB_NOT_FOUND
|
|
21118
|
+
detail: No job found with id 'Additional error context.'
|
|
21119
|
+
job_id: Additional error context.
|
|
21120
|
+
status: 404
|
|
21121
|
+
title: Batch Operation Error
|
|
21122
|
+
type: job-not-found
|
|
21123
|
+
schema:
|
|
21124
|
+
$ref: '#/components/schemas/Problem'
|
|
21125
|
+
description: Not Found
|
|
21126
|
+
'409':
|
|
21127
|
+
content:
|
|
21128
|
+
application/problem+json:
|
|
21129
|
+
example:
|
|
21130
|
+
code: ERROR_JOB_STATUS_CONFLICT
|
|
21131
|
+
detail: Additional error context.
|
|
21132
|
+
status: 409
|
|
21133
|
+
title: Batch Operation Error
|
|
21134
|
+
type: job-status-conflict
|
|
21135
|
+
schema:
|
|
21136
|
+
$ref: '#/components/schemas/Problem'
|
|
21137
|
+
description: Conflict
|
|
21138
|
+
'422':
|
|
21139
|
+
content:
|
|
21140
|
+
application/problem+json:
|
|
21141
|
+
schema:
|
|
21142
|
+
$ref: '#/components/schemas/HTTPValidationError'
|
|
21143
|
+
description: Validation Error
|
|
21144
|
+
security:
|
|
21145
|
+
- OAuth2PasswordBearer: []
|
|
21146
|
+
- APIKeyHeader: []
|
|
21147
|
+
summary: Retry a failed or dead-lettered job
|
|
21148
|
+
tags:
|
|
21149
|
+
- jobs
|
|
20981
21150
|
/v1/jobs:
|
|
20982
21151
|
get:
|
|
20983
21152
|
operationId: list_batches_v1_jobs_get
|
|
@@ -22039,6 +22208,72 @@ paths:
|
|
|
22039
22208
|
summary: Resume all paused jobs in a batch
|
|
22040
22209
|
tags:
|
|
22041
22210
|
- jobs
|
|
22211
|
+
/v1/jobs/{batch_id}/retry:
|
|
22212
|
+
post:
|
|
22213
|
+
operationId: retry_batch_v1_jobs__batch_id__retry_post
|
|
22214
|
+
parameters:
|
|
22215
|
+
- description: Batch ID
|
|
22216
|
+
in: path
|
|
22217
|
+
name: batch_id
|
|
22218
|
+
required: true
|
|
22219
|
+
schema:
|
|
22220
|
+
examples:
|
|
22221
|
+
- batch_01h45ytscbebyvny4gc8cr8ma2
|
|
22222
|
+
format: typeid
|
|
22223
|
+
pattern: ^batch_[0-7][0-9a-hjkmnpq-tv-z]{25}$
|
|
22224
|
+
title: Batch Id
|
|
22225
|
+
type: string
|
|
22226
|
+
x-typeid-prefix: batch
|
|
22227
|
+
- description: 'Optional repeatable filter: only retry jobs whose error_class
|
|
22228
|
+
matches one of these values. Example: `?error_class=BillingInsufficientFundsError`
|
|
22229
|
+
to retry only insufficient-funds failures. Omit to retry all failed/dead-lettered
|
|
22230
|
+
jobs in the batch.'
|
|
22231
|
+
in: query
|
|
22232
|
+
name: error_class
|
|
22233
|
+
required: false
|
|
22234
|
+
schema:
|
|
22235
|
+
anyOf:
|
|
22236
|
+
- items:
|
|
22237
|
+
type: string
|
|
22238
|
+
type: array
|
|
22239
|
+
- type: 'null'
|
|
22240
|
+
description: 'Optional repeatable filter: only retry jobs whose error_class
|
|
22241
|
+
matches one of these values. Example: `?error_class=BillingInsufficientFundsError`
|
|
22242
|
+
to retry only insufficient-funds failures. Omit to retry all failed/dead-lettered
|
|
22243
|
+
jobs in the batch.'
|
|
22244
|
+
title: Error Class
|
|
22245
|
+
responses:
|
|
22246
|
+
'200':
|
|
22247
|
+
content:
|
|
22248
|
+
application/json:
|
|
22249
|
+
schema:
|
|
22250
|
+
$ref: '#/components/schemas/JobBatchRetryResponse'
|
|
22251
|
+
description: Successful Response
|
|
22252
|
+
'404':
|
|
22253
|
+
content:
|
|
22254
|
+
application/problem+json:
|
|
22255
|
+
example:
|
|
22256
|
+
code: ERROR_BATCH_NOT_FOUND
|
|
22257
|
+
correlation_id: Additional error context.
|
|
22258
|
+
detail: No batch found with correlation_id 'Additional error context.'
|
|
22259
|
+
status: 404
|
|
22260
|
+
title: Batch Operation Error
|
|
22261
|
+
type: batch-not-found
|
|
22262
|
+
schema:
|
|
22263
|
+
$ref: '#/components/schemas/Problem'
|
|
22264
|
+
description: Not Found
|
|
22265
|
+
'422':
|
|
22266
|
+
content:
|
|
22267
|
+
application/problem+json:
|
|
22268
|
+
schema:
|
|
22269
|
+
$ref: '#/components/schemas/HTTPValidationError'
|
|
22270
|
+
description: Validation Error
|
|
22271
|
+
security:
|
|
22272
|
+
- OAuth2PasswordBearer: []
|
|
22273
|
+
- APIKeyHeader: []
|
|
22274
|
+
summary: Retry failed and dead-lettered jobs in a batch
|
|
22275
|
+
tags:
|
|
22276
|
+
- jobs
|
|
22042
22277
|
/v1/organizations:
|
|
22043
22278
|
get:
|
|
22044
22279
|
description: Retrieves a paginated list of organizations under the current organization
|
|
@@ -23223,7 +23458,8 @@ paths:
|
|
|
23223
23458
|
required: false
|
|
23224
23459
|
schema:
|
|
23225
23460
|
anyOf:
|
|
23226
|
-
-
|
|
23461
|
+
- maxLength: 255
|
|
23462
|
+
minLength: 1
|
|
23227
23463
|
type: string
|
|
23228
23464
|
- type: 'null'
|
|
23229
23465
|
title: Product Reference
|
|
@@ -24931,25 +25167,60 @@ tags:
|
|
|
24931
25167
|
\ **Review results** \u2014 `GET /v1/jobs/{batch_id}/jobs` to see individual job\
|
|
24932
25168
|
\ outcomes\n\n### Managing Batches\n\n- **Pause** \u2014 `POST /v1/jobs/{batch_id}/pause`\
|
|
24933
25169
|
\ pauses all eligible jobs in the batch\n- **Resume** \u2014 `POST /v1/jobs/{batch_id}/resume`\
|
|
24934
|
-
\ resumes all paused jobs\n- **
|
|
24935
|
-
\
|
|
24936
|
-
|
|
24937
|
-
\
|
|
24938
|
-
\
|
|
24939
|
-
\
|
|
24940
|
-
\
|
|
24941
|
-
\
|
|
24942
|
-
\
|
|
24943
|
-
|
|
24944
|
-
\
|
|
24945
|
-
\
|
|
24946
|
-
\
|
|
24947
|
-
\
|
|
24948
|
-
\ in
|
|
24949
|
-
\
|
|
24950
|
-
\
|
|
24951
|
-
\
|
|
24952
|
-
\
|
|
25170
|
+
\ resumes all paused jobs\n- **Retry** \u2014 `POST /v1/jobs/{batch_id}/retry`\
|
|
25171
|
+
\ retries failed and dead-lettered jobs in the batch (see [Retrying Failed Jobs](#retrying-failed-jobs))\n\
|
|
25172
|
+
- **Cancel** \u2014 `DELETE /v1/jobs/{batch_id}` cancels all pending jobs in the\
|
|
25173
|
+
\ batch\n\nIndividual jobs can also be paused, resumed, retried, or canceled via\
|
|
25174
|
+
\ the `/v1/job/{job_id}` endpoints.\n\n### Retrying Failed Jobs\n\nIf jobs in\
|
|
25175
|
+
\ a batch end up in `failed` or `dead_letter` state \u2014 for example because\
|
|
25176
|
+
\ the account had insufficient funds at the time the batch was processed \u2014\
|
|
25177
|
+
\ you can re-attempt them without rebuilding the batch from scratch.\n\n- **Single\
|
|
25178
|
+
\ job:** `POST /v1/job/{job_id}/retry`\n- **Whole batch:** `POST /v1/jobs/{batch_id}/retry`\n\
|
|
25179
|
+
\n#### What gets retried\n\nOnly jobs in `failed` or `dead_letter` status are\
|
|
25180
|
+
\ eligible. Jobs in any other status are left unchanged:\n\n- `succeeded` \u2014\
|
|
25181
|
+
\ already complete; retrying returns **409 Conflict**\n- `canceled` \u2014 you\
|
|
25182
|
+
\ explicitly canceled these, so the retry won't undo that; returns **409 Conflict**\
|
|
25183
|
+
\ (single) or is silently skipped (batch)\n- `queued`, `blocked`, `paused`, `running`\
|
|
25184
|
+
\ \u2014 still in progress; not touched\n\nCalling batch retry on a mixed-state\
|
|
25185
|
+
\ batch returns `retried_count` (the number of `failed` / `dead_letter` jobs that\
|
|
25186
|
+
\ were re-queued); everything else is left alone. If the batch has no retryable\
|
|
25187
|
+
\ jobs, `retried_count` is `0`.\n\n#### What happens to a retried job\n\nEach\
|
|
25188
|
+
\ retried job is reset to a fresh attempt:\n\n- `status` \u2192 `queued`\n- `attempts`\
|
|
25189
|
+
\ \u2192 `0`\n- `not_before` \u2192 now\n- `error_class` and `error_message` \u2192\
|
|
25190
|
+
\ cleared\n- The job is republished for worker pickup\n\nThe original `payload`,\
|
|
25191
|
+
\ `idempotency_key`, `correlation_id` (batch id), `max_attempts`, and backoff\
|
|
25192
|
+
\ configuration are preserved. Each retry is processed under the same worker idempotency\
|
|
25193
|
+
\ guarantees as the original \u2014 for billing operations specifically, a retried\
|
|
25194
|
+
\ job will not double-charge an account that was already debited.\n\n#### Filtering\
|
|
25195
|
+
\ by error type\n\nA batch may contain a mix of failures that you do and don't\
|
|
25196
|
+
\ want to retry. For example, after adding funds to your account, you may want\
|
|
25197
|
+
\ to retry only the jobs that failed with `BillingInsufficientFundsError`, while\
|
|
25198
|
+
\ leaving alone jobs that failed for other reasons (e.g. an invalid domain name\
|
|
25199
|
+
\ that should not be re-attempted).\n\nPass one or more `error_class` query parameters\
|
|
25200
|
+
\ to filter:\n\n```\nPOST /v1/jobs/{batch_id}/retry?error_class=BillingInsufficientFundsError\n\
|
|
25201
|
+
POST /v1/jobs/{batch_id}/retry?error_class=BillingInsufficientFundsError&error_class=DomainRegistryTemporaryError\n\
|
|
25202
|
+
```\n\nMultiple values are OR'd \u2014 a job is retried if its `error_class` matches\
|
|
25203
|
+
\ **any** of the supplied values. Omitting the filter retries all `failed` and\
|
|
25204
|
+
\ `dead_letter` jobs in the batch.\n\nThe `error_class` for each failed job is\
|
|
25205
|
+
\ visible on the individual job response (`GET /v1/jobs/{batch_id}/jobs`), so\
|
|
25206
|
+
\ the typical flow is:\n\n1. List the failed jobs in the batch and group by `error_class`.\n\
|
|
25207
|
+
2. Determine which failures are recoverable.\n3. Call retry with the relevant\
|
|
25208
|
+
\ `error_class` filter.\n\n### Limits\n\n- Maximum **50,000 commands** per batch\n\
|
|
25209
|
+
- Bulk commands support up to **1,000 instances** per command\n\n### Scheduling\n\
|
|
25210
|
+
\nUse `not_before` to schedule batch execution for a future time (UTC timestamp).\
|
|
25211
|
+
\ If not provided, processing begins as soon as a worker is available.\n\n###\
|
|
25212
|
+
\ Idempotency\n\nEach command can include an optional `idempotency_key` to prevent\
|
|
25213
|
+
\ duplicate execution. If a command with the same idempotency key has already\
|
|
25214
|
+
\ been processed, it will be skipped.\n\n### Domain Status Updates in Batches\n\
|
|
25215
|
+
\nThe `domain_update` and `domain_update_bulk` commands support two mutually exclusive\
|
|
25216
|
+
\ approaches for modifying domain statuses. These work the same way as the `PATCH\
|
|
25217
|
+
\ /v1/domains/{domain_reference}` endpoint \u2014 see the [Domain management](#tag/Domain-management)\
|
|
25218
|
+
\ documentation for full details on `statuses` vs `status_changes`.\n\n#### Using\
|
|
25219
|
+
\ `status_changes` in bulk templates\n\nThe `domain_update_bulk` command is particularly\
|
|
25220
|
+
\ useful with `status_changes` when you need to apply the same relative status\
|
|
25221
|
+
\ change across many domains. Set `status_changes` in the **template** and list\
|
|
25222
|
+
\ the target domains as **instances**. Each instance identifies a domain by either\
|
|
25223
|
+
\ `name` or `domain_id` (but not both):\n\n```json\n{\n \"command\": \"domain_update_bulk\"\
|
|
24953
25224
|
,\n \"payload\": {\n \"template\": {\n \"status_changes\": {\n \
|
|
24954
25225
|
\ \"add\": [\"clientTransferProhibited\"]\n }\n },\n \"instances\"\
|
|
24955
25226
|
: [\n { \"name\": \"example.com\" },\n { \"name\": \"example.net\" },\n\
|