forked from akamai/akamai-apis
-
Notifications
You must be signed in to change notification settings - Fork 0
/
openapi.json
553 lines (553 loc) · 21.9 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
{
"openapi": "3.0.0",
"externalDocs": {
"description": "See documentation for Akamai's Live Archive Management API",
"url": "https://techdocs.akamai.com/live-archive-management/reference"
},
"info": {
"title": "Akamai: Live Archive Management API",
"version": "1.0",
"license": {
"name": "Apache 2.0",
"url": "https://www.apache.org/licenses/LICENSE-2.0.html"
}
},
"paths": {
"/streams/{streamId}/archives": {
"get": {
"description": "Lists all archives, or optionally those created within a specified time range.",
"operationId": "get-stream-archives",
"summary": "List archives",
"tags": [
"Archives"
],
"externalDocs": {
"description": "See documentation for this operation in Akamai's Live Archive Management API",
"url": "https://techdocs.akamai.com/live-archive-management/reference/get-stream-archives"
},
"responses": {
"200": {
"description": "Successful response.",
"content": {
"application/json": {
"example": {
"archives": [
{
"archiveEndTime": "1523371284",
"archiveStartTime": "1523371274",
"name": "master.m3u8",
"uri": "609993/1523371274.347/master.m3u8",
"manifestUpdateTimes": []
},
{
"archiveEndTime": "0",
"archiveStartTime": "1523371482",
"name": "master.m3u8",
"uri": "609993/1523371482.096/master.m3u8",
"manifestUpdateTimes": [
1523371492,
1523371502
]
}
]
},
"schema": {
"additionalProperties": false,
"description": "Response to a request for all the archives for a stream ID or archives within a specified time range.",
"type": "object",
"properties": {
"archives": {
"description": "A collection of archives.",
"type": "array",
"items": {
"additionalProperties": false,
"description": "An archive on storage for the specified stream ID and name.",
"type": "object",
"properties": {
"archiveEndTime": {
"description": "Time at which the stream is not archived, \"End of Stream\" detected from manifests. The value is a Unix epoch timestamp.",
"type": "string"
},
"archiveStartTime": {
"description": "Time at which the stream starts to be archived. The value is a Unix epoch timestamp.",
"type": "string"
},
"manifestUpdateTimes": {
"description": "Unix epoch timestamps representing when MSL updated and published the master manifest file during the live stream.",
"type": "array",
"items": {
"type": "integer"
}
},
"name": {
"description": "The name of the manifest.",
"type": "string"
},
"uri": {
"description": "The URL path used to fetch the bit rates published for this master playlist. For example, this could be `{event_name}/master.m3u8`.",
"type": "string"
}
}
}
}
},
"x-akamai": {
"file-path": "schemas/archives-200.yaml"
}
}
}
}
}
},
"parameters": [
{
"description": "Start time of the required time range in Unix epoch time.",
"example": "{{startTime}}",
"in": "query",
"name": "startTime",
"schema": {
"type": "integer"
},
"x-akamai": {
"file-path": "parameters/startTime-query.yaml"
}
},
{
"description": "End time of the required time range in Unix epoch time.",
"example": "{{endTime}}",
"in": "query",
"name": "endTime",
"schema": {
"type": "integer"
},
"x-akamai": {
"file-path": "parameters/endTime-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"
}
}
]
},
"parameters": [
{
"description": "Uniquely identifies the stream from which this archive derives.",
"example": "{{streamId}}",
"in": "path",
"name": "streamId",
"required": true,
"schema": {
"type": "integer"
},
"x-akamai": {
"file-path": "parameters/streamId-path.yaml"
}
}
]
},
"/streams/{streamId}/endpoints": {
"get": {
"description": "Lists all the endpoints per stream.",
"operationId": "get-stream-endpoints",
"summary": "List endpoints",
"tags": [
"Endpoints"
],
"externalDocs": {
"description": "See documentation for this operation in Akamai's Live Archive Management API",
"url": "https://techdocs.akamai.com/live-archive-management/reference/get-stream-endpoints"
},
"responses": {
"200": {
"description": "Successful response.",
"content": {
"application/json": {
"example": {
"endpoints": [
"609993/l2v_no_timestamp3/bitrate_500k.m3u8",
"609993/l2v_no_timestamp3",
"609993/l2v_no_timestamp7",
"609993/l2v_no_timestamp7/bitrate_1500k.m3u8",
"609993/streamcat",
"609993/streamcat123abc"
]
},
"schema": {
"additionalProperties": false,
"description": "Details about an endpoint.",
"type": "object",
"properties": {
"endpoints": {
"description": "The set of URL paths available for each stream for the specified time range.",
"type": "array",
"items": {
"title": "Endpoint",
"type": "string"
}
}
},
"x-akamai": {
"file-path": "schemas/endpoints-200.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"
}
}
]
},
"parameters": [
{
"description": "Uniquely identifies the stream from which this archive derives.",
"example": "{{streamId}}",
"in": "path",
"name": "streamId",
"required": true,
"schema": {
"type": "integer"
},
"x-akamai": {
"file-path": "parameters/streamId-path.yaml"
}
}
]
},
"/streams/{streamId}/endpoints/{endpoint}": {
"delete": {
"description": "Delete all objects under this endpoint.",
"operationId": "delete-stream-endpoint",
"summary": "Remove objects",
"tags": [
"Endpoints"
],
"externalDocs": {
"description": "See documentation for this operation in Akamai's Live Archive Management API",
"url": "https://techdocs.akamai.com/live-archive-management/reference/delete-stream-endpoint"
},
"responses": {
"200": {
"description": "All objects were successfully deleted.",
"content": {
"*/*": {}
}
},
"404": {
"description": "The endpoint was not found.",
"content": {
"*/*": {}
}
}
},
"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"
}
}
]
},
"parameters": [
{
"description": "The URL path for which all objects need to be deleted. This is URL-encoded.",
"example": "{{endpoint}}",
"in": "path",
"name": "endpoint",
"required": true,
"schema": {
"type": "string"
},
"x-akamai": {
"file-path": "parameters/endpoint-path.yaml"
}
},
{
"description": "Uniquely identifies the stream from which this archive derives.",
"example": "{{streamId}}",
"in": "path",
"name": "streamId",
"required": true,
"schema": {
"type": "integer"
},
"x-akamai": {
"file-path": "parameters/streamId-path.yaml"
}
}
]
},
"/vod": {
"post": {
"description": "**For beta customers only.** _Akamai is no longer accepting new members for this beta program._ When you enable archiving for an MSL live stream, you can retain it for a maximum of 31 days. To retain archived content beyond 31 days, use this operation to create a separate VOD asset that MSL stores in Akamai NetStorage. You need to set up the desired NetStorage storage group using the [Live-to-VOD Export](https://learn.akamai.com/en-us/webhelp/media-services-live/media-services-live-4-user-guide/GUID-039CB50F-CB56-49D8-BBDF-E6675E159023.html) option in Akamai Control Center.",
"operationId": "post-vod",
"summary": "Create a VOD asset",
"tags": [
"VOD assets"
],
"externalDocs": {
"description": "See documentation for this operation in Akamai's Live Archive Management API",
"url": "https://techdocs.akamai.com/live-archive-management/reference/post-vod"
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"example": {
"URI": "/dash/609978/DevtestDashStream1/dash.mpd",
"assetId": "ABCD1234567890123456",
"endTime": 1552933330,
"maxFileSize": 100,
"preserveKeys": true,
"startTime": 1552933300
},
"schema": {
"additionalProperties": false,
"description": "When you enable archiving for an MSL live stream, you can tell Akamai to keep the live archive for a maximum of 31 days. A VOD Asset is physical on-demand video content that you create from a live archive and store in Akamai NetStorage. This lets you preserve live archive content for longer than 31 days.",
"type": "object",
"required": [
"URI",
"startTime",
"endTime",
"assetId"
],
"properties": {
"URI": {
"description": "This is the URL for the live stream archive, using the form `/{format}/{streamId}/{eventName}/{manifestName}`. In it, `format` is either `hls` or `dash`, `streamId` is the unique, numeric identifier that's been assigned to the stream, `eventName` is the name of the event that you've assigned to the stream, and `manifestName` is the manifest filename. For example, `/hls/708976/helloworld/master.m3u8` is an HLS master manifest URL and `/dash/708976/helloworld/hello.mpd` is a DASH manifest URL.",
"example": "{{URI}}",
"type": "string"
},
"assetId": {
"description": "This is a unique identifier you set for a VOD asset. Start it with four alphanumeric characters followed by 16 numeric characters.",
"example": "{{assetId}}",
"type": "string"
},
"endTime": {
"description": "The Unix epoch timestamp that marks the end time of the VOD clip. The value needs to be greater than the `startTime` by at least 30 seconds and no more than 43200 seconds, representing the clip's maximum allowed duration of 12 hours. There is a 30 minute latency. So, this needs to be less than the current epoch time by at least 1800 seconds.",
"example": "{{endTime}}",
"type": "integer"
},
"maxFileSize": {
"description": "The maximum exported segment size in MB. The default value is 100 MB. This only applies to HLS VOD assets.",
"example": "{{maxFileSize}}",
"type": "integer"
},
"preserveKeys": {
"default": false,
"description": "When set to `true`, MSL won't export keys and won't change key metadata in the manifests. When set to `false`, MSL exports keys and may change metadata in the manifests to accommodate. The default value is `false`. This only applies to HLS VOD assets.",
"example": "{{preserveKeys}}",
"type": "boolean"
},
"startTime": {
"description": "The Unix epoch timestamp that marks the start time of the VOD clip.",
"example": "{{startTime}}",
"type": "integer"
}
},
"x-akamai": {
"file-path": "schemas/post-vod.yaml"
}
}
}
}
},
"responses": {
"202": {
"description": "The VOD job is successfully created. Returns an export ID (EID).",
"content": {
"application/json": {
"example": {
"EID": "553960_244dcbf53b61f4ea62dc650425858424"
},
"schema": {
"additionalProperties": false,
"description": "Create VOD asset response body.",
"type": "object",
"properties": {
"EID": {
"description": "This is a unique identifier that Akamai applies to a request to create a new VOD asset.",
"type": "string"
}
},
"x-akamai": {
"file-path": "schemas/post-vod-202.yaml"
}
}
}
}
},
"400": {
"description": "The URL is not formed correctly. The POST body is not valid.",
"content": {
"*/*": {}
}
},
"403": {
"description": "The VOD Management API is not enabled for this stream. The VOD Management API is not enabled globally.",
"content": {
"*/*": {}
}
},
"405": {
"description": "HTTP method error.",
"content": {
"*/*": {}
}
},
"500": {
"description": "The CP code or originshield hostname is not available for the stream ID. There is an error initiating the VOD job.",
"content": {
"*/*": {}
}
}
},
"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"
}
}
]
}
},
"/vod/{EID}": {
"get": {
"description": "**For beta customers only.** _Akamai is no longer accepting new members for this beta program._ Use this to query the status of a VOD asset creation operation, using its export ID (`EID`).",
"operationId": "get-vod-eid",
"summary": "Get VOD status",
"tags": [
"VOD assets"
],
"externalDocs": {
"description": "See documentation for this operation in Akamai's Live Archive Management API",
"url": "https://techdocs.akamai.com/live-archive-management/reference/get-vod-eid"
},
"responses": {
"200": {
"description": "The status of a VOD job is returned.",
"content": {
"application/json": {
"example": {
"status": "ready"
},
"schema": {
"additionalProperties": false,
"description": "Status of a VOD job.",
"type": "object",
"properties": {
"status": {
"description": "The status of a request to create a new VOD asset. It can be `ready`, `in_progress`, or `failed`.",
"type": "string",
"enum": [
"in_progress",
"ready",
"failed"
]
}
},
"x-akamai": {
"file-path": "schemas/vod-status-200.yaml"
}
}
}
}
},
"400": {
"description": "The URL isn't formed correctly.",
"content": {
"*/*": {}
}
},
"403": {
"description": "The VOD Management API isn't enabled for this stream. The VOD Management API is not enabled globally.",
"content": {
"*/*": {}
}
},
"405": {
"description": "HTTP method error.",
"content": {
"*/*": {}
}
},
"500": {
"description": "The export ID does not exist or isn't valid. JSON status error.",
"content": {
"*/*": {}
}
}
},
"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"
}
}
]
},
"parameters": [
{
"description": "A unique ID assigned to the export.",
"example": "{{EID}}",
"in": "path",
"name": "EID",
"required": true,
"schema": {
"type": "string"
},
"x-akamai": {
"file-path": "parameters/EID-path.yaml"
}
}
]
}
},
"x-readme": {
"samples-languages": [
"curl",
"python",
"node"
]
},
"servers": [
{
"url": "https://{hostname}/live-archive/v1"
}
]
}