-
Notifications
You must be signed in to change notification settings - Fork 8
/
openapi.json
3283 lines (3283 loc) · 153 KB
/
openapi.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
{
"openapi": "3.0.0",
"externalDocs": {
"description": "See documentation for Akamai's Sandbox API",
"url": "https://techdocs.akamai.com/sandbox/reference"
},
"info": {
"title": "Akamai: Sandbox API",
"version": "v0",
"license": {
"name": "Apache 2.0",
"url": "https://www.apache.org/licenses/LICENSE-2.0.html"
}
},
"paths": {
"/sandboxes": {
"post": {
"description": "You can create a sandbox based on an existing `property`, `hostname`, or property `version`. Refer to the example JSONs for each use case in the [Recipes](https://techdocs.akamai.com/sandbox/recipes). In order to create a sandbox with this method, you need to have an API client for the `Sandbox API` with read-write access and Property Manager authorization enabled in Control Center.",
"operationId": "post-sandbox",
"summary": "Create a sandbox",
"tags": [
"Sandboxes"
],
"externalDocs": {
"description": "See documentation for this operation in Akamai's Sandbox API",
"url": "https://techdocs.akamai.com/sandbox/reference/post-sandbox"
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"example": {
"isClonable": true,
"name": "Sandbox-123",
"property": {
"propertyName": "exampledevops.com",
"propertyVersion": 12345
}
},
"schema": {
"additionalProperties": false,
"description": "Create a JSON request body including data members as described in the table below.",
"type": "object",
"required": [
"property"
],
"properties": {
"isClonable": {
"default": false,
"description": "Indicates whether the sandbox can be cloned by other developers.",
"example": "{{isClonable}}",
"type": "boolean"
},
"name": {
"description": "Descriptive name for the new sandbox. If you do not specify a name, the default name will be the `sandboxId`. You will get an error message if the name is not unique.",
"example": "{{name}}",
"type": "string"
},
"property": {
"additionalProperties": false,
"description": "Contains information about the property within the sandbox.",
"minProperties": 1,
"type": "object",
"properties": {
"contractId": {
"description": "The identifier you can use to create a sandbox from a specific contract. If you use this, you also need to specify the `groupId`.",
"type": "string"
},
"cpcode": {
"description": "Unique code that enables you to isolate sandbox traffic in report data. If you do not specify a value, the system creates one.",
"type": "number"
},
"edgeHostname": {
"description": "The edge hostname for the property as configured in Property Manager. May be specified instead of `propertyId`, `hostname`, or `propertyName`.",
"type": "string"
},
"groupId": {
"description": "The identifier you can use to create a sandbox from a specific group. If you use this, you also need to specify the `contractId`.",
"type": "string"
},
"hostname": {
"description": "The hostname for the property as configured in Property Manager. May be specified instead of `propertyId`, `edgeHostname`, or `propertyName`.",
"type": "string"
},
"propertyId": {
"description": "The unique identifier for the property as it appears in Property Manager. May be specified instead of `hostname`, `edgeHostname`, or `propertyName`.",
"type": "string"
},
"propertyName": {
"description": "The name of the property as it appears in Property Manager. May be specified instead of `propertyId`, `edgeHostname`, or `hostname`.",
"type": "string"
},
"propertyVersion": {
"description": "If not specified, the API uses the version that is active in production. If an active version is not found, the API uses the most recent version.",
"type": "number"
},
"requestHostnames": {
"description": "Specifies the hostnames for the request. If you try to create a sandbox property with a `requestHostname` that is not already contained in the property configuration, you may get unexpected results. The Sandbox API automatically converts any specified request hostnames to lower case.",
"type": "array",
"items": {
"type": "string"
}
},
"ruleFormat": {
"description": "Specifies the rule format. The rule format is a dated version of the rule object in a property configuration. For more information, refer to the [Property Manager API](https://developer.akamai.com/api/core_features/property_manager/v1.html#understandingruleformats).",
"type": "string"
},
"rules": {
"description": "Defines how your website and applications process requests and the behaviors to apply to those requests. Include a `rules` object if you want to apply specific rules to test within your sandbox. The content-handling rules are defined in the [Property Manager API](https://techdocs.akamai.com/property-mgr/reference/rule-trees).",
"type": "object"
}
}
}
},
"x-akamai": {
"file-path": "schemas/sandbox-create-request.yaml"
}
}
}
}
},
"responses": {
"201": {
"description": "The resource was created.",
"content": {
"application/json": {
"example": {
"createdBy": "hgildong",
"createdOn": "2021-10-09T15:20:36.441Z",
"isClonable": true,
"jwtToken": "eyJ0eXA ... qggqqw",
"name": "Sandbox-123",
"sandboxId": "2956607f-854e-11e8-898a-0242ac110002",
"status": "OK",
"_links": {
"clone": {
"href": "/sandbox-api/v1/sandboxes/2956607f-854e-11e8-898a-0242ac110002/clone"
},
"rotateJWT": {
"href": "/sandbox-api/v1/sandboxes/2956607f-854e-11e8-898a-0242ac110002/rotateJWT"
},
"self": {
"href": "/sandbox-api/v1/sandboxes/2956607f-854e-11e8-898a-0242ac110002"
}
},
"properties": [
{
"sandboxPropertyId": "e7b77afe-271b-4159-bdd1-c312ef560cdb",
"additionalRequestHostnamesInProperty": [
"www.abc1234def.com"
],
"editedRuleBehaviors": [
"cpCode"
],
"filteredRuleBehaviors": [
"http2"
],
"requestHostnames": [
"shop.exampledevops.com",
"info.abc1234def.com"
],
"_links": {
"property": {
"href": "/sandbox-api/v1/sandboxes/2956607f-854e-11e8-898a-0242ac110002/properties/e7b77afe-271b-4159-bdd1-c312ef560cdb"
},
"rules": {
"href": "/sandbox-api/v1/sandboxes/2956607f-854e-11e8-898a-0242ac110002/properties/e7b77afe-271b-4159-bdd1-c312ef560cdb/rules"
}
},
"validationWarnings": [
{
"detail": "If your `Origin Server` uses HTTPS, make sure to follow <a href=\"/dl/property-manager/property-manager-help/csh_lookup.html?id=PM_0034\" target=\"_blank\">this procedure</a> to avoid a service outage or a security breach when you rotate your origin's certificate.",
"errorLocation": "#/rules/behaviors/0",
"type": "https://problems.luna.akamaiapis.net/papi/v1/validation/validation_message.ssl_delegate_warning_rotate"
}
]
}
]
},
"schema": {
"additionalProperties": false,
"description": "A sandbox is an isolated development environment used for testing. Each sandbox has a unique identifier, or `sandboxId`. If you create a sandbox with `isClonable` enabled, another developer can quickly create a sandbox with the same configuration settings. When you create a sandbox, give it a meaningful `name`.",
"type": "object",
"required": [
"sandboxId",
"createdBy",
"createdOn",
"name",
"isClonable",
"properties"
],
"properties": {
"_links": {
"additionalProperties": true,
"description": "HAL-formatted hypermedia links relating to the sandbox. See [Hypermedia](https://techdocs.akamai.com/sandbox/reference/hypermedia) for more information.",
"minProperties": 1,
"type": "object",
"properties": {
"resource": {
"additionalProperties": true,
"description": "Contains a link to the current resource.",
"type": "object",
"required": [
"href"
],
"properties": {
"href": {
"description": "A relative link to access the resource.",
"type": "string"
}
}
}
},
"x-akamai": {
"file-path": "schemas/Links.yaml"
}
},
"createdBy": {
"description": "The identifier for the developer who created the sandbox.",
"type": "string"
},
"createdOn": {
"description": "A timestamp representing when the system created the sandbox.",
"format": "date-time",
"type": "string"
},
"isClonable": {
"description": "Indicates whether the sandbox can be copied for another developer's use.",
"type": "boolean"
},
"jwtToken": {
"description": "Java Web Token that is returned in the JSON response when you create a sandbox and is used for authentication. You need this string value to configure the Sandbox Client.",
"type": "string"
},
"name": {
"description": "The name of the sandbox defined by the developer when the sandbox was created. If you do not specify a name, the default is the `sandboxId`.",
"type": "string"
},
"properties": {
"description": "A list of the properties available for testing in the sandbox environment. A sandbox can contain more than one property, but a given hostname may only be associated to one property within a sandbox.",
"type": "array",
"items": {
"additionalProperties": false,
"type": "object",
"properties": {
"_links": {
"additionalProperties": true,
"description": "HAL-formatted hypermedia links relating to the sandbox's properties. See [Hypermedia](https://techdocs.akamai.com/sandbox/reference/hypermedia) for more information.",
"minProperties": 1,
"type": "object",
"properties": {
"resource": {
"additionalProperties": true,
"description": "Contains a link to the current resource.",
"type": "object",
"required": [
"href"
],
"properties": {
"href": {
"description": "A relative link to access the resource.",
"type": "string"
}
}
}
},
"x-akamai": {
"file-path": "schemas/Links.yaml"
}
},
"additionalRequestHostnamesInProperty": {
"description": "A list of hostnames that are associated with the property referenced in the create sandbox POST request that were not included as request hostnames in the JSON body.",
"type": "array",
"items": {
"type": "string"
}
},
"editedRuleBehaviors": {
"description": "Behaviors in the rule tree that were modified for use in the Sandbox.",
"type": "array",
"items": {
"type": "string"
}
},
"filteredRuleBehaviors": {
"description": "Behaviors in the rule tree that were removed because they are not supported by Sandbox.",
"type": "array",
"items": {
"type": "string"
}
},
"requestHostnames": {
"description": "A set of hostnames you can use for testing requests within your sandbox.",
"type": "array",
"items": {
"type": "string"
}
},
"sandboxPropertyId": {
"description": "The unique identifier for the sandbox.",
"type": "string"
},
"validationWarnings": {
"description": "Contains warnings related to validating the rule tree when a sandbox is created or a property is added.",
"type": "array",
"items": {
"additionalProperties": false,
"description": "Contains warnings related to validating the rule tree. For details, refer to [Errors](https://techdocs.akamai.com/sandbox/reference/errors).",
"type": "object",
"properties": {
"detail": {
"description": "Provides specific information related to this validation warning.",
"readOnly": true,
"type": "string"
},
"errorLocation": {
"description": "Provides a path expression to the offending rule.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "A unique name for this particular validation.",
"readOnly": true,
"type": "string"
}
}
},
"x-akamai": {
"file-path": "schemas/ValidationWarnings.yaml"
}
}
}
}
},
"sandboxId": {
"description": "The unique identifier for the sandbox.",
"type": "string"
},
"status": {
"description": "The status of the sandbox. `OK` indicates that the sandbox is able to send traffic.",
"type": "string"
},
"statusReason": {
"description": "Provides more information when the status field is `ERROR`.",
"type": "string"
}
},
"x-akamai": {
"file-path": "schemas/sandbox.yaml"
}
}
}
},
"headers": {
"Location": {
"description": "Provides a URL link to GET the newly created resource.",
"schema": {
"example": "/sandbox-api/v1/sandboxes/2956607f-854e-11e8-898a-0242ac110002/properties/f48caeff-68e5-11e8-8870-0242ac110003",
"type": "string"
},
"x-akamai": {
"file-path": "headers/Location.yaml"
}
},
"X-Limit-Sandboxes-Limit": {
"description": "Unique identifier for the sandbox.",
"schema": {
"example": 100,
"type": "string"
},
"x-akamai": {
"file-path": "headers/X-Limit-Sandboxes-Limit.yaml"
}
},
"X-Limit-Sandboxes-Remaining": {
"description": "Unique identifier for the sandbox.",
"schema": {
"example": 98,
"type": "string"
},
"x-akamai": {
"file-path": "headers/X-Limit-Sandboxes-Remaining.yaml"
}
}
}
}
},
"parameters": [
{
"description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).",
"example": "{{accountSwitchKey}}",
"in": "query",
"name": "accountSwitchKey",
"required": false,
"schema": {
"example": "1-5C0YLB:1-8BYUX",
"type": "string"
}
}
]
},
"get": {
"description": "This operation returns a list of sandboxes. In the response object, you can see the `sandboxId`, the developer who created the sandbox, and the sandbox `name`. The `X-Limit-Sandboxes-Remaining` in the response header indicates the number of remaining sandboxes you can create. Generally, you will only see a list of sandboxes you created. If your Control Center user role has permission to edit Property Manager configurations, you have access to view all the sandboxes within the account. You'll be able to [Delete a sandbox](https://techdocs.akamai.com/sandbox/reference/delete-sandbox) returned in the list. You will only be able to [Update a rule tree](https://techdocs.akamai.com/sandbox/reference/put-sandbox-properties-rules) if your user role has permission to edit the property within your Property Manager configuration. For more information on user roles and permissions, refer to [Identity and Access Management](https://techdocs.akamai.com/iam/docs/welcome-id-access-mgmt).",
"operationId": "get-sandboxes",
"summary": "List sandboxes",
"tags": [
"Sandboxes"
],
"externalDocs": {
"description": "See documentation for this operation in Akamai's Sandbox API",
"url": "https://techdocs.akamai.com/sandbox/reference/get-sandboxes"
},
"responses": {
"200": {
"description": "Successful operation.",
"content": {
"application/json": {
"example": {
"accountId": "A-CCT3456",
"_links": {
"self": {
"href": "/sandbox-api/v1/sandboxes"
}
},
"sandboxes": [
{
"createdBy": "jsmith",
"name": "STAR-04",
"sandboxId": "a7123f13-6f14-11e8-8592-0242ac110002",
"_links": {
"rotateJWT": {
"href": "/sandbox-api/v1/sandboxes/a7123f13-6f14-11e8-8592-0242ac110002/rotateJWT"
},
"self": {
"href": "/sandbox-api/v1/sandboxes/a7123f13-6f14-11e8-8592-0242ac110002"
}
}
}
]
},
"schema": {
"additionalProperties": false,
"type": "object",
"required": [
"accountId",
"sandboxes"
],
"properties": {
"accountId": {
"description": "Unique identifier for an account.",
"type": "string"
},
"sandboxes": {
"description": "The set of sandboxes created by the developer.",
"type": "array",
"items": {
"additionalProperties": false,
"description": "Detailed information on the sandbox.",
"type": "object",
"required": [
"sandboxId",
"createdBy",
"createdOn",
"name",
"isClonable",
"properties"
],
"properties": {
"_links": {
"additionalProperties": true,
"description": "HAL-formatted hypermedia links relating to the sandbox. See [Hypermedia](https://techdocs.akamai.com/sandbox/reference/hypermedia) for more information.",
"minProperties": 1,
"type": "object",
"properties": {
"resource": {
"additionalProperties": true,
"description": "Contains a link to the current resource.",
"type": "object",
"required": [
"href"
],
"properties": {
"href": {
"description": "A relative link to access the resource.",
"type": "string"
}
}
}
},
"x-akamai": {
"file-path": "schemas/Links.yaml"
}
},
"createdBy": {
"description": "The identifier for the developer who created the sandbox.",
"type": "string"
},
"createdOn": {
"description": "A timestamp representing when the system created the sandbox.",
"format": "date-time",
"type": "string"
},
"isClonable": {
"description": "Indicates whether the sandbox can be copied for another developer's use.",
"type": "boolean"
},
"jwtToken": {
"description": "Java Web Token that is returned in the JSON response when you create a sandbox and is used for authentication. You need this string value to configure the Sandbox Client.",
"type": "string"
},
"name": {
"description": "The name of the sandbox defined by the developer when the sandbox was created. If you do not specify a name, the default is the `sandboxId`.",
"type": "string"
},
"properties": {
"description": "A list of the properties available for testing in the sandbox environment. A sandbox can contain more than one property, but a given hostname may only be associated to one property within a sandbox.",
"type": "array",
"items": {
"additionalProperties": false,
"type": "object",
"properties": {
"_links": {
"additionalProperties": true,
"description": "HAL-formatted hypermedia links relating to the sandbox's properties. See [Hypermedia](https://techdocs.akamai.com/sandbox/reference/hypermedia) for more information.",
"minProperties": 1,
"type": "object",
"properties": {
"resource": {
"additionalProperties": true,
"description": "Contains a link to the current resource.",
"type": "object",
"required": [
"href"
],
"properties": {
"href": {
"description": "A relative link to access the resource.",
"type": "string"
}
}
}
},
"x-akamai": {
"file-path": "schemas/Links.yaml"
}
},
"additionalRequestHostnamesInProperty": {
"description": "A list of hostnames that are associated with the property referenced in the create sandbox POST request that were not included as request hostnames in the JSON body.",
"type": "array",
"items": {
"type": "string"
}
},
"editedRuleBehaviors": {
"description": "Behaviors in the rule tree that were modified for use in the Sandbox.",
"type": "array",
"items": {
"type": "string"
}
},
"filteredRuleBehaviors": {
"description": "Behaviors in the rule tree that were removed because they are not supported by Sandbox.",
"type": "array",
"items": {
"type": "string"
}
},
"requestHostnames": {
"description": "A set of hostnames you can use for testing requests within your sandbox.",
"type": "array",
"items": {
"type": "string"
}
},
"sandboxPropertyId": {
"description": "The unique identifier for the sandbox.",
"type": "string"
},
"validationWarnings": {
"description": "Contains warnings related to validating the rule tree when a sandbox is created or a property is added.",
"type": "array",
"items": {
"additionalProperties": false,
"description": "Contains warnings related to validating the rule tree. For details, refer to [Errors](https://techdocs.akamai.com/sandbox/reference/errors).",
"type": "object",
"properties": {
"detail": {
"description": "Provides specific information related to this validation warning.",
"readOnly": true,
"type": "string"
},
"errorLocation": {
"description": "Provides a path expression to the offending rule.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "A unique name for this particular validation.",
"readOnly": true,
"type": "string"
}
}
},
"x-akamai": {
"file-path": "schemas/ValidationWarnings.yaml"
}
}
}
}
},
"sandboxId": {
"description": "The unique identifier for the sandbox.",
"type": "string"
},
"status": {
"description": "The status of the sandbox. `OK` indicates that the sandbox is able to send traffic.",
"type": "string"
},
"statusReason": {
"description": "Provides more information when the status field is `ERROR`.",
"type": "string"
}
},
"x-akamai": {
"file-path": "schemas/sandbox.yaml"
}
}
}
},
"x-akamai": {
"file-path": "schemas/sandboxes-get-response.yaml"
}
}
}
},
"headers": {
"X-Limit-Sandboxes-Limit": {
"description": "Unique identifier for the sandbox.",
"schema": {
"example": 100,
"type": "string"
},
"x-akamai": {
"file-path": "headers/X-Limit-Sandboxes-Limit.yaml"
}
},
"X-Limit-Sandboxes-Remaining": {
"description": "Unique identifier for the sandbox.",
"schema": {
"example": 98,
"type": "string"
},
"x-akamai": {
"file-path": "headers/X-Limit-Sandboxes-Remaining.yaml"
}
}
}
}
},
"parameters": [
{
"description": "__Enum__ Indicates the access level of the request. Specify either `USER` to perform the request for the sandboxes that you can access, or `ACCOUNT` to perform the request for all sandboxes within the account.",
"example": "{{access}}",
"in": "query",
"name": "access",
"schema": {
"default": "USER",
"example": "ACCOUNT",
"type": "string",
"enum": [
"USER",
"ACCOUNT"
]
},
"x-akamai": {
"file-path": "parameters/accessParam-query.yaml"
}
},
{
"description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).",
"example": "{{accountSwitchKey}}",
"in": "query",
"name": "accountSwitchKey",
"required": false,
"schema": {
"example": "1-5C0YLB:1-8BYUX",
"type": "string"
}
}
]
}
},
"/sandboxes/{sandboxId}": {
"get": {
"description": "Get a specific sandbox based on `sandboxId`.",
"operationId": "get-sandbox",
"summary": "Get a sandbox",
"tags": [
"Sandboxes"
],
"externalDocs": {
"description": "See documentation for this operation in Akamai's Sandbox API",
"url": "https://techdocs.akamai.com/sandbox/reference/get-sandbox"
},
"responses": {
"200": {
"description": "Successful operation.",
"content": {
"application/json": {
"example": {
"createdBy": "jsmith",
"createdOn": "2021-07-11T21:05:38.227Z",
"isClonable": true,
"name": "Sandbox-clone-1",
"sandboxId": "2956607f-854e-11e8-898a-0242ac110002",
"status": "OK",
"_links": {
"clone": {
"href": "/sandbox-api/v1/sandboxes/2956607f-854e-11e8-898a-0242ac110002/clone"
},
"rotateJWT": {
"href": "/sandbox-api/v1/sandboxes/2956607f-854e-11e8-898a-0242ac110002/rotateJWT"
},
"self": {
"href": "/sandbox-api/v1/sandboxes/2956607f-854e-11e8-898a-0242ac110002"
}
},
"properties": [
{
"requestHostnames": [
"shop.example.com"
],
"_links": {
"property": {
"href": "/sandbox-api/v1/sandboxes/2956607f-854e-11e8-898a-0242ac110002/properties/29b5e5a0-854e-11e8-898a-0242ac110002"
},
"rules": {
"href": "/sandbox-api/v1/sandboxes/2956607f-854e-11e8-898a-0242ac110002/properties/29b5e5a0-854e-11e8-898a-0242ac110002/rules"
}
}
}
]
},
"schema": {
"additionalProperties": false,
"description": "A sandbox is an isolated development environment used for testing. Each sandbox has a unique identifier, or `sandboxId`. If you create a sandbox with `isClonable` enabled, another developer can quickly create a sandbox with the same configuration settings. When you create a sandbox, give it a meaningful `name`.",
"type": "object",
"required": [
"sandboxId",
"createdBy",
"createdOn",
"name",
"isClonable",
"properties"
],
"properties": {
"_links": {
"additionalProperties": true,
"description": "HAL-formatted hypermedia links relating to the sandbox. See [Hypermedia](https://techdocs.akamai.com/sandbox/reference/hypermedia) for more information.",
"minProperties": 1,
"type": "object",
"properties": {
"resource": {
"additionalProperties": true,
"description": "Contains a link to the current resource.",
"type": "object",
"required": [
"href"
],
"properties": {
"href": {
"description": "A relative link to access the resource.",
"type": "string"
}
}
}
},
"x-akamai": {
"file-path": "schemas/Links.yaml"
}
},
"createdBy": {
"description": "The identifier for the developer who created the sandbox.",
"type": "string"
},
"createdOn": {
"description": "A timestamp representing when the system created the sandbox.",
"format": "date-time",
"type": "string"
},
"isClonable": {
"description": "Indicates whether the sandbox can be copied for another developer's use.",
"type": "boolean"
},
"jwtToken": {
"description": "Java Web Token that is returned in the JSON response when you create a sandbox and is used for authentication. You need this string value to configure the Sandbox Client.",
"type": "string"
},
"name": {
"description": "The name of the sandbox defined by the developer when the sandbox was created. If you do not specify a name, the default is the `sandboxId`.",
"type": "string"
},
"properties": {
"description": "A list of the properties available for testing in the sandbox environment. A sandbox can contain more than one property, but a given hostname may only be associated to one property within a sandbox.",
"type": "array",
"items": {
"additionalProperties": false,
"type": "object",
"properties": {
"_links": {
"additionalProperties": true,
"description": "HAL-formatted hypermedia links relating to the sandbox's properties. See [Hypermedia](https://techdocs.akamai.com/sandbox/reference/hypermedia) for more information.",
"minProperties": 1,
"type": "object",
"properties": {
"resource": {
"additionalProperties": true,
"description": "Contains a link to the current resource.",
"type": "object",
"required": [
"href"
],
"properties": {
"href": {
"description": "A relative link to access the resource.",
"type": "string"
}
}
}
},
"x-akamai": {
"file-path": "schemas/Links.yaml"
}
},
"additionalRequestHostnamesInProperty": {
"description": "A list of hostnames that are associated with the property referenced in the create sandbox POST request that were not included as request hostnames in the JSON body.",
"type": "array",
"items": {
"type": "string"
}
},
"editedRuleBehaviors": {
"description": "Behaviors in the rule tree that were modified for use in the Sandbox.",
"type": "array",
"items": {
"type": "string"
}
},
"filteredRuleBehaviors": {
"description": "Behaviors in the rule tree that were removed because they are not supported by Sandbox.",
"type": "array",
"items": {
"type": "string"
}
},
"requestHostnames": {
"description": "A set of hostnames you can use for testing requests within your sandbox.",
"type": "array",
"items": {
"type": "string"
}
},
"sandboxPropertyId": {
"description": "The unique identifier for the sandbox.",
"type": "string"
},
"validationWarnings": {
"description": "Contains warnings related to validating the rule tree when a sandbox is created or a property is added.",
"type": "array",
"items": {
"additionalProperties": false,
"description": "Contains warnings related to validating the rule tree. For details, refer to [Errors](https://techdocs.akamai.com/sandbox/reference/errors).",
"type": "object",
"properties": {
"detail": {
"description": "Provides specific information related to this validation warning.",
"readOnly": true,
"type": "string"
},
"errorLocation": {
"description": "Provides a path expression to the offending rule.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "A unique name for this particular validation.",
"readOnly": true,
"type": "string"
}
}
},
"x-akamai": {
"file-path": "schemas/ValidationWarnings.yaml"
}
}
}
}
},
"sandboxId": {
"description": "The unique identifier for the sandbox.",
"type": "string"
},
"status": {
"description": "The status of the sandbox. `OK` indicates that the sandbox is able to send traffic.",
"type": "string"
},
"statusReason": {
"description": "Provides more information when the status field is `ERROR`.",
"type": "string"
}
},
"x-akamai": {
"file-path": "schemas/sandbox.yaml"
}
}
}
}
}
},
"parameters": [
{
"description": "__Enum__ Indicates the access level of the request. Specify either `USER` to perform the request for the sandboxes that you can access, or `ACCOUNT` to perform the request for all sandboxes within the account.",
"example": "{{access}}",
"in": "query",
"name": "access",
"schema": {
"default": "USER",
"example": "ACCOUNT",
"type": "string",
"enum": [
"USER",
"ACCOUNT"
]
},
"x-akamai": {
"file-path": "parameters/accessParam-query.yaml"
}
},
{
"description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).",
"example": "{{accountSwitchKey}}",
"in": "query",
"name": "accountSwitchKey",
"required": false,
"schema": {
"example": "1-5C0YLB:1-8BYUX",
"type": "string"
}
}
]
},
"put": {
"description": "Enable `isClonable` if you have preconfigured the settings for the sandbox and want to make it possible for other developers to create an exact replica in their development environment. You can also update the sandbox `name` to make it easy to identify when returned in a list or in a log line.",
"operationId": "put-sandbox",
"summary": "Modify a sandbox",
"tags": [
"Sandboxes"
],
"externalDocs": {
"description": "See documentation for this operation in Akamai's Sandbox API",
"url": "https://techdocs.akamai.com/sandbox/reference/put-sandbox"
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"example": {
"isClonable": true,
"name": "SHOP-123212"
},
"schema": {
"additionalProperties": false,
"description": "A sandbox is an isolated development environment used for testing. Each sandbox has a unique identifier, or `sandboxId`. If you create a sandbox with `isClonable` enabled, another developer can quickly create a sandbox with the same configuration settings. When you create a sandbox, give it a meaningful `name`.",
"type": "object",
"required": [
"sandboxId",
"createdBy",
"createdOn",
"name",
"isClonable",
"properties"
],
"properties": {
"_links": {
"additionalProperties": true,
"description": "HAL-formatted hypermedia links relating to the sandbox. See [Hypermedia](https://techdocs.akamai.com/sandbox/reference/hypermedia) for more information.",
"minProperties": 1,
"type": "object",
"properties": {
"resource": {
"additionalProperties": true,
"description": "Contains a link to the current resource.",
"type": "object",
"required": [
"href"
],
"properties": {
"href": {
"description": "A relative link to access the resource.",
"type": "string"