{ "openapi": "3.0.0", "externalDocs": { "description": "See documentation for Akamai's Media Services Live Stream Provisioning API", "url": "https://techdocs.akamai.com/msl/reference" }, "info": { "title": "Akamai: Media Services Live Stream Provisioning API", "version": "2", "license": { "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" } }, "paths": { "/msl-origin/cdns": { "get": { "description": "Fetch predefined list of CDN providers. You can configure your MSL origin to include multiple CDN providers.", "operationId": "get-cdns", "summary": "List CDNs", "tags": [ "CDNs" ], "externalDocs": { "description": "See documentation for this operation in Akamai's Media Services Live Stream Provisioning API", "url": "https://techdocs.akamai.com/msl/reference/get-cdns" }, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "description": "Contains information about the CDN.", "type": "array", "items": { "additionalProperties": false, "type": "object", "properties": { "code": { "description": "Predefined code to identify the CDN.", "type": "string" }, "name": { "description": "Name to identify the CDN.", "type": "string" } } }, "x-akamai": { "file-path": "schemas/CdnResourceDTO.yaml" } }, "example": [ { "code": "dn002", "name": "L3" }, { "code": "dn003", "name": "Fastly" }, { "code": "dn004", "name": "Cloudfront" } ] } } } }, "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" } } ] } }, "/msl-origin/contracts": { "get": { "description": "Fetch MSL contracts.", "operationId": "get-contracts", "summary": "List contracts", "tags": [ "Contracts" ], "externalDocs": { "description": "See documentation for this operation in Akamai's Media Services Live Stream Provisioning API", "url": "https://techdocs.akamai.com/msl/reference/get-contracts" }, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "additionalProperties": false, "description": "The contract ID to associate with the origin. The system filters the CP codes based on the contract ID that you specify. It associates the NetStorage CP code, if there is one, with the same contract as the ingest CP code.", "type": "object", "properties": { "accountId": { "description": "Customer account ID.", "type": "string" }, "childContractIds": { "description": "Value is `null` if no child contract ID is assigned to the contract.", "type": "array", "items": { "nullable": true, "type": "string" } }, "contractId": { "description": "The contract ID to assign to the origin.", "type": "string" }, "contractTypeId": { "description": "The type of contract.", "type": "string" }, "expired": { "description": "Indicates whether the contract has expired.", "type": "boolean" }, "groups": { "description": "Indicates the list of basic groups associated with the contract.", "type": "array", "items": { "additionalProperties": false, "description": "Specify the group ID to associate with the contract.", "type": "object", "properties": { "groupId": { "description": "Specify the group ID.", "type": "integer" }, "groupName": { "description": "Specify the group name.", "type": "string" } }, "x-akamai": { "file-path": "schemas/BasicGroupDTO.yaml" } } }, "parentContractId": { "description": "Value is `null` if there is no parent contract ID assigned to the contract.", "nullable": true, "type": "string" } }, "x-akamai": { "file-path": "schemas/BasicContractDTO.yaml" } }, "example": [ { "accountId": "A-CCT9012", "childContractIds": null, "contractId": "C-0N7RAC7", "contractTypeId": "R-T746", "expired": false, "parentContractId": null }, { "accountId": "A-CCT7890", "childContractIds": null, "contractId": "K-0N7RAK7", "contractTypeId": "I-K1YX", "expired": false, "parentContractId": null } ] } } }, "400": { "description": "[Invalid input in the request](https://techdocs.akamai.com/msl/reference/400).", "content": { "application/problem+json": { "schema": { "additionalProperties": false, "description": "Contains debugging information about error responses.", "type": "object", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "The list of errors.", "type": "array", "items": { "description": "A further-nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/Problem-nested.yaml" } } }, "instance": { "description": "A non-referenceable URI indicating an error instance.", "type": "string" }, "status": { "description": "The HTTP status code of the error response.", "type": "integer" }, "title": { "description": "The title of the error response.", "type": "string" }, "type": { "description": "The URL for the error type description.", "type": "string" } }, "x-akamai": { "file-path": "schemas/ProblemDetailDTO.yaml" } } } }, "x-akamai": { "file-path": "errors/400.yaml" } }, "429": { "description": "[Rate limiting error](https://techdocs.akamai.com/msl/reference/429). The maximum request count for a specific time duration for this resource has been reached. See [Rate limiting](https://techdocs.akamai.com/msl/reference/resource-limiting) for more information.", "content": {}, "headers": { "X-RateLimit-Limit": { "schema": { "example": 50, "type": "string" }, "x-akamai": { "file-path": "headers/X-RateLimit-Limit.yaml" } }, "X-RateLimit-Remaining": { "schema": { "example": 0, "type": "string" }, "x-akamai": { "file-path": "headers/X-RateLimit-Remaining.yaml" } } }, "x-akamai": { "file-path": "errors/429.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" } } ] } }, "/msl-origin/cpcodes": { "post": { "description": "Creates a new MSL CP code. You need a CP code to create a stream or an origin.", "operationId": "post-cpcodes", "summary": "Create a CP code", "tags": [ "CP codes" ], "externalDocs": { "description": "See documentation for this operation in Akamai's Media Services Live Stream Provisioning API", "url": "https://techdocs.akamai.com/msl/reference/post-cpcodes" }, "requestBody": { "required": true, "content": { "application/json": { "example": { "contractId": "K-0N7RAK71", "name": "Cpcode 1" }, "schema": { "additionalProperties": false, "description": "Specifies the origin CP code.", "type": "object", "properties": { "contractId": { "description": "The ID of the contract associated with the CP code.", "example": "{{contractId}}", "type": "string" }, "name": { "description": "Name of the CP code.", "example": "{{name}}", "type": "string" } }, "x-akamai": { "file-path": "schemas/CreateCpcodeDTO.yaml" } } } } }, "responses": { "202": { "description": "Successful response.", "content": { "application/json": { "example": { "contractId": "C-0N7RAC7", "id": 12345, "name": "Cpcode 1" }, "schema": { "additionalProperties": false, "description": "Specifies the origin CP code.", "type": "object", "properties": { "contractId": { "description": "The ID of the contract associated with the CP code.", "type": "string" }, "id": { "description": "CP code that you can use to create the origin.", "type": "integer" }, "name": { "description": "Name of the CP code.", "type": "string" } }, "x-akamai": { "file-path": "schemas/CpcodeCreateResponse.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": "Obtains the CP code based on the type. You need a CP code to create a stream.", "operationId": "get-cpcodes", "summary": "List CP codes", "tags": [ "CP codes" ], "externalDocs": { "description": "See documentation for this operation in Akamai's Media Services Live Stream Provisioning API", "url": "https://techdocs.akamai.com/msl/reference/get-cpcodes" }, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "description": "Specifies the origin CP codes.", "type": "array", "items": { "additionalProperties": false, "type": "object", "properties": { "contracts": { "description": "CP code identifiers.", "type": "array", "items": { "additionalProperties": false, "type": "object", "properties": { "contractId": { "description": "The ID of the contract associated with the CP code.", "type": "string" } } } }, "id": { "description": "CP code that you can use to create the origin.", "type": "integer" }, "isUsed": { "description": "Indicates whether the CP code is assigned to an origin.", "type": "boolean" }, "name": { "description": "Name of the CP code.", "type": "string" } } }, "x-akamai": { "file-path": "schemas/CpcodeDTO.yaml" } }, "example": [ { "id": 321234, "name": "Test", "contracts": [ { "contractId": "C-0N7RAC7" } ] } ] } } } }, "parameters": [ { "description": "When enabled, lists only CP codes that have not already been used to provision an origin.", "example": "{{unused}}", "in": "query", "name": "unused", "schema": { "example": true, "type": "boolean" }, "x-akamai": { "file-path": "parameters/unused-query.yaml" } }, { "description": "__Enum__ Specify the type of CP code. Specify `INGEST` to obtain the INGEST CP codes, `DELIVERY` for the delivery CP codes, and `STORAGE` for the storage CP codes.", "example": "{{type}}", "in": "query", "name": "type", "required": true, "schema": { "example": "INGEST", "type": "string", "enum": [ "INGEST", "DELIVERY", "STORAGE" ] }, "x-akamai": { "file-path": "parameters/type-cpcodes-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" } } ] } }, "/msl-origin/generate-key": { "get": { "description": "Specify either an `AKAMAI` or `THIRD_PARTY` key format.", "operationId": "get-generate-key", "summary": "Generate a key", "tags": [ "Keys" ], "externalDocs": { "description": "See documentation for this operation in Akamai's Media Services Live Stream Provisioning API", "url": "https://techdocs.akamai.com/msl/reference/get-generate-key" }, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "example": { "key": "Ab+DgsTEL6t5Trcv5KYUZw==" }, "schema": { "additionalProperties": false, "description": "Contains generated authentication token for the stream.", "type": "object", "properties": { "key": { "description": "A single return value with alphanumeric which include special characters.", "type": "string" } }, "x-akamai": { "file-path": "schemas/GenerateSecretDTO.yaml" } } } } } }, "parameters": [ { "description": "__Enum__ Specifies whether to retrieve `AKAMAI` or `THIRD_PARTY` CP codes.", "example": "{{type}}", "in": "query", "name": "type", "schema": { "example": "AKAMAI", "type": "string", "enum": [ "AKAMAI", "THIRD_PARTY" ] }, "x-akamai": { "file-path": "parameters/type-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" } } ] } }, "/msl-origin/origins": { "post": { "description": "Create a Media Services live origin for the stream. You can associate this origin hostname with an Adaptive Media Delivery configuration.", "operationId": "post-origin", "summary": "Create a new origin", "tags": [ "Origins" ], "externalDocs": { "description": "See documentation for this operation in Akamai's Media Services Live Stream Provisioning API", "url": "https://techdocs.akamai.com/msl/reference/post-origin" }, "requestBody": { "required": true, "content": { "application/json": { "example": { "backupEncoderZone": "EUROPE", "contractId": "K-0N7RAK7", "cpcode": 123456, "encoderZone": "US_EAST", "groupId": 1234, "hostName": "demohost", "thirdPartyCdnCpcode": 654321, "emailIds": [ "email1", "email2" ], "sharedKeys": [ { "authMethod": "MSL_MULTI_ACCOUNT", "enabled": true, "key": "7153f558f89e058ae", "name": "SomeName01", "type": "AKAMAI" }, { "authMethod": "MSL_MULTI_ACCOUNT", "enabled": false, "key": "2557f557f39e025db", "name": "nonce2", "type": "AKAMAI" }, { "authMethod": "SIMPLE_AKAMAI_HEADER_VERIFICATION", "cdnCode": "dn00x", "enabled": false, "expiryDate": "2018-12-12T06:15:00.000Z", "guid": "402254d3-e75e-4501-8709-5a3a2211f79", "key": "h0BhBScF1Wb3y1r8clJqqg==", "name": "SomeName03", "type": "THIRD_PARTY" }, { "authMethod": "SIMPLE_AKAMAI_HEADER_VERIFICATION", "cdnCode": "dn00x", "enabled": true, "expiryDate": "2017-09-25T18:33:00.000Z", "guid": "105254f3-e75e-4501-8709-5a3a2277d09", "key": "h2MhYEcH1Wu3z1r9clJoob==", "name": "SomeName04", "type": "THIRD_PARTY" } ] }, "schema": { "additionalProperties": false, "description": "Configures a Media Services Live origin for the stream and lets you to share the origin with partner accounts within Akamai (using multi-account) as well as third-party delivery providers (using multi-CDN).", "type": "object", "properties": { "backupEncoderZone": { "description": "Specify the backup encoder's geographical location.", "example": "{{backupEncoderZone}}", "type": "string" }, "contractId": { "description": "Specify the contract ID to assign to the origin. The system filters CP codes based on the contract ID that you specify. If there is a NetStorage CP code, the system associates it with the same contract as the ingest CP code.", "example": "{{contractId}}", "type": "string" }, "cpcode": { "description": "Select the Media Services Live CP code. You use CP codes for reporting, billing, and monitoring traffic served over the intelligent edge platform.", "example": "{{cpcode}}", "type": "integer" }, "emailIds": { "description": "Specify the email addresses to receive details and status notifications for the live stream origin.", "type": "array", "items": { "type": "string" } }, "encoderZone": { "description": "Specify the primary encoder's geographical location. Choose a location that is close to your encoder.", "example": "{{encoderZone}}", "type": "string" }, "groupId": { "description": "Specify the group ID to assign to the origin.", "example": "{{groupId}}", "type": "integer" }, "hostName": { "description": "Specify the origin hostname.", "example": "{{hostName}}", "type": "string" }, "isDedicatedOrigin": { "description": "Specify whether or not the origin is a dedicated origin. When you use a dedicated origin, you must create a new stream. You can't edit an existing stream to make it dedicated. If you use a dedicated origin, the origin shield network has a new item called resource group to identify your company.", "example": "{{isDedicatedOrigin}}", "type": "boolean" }, "sharedKeys": { "description": "Shared keys enable you to share your MSL origin with partner accounts within Akamai (Multi-Account) or third-party delivery providers (Multi-CDN).", "type": "array", "items": { "additionalProperties": false, "description": "Shared keys enable you to share your MSL origin with partner accounts within Akamai (Multi-Account) or third-party delivery providers (Multi-CDN).", "type": "object", "properties": { "authMethod": { "description": "Specify the authentication method as `SIMPLE_AKAMAI_HEADER_VERIFICATION` for Akamai partner accounts or `MSL_MULTI_ACCOUNT` for third-party CDN accounts.", "type": "string", "enum": [ "SIMPLE_AKAMAI_HEADER_VERIFICATION", "MSL_MULTI_ACCOUNT" ] }, "cdnCode": { "description": "Predefined code to identify the CDN.", "type": "string" }, "enabled": { "description": "Specify `enabled` or `disabled` to activate or deactivate the CDN.", "type": "boolean" }, "expiryDate": { "description": "Specify a future date and time up to which the CDN provider configuration is valid.", "format": "date-time", "type": "string" }, "guid": { "description": "Automatically generated GUI ID for the CDN.", "type": "string" }, "key": { "description": "Automatically generated key to access the CDN.", "type": "string" }, "name": { "description": "Name to identify the CDN.", "type": "string" }, "type": { "description": "Specify `AKAMAI` if you are using an Akamai CDN or `THIRD_PARTY` if you are using some other CDN.", "type": "string", "enum": [ "AKAMAI", "THIRD_PARTY" ] } } } }, "thirdPartyCdnCpcode": { "description": "CP code to identify the third party CDN.", "example": "{{thirdPartyCdnCpcode}}", "type": "integer" } }, "x-akamai": { "file-path": "schemas/OriginDetailDTOV2Post.yaml" } } } } }, "responses": { "202": { "description": "Successful response.", "content": {}, "headers": { "Location": { "description": "Relative URL for created origin endpoint.", "schema": { "example": "/streams/123", "type": "string" }, "x-akamai": { "file-path": "headers/Location.yaml" } } } }, "400": { "description": "[Invalid data input](https://techdocs.akamai.com/msl/reference/400).", "content": { "application/problem+json": { "example": { "instance": "8ed959ae-bc22-43f4-893c-2f293518f258", "status": 400, "title": "Erroneous data input", "type": "bad-request", "errors": [ { "detail": "Expiry Date of Previous Key is required", "instance": "1664e1a7-d916-4cf9-944f-2d9f6d176f8f", "title": "Bad Request", "type": "bad-request" } ] }, "schema": { "additionalProperties": false, "description": "Contains debugging information about error responses.", "type": "object", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "The list of errors.", "type": "array", "items": { "description": "A further-nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/Problem-nested.yaml" } } }, "instance": { "description": "A non-referenceable URI indicating an error instance.", "type": "string" }, "status": { "description": "The HTTP status code of the error response.", "type": "integer" }, "title": { "description": "The title of the error response.", "type": "string" }, "type": { "description": "The URL for the error type description.", "type": "string" } }, "x-akamai": { "file-path": "schemas/ProblemDetailDTO.yaml" } } } }, "x-akamai": { "file-path": "errors/400-origin-bad-request.yaml" } }, "429": { "description": "[Rate limiting error](https://techdocs.akamai.com/msl/reference/429). The maximum request count for a specific time duration for this resource has been reached. See [Rate limiting](https://techdocs.akamai.com/msl/reference/resource-limiting) for more information.", "content": {}, "headers": { "X-RateLimit-Limit": { "schema": { "example": 50, "type": "string" }, "x-akamai": { "file-path": "headers/X-RateLimit-Limit.yaml" } }, "X-RateLimit-Remaining": { "schema": { "example": 0, "type": "string" }, "x-akamai": { "file-path": "headers/X-RateLimit-Remaining.yaml" } } }, "x-akamai": { "file-path": "errors/429.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": "Retrieves a list of all live origins associated with the profile by default, or optionally filtered live origins.", "operationId": "get-msl-origin-origins", "summary": "List live origins", "tags": [ "Origins" ], "externalDocs": { "description": "See documentation for this operation in Akamai's Media Services Live Stream Provisioning API", "url": "https://techdocs.akamai.com/msl/reference/get-msl-origin-origins" }, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "description": "Encapsulates Media Services Live origin information for the stream.", "type": "array", "items": { "additionalProperties": false, "description": "Configures a Media Services Live origin for the stream. You can share the origin with partner accounts within Akamai using 'MSL_MULTI_ACCOUNT' as well as third-party delivery providers using 'MSL_MULTI_CDN'.", "type": "object", "required": [ "id", "contractId", "cpcode", "encoderZone", "hostName", "sharedKeys" ], "properties": { "activeVersion": { "description": "The version of the origin that is enabled.", "type": "integer" }, "amdProperties": { "description": "AMD properties assigned to this origin in the current account.", "type": "array", "items": { "additionalProperties": false, "type": "object", "properties": { "assetId": { "description": "Asset ID of AMD property.", "type": "integer" }, "propertyName": { "description": "Name of AMD property.", "type": "string" } } } }, "backupEncoderZone": { "description": "The backup encoder's geographical location.", "type": "string" }, "backupHostName": { "description": "The hostname for the origin used for failover.", "type": "string" }, "contractId": { "description": "The contract ID associated with the origin. The CP code is filtered based on the contract ID that you specify. The system associates the NetStorage CP code, if there is one, with the same contract as the ingest CP code.", "type": "integer" }, "cpcode": { "description": "The Media Services Live CP code. A CP code is a unique identifier for reporting, billing, and monitoring traffic served over the Akamai network.", "type": "integer" }, "encoderZone": { "description": "The primary encoder's geographical location. Choose a location that is close to your encoder.", "type": "string" }, "hostName": { "description": "The hostname defined in your origin DNS.", "type": "string" }, "id": { "description": "Enter a unique identifier for the origin. The identifier must be unique, regardless of encoder locations and customers. The primary hostname and backup hostname are automatically derived from the origin identifier you specify.", "type": "integer" }, "isDedicatedOrigin": { "description": "Indicates whether or not the origin is a dedicated origin. When you use a dedicated origin, you must create a new stream. You can't edit an existing stream to make it dedicated. If you use a dedicated origin, the origin shield network has a new item called resource group to identify your company.", "type": "boolean" }, "modifiedBy": { "description": "The username of the person who changed the origin.", "type": "string" }, "modifiedDate": { "description": "The date on which the origin settings were modified.", "format": "date-time", "type": "string" }, "sharedKeys": { "description": "Shared keys let you share your MSL origin with Akamai partner accounts and third-party delivery providers.", "type": "array", "items": { "additionalProperties": false, "type": "object", "properties": { "amdProperties": { "description": "AMD properties assigned to this key in other accounts. It is only applicable for `AKAMAI` type of keys.", "type": "array", "items": { "additionalProperties": false, "type": "object", "properties": { "accountId": { "description": "Account ID where the AMD property was created using this shared key.", "type": "string" }, "accountName": { "description": "Account name where the AMD property was created using this shared key.", "type": "string" }, "propertyName": { "description": "Name of the AMD property created using this shared key.", "type": "string" } } } }, "authMethod": { "description": "Specify the authentication method as `SIMPLE_AKAMAI_HEADER_VERIFICATION` for Akamai partner accounts or `MSL_MULTI_ACCOUNT` for third-party CDN accounts.", "type": "string", "enum": [ "SIMPLE_AKAMAI_HEADER_VERIFICATION", "MSL_MULTI_ACCOUNT" ] }, "backupHostName": { "description": "A backup hostname for the origin.", "type": "string" }, "cdnCode": { "description": "Automatically generated code for the CDN.", "type": "string" }, "data": { "description": "Automatically generated data field for the CDN.", "type": "string" }, "enabled": { "description": "The activated status of the CDN.", "type": "boolean" }, "expiryDate": { "description": "A date and time when the CDN settings will expire. The time zone is the current time zone where you configure your settings.", "format": "date-time", "type": "string" }, "guid": { "description": "Automatically generated GUI ID for the CDN.", "type": "string" }, "hostName": { "description": "The hostname for the CDN.", "type": "string" }, "key": { "description": "Automatically generated key to access the CDN.", "type": "string" }, "name": { "description": "Name to identify the CDN.", "type": "string" }, "previousData": { "description": "Automatically generated previous data field for the CDN.", "type": "string" }, "previousKey": { "description": "The previously configured key to access the CDN.", "type": "string" }, "previousKeyExpiryDate": { "description": "The expiration date for the previous key.", "format": "date-time", "type": "string" }, "type": { "description": "Specify `AKAMAI` if you are using an Akamai CDN or `THIRD_PARTY` if you are using some other CDN.", "type": "string", "enum": [ "AKAMAI", "THIRD_PARTY" ] } } } }, "status": { "description": "The origin creation status: `SUCCEEDED` or `FAILED`.", "type": "string" }, "thirdPartyCdnCpcode": { "description": "The CP code for the third-party CDN.", "type": "integer" } }, "x-akamai": { "file-path": "schemas/OriginDetailDTOV2.yaml" } }, "x-akamai": { "file-path": "schemas/OriginsDTO.yaml" } }, "example": [ { "cpcode": 1234567, "createdBy": "adevi", "createdDate": "2018-03-12T13:14:02.607Z", "hostName": "demoHost1.akamaiorigin.net", "hostNameIdentifier": "demoHost1", "id": 7345, "location": "EUROPE", "modifiedBy": "jkowalski", "modifiedDate": "2018-03-12T13:14:02.607Z", "otherCdnCpcode": 978902, "resourceGroup": "resGrp01", "status": "PENDING", "storageCpcode": 0, "backupOriginHost": { "backupHostName": "demoHost2.akamaiorigin.net", "location": "AUSTRALIA", "storageCpcode": null } }, { "cpcode": 7654321, "createdBy": "adevi", "createdDate": "2017-06-09T20:46:34.000Z", "hostName": "demo-host3.akamaiorigin.net", "hostNameIdentifier": "demo-host3", "id": 5909, "location": "EUROPE", "modifiedBy": "jperez", "modifiedDate": "2017-06-09T20:46:34.000Z", "otherCdnCpcode": 954371, "resourceGroup": "resGrp01", "status": "PROVISIONED", "storageCpcode": 978765, "backupOriginHost": { "backupHostName": "demo-host4.akamaiorigin.net", "location": "GERMANY", "storageCpcode": null } } ] } } }, "429": { "description": "[Rate limiting error](https://techdocs.akamai.com/msl/reference/429). The maximum request count for a specific time duration for this resource has been reached. See [Rate limiting](https://techdocs.akamai.com/msl/reference/resource-limiting) for more information.", "content": {}, "headers": { "X-RateLimit-Limit": { "schema": { "example": 50, "type": "string" }, "x-akamai": { "file-path": "headers/X-RateLimit-Limit.yaml" } }, "X-RateLimit-Remaining": { "schema": { "example": 0, "type": "string" }, "x-akamai": { "file-path": "headers/X-RateLimit-Remaining.yaml" } } }, "x-akamai": { "file-path": "errors/429.yaml" } } }, "parameters": [ { "description": "Specifies the geographical region where the VOD origin is located.", "example": "{{encoderLocation}}", "in": "query", "name": "encoderLocation", "schema": { "example": "Europe", "type": "string" }, "x-akamai": { "file-path": "parameters/encoderLocation-query.yaml" } }, { "description": "The Media Services Live Content Provider code.", "example": "{{cpcode}}", "in": "query", "name": "cpcode", "schema": { "example": 876213, "type": "integer" }, "x-akamai": { "file-path": "parameters/cpcode-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" } } ] } }, "/msl-origin/origins/cpcodes": { "get": { "description": "Fetches available CP codes for a new origin.", "operationId": "get-origin-cpcodes", "summary": "List CP codes per origin", "tags": [ "Origins" ], "externalDocs": { "description": "See documentation for this operation in Akamai's Media Services Live Stream Provisioning API", "url": "https://techdocs.akamai.com/msl/reference/get-origin-cpcodes" }, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "description": "Specifies the origin CP codes.", "type": "array", "items": { "additionalProperties": false, "type": "object", "properties": { "contracts": { "description": "CP code identifiers.", "type": "array", "items": { "additionalProperties": false, "type": "object", "properties": { "contractId": { "description": "The ID of the contract associated with the CP code.", "type": "string" } } } }, "id": { "description": "CP code that you can use to create the origin.", "type": "integer" }, "isUsed": { "description": "Indicates whether the CP code is assigned to an origin.", "type": "boolean" }, "name": { "description": "Name of the CP code.", "type": "string" } } }, "x-akamai": { "file-path": "schemas/CpcodeDTO.yaml" } }, "example": [ { "id": 321234, "name": "Test", "contracts": [ { "contractId": "C-0N7RAC71" } ] } ] } } } }, "parameters": [ { "description": "__Enum__ Specifies whether to retrieve `AKAMAI` or `THIRD_PARTY` CP codes.", "example": "{{type}}", "in": "query", "name": "type", "schema": { "example": "AKAMAI", "type": "string", "enum": [ "AKAMAI", "THIRD_PARTY" ] }, "x-akamai": { "file-path": "parameters/type-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" } } ] } }, "/msl-origin/origins/{originId}": { "get": { "description": "Retrieves detailed information about the requested origin.", "operationId": "get-origin", "summary": "Get an origin", "tags": [ "Origins" ], "externalDocs": { "description": "See documentation for this operation in Akamai's Media Services Live Stream Provisioning API", "url": "https://techdocs.akamai.com/msl/reference/get-origin" }, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "example": { "activeVersion": "3", "backupEncoderZone": "EUROPE", "backupHostName": "003-dn001-demohost.akamaiorigin.net", "cpcode": 1234567, "encoderZone": "US_EAST", "format": "HLS", "hostName": "001-dn001-demohost.akamaiorigin.net", "id": 101, "modifiedBy": "jsmith", "modifiedDate": "2017-03-04T02:41:27.964Z", "status": "SUCCEEDED", "thirdPartyCdnCpcode": 654321, "sharedKeys": [ { "authMethod": "MSL_MULTI_ACCOUNT", "enabled": true, "key": "7153f558f89e058ae", "name": "SomeName01", "type": "AKAMAI" }, { "authMethod": "MSL_MULTI_ACCOUNT", "enabled": false, "key": "2557f557f39e025db", "name": "nonce2", "type": "AKAMAI" }, { "authMethod": "SIMPLE_AKAMAI_HEADER_VERIFICATION", "backupHostName": "003-dn00x-demohost.akamaiorigin.net", "cdnCode": "dn00x", "enabled": false, "expiryDate": "2018-12-12T06:15:00.000Z", "guid": "402254d3-e75e-4501-8709-5a3a2211f79", "hostName": "001-dn00x-demohost.akamaiorigin.net", "key": "h0BhBScF1Wb3y1r8clJqqg==", "name": "SomeName03", "previousKey": "a2BhDFcH1Wu6y1r8clJllm==", "previousKeyExpiryDate": "2017-11-22T12:33:00.000Z", "type": "THIRD_PARTY" }, { "authMethod": "SIMPLE_AKAMAI_HEADER_VERIFICATION", "backupHostName": "003-dn00x-demohost.akamaiorigin.net", "cdnCode": "dn00x", "enabled": true, "expiryDate": "2017-09-25T18:33:00.000Z", "guid": "105254f3-e75e-4501-8709-5a3a2277d09", "hostName": "001-dn00x-demohost.akamaiorigin.net", "key": "h2MhYEcH1Wu3z1r9clJoob==", "name": "SomeName04", "type": "THIRD_PARTY" } ] }, "schema": { "additionalProperties": false, "description": "Configures a Media Services Live origin for the stream. You can share the origin with partner accounts within Akamai using 'MSL_MULTI_ACCOUNT' as well as third-party delivery providers using 'MSL_MULTI_CDN'.", "type": "object", "required": [ "id", "contractId", "cpcode", "encoderZone", "hostName", "sharedKeys" ], "properties": { "activeVersion": { "description": "The version of the origin that is enabled.", "type": "integer" }, "amdProperties": { "description": "AMD properties assigned to this origin in the current account.", "type": "array", "items": { "additionalProperties": false, "type": "object", "properties": { "assetId": { "description": "Asset ID of AMD property.", "type": "integer" }, "propertyName": { "description": "Name of AMD property.", "type": "string" } } } }, "backupEncoderZone": { "description": "The backup encoder's geographical location.", "type": "string" }, "backupHostName": { "description": "The hostname for the origin used for failover.", "type": "string" }, "contractId": { "description": "The contract ID associated with the origin. The CP code is filtered based on the contract ID that you specify. The system associates the NetStorage CP code, if there is one, with the same contract as the ingest CP code.", "type": "integer" }, "cpcode": { "description": "The Media Services Live CP code. A CP code is a unique identifier for reporting, billing, and monitoring traffic served over the Akamai network.", "type": "integer" }, "encoderZone": { "description": "The primary encoder's geographical location. Choose a location that is close to your encoder.", "type": "string" }, "hostName": { "description": "The hostname defined in your origin DNS.", "type": "string" }, "id": { "description": "Enter a unique identifier for the origin. The identifier must be unique, regardless of encoder locations and customers. The primary hostname and backup hostname are automatically derived from the origin identifier you specify.", "type": "integer" }, "isDedicatedOrigin": { "description": "Indicates whether or not the origin is a dedicated origin. When you use a dedicated origin, you must create a new stream. You can't edit an existing stream to make it dedicated. If you use a dedicated origin, the origin shield network has a new item called resource group to identify your company.", "type": "boolean" }, "modifiedBy": { "description": "The username of the person who changed the origin.", "type": "string" }, "modifiedDate": { "description": "The date on which the origin settings were modified.", "format": "date-time", "type": "string" }, "sharedKeys": { "description": "Shared keys let you share your MSL origin with Akamai partner accounts and third-party delivery providers.", "type": "array", "items": { "additionalProperties": false, "type": "object", "properties": { "amdProperties": { "description": "AMD properties assigned to this key in other accounts. It is only applicable for `AKAMAI` type of keys.", "type": "array", "items": { "additionalProperties": false, "type": "object", "properties": { "accountId": { "description": "Account ID where the AMD property was created using this shared key.", "type": "string" }, "accountName": { "description": "Account name where the AMD property was created using this shared key.", "type": "string" }, "propertyName": { "description": "Name of the AMD property created using this shared key.", "type": "string" } } } }, "authMethod": { "description": "Specify the authentication method as `SIMPLE_AKAMAI_HEADER_VERIFICATION` for Akamai partner accounts or `MSL_MULTI_ACCOUNT` for third-party CDN accounts.", "type": "string", "enum": [ "SIMPLE_AKAMAI_HEADER_VERIFICATION", "MSL_MULTI_ACCOUNT" ] }, "backupHostName": { "description": "A backup hostname for the origin.", "type": "string" }, "cdnCode": { "description": "Automatically generated code for the CDN.", "type": "string" }, "data": { "description": "Automatically generated data field for the CDN.", "type": "string" }, "enabled": { "description": "The activated status of the CDN.", "type": "boolean" }, "expiryDate": { "description": "A date and time when the CDN settings will expire. The time zone is the current time zone where you configure your settings.", "format": "date-time", "type": "string" }, "guid": { "description": "Automatically generated GUI ID for the CDN.", "type": "string" }, "hostName": { "description": "The hostname for the CDN.", "type": "string" }, "key": { "description": "Automatically generated key to access the CDN.", "type": "string" }, "name": { "description": "Name to identify the CDN.", "type": "string" }, "previousData": { "description": "Automatically generated previous data field for the CDN.", "type": "string" }, "previousKey": { "description": "The previously configured key to access the CDN.", "type": "string" }, "previousKeyExpiryDate": { "description": "The expiration date for the previous key.", "format": "date-time", "type": "string" }, "type": { "description": "Specify `AKAMAI` if you are using an Akamai CDN or `THIRD_PARTY` if you are using some other CDN.", "type": "string", "enum": [ "AKAMAI", "THIRD_PARTY" ] } } } }, "status": { "description": "The origin creation status: `SUCCEEDED` or `FAILED`.", "type": "string" }, "thirdPartyCdnCpcode": { "description": "The CP code for the third-party CDN.", "type": "integer" } }, "x-akamai": { "file-path": "schemas/OriginDetailDTOV2.yaml" } } } } }, "404": { "description": "The API returns 404 response when the user doesn't have access to the requested Origin or when an invalid Origin ID is passed.", "content": { "application/problem+json": { "example": { "detail": "Resource Not Found", "instance": "28b19a30-9f46-4fbe-9242-cf987fb08b83", "status": 404, "title": "Resource Not Found", "type": "resource-not-found" }, "schema": { "additionalProperties": false, "description": "Contains debugging information about error responses.", "type": "object", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "The list of errors.", "type": "array", "items": { "description": "A further-nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/Problem-nested.yaml" } } }, "instance": { "description": "A non-referenceable URI indicating an error instance.", "type": "string" }, "status": { "description": "The HTTP status code of the error response.", "type": "integer" }, "title": { "description": "The title of the error response.", "type": "string" }, "type": { "description": "The URL for the error type description.", "type": "string" } }, "x-akamai": { "file-path": "schemas/ProblemDetailDTO.yaml" } } } } }, "429": { "description": "[Rate limiting error](https://techdocs.akamai.com/msl/reference/429). The maximum request count for a specific time duration for this resource has been reached. See [Rate limiting](https://techdocs.akamai.com/msl/reference/resource-limiting) for more information.", "content": {}, "headers": { "X-RateLimit-Limit": { "schema": { "example": 50, "type": "string" }, "x-akamai": { "file-path": "headers/X-RateLimit-Limit.yaml" } }, "X-RateLimit-Remaining": { "schema": { "example": 0, "type": "string" }, "x-akamai": { "file-path": "headers/X-RateLimit-Remaining.yaml" } } }, "x-akamai": { "file-path": "errors/429.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" } } ] }, "put": { "description": "Updates certain fields of the origin. You can also use this API to rotate keys. Populate `previousKey` and `previousKeyExpiryDate` fields if you need your old keys to be valid for a certain amount of time even after rotating.", "operationId": "put-origin", "summary": "Update an origin", "tags": [ "Origins" ], "externalDocs": { "description": "See documentation for this operation in Akamai's Media Services Live Stream Provisioning API", "url": "https://techdocs.akamai.com/msl/reference/put-origin" }, "requestBody": { "required": true, "content": { "application/json": { "example": { "id": 101, "emailIds": [ "email1", "email2" ], "sharedKeys": [ { "authMethod": "MSL_MULTI_ACCOUNT", "enabled": true, "key": "7153f558f89e058ae", "name": "SomeName01", "type": "AKAMAI" }, { "authMethod": "MSL_MULTI_ACCOUNT", "enabled": false, "key": "2557f557f39e025db", "name": "nonce2", "type": "AKAMAI" }, { "authMethod": "SIMPLE_AKAMAI_HEADER_VERIFICATION", "cdnCode": "dn00x", "enabled": false, "expiryDate": "2018-12-12T06:15:00.000Z", "guid": "402254d3-e75e-4501-8709-5a3a2211f79", "key": "h0BhBScF1Wb3y1r8clJqqg==", "name": "SomeName03", "previousKey": "a2BhDFcH1Wu6y1r8clJllm==", "previousKeyExpiryDate": "2017-11-22T12:33:00.000Z", "type": "THIRD_PARTY" }, { "authMethod": "SIMPLE_AKAMAI_HEADER_VERIFICATION", "cdnCode": "dn00x", "enabled": true, "expiryDate": "2017-09-25T18:33:00.000Z", "guid": "105254f3-e75e-4501-8709-5a3a2277d09", "key": "h2MhYEcH1Wu3z1r9clJoob==", "name": "SomeName04", "type": "THIRD_PARTY" } ] }, "schema": { "additionalProperties": false, "description": "Configures a Media Services Live origin for the stream and lets you share the origin with partner accounts within Akamai using 'MSL_MULTI_ACCOUNT' as well as third-party delivery providers using 'MSL_MULTI_CDN'.", "type": "object", "properties": { "emailIds": { "description": "Specify the email addresses to receive details and status notifications for the live stream origin.", "type": "array", "items": { "type": "string" } }, "id": { "description": "Enter a unique identifier for the origin. The identifier must be unique, regardless of encoder locations and customers. The primary hostname and backup hostname are automatically derived from the origin identifier you specify.", "example": "{{id}}", "type": "integer" }, "sharedKeys": { "description": "Shared keys enable you to share your MSL origin with partner accounts within Akamai (Multi-Account) or third-party delivery providers (Multi-CDN).", "type": "array", "items": { "additionalProperties": false, "description": "Shared keys enable you to share your MSL origin with partner accounts within Akamai or third-party delivery providers.", "type": "object", "properties": { "authMethod": { "description": "Specify the authentication method as `SIMPLE_AKAMAI_HEADER_VERIFICATION` for Akamai partner accounts or `MSL_MULTI_ACCOUNT` for third-party CDN accounts.", "type": "string", "enum": [ "SIMPLE_AKAMAI_HEADER_VERIFICATION", "MSL_MULTI_ACCOUNT" ] }, "backupHostName": { "description": "Specify a backup hostname for the CDN.", "type": "string" }, "cdnCode": { "description": "Automatically generated code for the CDN.", "type": "string" }, "enabled": { "description": "Specify `enabled` or `disabled` to activate or deactivate the CDN.", "type": "boolean" }, "expiryDate": { "description": "Specify a future date and time up to which the CDN provider configuration is valid. The time zone is the current time zone where you configure your settings.", "format": "date-time", "type": "string" }, "guid": { "description": "Automatically generated GUI ID for the CDN.", "type": "string" }, "hostName": { "description": "Specify the hostname for the origin.", "type": "string" }, "key": { "description": "Automatically generated key to access the CDN.", "type": "string" }, "name": { "description": "Name to identify the CDN.", "type": "string" }, "previousKey": { "description": "Displays the previously configured key to access the CDN.", "type": "string" }, "previousKeyExpiryDate": { "description": "Displays the expiration date for the previous key.", "format": "date-time", "type": "string" }, "type": { "description": "Specify `AKAMAI` if you are using an Akamai CDN or `THIRD_PARTY` if you are using some other CDN.", "type": "string", "enum": [ "AKAMAI", "THIRD_PARTY" ] } } } } }, "x-akamai": { "file-path": "schemas/OriginDetailDTOV2Put.yaml" } } } } }, "responses": { "202": { "description": "Successful response.", "content": { "*/*": {} } }, "400": { "description": "[Invalid data input](https://techdocs.akamai.com/msl/reference/400).", "content": { "application/problem+json": { "example": { "instance": "8ed959ae-bc22-43f4-893c-2f293518f258", "status": 400, "title": "Erroneous data input", "type": "bad-request", "errors": [ { "detail": "Expiry Date of Previous Key is required", "instance": "1664e1a7-d916-4cf9-944f-2d9f6d176f8f", "title": "Bad Request", "type": "bad-request" } ] }, "schema": { "additionalProperties": false, "description": "Contains debugging information about error responses.", "type": "object", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "The list of errors.", "type": "array", "items": { "description": "A further-nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/Problem-nested.yaml" } } }, "instance": { "description": "A non-referenceable URI indicating an error instance.", "type": "string" }, "status": { "description": "The HTTP status code of the error response.", "type": "integer" }, "title": { "description": "The title of the error response.", "type": "string" }, "type": { "description": "The URL for the error type description.", "type": "string" } }, "x-akamai": { "file-path": "schemas/ProblemDetailDTO.yaml" } } } }, "x-akamai": { "file-path": "errors/400-origin-bad-request.yaml" } }, "429": { "description": "[Rate limiting error](https://techdocs.akamai.com/msl/reference/429). The maximum request count for a specific time duration for this resource has been reached. See [Rate limiting](https://techdocs.akamai.com/msl/reference/resource-limiting) for more information.", "content": {}, "headers": { "X-RateLimit-Limit": { "schema": { "example": 50, "type": "string" }, "x-akamai": { "file-path": "headers/X-RateLimit-Limit.yaml" } }, "X-RateLimit-Remaining": { "schema": { "example": 0, "type": "string" }, "x-akamai": { "file-path": "headers/X-RateLimit-Remaining.yaml" } } }, "x-akamai": { "file-path": "errors/429.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" } } ] }, "delete": { "description": "Deletes the specified origin.", "operationId": "delete-origin", "summary": "Remove an origin", "tags": [ "Origins" ], "externalDocs": { "description": "See documentation for this operation in Akamai's Media Services Live Stream Provisioning API", "url": "https://techdocs.akamai.com/msl/reference/delete-origin" }, "responses": { "202": { "description": "Successful response.", "content": { "*/*": {} } }, "400": { "description": "[Invalid data input](https://techdocs.akamai.com/msl/reference/400). The API returns 400 response when the user doesn't have access to the requested origin or when there are streams in the origin.", "content": { "application/problem+json": { "example": { "detail": "There are active streams existing under this origin. Please delete the streams before deleting the origin.", "instance": "d99ef8b5-04eb-4e98-b689-ac0778bf510c", "status": 400, "title": "Bad Request", "type": "bad-request" }, "schema": { "additionalProperties": false, "description": "Contains debugging information about error responses.", "type": "object", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "The list of errors.", "type": "array", "items": { "description": "A further-nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/Problem-nested.yaml" } } }, "instance": { "description": "A non-referenceable URI indicating an error instance.", "type": "string" }, "status": { "description": "The HTTP status code of the error response.", "type": "integer" }, "title": { "description": "The title of the error response.", "type": "string" }, "type": { "description": "The URL for the error type description.", "type": "string" } }, "x-akamai": { "file-path": "schemas/ProblemDetailDTO.yaml" } } } }, "x-akamai": { "file-path": "errors/400-origin-delete-exception.yaml" } }, "429": { "description": "[Rate limiting error](https://techdocs.akamai.com/msl/reference/429). The maximum request count for a specific time duration for this resource has been reached. See [Rate limiting](https://techdocs.akamai.com/msl/reference/resource-limiting) for more information.", "content": {}, "headers": { "X-RateLimit-Limit": { "schema": { "example": 50, "type": "string" }, "x-akamai": { "file-path": "headers/X-RateLimit-Limit.yaml" } }, "X-RateLimit-Remaining": { "schema": { "example": 0, "type": "string" }, "x-akamai": { "file-path": "headers/X-RateLimit-Remaining.yaml" } } }, "x-akamai": { "file-path": "errors/429.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": "Unique identifier for each origin.", "example": "{{originId}}", "in": "path", "name": "originId", "required": true, "schema": { "example": 123456, "type": "integer" }, "x-akamai": { "file-path": "parameters/originId-path.yaml" } } ] }, "/msl-origin/publishing-locations": { "get": { "description": "Get valid encoder locations.", "operationId": "get-publishing-locations", "summary": "List publishing locations", "tags": [ "Publishing locations" ], "externalDocs": { "description": "See documentation for this operation in Akamai's Media Services Live Stream Provisioning API", "url": "https://techdocs.akamai.com/msl/reference/get-publishing-locations" }, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "description": "Specifies details about the location where the stream is published.", "type": "array", "items": { "additionalProperties": false, "type": "object", "properties": { "code": { "description": "Specifies an identifier for the location where the stream is published.", "type": "string" }, "ingestLocations": { "additionalProperties": false, "description": "Specifies the Ingest Locations such as countries, states and cities associated with the Encoder location.", "type": "object", "properties": { "countryName": { "description": "Specify the preferred country name.", "type": "string" }, "states": { "description": "Specify one or more states associated with the selected country.", "type": "array", "items": { "additionalProperties": false, "description": "Contains information about the state and corresponding cities for the ingest location.", "type": "object", "properties": { "cities": { "description": "Specify one or more cities associated with the selected state.", "type": "array", "items": { "additionalProperties": false, "description": "Contains information about the city.", "type": "object", "properties": { "name": { "description": "Specify the preferred city name for the ingest location.", "type": "string" } }, "x-akamai": { "file-path": "schemas/GeoCityDTO.yaml" } } }, "name": { "description": "Specify the preferred state name.", "type": "string" } }, "x-akamai": { "file-path": "schemas/GeoStateDTO.yaml" } } } }, "x-akamai": { "file-path": "schemas/GeoCountryDTO.yaml" } }, "location": { "description": "Specifies the geographical location where the stream is published.", "type": "string" }, "netstorageZone": { "description": "Specifies the NetStorage zone location you can use to replicate your content.", "type": "string" } } }, "x-akamai": { "file-path": "schemas/PublishingLocationDTO.yaml" } }, "example": [ { "code": "001", "location": "EUROPE", "netstorageZone": "europe", "geoCountries": [ { "name": "DE", "states": [ { "name": "HE", "cities": [ { "name": "FRANKFURT" } ] } ] }, { "name": "NL", "states": [ { "name": "N/A", "cities": [ { "name": "SCHIPHOL" }, { "name": "AMSTERDAM" } ] } ] } ] }, { "code": "002", "location": "NORTH_AMERICA", "netstorageZone": "us", "geoCountries": [ { "name": "US", "states": [ { "name": "CA", "cities": [ { "name": "LOSANGELES" }, { "name": "SANJOSE" } ] }, { "name": "IL", "cities": [ { "name": "CHICAGO" } ] } ] } ] }, { "code": "012", "location": "INDIA", "netstorageZone": "asia", "geoCountries": [ { "name": "IN", "states": [ { "name": "N/A", "cities": [ { "name": "MUMBAI" }, { "name": "CHENNAI" }, { "name": "BANGALORE" } ] } ] } ] }, { "code": "010", "location": "AUSTRALIA", "netstorageZone": "AU", "geoCountries": [ { "name": "AU", "states": [ { "name": "N/A", "cities": [ { "name": "SYDNEY" } ] } ] } ] }, { "code": "016", "location": "TAIWAN", "netstorageZone": "asia" }, { "code": "015", "location": "MEXICO", "netstorageZone": "us" } ] } } } }, "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" } } ] } }, "/msl-origin/streams": { "post": { "description": "Provisions a new stream. To create an ingest stream using Media Services Live 4, you need to:\n\n- Set up an ingest for the stream\n- Set up an archive for the stream. For details on the types of archive you can specify, see [Archive stream members](https://techdocs.akamai.com/msl/reference/archive-stream-members).\n- Set up Media Services Live origin for the stream.\n\nThe process of creating or updating any stream changes its status to `PENDING`. When all of the steps are complete, the stream status changes to `PROVISIONED`. If any of the steps fail, the stream status changes to `FAILED`. It takes two to three hours to provision a stream.", "operationId": "post-stream", "summary": "Create a stream", "tags": [ "Streams" ], "externalDocs": { "description": "See documentation for this operation in Akamai's Media Services Live Stream Provisioning API", "url": "https://techdocs.akamai.com/msl/reference/post-stream" }, "requestBody": { "required": true, "content": { "application/json": { "example": { "activeArchiveDurationInDays": 2, "backupEncoderZone": "AUSTRALIA", "contractId": "C-0N7RAC71", "cpcode": 7654321, "encoderZone": "EUROPE", "format": "HLS", "groupId": 1234, "ingestAccelerated": false, "isDedicatedOrigin": false, "name": "Demostream", "additionalEmailIds": [ "xyz@akamai1.com" ], "allowedIps": [ "192.0.2.26" ], "origin": { "hostName": "demo-host1" }, "streamAuth": { "algorithm": "SHA512", "password": "123abc!", "username": "tyamada" } }, "schema": { "additionalProperties": false, "description": "Encapsulates stream configuration and version information. You can list, create, edit, delete, and get details of streams.", "type": "object", "properties": { "activeArchiveDurationInDays": { "description": "Specify from `1` to `31` to archive your active content. This option is available only for HLS and DASH streams. It appears if you have `MediaServicesLive4::LiveToVOD` in your contract. There is no default value.", "example": "{{activeArchiveDurationInDays}}", "type": "integer" }, "additionalEmailIds": { "description": "Email addresses for people to receive the stream configuration details and status notifications.", "type": "array", "items": { "description": "Email address to receive the stream configuration details and status notifications.", "type": "string" } }, "allowedIps": { "description": "The IP addresses for your encoder. You can enter up to 50 IP addresses.", "type": "array", "items": { "description": "The IP address for your encoder. You can enter up to 50 IP addresses.", "type": "string" } }, "backupDirectConnectSettings": { "additionalProperties": false, "description": "Specify details about the backup stream direct connect settings.", "type": "object", "properties": { "message": { "description": "A message about the stream provisioning status.", "type": "string" }, "status": { "description": "The status of the stream. Possible enum values are: `PENDING`, `PROVISIONED`, `FAILED`.", "type": "string", "enum": [ "PENDING", "PROVISIONED", "FAILED" ] }, "streamId": { "description": "A unique identifier for the stream.", "type": "integer" } }, "x-akamai": { "file-path": "schemas/DirectConnectSettingsDTO.yaml" } }, "backupEncoderZone": { "description": "The geographical location of your backup encoder.", "example": "{{backupEncoderZone}}", "type": "string" }, "backupIngestLocations": { "additionalProperties": false, "description": "Specifies the ingest locations such as countries, states, and cities associated with the backup encoder zone.", "type": "object", "properties": { "countryName": { "description": "Specify the preferred country name.", "type": "string" }, "states": { "description": "Specify one or more states associated with the selected country.", "type": "array", "items": { "additionalProperties": false, "description": "Contains information about the state and corresponding cities for the ingest location.", "type": "object", "properties": { "cities": { "description": "Specify one or more cities associated with the selected state.", "type": "array", "items": { "additionalProperties": false, "description": "Contains information about the city.", "type": "object", "properties": { "name": { "description": "Specify the preferred city name for the ingest location.", "type": "string" } }, "x-akamai": { "file-path": "schemas/GeoCityDTO.yaml" } } }, "name": { "description": "Specify the preferred state name.", "type": "string" } }, "x-akamai": { "file-path": "schemas/GeoStateDTO.yaml" } } } }, "x-akamai": { "file-path": "schemas/GeoCountryDTO.yaml" } }, "backupStorageGroup": { "additionalProperties": false, "description": "Specifies the details about the secondary storage group override.", "type": "object", "properties": { "cpcode": { "description": "The storage group's Content Provider code.", "type": "integer" }, "isNew": { "description": "Whether a new storage CP code needs to be created along with a stream.", "type": "boolean" }, "name": { "description": "The name that identifies the Content Provider code.", "type": "string" } }, "x-akamai": { "file-path": "schemas/StorageGroupPostDTO.yaml" } }, "contractId": { "description": "The unique identifier for the contract associated with the stream. The system filters the ingest CP code based on the contract ID that you specify. If you create a NetStorage CP code, it is associated with the same contract as the ingest CP code. If you do not specify a contract ID, the system uses the first valid contract.", "example": "{{contractId}}", "type": "string" }, "cpcode": { "description": "The Content Provider code (CP code) assigned to the stream. A CP code is a unique identifier for reporting, billing, and monitoring traffic served over the Akamai network. It is supplied to you when you purchase a product, and you need it to activate any associated properties. You can generate additional CP codes, typically to implement more detailed billing and reporting functions and assign to custom properties.", "example": "{{cpcode}}", "type": "integer" }, "dvrWindow": { "description": "The length of time the streaming content is available in archive, from 5 to 30 minutes. All streams use a 30-minute scrub back window.", "example": "{{dvrWindow}}", "type": "integer" }, "encoderZone": { "description": "The primary encoder's geographical location. Choose an encoder that is close to your location.", "example": "{{encoderZone}}", "type": "string" }, "events": { "description": "The name of the event you want to purge.", "type": "array", "items": { "additionalProperties": false, "description": "Specify the name of the event and the number of days of data pertaining to the event that you want to purge.", "type": "object", "properties": { "age": { "description": "The number of days of data for the event that you want to delete from storage.", "type": "integer" }, "event": { "description": "The name of the event you want to purge.", "type": "string" } } } }, "format": { "description": "The ingest format for Apple HTTP Live Streaming (`HLS`), Adobe HTTP Dynamic Streaming (`HDS`), Dynamic Adaptive Streaming over HTTP (`DASH`), or Common Media Application Format (`CMAF`).", "example": "{{format}}", "type": "string", "enum": [ "HLS", "HDS", "DASH", "CMAF" ] }, "groupId": { "description": "Specify the group ID to assign to the origin.", "example": "{{groupId}}", "type": "integer" }, "ingestAccelerated": { "description": "Indicates whether to use the Media Services Live Ingest Acceleration feature. The Ingest Acceleration feature improves encoder to Akamai ingest performance and provides more stability and reliability over the first mile. If you select `true`, enter a password in the `Password` field. The username is the Media Services Live CP code.", "example": "{{ingestAccelerated}}", "type": "boolean" }, "isDedicatedOrigin": { "description": "If you use a dedicated origin, the origin shield network uses resource group to identify your company. You can't edit an existing stream to make it dedicated, you can use this option only when you create a new stream.", "example": "{{isDedicatedOrigin}}", "type": "boolean" }, "name": { "description": "The name of the stream. The name can be up to 90 characters long and can include alphanumeric, underscore, and dash characters.", "example": "{{name}}", "type": "string" }, "origin": { "additionalProperties": false, "description": "The primary Media Services Live origin for the stream.", "type": "object", "properties": { "cpcode": { "description": "The origin CP code.", "type": "integer" }, "hostName": { "description": "Specify the origin hostname.", "type": "string" } } }, "password": { "description": "Specifies the password for authentication.", "example": "{{password}}", "type": "string" }, "primaryDirectConnectSettings": { "additionalProperties": false, "description": "Specify details about the primary stream direct connect settings.", "type": "object", "properties": { "message": { "description": "A message about the stream provisioning status.", "type": "string" }, "status": { "description": "The status of the stream. Possible enum values are: `PENDING`, `PROVISIONED`, `FAILED`.", "type": "string", "enum": [ "PENDING", "PROVISIONED", "FAILED" ] }, "streamId": { "description": "A unique identifier for the stream.", "type": "integer" } }, "x-akamai": { "file-path": "schemas/DirectConnectSettingsDTO.yaml" } }, "primaryIngestLocations": { "additionalProperties": false, "description": "Specifies the ingest locations such as countries, states, and cities associated with the primary encoder zone.", "type": "object", "properties": { "countryName": { "description": "Specify the preferred country name.", "type": "string" }, "states": { "description": "Specify one or more states associated with the selected country.", "type": "array", "items": { "additionalProperties": false, "description": "Contains information about the state and corresponding cities for the ingest location.", "type": "object", "properties": { "cities": { "description": "Specify one or more cities associated with the selected state.", "type": "array", "items": { "additionalProperties": false, "description": "Contains information about the city.", "type": "object", "properties": { "name": { "description": "Specify the preferred city name for the ingest location.", "type": "string" } }, "x-akamai": { "file-path": "schemas/GeoCityDTO.yaml" } } }, "name": { "description": "Specify the preferred state name.", "type": "string" } }, "x-akamai": { "file-path": "schemas/GeoStateDTO.yaml" } } } }, "x-akamai": { "file-path": "schemas/GeoCountryDTO.yaml" } }, "storageGroup": { "additionalProperties": false, "description": "Specifies the details about the primary storage group override.", "type": "object", "properties": { "cpcode": { "description": "The storage group's Content Provider code.", "type": "integer" }, "isNew": { "description": "Whether a new storage CP code needs to be created along with a stream.", "type": "boolean" }, "name": { "description": "The name that identifies the Content Provider code.", "type": "string" } }, "x-akamai": { "file-path": "schemas/StorageGroupPostDTO.yaml" } }, "streamAuth": { "additionalProperties": false, "description": "Specifies details about the stream authentication settings.", "type": "object", "properties": { "algorithm": { "description": "The algorithm used to generate the hash for authentication. Specify `SHA256`, `SHA512`, `SHA512_256`, or `MD5`. `SHA256` is the Secure Hash Algorithm, which is a type of cryptographic hash function that generates a 256-bit (32-byte) hash. A cryptographic hash is like a signature for a text or a data file. `SHA512` is a cryptographic hash function that when applied to the provided input results in a 128-digit hexadecimal number that is highly unlikely to match the value produced for a different input. The `MD5` message-digest algorithm is a hash function producing a 128-bit hash value. It is less secure than `SHA256`.", "type": "string", "enum": [ "SHA256", "SHA512", "SHA512_256", "MD5" ] }, "password": { "description": "Specify the password for authentication.", "type": "string" }, "username": { "description": "Specify the username for authentication.", "type": "string" } }, "x-akamai": { "file-path": "schemas/StreamAuthDTOPost.yaml" } }, "streamLevelPurgeDays": { "description": "Specify the archive duration value to purge the content for all the events. You need this value only when specifying the `dvrWindow`. You don't need it when specifying `activeArchiveDurationInDays`.", "example": "{{streamLevelPurgeDays}}", "type": "integer" }, "vodOrigin": { "additionalProperties": false, "description": "Enables you to record the video on demand. This option is available only for HLS and DASH streams and applies only when you include the `activeArchiveDurationInDays` member. You can include it if you have `MediaServicesLive4::LiveToVOD` or `MediaServicesLive4::LiveToVodBeta2` in your contract.", "type": "object", "properties": { "cpcode": { "description": "The CP code of an existing VOD origin. This is the NetStorage CP code that is used to archive the live recordings. The CP code name is mandatory when you create a new VOD origin, but its value is optional.", "type": "integer" }, "name": { "description": "Name of your new VOD origin.", "type": "string" } } } }, "x-akamai": { "file-path": "schemas/StreamDetailsPostDTO.yaml" } } } } }, "responses": { "202": { "description": "Successful response.", "content": {}, "headers": { "Location": { "description": "Relative URL for created stream endpoint.", "schema": { "type": "string" } } } }, "400": { "description": "[Invalid data input](https://techdocs.akamai.com/msl/reference/400).", "content": { "application/problem+json": { "example": { "instance": "84429474-0f5c-4b85-9d8f-bfe7760a8c5a", "status": 400, "title": "Erroneous data input", "type": "bad-request", "errors": [ { "detail": "Invalid CPCode", "instance": "cb10d72d-8898-45df-815f-7ddeda6ccfbe", "title": "Bad Request", "type": "bad-request" }, { "detail": "Lengthy Origin Identifier. Should not exceed 16 characters", "instance": "c8bd6cb7-5d81-414e-857e-f3533df7cca0", "title": "Bad Request", "type": "bad-request" } ] }, "schema": { "additionalProperties": false, "description": "Contains debugging information about error responses.", "type": "object", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "The list of errors.", "type": "array", "items": { "description": "A further-nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/Problem-nested.yaml" } } }, "instance": { "description": "A non-referenceable URI indicating an error instance.", "type": "string" }, "status": { "description": "The HTTP status code of the error response.", "type": "integer" }, "title": { "description": "The title of the error response.", "type": "string" }, "type": { "description": "The URL for the error type description.", "type": "string" } }, "x-akamai": { "file-path": "schemas/ProblemDetailDTO.yaml" } } } }, "x-akamai": { "file-path": "errors/400-stream-create-exception.yaml" } }, "429": { "description": "[Rate limiting error](https://techdocs.akamai.com/msl/reference/429). The maximum request count for a specific time duration for this resource has been reached. See [Rate limiting](https://techdocs.akamai.com/msl/reference/resource-limiting) for more information.", "content": {}, "headers": { "X-RateLimit-Limit": { "schema": { "example": 50, "type": "string" }, "x-akamai": { "file-path": "headers/X-RateLimit-Limit.yaml" } }, "X-RateLimit-Remaining": { "schema": { "example": 0, "type": "string" }, "x-akamai": { "file-path": "headers/X-RateLimit-Remaining.yaml" } } }, "x-akamai": { "file-path": "errors/429.yaml" } } }, "parameters": [ { "description": "Specifies the stream to clone the internal settings from.", "example": "{{cloneInternalSettingsFromStreamId}}", "in": "query", "name": "cloneInternalSettingsFromStreamId", "schema": { "default": -1, "example": 50005, "type": "integer" }, "x-akamai": { "file-path": "parameters/cloneInternalSettingsFromStreamId-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" } } ] }, "get": { "description": "Retrieves a list of all streams available to a user. Supports optional URL Parameters for pagination and sorting of the results.", "operationId": "get-streams", "summary": "List streams", "tags": [ "Streams" ], "externalDocs": { "description": "See documentation for this operation in Akamai's Media Services Live Stream Provisioning API", "url": "https://techdocs.akamai.com/msl/reference/get-streams" }, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "example": { "page": 1, "pageSize": 10, "totalSize": 5, "streams": [ { "backupStorageCpcode": null, "cpcode": 1234567, "createdBy": "jperez", "createdDate": "2017-11-14T07:06:25.794Z", "dvrWindowInMin": -1, "encoderZone": "EUROPE", "format": "HLS", "id": 123456, "modifiedBy": "adevi", "modifiedDate": "2017-05-25T07:38:18.003Z", "name": "DemoStream1", "originHostName": "demo-host1.akamaiorigin.net", "primaryStorageCpcode": 514779, "streamAuth": true, "provisionDetail": { "message": "Provisioned", "status": "PROVISIONED" } }, { "backupStorageCpcode": null, "cpcode": 987654, "createdBy": "jdupont", "createdDate": "2017-11-14T07:06:25.794Z", "dvrWindowInMin": 5, "encoderZone": "EUROPE", "format": "HLS", "id": 232123, "modifiedBy": "jperez", "modifiedDate": "2017-05-25T06:30:48.215Z", "name": "DemoStream2", "originHostName": "demo-host2.akamaiorigin.net", "primaryStorageCpcode": 558239, "streamAuth": false, "provisionDetail": { "message": "Stream provisioning failed", "status": "FAILED" } }, { "backupStorageCpcode": null, "cpcode": 123455, "createdBy": "jperez", "createdDate": "2017-11-14T07:06:25.794Z", "dvrWindowInMin": 9, "encoderZone": "EUROPE", "format": "HLS", "id": 324453, "modifiedBy": "alfulani", "modifiedDate": "2017-05-25T06:13:13.436Z", "name": "DemoStream3", "originHostName": "demo-host3.akamaiorigin.net", "primaryStorageCpcode": 678779, "streamAuth": true, "provisionDetail": { "status": "PENDING" } } ] }, "schema": { "additionalProperties": false, "description": "Lists all the streams configured.", "type": "object", "properties": { "page": { "description": "Specifies the page number to view, starting at 1.", "type": "integer" }, "pageSize": { "description": "Indicates the number of data points that are displayed per page. The default is to display all data if you don't specify the page size.", "type": "integer" }, "streams": { "description": "Encapsulates stream configuration and version information.", "type": "array", "items": { "additionalProperties": false, "description": "Encapsulates stream configuration and version information. You can list, create, edit, delete, and get details of streams.", "type": "object", "required": [ "id", "originHostname", "cpcode", "encoderZone", "name", "format", "modifiedDate", "provisionDetail", "primaryStorageCpcode", "createdBy", "modifiedBy" ], "properties": { "backupDirectConnectSettings": { "additionalProperties": false, "description": "Details about Direct Connect settings for the backup stream.", "type": "object", "properties": { "enabled": { "description": "Enables direct connect for the stream.", "type": "boolean" } }, "x-akamai": { "file-path": "schemas/DirectConnectSettingsGetDTO.yaml" } }, "backupStorageCpcode": { "description": "The CP code for the backup storage.", "nullable": true, "type": "integer" }, "cpcode": { "description": "The Content Provider code (CP code) associated with the stream. A CP code is a unique identifier for reporting, billing, and monitoring traffic served over the Akamai network.", "type": "integer" }, "createdBy": { "description": "The Control Center username who created the stream.", "type": "string" }, "dvrWindowInMin": { "description": "The length of time that content is available as DVR content. You can specify an archive window value from 5 to 30 minutes. A 30-minute scrub back window is enabled for all streams.", "type": "integer" }, "encoderZone": { "description": "The encoder's geographical location. Choose an encoder that is close to your location.", "type": "string" }, "format": { "description": "The ingest format for Apple HTTP Live Streaming (`HLS`), Adobe HTTP Dynamic Streaming (`HDS`), Dynamic Adaptive Streaming over HTTP (`DASH`), or Common Media Application Format (`CMAF`).", "type": "string", "enum": [ "HLS", "HDS", "DASH", "CMAF" ] }, "id": { "description": "The unique identifier for the stream. The stream ID must be identical between your primary and backup streams.", "type": "integer" }, "modifiedBy": { "description": "The Control Center username who edited the stream.", "type": "string" }, "modifiedDate": { "description": "The date on which the stream was modified.", "format": "date-time", "type": "string" }, "name": { "description": "The stream name can be up to 90 characters long and can include alphanumeric, underscore, and dash characters.", "type": "string" }, "originHostName": { "description": "The hostname as defined in your origin DNS. This depends on the CDN that you use. For an AMD property on the Akamai CDN, the hostname is `origin.akamaized.net`.", "type": "string" }, "primaryDirectConnectSettings": { "additionalProperties": false, "description": "Details about the primary stream Direct Connect settings.", "type": "object", "properties": { "enabled": { "description": "Enables direct connect for the stream.", "type": "boolean" } }, "x-akamai": { "file-path": "schemas/DirectConnectSettingsGetDTO.yaml" } }, "primaryStorageCpcode": { "description": "Specify the Media Services Live CP code for the primary storage.", "type": "integer" }, "provisionDetail": { "additionalProperties": false, "description": "Details about the stream provisioning status.", "type": "object", "properties": { "message": { "description": "A message about the stream provisioning status.", "type": "string" }, "status": { "description": "The status of the stream. Possible enum values are: `PENDING`, `PROVISIONED`, or `FAILED`.", "type": "string", "enum": [ "PENDING", "PROVISIONED", "FAILED" ] }, "streamId": { "description": "A unique identifier for the stream.", "type": "integer" } }, "x-akamai": { "file-path": "schemas/ProvisionDetailsDTO.yaml" } }, "streamAuth": { "description": "Indicates whether stream authentication is enabled for the stream.", "type": "boolean" } }, "x-akamai": { "file-path": "schemas/StreamDTO.yaml" } } }, "totalSize": { "description": "Count of all streams by CP code.", "type": "integer" } }, "x-akamai": { "file-path": "schemas/StreamsDTO.yaml" } } } } }, "400": { "description": "[Invalid input in the request](https://techdocs.akamai.com/msl/reference/400).", "content": { "application/problem+json": { "schema": { "additionalProperties": false, "description": "Contains debugging information about error responses.", "type": "object", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "The list of errors.", "type": "array", "items": { "description": "A further-nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/Problem-nested.yaml" } } }, "instance": { "description": "A non-referenceable URI indicating an error instance.", "type": "string" }, "status": { "description": "The HTTP status code of the error response.", "type": "integer" }, "title": { "description": "The title of the error response.", "type": "string" }, "type": { "description": "The URL for the error type description.", "type": "string" } }, "x-akamai": { "file-path": "schemas/ProblemDetailDTO.yaml" } } } }, "x-akamai": { "file-path": "errors/400.yaml" } }, "429": { "description": "[Rate limiting error](https://techdocs.akamai.com/msl/reference/429). The maximum request count for a specific time duration for this resource has been reached. See [Rate limiting](https://techdocs.akamai.com/msl/reference/resource-limiting) for more information.", "content": {}, "headers": { "X-RateLimit-Limit": { "schema": { "example": 50, "type": "string" }, "x-akamai": { "file-path": "headers/X-RateLimit-Limit.yaml" } }, "X-RateLimit-Remaining": { "schema": { "example": 0, "type": "string" }, "x-akamai": { "file-path": "headers/X-RateLimit-Remaining.yaml" } } }, "x-akamai": { "file-path": "errors/429.yaml" } } }, "parameters": [ { "description": "Specifies the page number to view, starting at 1.", "example": "{{page}}", "in": "query", "name": "page", "schema": { "default": 1, "example": 2, "type": "integer" }, "x-akamai": { "file-path": "parameters/page-query.yaml" } }, { "description": "Indicates the number of data points that are displayed per page. The default is to display all data if you don't specify the page size.", "example": "{{pageSize}}", "in": "query", "name": "pageSize", "schema": { "example": 10, "type": "integer" }, "x-akamai": { "file-path": "parameters/pageSize-query.yaml" } }, { "description": "__Enum__ Sorts the fields displayed based on the key that you specify, either `cpcode`, `createdDate`, `dvrWindowInMin`, `format`, `modifiedDate`, `name`, `originHostName`, `status`, or `zone`.", "example": "{{sortKey}}", "in": "query", "name": "sortKey", "schema": { "default": "modifiedDate", "example": "createdDate", "type": "string", "enum": [ "name", "format", "cpcode", "zone", "originHostName", "status", "dvrWindowInMin", "createdDate", "modifiedDate" ] }, "x-akamai": { "file-path": "parameters/sortKey-query.yaml" } }, { "description": "__Enum__ Sorts the streams list in ascending (`ASC`) or descending (`DESC`) order.", "example": "{{sortOrder}}", "in": "query", "name": "sortOrder", "schema": { "default": "DESC", "example": "ASC", "type": "string", "enum": [ "ASC", "DESC" ] }, "x-akamai": { "file-path": "parameters/sortOrder-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" } } ] } }, "/msl-origin/streams/{streamId}": { "get": { "description": "Retrieves detailed information about the requested stream.", "operationId": "get-stream", "summary": "Get a stream", "tags": [ "Streams" ], "externalDocs": { "description": "See documentation for this operation in Akamai's Media Services Live Stream Provisioning API", "url": "https://techdocs.akamai.com/msl/reference/get-stream" }, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "example": { "backupEncoderZone": "AUSTRALIA", "backupPublishingUrl": "test2.akamaientrypoint.net", "cpcode": 1324567, "createdBy": "jdupont", "createdDate": "2017-11-14T07:06:25.794Z", "dvrWindow": 5, "encoderZone": "EUROPE", "format": "HLS", "id": 745645, "ingestAccelerated": false, "isDedicatedOrigin": false, "modifiedBy": "jperez", "modifiedDate": "2017-11-14T07:20:12.359Z", "name": "DemoStream", "primaryPublishingUrl": "test1.akamaientrypoint.net", "additionalEmailIds": [ "xyz@akamai1.com" ], "allowedIps": [], "events": [], "backupOrigin": { "hostName": "demo-host2.akamaiorigin.net" }, "backupStorageGroup": { "cpcode": 1234567 }, "origin": { "hostName": "demo-host1.akamaiorigin.net" }, "provisionDetail": { "status": "PENDING", "streamId": 745645 }, "storageGroup": { "cpcode": 1234567 }, "streamAuth": { "algorithm": "SHA256", "username": "tyamada" } }, "schema": { "additionalProperties": false, "description": "Encapsulates stream configuration and version information. You can [list streams](https://techdocs.akamai.com/msl/reference/get-streams), [create a stream](https://techdocs.akamai.com/msl/reference/post-stream), [update a stream](https://techdocs.akamai.com/msl/reference/put-stream), [remove a stream](https://techdocs.akamai.com/msl/reference/delete-stream), and [get stream details](https://techdocs.akamai.com/msl/reference/get-stream).", "type": "object", "properties": { "activeArchiveDurationInDays": { "description": "The number of days the archived stream is available. This appears if you have MediaServicesLive4::LiveToVOD in your contract.", "type": "integer" }, "additionalEmailIds": { "description": "Email addresses for people to receive the stream configuration details and status notifications.", "type": "array", "items": { "description": "Email address to receive the stream configuration details and status notifications.", "type": "string" } }, "allowedIps": { "description": "The IP addresses for your encoder. You can enter up to 50 IP addresses separated by commas.", "type": "array", "items": { "description": "The IP address for your encoder. You can enter up to 50 IP addresses separated by commas.", "type": "string" } }, "backupDirectConnectSettings": { "additionalProperties": false, "description": "Details about the backup stream Direct Connect settings.", "type": "object", "properties": { "message": { "description": "A message about the stream provisioning status.", "type": "string" }, "status": { "description": "The status of the stream. Possible enum values are: `PENDING`, `PROVISIONED`, `FAILED`.", "type": "string", "enum": [ "PENDING", "PROVISIONED", "FAILED" ] }, "streamId": { "description": "A unique identifier for the stream.", "type": "integer" } }, "x-akamai": { "file-path": "schemas/DirectConnectSettingsDTO.yaml" } }, "backupEncoderZone": { "description": "The geographical location of your backup encoder.", "type": "string" }, "backupIngestLocations": { "additionalProperties": false, "description": "The ingest locations such as countries, states, and cities associated with the backup encoder zone.", "type": "object", "properties": { "countryName": { "description": "Specify the preferred country name.", "type": "string" }, "states": { "description": "Specify one or more states associated with the selected country.", "type": "array", "items": { "additionalProperties": false, "description": "Contains information about the state and corresponding cities for the ingest location.", "type": "object", "properties": { "cities": { "description": "Specify one or more cities associated with the selected state.", "type": "array", "items": { "additionalProperties": false, "description": "Contains information about the city.", "type": "object", "properties": { "name": { "description": "Specify the preferred city name for the ingest location.", "type": "string" } }, "x-akamai": { "file-path": "schemas/GeoCityDTO.yaml" } } }, "name": { "description": "Specify the preferred state name.", "type": "string" } }, "x-akamai": { "file-path": "schemas/GeoStateDTO.yaml" } } } }, "x-akamai": { "file-path": "schemas/GeoCountryDTO.yaml" } }, "backupOrigin": { "additionalProperties": false, "description": "The backup origin hostname for the stream.", "type": "object", "required": [ "id", "contractId", "cpcode", "encoderZone", "hostName", "sharedKeys" ], "properties": { "activeVersion": { "description": "The version of the origin that is enabled.", "type": "integer" }, "amdProperties": { "description": "AMD properties assigned to this origin in the current account.", "type": "array", "items": { "additionalProperties": false, "type": "object", "properties": { "assetId": { "description": "Asset ID of AMD property.", "type": "integer" }, "propertyName": { "description": "Name of AMD property.", "type": "string" } } } }, "backupEncoderZone": { "description": "The backup encoder's geographical location.", "type": "string" }, "backupHostName": { "description": "The hostname for the origin used for failover.", "type": "string" }, "contractId": { "description": "The contract ID associated with the origin. The CP code is filtered based on the contract ID that you specify. The system associates the NetStorage CP code, if there is one, with the same contract as the ingest CP code.", "type": "integer" }, "cpcode": { "description": "The Media Services Live CP code. A CP code is a unique identifier for reporting, billing, and monitoring traffic served over the Akamai network.", "type": "integer" }, "encoderZone": { "description": "The primary encoder's geographical location. Choose a location that is close to your encoder.", "type": "string" }, "hostName": { "description": "The hostname defined in your origin DNS.", "type": "string" }, "id": { "description": "Enter a unique identifier for the origin. The identifier must be unique, regardless of encoder locations and customers. The primary hostname and backup hostname are automatically derived from the origin identifier you specify.", "type": "integer" }, "isDedicatedOrigin": { "description": "Indicates whether or not the origin is a dedicated origin. When you use a dedicated origin, you must create a new stream. You can't edit an existing stream to make it dedicated. If you use a dedicated origin, the origin shield network has a new item called resource group to identify your company.", "type": "boolean" }, "modifiedBy": { "description": "The username of the person who changed the origin.", "type": "string" }, "modifiedDate": { "description": "The date on which the origin settings were modified.", "format": "date-time", "type": "string" }, "sharedKeys": { "description": "Shared keys let you share your MSL origin with Akamai partner accounts and third-party delivery providers.", "type": "array", "items": { "additionalProperties": false, "type": "object", "properties": { "amdProperties": { "description": "AMD properties assigned to this key in other accounts. It is only applicable for `AKAMAI` type of keys.", "type": "array", "items": { "additionalProperties": false, "type": "object", "properties": { "accountId": { "description": "Account ID where the AMD property was created using this shared key.", "type": "string" }, "accountName": { "description": "Account name where the AMD property was created using this shared key.", "type": "string" }, "propertyName": { "description": "Name of the AMD property created using this shared key.", "type": "string" } } } }, "authMethod": { "description": "Specify the authentication method as `SIMPLE_AKAMAI_HEADER_VERIFICATION` for Akamai partner accounts or `MSL_MULTI_ACCOUNT` for third-party CDN accounts.", "type": "string", "enum": [ "SIMPLE_AKAMAI_HEADER_VERIFICATION", "MSL_MULTI_ACCOUNT" ] }, "backupHostName": { "description": "A backup hostname for the origin.", "type": "string" }, "cdnCode": { "description": "Automatically generated code for the CDN.", "type": "string" }, "data": { "description": "Automatically generated data field for the CDN.", "type": "string" }, "enabled": { "description": "The activated status of the CDN.", "type": "boolean" }, "expiryDate": { "description": "A date and time when the CDN settings will expire. The time zone is the current time zone where you configure your settings.", "format": "date-time", "type": "string" }, "guid": { "description": "Automatically generated GUI ID for the CDN.", "type": "string" }, "hostName": { "description": "The hostname for the CDN.", "type": "string" }, "key": { "description": "Automatically generated key to access the CDN.", "type": "string" }, "name": { "description": "Name to identify the CDN.", "type": "string" }, "previousData": { "description": "Automatically generated previous data field for the CDN.", "type": "string" }, "previousKey": { "description": "The previously configured key to access the CDN.", "type": "string" }, "previousKeyExpiryDate": { "description": "The expiration date for the previous key.", "format": "date-time", "type": "string" }, "type": { "description": "Specify `AKAMAI` if you are using an Akamai CDN or `THIRD_PARTY` if you are using some other CDN.", "type": "string", "enum": [ "AKAMAI", "THIRD_PARTY" ] } } } }, "status": { "description": "The origin creation status: `SUCCEEDED` or `FAILED`.", "type": "string" }, "thirdPartyCdnCpcode": { "description": "The CP code for the third-party CDN.", "type": "integer" } }, "x-akamai": { "file-path": "schemas/OriginDetailDTOV2.yaml" } }, "backupPublishingUrl": { "description": "The encoder's backup publishing URL. For example, if the stream `format` is HLS, `streamId` is 50002, and `event` is test79, the backup publishing URL is `http://b-ep50002.i.akamaientrypoint.net/50002-b/test79/master.m3u8`.", "type": "string" }, "backupStorageGroup": { "additionalProperties": false, "description": "The backup storage group for the stream.", "type": "object", "properties": { "cpcode": { "description": "The Media Services Live CP code for the backup storage.", "type": "integer" } } }, "contractId": { "description": "The unique identifier for the contract associated with the stream. The system filters the ingest CP code based on the contract ID that you specify. If you create a NetStorage CP code, it is associated with the same contract as the ingest CP code. If you do not specify a contract ID, the system uses the first valid contract.", "type": "string" }, "cpcode": { "description": "The Content Provider code (CP code) associated with the stream. A CP code is a unique identifier for reporting, billing, and monitoring traffic served over the Akamai network. It is supplied to you when you purchase a product, and you need it to activate any associated properties. You can generate additional CP codes, typically to implement more detailed billing and reporting functions and assign to custom properties.", "type": "integer" }, "createdBy": { "description": "The Control Center username for the person who created the stream.", "type": "string" }, "createdDate": { "description": "The date the stream was created.", "format": "date-time", "type": "string" }, "dvrWindow": { "description": "The length of time the streaming content is available in archive, from 5 to 30 minutes. A 30 minute scrub back window is enabled for all streams.", "type": "integer" }, "encoderZone": { "description": "The primary encoder's geographical location. Choose an encoder that is close to your location.", "type": "string" }, "events": { "description": "The names of the events and the number of days of data for these particular events that you want to purge.", "type": "array", "items": { "additionalProperties": false, "description": "The name of the event and the number of days of data for that particular event that you want to purge.", "type": "object", "properties": { "age": { "description": "The number of days of data for the event that you want to delete from storage.", "type": "integer" }, "event": { "description": "The name of the event you want to purge.", "type": "string" } } } }, "format": { "description": "The ingest format for Apple HTTP Live Streaming (`HLS`), Adobe HTTP Dynamic Streaming (`HDS`), Dynamic Adaptive Streaming over HTTP (`DASH`), or Common Media Application Format (`CMAF`).", "type": "string", "enum": [ "HLS", "HDS", "DASH", "CMAF" ] }, "id": { "description": "A unique identifier for the stream.", "type": "integer" }, "ingestAccelerated": { "description": "Indicates whether to use the Media Services Live Ingest Acceleration feature. The Ingest Acceleration feature improves encoder to Akamai ingest performance and provides more stability and reliability over the first mile. If you select `true`, enter a password in the `Password` field. The username is the Media Services Live CP code.", "type": "boolean" }, "isDedicatedOrigin": { "description": "If you use a dedicated origin, the origin shield network uses `resource group` to identify your company. You cannot edit an existing stream to make it dedicated, you can use this option only when you create a new stream.", "type": "boolean" }, "modifiedBy": { "description": "The Control Center username who edited the stream.", "type": "string" }, "modifiedDate": { "description": "The date the stream was changed or updated.", "format": "date-time", "type": "string" }, "name": { "description": "The name of the stream. The name can be up to 90 characters long and can include alphanumeric, underscore, and dash characters.", "type": "string" }, "origin": { "additionalProperties": false, "description": "The primary Media Services Live origin for the stream.", "type": "object", "required": [ "id", "contractId", "cpcode", "encoderZone", "hostName", "sharedKeys" ], "properties": { "activeVersion": { "description": "The version of the origin that is enabled.", "type": "integer" }, "amdProperties": { "description": "AMD properties assigned to this origin in the current account.", "type": "array", "items": { "additionalProperties": false, "type": "object", "properties": { "assetId": { "description": "Asset ID of AMD property.", "type": "integer" }, "propertyName": { "description": "Name of AMD property.", "type": "string" } } } }, "backupEncoderZone": { "description": "The backup encoder's geographical location.", "type": "string" }, "backupHostName": { "description": "The hostname for the origin used for failover.", "type": "string" }, "contractId": { "description": "The contract ID associated with the origin. The CP code is filtered based on the contract ID that you specify. The system associates the NetStorage CP code, if there is one, with the same contract as the ingest CP code.", "type": "integer" }, "cpcode": { "description": "The Media Services Live CP code. A CP code is a unique identifier for reporting, billing, and monitoring traffic served over the Akamai network.", "type": "integer" }, "encoderZone": { "description": "The primary encoder's geographical location. Choose a location that is close to your encoder.", "type": "string" }, "hostName": { "description": "The hostname defined in your origin DNS.", "type": "string" }, "id": { "description": "Enter a unique identifier for the origin. The identifier must be unique, regardless of encoder locations and customers. The primary hostname and backup hostname are automatically derived from the origin identifier you specify.", "type": "integer" }, "isDedicatedOrigin": { "description": "Indicates whether or not the origin is a dedicated origin. When you use a dedicated origin, you must create a new stream. You can't edit an existing stream to make it dedicated. If you use a dedicated origin, the origin shield network has a new item called resource group to identify your company.", "type": "boolean" }, "modifiedBy": { "description": "The username of the person who changed the origin.", "type": "string" }, "modifiedDate": { "description": "The date on which the origin settings were modified.", "format": "date-time", "type": "string" }, "sharedKeys": { "description": "Shared keys let you share your MSL origin with Akamai partner accounts and third-party delivery providers.", "type": "array", "items": { "additionalProperties": false, "type": "object", "properties": { "amdProperties": { "description": "AMD properties assigned to this key in other accounts. It is only applicable for `AKAMAI` type of keys.", "type": "array", "items": { "additionalProperties": false, "type": "object", "properties": { "accountId": { "description": "Account ID where the AMD property was created using this shared key.", "type": "string" }, "accountName": { "description": "Account name where the AMD property was created using this shared key.", "type": "string" }, "propertyName": { "description": "Name of the AMD property created using this shared key.", "type": "string" } } } }, "authMethod": { "description": "Specify the authentication method as `SIMPLE_AKAMAI_HEADER_VERIFICATION` for Akamai partner accounts or `MSL_MULTI_ACCOUNT` for third-party CDN accounts.", "type": "string", "enum": [ "SIMPLE_AKAMAI_HEADER_VERIFICATION", "MSL_MULTI_ACCOUNT" ] }, "backupHostName": { "description": "A backup hostname for the origin.", "type": "string" }, "cdnCode": { "description": "Automatically generated code for the CDN.", "type": "string" }, "data": { "description": "Automatically generated data field for the CDN.", "type": "string" }, "enabled": { "description": "The activated status of the CDN.", "type": "boolean" }, "expiryDate": { "description": "A date and time when the CDN settings will expire. The time zone is the current time zone where you configure your settings.", "format": "date-time", "type": "string" }, "guid": { "description": "Automatically generated GUI ID for the CDN.", "type": "string" }, "hostName": { "description": "The hostname for the CDN.", "type": "string" }, "key": { "description": "Automatically generated key to access the CDN.", "type": "string" }, "name": { "description": "Name to identify the CDN.", "type": "string" }, "previousData": { "description": "Automatically generated previous data field for the CDN.", "type": "string" }, "previousKey": { "description": "The previously configured key to access the CDN.", "type": "string" }, "previousKeyExpiryDate": { "description": "The expiration date for the previous key.", "format": "date-time", "type": "string" }, "type": { "description": "Specify `AKAMAI` if you are using an Akamai CDN or `THIRD_PARTY` if you are using some other CDN.", "type": "string", "enum": [ "AKAMAI", "THIRD_PARTY" ] } } } }, "status": { "description": "The origin creation status: `SUCCEEDED` or `FAILED`.", "type": "string" }, "thirdPartyCdnCpcode": { "description": "The CP code for the third-party CDN.", "type": "integer" } }, "x-akamai": { "file-path": "schemas/OriginDetailDTOV2.yaml" } }, "password": { "description": "The password for the Ingest Acceleration feature.", "type": "string" }, "primaryDirectConnectSettings": { "additionalProperties": false, "description": "Details about the primary stream Direct Connect settings.", "type": "object", "properties": { "message": { "description": "A message about the stream provisioning status.", "type": "string" }, "status": { "description": "The status of the stream. Possible enum values are: `PENDING`, `PROVISIONED`, `FAILED`.", "type": "string", "enum": [ "PENDING", "PROVISIONED", "FAILED" ] }, "streamId": { "description": "A unique identifier for the stream.", "type": "integer" } }, "x-akamai": { "file-path": "schemas/DirectConnectSettingsDTO.yaml" } }, "primaryIngestLocations": { "additionalProperties": false, "description": "The ingest locations such as countries, states, and cities associated with the primary encoder zone.", "type": "object", "properties": { "countryName": { "description": "Specify the preferred country name.", "type": "string" }, "states": { "description": "Specify one or more states associated with the selected country.", "type": "array", "items": { "additionalProperties": false, "description": "Contains information about the state and corresponding cities for the ingest location.", "type": "object", "properties": { "cities": { "description": "Specify one or more cities associated with the selected state.", "type": "array", "items": { "additionalProperties": false, "description": "Contains information about the city.", "type": "object", "properties": { "name": { "description": "Specify the preferred city name for the ingest location.", "type": "string" } }, "x-akamai": { "file-path": "schemas/GeoCityDTO.yaml" } } }, "name": { "description": "Specify the preferred state name.", "type": "string" } }, "x-akamai": { "file-path": "schemas/GeoStateDTO.yaml" } } } }, "x-akamai": { "file-path": "schemas/GeoCountryDTO.yaml" } }, "primaryPublishingUrl": { "description": "The encoder's primary publishing URL. For example, if the stream `format` is HLS, `streamId` is 50002, and `event` is test79, the primary publishing URL is `http://p-ep50002.i.akamaientrypoint.net/50002/test79/master.m3u8`.", "type": "string" }, "provisionDetail": { "additionalProperties": false, "description": "Details about the stream provisioning status.", "type": "object", "properties": { "message": { "description": "A message about the stream provisioning status.", "type": "string" }, "status": { "description": "The status of the stream, either `PENDING`, `PROVISIONED`, `FAILED`, or `NOT_STARTED`.", "type": "string", "enum": [ "PENDING", "PROVISIONED", "FAILED", "NOT_STARTED" ] }, "streamId": { "description": "A unique identifier for your stream.", "type": "integer" } } }, "storageGroup": { "additionalProperties": false, "description": "A storage group is where you keep your content for distribution.", "type": "object", "properties": { "cpcode": { "description": "The CP code for the storage group.", "type": "integer" } } }, "streamAuth": { "additionalProperties": false, "description": "Details about the stream authentication settings.", "type": "object", "properties": { "algorithm": { "description": "The algorithm used to generate the hash for authentication, either `SHA256`, `SHA512`, or `MD5`.", "type": "string", "enum": [ "SHA256", "SHA512", "MD5" ] }, "username": { "description": "The username for authentication.", "type": "string" } }, "x-akamai": { "file-path": "schemas/StreamAuthGetDTO.yaml" } }, "streamLevelPurgeDays": { "description": "The archive duration value to purge the content for all the events. You need this value only when specifying the `dvrWindow`. You don't need it when specifying the `activeArchiveDurationInDays`.", "type": "integer" }, "vodOrigin": { "additionalProperties": false, "description": "This enables VOD recordings for `HLS` and `DASH` streams. It applies once the `activeArchiveDurationInDays` has passed. To use this, you need to have `MediaServicesLive4::LiveToVOD` in your contract.", "type": "object", "properties": { "cpcode": { "description": "The CP code used to track the stream traffic, if you're using an existing VOD origin.", "type": "integer" }, "name": { "description": "The name of the CP code. This value is required, in addition to the CP code, when you're creating a new VOD origin.", "type": "string" } } } }, "x-akamai": { "file-path": "schemas/StreamDetailsDTO.yaml" } } } } }, "400": { "description": "[Invalid data input](https://techdocs.akamai.com/msl/reference/400). The API returns 400 response when the user doesn't have access to the requested stream ID or when an invalid stream ID is passed.", "content": { "application/problem+json": { "example": { "detail": "Requested Stream does not exist", "instance": "01d69231-d693-4701-be2c-7e66a9a14a8a", "status": 400, "title": "Bad Request", "type": "bad-request" }, "schema": { "additionalProperties": false, "description": "Contains debugging information about error responses.", "type": "object", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "The list of errors.", "type": "array", "items": { "description": "A further-nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/Problem-nested.yaml" } } }, "instance": { "description": "A non-referenceable URI indicating an error instance.", "type": "string" }, "status": { "description": "The HTTP status code of the error response.", "type": "integer" }, "title": { "description": "The title of the error response.", "type": "string" }, "type": { "description": "The URL for the error type description.", "type": "string" } }, "x-akamai": { "file-path": "schemas/ProblemDetailDTO.yaml" } } } }, "x-akamai": { "file-path": "errors/400-stream-get-exception.yaml" } }, "429": { "description": "[Rate limiting error](https://techdocs.akamai.com/msl/reference/429). The maximum request count for a specific time duration for this resource has been reached. See [Rate limiting](https://techdocs.akamai.com/msl/reference/resource-limiting) for more information.", "content": {}, "headers": { "X-RateLimit-Limit": { "schema": { "example": 50, "type": "string" }, "x-akamai": { "file-path": "headers/X-RateLimit-Limit.yaml" } }, "X-RateLimit-Remaining": { "schema": { "example": 0, "type": "string" }, "x-akamai": { "file-path": "headers/X-RateLimit-Remaining.yaml" } } }, "x-akamai": { "file-path": "errors/429.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" } } ] }, "put": { "description": "Modifies an existing stream. The request body object must be identical in structure to the Get Stream Details response object. You can edit the `name`, `ingestAccelerated`, `password`, `dvrWindow`, `allowedIps`, and `additionalEmailIds` members. If you try to edit any other member, the API returns a `400` error. If you want to update the HTTP digest authentication `username`, `password`, or `expiryDate` for a live stream, refer to these examples [Rotate HTTP digest authentication settings](https://techdocs.akamai.com/msl/reference/rotate-http-digest-authentication-settings).", "operationId": "put-stream", "summary": "Update a stream", "tags": [ "Streams" ], "externalDocs": { "description": "See documentation for this operation in Akamai's Media Services Live Stream Provisioning API", "url": "https://techdocs.akamai.com/msl/reference/put-stream" }, "requestBody": { "required": true, "content": { "application/json": { "example": { "cpcode": 1234567, "dvrWindow": 10, "encoderZone": "US_EAST", "format": "HLS", "id": 723456, "ingestAccelerated": true, "name": "DemostreamEdit", "password": 346789999, "additionalEmailIds": [ "xyz@akamai1.com", "efg@akamai.com" ], "allowedIps": [ "192.0.2.27", "192.0.2.195" ], "origin": { "hostName": "demoHost.akamaiorigin.net" } }, "schema": { "additionalProperties": false, "description": "Encapsulates stream configuration and version information. You can list, create, edit, delete, and get details of streams.", "type": "object", "properties": { "activeArchiveDurationInDays": { "description": "Specify from `1` to `31` to archive your active content. This option is available only for HLS and DASH streams. It appears if you have `MediaServicesLive4::LiveToVOD` in your contract. There is no default value.", "example": "{{activeArchiveDurationInDays}}", "type": "integer" }, "additionalEmailIds": { "description": "Email addresses for people to receive the stream configuration details and status notifications.", "type": "array", "items": { "description": "Email address receive the stream configuration details and status notifications.", "type": "string" } }, "allowedIps": { "description": "The IP addresses for your encoder. You can enter up to 50 IP addresses.", "type": "array", "items": { "description": "The IP address for your encoder. You can enter up to 50 IP addresses.", "type": "string" } }, "backupDirectConnectSettings": { "additionalProperties": false, "description": "Specify details about the backup stream direct connect settings.", "type": "object", "properties": { "message": { "description": "A message about the stream provisioning status.", "type": "string" }, "status": { "description": "The status of the stream. Possible enum values are: `PENDING`, `PROVISIONED`, `FAILED`.", "type": "string", "enum": [ "PENDING", "PROVISIONED", "FAILED" ] }, "streamId": { "description": "A unique identifier for the stream.", "type": "integer" } }, "x-akamai": { "file-path": "schemas/DirectConnectSettingsDTO.yaml" } }, "backupIngestLocations": { "additionalProperties": false, "description": "Specifies the ingest locations such as countries, states, and cities associated with the backup encoder zone.", "type": "object", "properties": { "countryName": { "description": "Specify the preferred country name.", "type": "string" }, "states": { "description": "Specify one or more states associated with the selected country.", "type": "array", "items": { "additionalProperties": false, "description": "Contains information about the state and corresponding cities for the ingest location.", "type": "object", "properties": { "cities": { "description": "Specify one or more cities associated with the selected state.", "type": "array", "items": { "additionalProperties": false, "description": "Contains information about the city.", "type": "object", "properties": { "name": { "description": "Specify the preferred city name for the ingest location.", "type": "string" } }, "x-akamai": { "file-path": "schemas/GeoCityDTO.yaml" } } }, "name": { "description": "Specify the preferred state name.", "type": "string" } }, "x-akamai": { "file-path": "schemas/GeoStateDTO.yaml" } } } }, "x-akamai": { "file-path": "schemas/GeoCountryDTO.yaml" } }, "contractId": { "description": "The unique identifier for the contract associated with the stream. The system filters the ingest CP code based on the contract ID that you specify. If you create a NetStorage CP code, it is associated with the same contract as the ingest CP code. If you do not specify a contract ID, the system uses the first valid contract.", "example": "{{contractId}}", "type": "string" }, "cpcode": { "description": "The CP code provided by Akamai for the VOD origin.", "example": "{{cpcode}}", "type": "integer" }, "dvrWindow": { "description": "The length of time the streaming content is available in archive, from 5 to 30 minutes. A 30 minute scrub back window is enabled for all streams.", "example": "{{dvrWindow}}", "type": "integer" }, "encoderZone": { "description": "The primary encoder's geographical location. Choose an encoder that is close to your location.", "example": "{{encoderZone}}", "type": "string" }, "events": { "description": "The events and the number of days of data pertaining to these events that you want to purge.", "type": "array", "items": { "additionalProperties": false, "description": "Specify the name of the event and the number of days of data pertaining to the event that you want to purge.", "type": "object", "properties": { "age": { "description": "The number of days of data for the event that you want to delete from storage.", "type": "integer" }, "event": { "description": "The name of the event you want to purge.", "type": "string" } } } }, "format": { "description": "The ingest format for Apple HTTP Live Streaming (`HLS`), Adobe HTTP Dynamic Streaming (`HDS`), Dynamic Adaptive Streaming over HTTP (`DASH`), or Common Media Application Format (`CMAF`).", "example": "{{format}}", "type": "string", "enum": [ "HLS", "HDS", "DASH", "CMAF" ] }, "id": { "description": "A unique identifier for the stream.", "example": "{{id}}", "type": "integer" }, "ingestAccelerated": { "description": "Indicates whether to use the Media Services Live Ingest Acceleration feature. The Ingest Acceleration feature improves encoder to Akamai ingest performance and provides more stability and reliability over the first mile. If you select `true`, enter a password in the `Password` field. The username is the Media Services Live CP code.", "example": "{{ingestAccelerated}}", "type": "boolean" }, "name": { "description": "The name of the stream. The name can be up to 90 characters long and can include alphanumeric, underscore, and dash characters.", "example": "{{name}}", "type": "string" }, "origin": { "additionalProperties": false, "description": "The primary Media Services Live origin for the stream.", "type": "object", "properties": { "hostName": { "description": "Specify the origin hostname.", "type": "string" } } }, "password": { "description": "Specifies the password for authentication.", "example": "{{password}}", "type": "string" }, "primaryDirectConnectSettings": { "additionalProperties": false, "description": "Specify details about the primary stream direct connect settings.", "type": "object", "properties": { "message": { "description": "A message about the stream provisioning status.", "type": "string" }, "status": { "description": "The status of the stream. Possible enum values are: `PENDING`, `PROVISIONED`, `FAILED`.", "type": "string", "enum": [ "PENDING", "PROVISIONED", "FAILED" ] }, "streamId": { "description": "A unique identifier for the stream.", "type": "integer" } }, "x-akamai": { "file-path": "schemas/DirectConnectSettingsDTO.yaml" } }, "primaryIngestLocations": { "additionalProperties": false, "description": "Specifies the ingest locations such as countries, states, and cities associated with the primary encoder zone.", "type": "object", "properties": { "countryName": { "description": "Specify the preferred country name.", "type": "string" }, "states": { "description": "Specify one or more states associated with the selected country.", "type": "array", "items": { "additionalProperties": false, "description": "Contains information about the state and corresponding cities for the ingest location.", "type": "object", "properties": { "cities": { "description": "Specify one or more cities associated with the selected state.", "type": "array", "items": { "additionalProperties": false, "description": "Contains information about the city.", "type": "object", "properties": { "name": { "description": "Specify the preferred city name for the ingest location.", "type": "string" } }, "x-akamai": { "file-path": "schemas/GeoCityDTO.yaml" } } }, "name": { "description": "Specify the preferred state name.", "type": "string" } }, "x-akamai": { "file-path": "schemas/GeoStateDTO.yaml" } } } }, "x-akamai": { "file-path": "schemas/GeoCountryDTO.yaml" } }, "streamAuth": { "additionalProperties": false, "description": "Specify details about the stream authentication settings.", "type": "object", "properties": { "delete": { "description": "Enable to delete the previous HTTP digest authentication settings. This will only take effect if multiple keys are active.", "type": "boolean" }, "algorithm": { "description": "The algorithm used to generate the hash for authentication. Specify `SHA256`, `SHA512`, `SHA512_256`, or `MD5`. `SHA256` is the Secure Hash Algorithm, which is a type of cryptographic hash function that generates a 256-bit (32-byte) hash. A cryptographic hash is like a signature for a text or a data file. `SHA512` is a cryptographic hash function that when applied to the provided input results in a 128-digit hexadecimal number that is highly unlikely to match the value produced for a different input. The `MD5` message-digest algorithm is a hash function producing a 128-bit hash value. It is less secure than `SHA256`.", "type": "string", "enum": [ "SHA256", "SHA512", "MD5", "SHA512_256" ] }, "password": { "description": "Specify the password for authentication.", "type": "string" }, "username": { "description": "Specify the username for authentication.", "type": "string" } }, "x-akamai": { "file-path": "schemas/StreamAuthDTOPut.yaml" } }, "streamAuthPrevious": { "additionalProperties": false, "description": "Specify details about the stream authentication settings.", "type": "object", "properties": { "delete": { "description": "Enable to delete the previous HTTP digest authentication settings.", "type": "boolean" }, "expiryDate": { "description": "The expiration date for the previous HTTP digest authentication settings in UTC format.", "format": "date-time", "type": "string" }, "retain": { "description": "Enable to retain the previous HTTP digest authentication settings.", "type": "boolean" } }, "x-akamai": { "file-path": "schemas/StreamAuthPreviousDTOPut.yaml" } }, "streamLevelPurgeDays": { "description": "Specify the archive duration value to purge the content for all the events. You need this value only when specifying the `dvrWindow`. You don't need it when specifying `activeArchiveDurationInDays`.", "example": "{{streamLevelPurgeDays}}", "type": "integer" }, "vodOrigin": { "additionalProperties": false, "description": "Enables you to record the video on demand. This option is only for HLS and DASH streams and applies only when you include the `activeArchiveDurationInDays` member. You can include it if you have `MediaServicesLive4::LiveToVOD` or `MediaServicesLive4::LiveToVodBeta2` in your contract.", "type": "object", "properties": { "cpcode": { "description": "The Content Provider code (CP code) assigned to the stream. A CP code is a unique identifier for reporting, billing, and monitoring traffic served over the Akamai network. It is supplied to you when you purchase a product, and you need it to activate any associated properties. You can generate additional CP codes, typically to implement more detailed billing and reporting functions and assign to custom properties.", "type": "integer" }, "name": { "description": "The name of the new VOD origin.", "type": "string" } } } }, "x-akamai": { "file-path": "schemas/StreamDetailsPutDTO.yaml" } } } } }, "responses": { "202": { "description": "Successful response.", "content": { "*/*": {} } }, "400": { "description": "[Invalid input in the request](https://techdocs.akamai.com/msl/reference/400).", "content": { "application/problem+json": { "schema": { "additionalProperties": false, "description": "Contains debugging information about error responses.", "type": "object", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "The list of errors.", "type": "array", "items": { "description": "A further-nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/Problem-nested.yaml" } } }, "instance": { "description": "A non-referenceable URI indicating an error instance.", "type": "string" }, "status": { "description": "The HTTP status code of the error response.", "type": "integer" }, "title": { "description": "The title of the error response.", "type": "string" }, "type": { "description": "The URL for the error type description.", "type": "string" } }, "x-akamai": { "file-path": "schemas/ProblemDetailDTO.yaml" } } } }, "x-akamai": { "file-path": "errors/400.yaml" } }, "429": { "description": "[Rate limiting error](https://techdocs.akamai.com/msl/reference/429). The maximum request count for a specific time duration for this resource has been reached. See [Rate limiting](https://techdocs.akamai.com/msl/reference/resource-limiting) for more information.", "content": {}, "headers": { "X-RateLimit-Limit": { "schema": { "example": 50, "type": "string" }, "x-akamai": { "file-path": "headers/X-RateLimit-Limit.yaml" } }, "X-RateLimit-Remaining": { "schema": { "example": 0, "type": "string" }, "x-akamai": { "file-path": "headers/X-RateLimit-Remaining.yaml" } } }, "x-akamai": { "file-path": "errors/429.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" } } ] }, "delete": { "description": "Deletes the specified stream. If you delete an archived stream, but set `purgeContent=false` the stream will be permanently deleted, but any archived content saved on NetStorage will continue to incur billing. If you set `purgeContent=true`, the stream will be permanently deleted and any archived content saved on NetStorage for this stream will also be deleted and cannot be restored.", "operationId": "delete-stream", "summary": "Remove a stream", "tags": [ "Streams" ], "externalDocs": { "description": "See documentation for this operation in Akamai's Media Services Live Stream Provisioning API", "url": "https://techdocs.akamai.com/msl/reference/delete-stream" }, "responses": { "200": { "description": "Successful response.", "content": { "*/*": {} } }, "400": { "description": "[Invalid data input](https://techdocs.akamai.com/msl/reference/400). The API returns 400 response when the user doesn't have access to the requested stream ID or when an invalid stream ID is passed.", "content": { "application/problem+json": { "example": { "detail": "Requested Stream does not exist", "instance": "d99ef8b5-04eb-4e98-b689-ac0778bf510c", "status": 400, "title": "Bad Request", "type": "bad-request" }, "schema": { "additionalProperties": false, "description": "Contains debugging information about error responses.", "type": "object", "properties": { "detail": { "description": "The detailed error message.", "type": "string" }, "errors": { "description": "The list of errors.", "type": "array", "items": { "description": "A further-nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/Problem-nested.yaml" } } }, "instance": { "description": "A non-referenceable URI indicating an error instance.", "type": "string" }, "status": { "description": "The HTTP status code of the error response.", "type": "integer" }, "title": { "description": "The title of the error response.", "type": "string" }, "type": { "description": "The URL for the error type description.", "type": "string" } }, "x-akamai": { "file-path": "schemas/ProblemDetailDTO.yaml" } } } }, "x-akamai": { "file-path": "errors/400-stream-delete-exception.yaml" } }, "429": { "description": "[Rate limiting error](https://techdocs.akamai.com/msl/reference/429). The maximum request count for a specific time duration for this resource has been reached. See [Rate limiting](https://techdocs.akamai.com/msl/reference/resource-limiting) for more information.", "content": {}, "headers": { "X-RateLimit-Limit": { "schema": { "example": 50, "type": "string" }, "x-akamai": { "file-path": "headers/X-RateLimit-Limit.yaml" } }, "X-RateLimit-Remaining": { "schema": { "example": 0, "type": "string" }, "x-akamai": { "file-path": "headers/X-RateLimit-Remaining.yaml" } } }, "x-akamai": { "file-path": "errors/429.yaml" } } }, "parameters": [ { "description": "This value determines whether to delete archived content on NetStorage.", "example": "{{purgeContent}}", "in": "query", "name": "purgeContent", "schema": { "default": false, "example": true, "type": "boolean" }, "x-akamai": { "file-path": "parameters/purgeContent-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": "Unique identifier for each stream.", "example": "{{streamId}}", "in": "path", "name": "streamId", "required": true, "schema": { "example": 50005, "type": "integer" }, "x-akamai": { "file-path": "parameters/streamId-path.yaml" } } ] }, "/msl-origin/vod-origin": { "get": { "description": "List all of the VOD origins.", "operationId": "get-vod-origin", "summary": "List VOD origins", "tags": [ "VOD origins" ], "externalDocs": { "description": "See documentation for this operation in Akamai's Media Services Live Stream Provisioning API", "url": "https://techdocs.akamai.com/msl/reference/get-vod-origin" }, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "description": "Contains information about the origin for the VOD streams.", "type": "array", "items": { "additionalProperties": false, "type": "object", "properties": { "cpcode": { "description": "CP code identifier for the VOD origin.", "type": "integer" }, "name": { "description": "Name to identify the VOD origin.", "type": "string" }, "streamCount": { "description": "Number of VOD streams.", "type": "integer" } } }, "x-akamai": { "file-path": "schemas/VODOriginDTO.yaml" } }, "example": [ { "cpcode": 1234567, "name": "SG-1-1234", "streamCount": 2 }, { "cpcode": 1234567, "name": "SG-1-1235", "streamCount": 10 } ] } } } }, "parameters": [ { "description": "Specifies the geographical region where the VOD origin is located.", "example": "{{encoderLocation}}", "in": "query", "name": "encoderLocation", "schema": { "example": "Europe", "type": "string" }, "x-akamai": { "file-path": "parameters/encoderLocation-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" } } ] } } }, "x-readme": { "samples-languages": [ "curl", "python", "node" ] }, "servers": [ { "url": "https://{hostname}/config-media-live/v2" } ] }