Learn more:

• Media Services Live

• Download this API’s RAML and JSON schema descriptors.

Overview

Use the Media Services API to access various media-related services without the need for an interface.

Media Services Stream Packaging combines the best features of both Adobe® Flash® Platform, Live (HD Flash 1.0) and Media Services Live (HLS), allowing for an RTMP ingress stream and egress streams in either Adobe® HDS output, Apple® HLS output, or HD Flash 1.0 output.

Media Services: HLS Ingest allows you to stream live media to appropriate devices running iOS version 3.0 or higher.

Purge HD content lets you refresh specific cached objects or remove all objects by URLs, ARLs, or content provider codes (CP codes) across the Akamai edge network. You can use this when you need to correct mistakes in your published content or when you want to upload content under the same filename.

Who should use this API

Developers and architects can use this API to access and provision media streaming using customized interfaces.

Get started

To configure the Media Services API for the first time:

• Review Get Started with APIs for details on how to set up client tokens to access any Akamai API. These tokens appear as custom hostnames that look like this: https://akzz-XXXXXXXXXXXXXXXX-XXXXXXXXXXXXXXXX.luna.akamaiapis.net.

• To enable this API, choose the API service named Media Streaming, and set the access level to READ-WRITE.

• If you need help, provide feedback to the Akamai developer community, or contact your Akamai representative for support.

Note the following:

• Currently, the API supports only Akamai HD for the Adobe® HTTP Dynamic Streaming and Apple® HTTP Live Streaming.

• The API mirrors the functionality available in Akamai Control Center.

• The event functionality works only for the stream packaging streams. It does not work for HLS ingest streams.

Dual data formats

Media Services Live Stream Packaging and HLS/HDS/DASH ingest APIs support only XML. However, MSL RTMP Streaming supports JSON.

Resources

This section provides details on the API’s various operations.

API summary

Download the RAML descriptors for this API.

List domains

Returns a list of all Universal Streaming and IDevices domains currently created on the account.

<?xml version="1.0" encoding="UTF-8"?>
<domains>
   <domain>
      <configuration-details>
         <configuration-name>hdconfig1</configuration-name>
         <hostname>hdconfig1-f.akamai-domain.net</hostname>
         <reporting-cpcode>123456</reporting-cpcode>
         <configuration-type>Universal Streaming Live</configuration-type>
         <access-control-group>ABCDEF</access-control-group>
      </configuration-details>
      <archive-configuration>
         <archive-name>hdconfig1 [HD Flash Live]</archive-name>
         <archive-cpcode>987654</archive-cpcode>
         <dvr-path>DVR</dvr-path>
         <domain-name>hdconfig1.akamai-domain.net</domain-name>
      </archive-configuration>
      <advanced-configuration>Disabled</advanced-configuration>
      <fms-backup-option>Disabled</fms-backup-option>
      <domain-versions>
         <domain-version>
            <version>1</version>
            <delivery-formats>
               <hd-flash-1.0>Enabled</hd-flash-1.0>
               <adobe-hds>Disabled</adobe-hds>
               <apple-hls>Disabled</apple-hls>
            </delivery-formats>
            <security>
               <hd-flash>
                  <token-authorization>Disabled</token-authorization>
                  <player-verification>Disabled</player-verification>
                  <geo-blocking />
               </hd-flash>
               <securehd-policy-editor>Disabled</securehd-policy-editor>
            </security>
            <advanced-configuration>
               <adobe-hds-advanced-config />
               <hd-flash-advanced-config>
                  <live-delay>14</live-delay>
               </hd-flash-advanced-config>
               <apple-hls-advanced-config />
            </advanced-configuration>
            <hd-client-support-information />
            <author>example@domain.com</author>
            <production-deployment-status>Activated</production-deployment-status>
            <activate-environment>Production</activate-environment>
         </domain-version>
      </domain-versions>
   </domain>
   <domain>
      <configuration-details>
         <configuration-name>hdconfig2</configuration-name>
         <hostname>hdconfig2-f.akamai-domain.net</hostname>
         <reporting-cpcode>678901</reporting-cpcode>
         <configuration-type>Universal Streaming Live</configuration-type>
         <access-control-group>1-ABCDEF</access-control-group>
      </configuration-details>
      <archive-configuration>
         <archive-name>hdconfig2 [HD Flash Live]</archive-name>
         <archive-cpcode>543210</archive-cpcode>
         <dvr-path>DVR</dvr-path>
         <domain-name>hdconfig2.akamai-domain.net</domain-name>
      </archive-configuration>
      <advanced-configuration>Disabled</advanced-configuration>
      <fms-backup-option>Disabled</fms-backup-option>
      <domain-versions>
         <domain-version>
            <version>1</version>
            <delivery-formats>
               <hd-flash-1.0>Enabled</hd-flash-1.0>
               <adobe-hds>Disabled</adobe-hds>
               <apple-hls>Disabled</apple-hls>
            </delivery-formats>
            <security>
               <hd-flash>
                  <token-authorization>Disabled</token-authorization>
                  <player-verification>Disabled</player-verification>
                  <geo-blocking />
               </hd-flash>
               <securehd-policy-editor>Disabled</securehd-policy-editor>
            </security>
            <advanced-configuration>
               <adobe-hds-advanced-config />
               <hd-flash-advanced-config>
                  <live-delay>14</live-delay>
               </hd-flash-advanced-config>
               <apple-hls-advanced-config />
            </advanced-configuration>
            <hd-client-support-information />
            <author>example@domain.com</author>
            <production-deployment-status>Activated</production-deployment-status>
            <activate-environment>Production</activate-environment>
         </domain-version>
      </domain-versions>
   </domain>
</domains>

Create a domain

Creates a new configuration with the assigned domain, initialized at version 1. Domains are either based on a Stream Packaging configuration or an HLS, HDS, and DASH Ingest configuration. See the Domain object for details on each type.

Before you can create new Stream Packaging streams, you must create at least one Stream Packaging configuration to establish parameters for packaged streams, such as the CP code and hostname. NetStorage is used with Media Services Live as your stream archive’s storage location. Therefore, you must have a NetStorage CP code set up and dedicated for use with Media Services Live, or you will be unable to create configurations. You can create as many configurations as you have CP codes available, depending on how you would like to have your streams being reported on and billed.

<domain>
    <configuration-details>
        <configuration-name>manch_123</configuration-name>
        <hostname>open736833-lh.edgeflash.qa.akamai.com</hostname>
        <reporting-cpcode>736833</reporting-cpcode>
        <configuration-type>Universal Streaming Live</configuration-type>
        <access-control-group>C-C8KEVT</access-control-group>
    </configuration-details>
    <archive-configuration>
        <archive-cpcode>736847</archive-cpcode>
        <archive-zones>
            <archive-zone>
                <zone>asia</zone>
            </archive-zone>
        </archive-zones>
    </archive-configuration>
    <domain-versions>
        <domain-version>
            <delivery-formats>
                <hd-flash-1.0>Disabled</hd-flash-1.0>
                <adobe-hds>Enabled</adobe-hds>
                <apple-hls>Enabled</apple-hls>
            </delivery-formats>
            <advanced-configuration>
                <adobe-hds-advanced-config>
                    <hds-segment-duration>5</hds-segment-duration>
                    <hds-live-delay>2</hds-live-delay>
                </adobe-hds-advanced-config>
                <apple-hls-advanced-config>
                    <hls-segment-duration>10</hls-segment-duration>
                    <audio-only-stream-from-lowest-bitrate>Enabled</audio-only-stream-from-lowest-bitrate>
                </apple-hls-advanced-config>
            </advanced-configuration>
            <edge-hostname-map>w17</edge-hostname-map>
        </domain-version>
    </domain-versions>
</domain>

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<response-message>
    <message>New Domain created successfully.</message>
</response-message>

Get a domain

Get the profile settings.

<?xml version="1.0" encoding="UTF-8"?>
<domain>
   <configuration-details>
      <configuration-name>live_test_123</configuration-name>
      <hostname>livetestapi-lh.akamai-domain.net</hostname>
      <reporting-cpcode>123456</reporting-cpcode>
      <configuration-type>Universal Streaming Live</configuration-type>
      <access-control-group>1-ABCDEF</access-control-group>
   </configuration-details>
   <archive-configuration>
      <archive-name>live_test_123 [Universal Stream]</archive-name>
      <archive-cpcode>987654</archive-cpcode>
      <dvr-path>DVR</dvr-path>
      <domain-name>987654l.akamai-domain.net</domain-name>
   </archive-configuration>
   <advanced-configuration>Disabled</advanced-configuration>
   <fms-backup-option>Disabled</fms-backup-option>
   <domain-versions>
      <domain-version>
         <version>1</version>
         <delivery-formats>
            <hd-flash-1.0>Disabled</hd-flash-1.0>
            <adobe-hds>Enabled</adobe-hds>
            <apple-hls>Enabled</apple-hls>
         </delivery-formats>
         <security>
            <hd-flash>
               <geo-blocking />
            </hd-flash>
            <securehd-policy-editor>Disabled</securehd-policy-editor>
         </security>
         <advanced-configuration>
            <adobe-hds-advanced-config>
               <hds-segment-duration>5.0</hds-segment-duration>
               <hds-live-delay>10</hds-live-delay>
            </adobe-hds-advanced-config>
            <hd-flash-advanced-config />
            <apple-hls-advanced-config />
         </advanced-configuration>
         <hd-client-support-information>
            <organization-name>Akamai</organization-name>
            <support-url>http://www.akamai.com/client/streaming-support</support-url>
         </hd-client-support-information>
         <author>example@domain.com</author>
      </domain-version>
   </domain-versions>
</domain>

Remove a domain

Deletes a domain.

<?xml version="1.0" encoding="UTF-8"?>
<response-message>
    <message>Your Domain delete request was successful.</message>
</response-message>

List streams

List all the streams associated with the profile. Streams may be based on either a Stream Packaging configuration or HLS, HDS, and DASH ingest configuration. See the Stream object for details on each type.

<?xml version="1.0" encoding="UTF-8"?>
<streams>
   <stream>
      <stream-id>10000</stream-id>
      <stream-type>Universal Streaming Live</stream-type>
      <stream-name>STREAM1</stream-name>
      <primary-contact-name>test.user.1</primary-contact-name>
      <secondary-contact-name>test.user.2</secondary-contact-name>
      <status>Provisioned</status>
      <notification-email>example@domain.com</notification-email>
      <encoder-settings>
         <primary-encoder-ip>250.250.250.250</primary-encoder-ip>
         <backup-encoder-ip>250.250.250.251</backup-encoder-ip>
         <username>username</username>
         <password>password</password>
      </encoder-settings>
      <dvr-settings>
         <dvr>Disabled</dvr>
      </dvr-settings>
      <security-1.0>
         <token-authorization>Disabled</token-authorization>
         <player-verification>Disabled</player-verification>
      </security-1.0>
      <entrypoints>
         <entrypoint>
            <type>Backup</type>
            <domain-name>b.ep10000.i.akamaidomain.net</domain-name>
         </entrypoint>
         <entrypoint>
            <type>Primary</type>
            <domain-name>p.ep10000.i.akamaidomain.net</domain-name>
         </entrypoint>
      </entrypoints>
      <hd-flash-1.0-playback-url>http://livetestapi-lh.akamai-domain.net/[EVENT_ANGLE_BITRATE]@10000</hd-flash-1.0-playback-url>
      <hds-playback-url>http://livetestapi-lh.akamai-domain.net/z/[EVENT_ANGLE]@10000/manifest.f4m</hds-playback-url>
      <hls-playback-url>http://livetestapi-lh.akamai-domain.net/i/[EVENT_ANGLE]@10000/master.m3u8</hls-playback-url>
   </stream>
</streams>

Create a new stream

Create a new stream, either based on a Stream Packaging configuration or an HLS, HDS, and DASH configuration. See the Stream object for details on each type.

<?xml version="1.0" encoding="UTF-8"?>
<stream>
   <stream-type>Universal Streaming Live</stream-type>
   <stream-name>STREAM1</stream-name>
   <primary-contact-name>John Doe</primary-contact-name>
   <secondary-contact-name>Jane Doe</secondary-contact-name>
   <notification-email>jdoe@example.com</notification-email>
   <encoder-settings>
      <primary-encoder-ip>250.250.250.250</primary-encoder-ip>
      <backup-encoder-ip>250.250.250.251</backup-encoder-ip>
      <password>password</password>
   </encoder-settings>
   <dvr-settings>
      <dvr>Disabled</dvr>
   </dvr-settings>
</stream>

<?xml version="1.0" encoding="UTF-8"?>
<stream>
   <stream-id>10001</stream-id>
   <stream-type>Universal Streaming Live</stream-type>
   <stream-name>STREAM1</stream-name>
   <primary-contact-name>Stream User1</primary-contact-name>
   <secondary-contact-name>Stream User2</secondary-contact-name>
   <status>Not yet provisioned</status>
   <notification-email>example@domain.com</notification-email>
   <encoder-settings>
      <primary-encoder-ip>250.250.250.250</primary-encoder-ip>
      <backup-encoder-ip>250.250.250.251</backup-encoder-ip>
      <username>12345</username>
      <password>password</password>
   </encoder-settings>
   <dvr-settings>
      <dvr>Disabled</dvr>
   </dvr-settings>
   <security-1.0>
      <token-authorization>Disabled</token-authorization>
      <player-verification>Disabled</player-verification>
   </security-1.0>
   <entrypoints>
      <entrypoint>
         <type>Backup</type>
         <domain-name>b.ep10001.i.akamaidomain.net</domain-name>
      </entrypoint>
      <entrypoint>
         <type>Primary</type>
         <domain-name>p.ep10001.i.akamaidomain.net</domain-name>
      </entrypoint>
   </entrypoints>
   <hd-flash-1.0-playback-url>http://akamai-lh.akamai-domain.net/[EVENT_ANGLE_BITRATE]@10001</hd-flash-1.0-playback-url>
   <hds-playback-url>http://akamai-lh.akamai-domain.net/z/[EVENT_ANGLE]@10001/manifest.f4m</hds-playback-url>
   <hls-playback-url>http://akamai-lh.akamai-domain.net/i/[EVENT_ANGLE]@10001/master.m3u8</hls-playback-url>
</stream>

Get a stream

Get the stream’s details.

<?xml version="1.0" encoding="UTF-8"?>
<stream>
      <stream-id>10000</stream-id>
      <stream-type>Universal Streaming Live</stream-type>
      <stream-name>STREAM1</stream-name>
      <primary-contact-name>test.user.1</primary-contact-name>
      <secondary-contact-name>test.user.2</secondary-contact-name>
      <status>Provisioned</status>
      <notification-email>example@domain.com</notification-email>
      <encoder-settings>
         <primary-encoder-ip>250.250.250.250</primary-encoder-ip>
         <backup-encoder-ip>250.250.250.251</backup-encoder-ip>
         <username>username</username>
         <password>password</password>
      </encoder-settings>
      <dvr-settings>
         <dvr>Disabled</dvr>
      </dvr-settings>
      <security-1.0>
         <token-authorization>Disabled</token-authorization>
         <player-verification>Disabled</player-verification>
      </security-1.0>
      <entrypoints>
         <entrypoint>
            <type>Backup</type>
            <domain-name>b.ep10000.i.akamaidomain.net</domain-name>
         </entrypoint>
         <entrypoint>
            <type>Primary</type>
            <domain-name>p.ep10000.i.akamaidomain.net</domain-name>
         </entrypoint>
      </entrypoints>
      <hd-flash-1.0-playback-url>http://livetestapi-lh.akamai-domain.net/[EVENT_ANGLE_BITRATE]@10000</hd-flash-1.0-playback-url>
      <hds-playback-url>http://livetestapi-lh.akamai-domain.net/z/[EVENT_ANGLE]@10000/manifest.f4m</hds-playback-url>
      <hls-playback-url>http://livetestapi-lh.akamai-domain.net/i/[EVENT_ANGLE]@10000/master.m3u8</hls-playback-url>
   </stream>

Modify a stream

Edit an existing stream, based on either a Stream Packaging configuration or HLS, HDS, and DASH ingest configuration. See the Stream object for details on each type.

<?xml version="1.0" encoding="UTF-8"?>
<stream>
   <stream-name>Sample_Stream</stream-name>
   <primary-contact-name>John Doe</primary-contact-name>
   <secondary-contact-name>Jane Doe</secondary-contact-name>
   <notification-email>jdoe@example.com</notification-email>
   <encoder-settings>
      <primary-encoder-ip>8.8.8.9</primary-encoder-ip>
      <backup-encoder-ip>8.8.8.9</backup-encoder-ip>
      <password>abc123</password>
   </encoder-settings>
   <dvr-settings>
      <dvr>Enabled</dvr>
      <dvr-window>24</dvr-window>
      </dvr-settings>
</stream>

<stream>
    <stream-id>12345</stream-id>
   <stream-type>Universal Streaming Live</stream-type>
   <stream-name>STREAM1</stream-name>
   <primary-contact-name>Stream User1</primary-contact-name>
   <secondary-contact-name>Stream User2</secondary-contact-name>
   <notification-email>example@domain.com</notification-email>
   <encoder-settings>
      <primary-encoder-ip>250.250.250.250</primary-encoder-ip>
      <backup-encoder-ip>250.250.250.251</backup-encoder-ip>
      <password>password</password>
   </encoder-settings>
   <dvr-settings>
      <dvr>Disabled</dvr>
   </dvr-settings>
</stream>

Remove a stream

Delete a stream.

<?xml version="1.0" encoding="UTF-8"?>

List events

List the stream’s events.

NOTE: The event functionality works only for the stream packaging streams. It does not work for HLS ingest streams.

<?xml version="1.0" encoding="UTF-8"?>
<event-list>
   <event>
      <stream-id>10001</stream-id>
      <event-name>news_event</event-name>
      <primary-event>
         <archive-start-time>05/19/2013 19:42:10 AM</archive-start-time>
         <archive-end-time>06/21/2013 07:37:42 PM</archive-end-time>
      </primary-event>
      <backup-event>
         <archive-start-time>05/19/2013 19:42:10 AM</archive-start-time>
         <archive-end-time>06/21/2013 07:37:42 PM</archive-end-time>
      </backup-event>
   </event>
   <event>
      <stream-id>10001</stream-id>
      <event-name>sports_event</event-name>
      <primary-event>
         <archive-start-time>05/15/2013 12:40:21 PM</archive-start-time>
         <archive-end-time>06/15/2013 12:38:00 PM</archive-end-time>
         <on-air-time>05/15/2013 12:40:21 PM</on-air-time>
         <delete-time>05/15/2013 12:40:21 PM</delete-time>
      </primary-event>
   </event>
</event-list>

Get an event

Get primary and backup archive details for an event.

NOTE: The event functionality works only for the stream packaging streams. It does not work for HLS ingest streams.

<?xml version="1.0" encoding="UTF-8"?>
<event>
   <stream-id>10001</stream-id>
   <event-name>event_name</event-name>
   <primary-event>
      <archive-start-time>05/15/2013 12:40:21 PM</archive-start-time>
      <archive-end-time>06/15/2013 12:38:00 PM</archive-end-time>
      <on-air-time>05/15/2013 12:40:21 PM</on-air-time>
      <delete-time>05/15/2013 12:40:21 PM</delete-time>
   </primary-event>
</event>

Modify an event

Update a stream event. The off-air-time element corresponds to the On Air End field in the Control Center.

NOTE: The event functionality works only for the stream packaging streams. It does not work for HLS ingest streams.

<?xml version="1.0" encoding="UTF-8"?>
<event>
   <stream-id>10001</stream-id>
   <event-name>sports_event</event-name>
   <primary-event>
      <on-air-time>05/15/2013 12:40:21 PM</on-air-time>
      <delete-time>05/15/2013 12:40:21 PM</delete-time>
   </primary-event>
</event>

<?xml version="1.0" encoding="UTF-8"?>
<event>
   <stream-id>10001</stream-id>
   <event-name>sports_event</event-name>
   <primary-event>
      <archive-start-time>05/15/2013 12:40:21 PM</archive-start-time>
      <archive-end-time>06/15/2013 12:38:00 PM</archive-end-time>
      <on-air-time>05/15/2013 12:40:21 PM</on-air-time>
      <delete-time>05/15/2013 12:40:21 PM</delete-time>
   </primary-event>
</event>

Remove an event

Delete the event details. You can delete your events at any time.

NOTE: The event functionality works only for the stream packaging streams. It does not work for HLS ingest streams.

<?xml version="1.0" encoding="UTF-8"?>

Create a new version

Create a new profile version.

<?xml version="1.0" encoding="UTF-8"?>
<domain-version>
   <delivery-formats>
      <hd-flash-1.0>Disabled</hd-flash-1.0>
      <adobe-hds>Disabled</adobe-hds>
      <apple-hls>Enabled</apple-hls>
   </delivery-formats>
   <security>
      <hd-flash>
         <geo-blocking />
      </hd-flash>
      <securehd-policy-editor>Disabled</securehd-policy-editor>
   </security>
   <advanced-configuration>
      <adobe-hds-advanced-config />
      <hd-flash-advanced-config />
      <apple-hls-advanced-config>
         <hls-segment-duration>10.0</hls-segment-duration>
         <hls-live-delay>10</hls-live-delay>
         <audio-only-stream-from-lowest-bitrate>Disabled</audio-only-stream-from-lowest-bitrate>
         <insert-audio-poster>Disabled</insert-audio-poster>
         <add-alternate-stream>Enabled</add-alternate-stream>
         <limit-segments-per-playlist>0</limit-segments-per-playlist>
         <serve-archive>Enabled</serve-archive>
      </apple-hls-advanced-config>
   </advanced-configuration>
</domain-version>

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<response-message>
    <message>New Domain version 13 created successfully.</message>
</response-message>

Get a version

Profile version settings.

<?xml version="1.0" encoding="UTF-8"?>
<domain-version>
   <version>2</version>
   <delivery-formats>
      <hd-flash-1.0>Disabled</hd-flash-1.0>
      <adobe-hds>Disabled</adobe-hds>
      <apple-hls>Enabled</apple-hls>
   </delivery-formats>
   <security>
      <hd-flash>
         <geo-blocking />
      </hd-flash>
      <securehd-policy-editor>Disabled</securehd-policy-editor>
   </security>
   <advanced-configuration>
      <adobe-hds-advanced-config />
      <hd-flash-advanced-config />
      <apple-hls-advanced-config>
         <hls-segment-duration>10.0</hls-segment-duration>
         <hls-live-delay>10</hls-live-delay>
         <audio-only-stream-from-lowest-bitrate>Disabled</audio-only-stream-from-lowest-bitrate>
         <insert-audio-poster>Disabled</insert-audio-poster>
         <add-alternate-stream>Enabled</add-alternate-stream>
         <limit-segments-per-playlist>0</limit-segments-per-playlist>
         <serve-archive>Enabled</serve-archive>
      </apple-hls-advanced-config>
   </advanced-configuration>
   <author>example@domain.com</author>
</domain-version>

Get activation status

Get activation status of the profile version.

<?xml version="1.0" encoding="UTF-8"?>
<response-message>
   <message>Version 13 is currently NOT active on Staging.</message>
</response-message>

Activate a version

Activate profile version on an environment.

<?xml version="1.0" encoding="UTF-8"?>
<response-message>
   <message>This version of ARL metadata has been submitted to staging network. Please note that it may take upwards of 1 hour for your configuration to take effect on our network. Contact your Akamai representative if you are having problems with your configuration.</message>
</response-message>

List archive locations

Returns a list of NetStorage archive locations to be used for provisioning.

<?xml version="1.0" encoding="UTF-8"?>
<archive-storage-locations>
   <archive-storage-location>
      <name>Asia and US West</name>
   </archive-storage-location>
   <archive-storage-location>
      <name>Asia/Ireland</name>
   </archive-storage-location>
   <archive-storage-location>
      <name>Hong Kong/Malaysia</name>
   </archive-storage-location>
   <archive-storage-location>
      <name>Asia/Asia preferred</name>
   </archive-storage-location>
   <archive-storage-location>
      <name>EU/EU preferred</name>
   </archive-storage-location>
   <archive-storage-location>
      <name>US/US preferred</name>
   </archive-storage-location>
   <archive-storage-location>
      <name>EU/US preferred</name>
   </archive-storage-location>
   <archive-storage-location>
      <name>Asia/Europe</name>
   </archive-storage-location>
</archive-storage-locations>

List contacts

List an organization’s contact names who are responsible for the stream entrypoint availability.

<contacts>
   <contact>
      <name>NAME- 1</name>
   </contact>
   <contact>
      <name>NAME -2</name>
   </contact>
   <contact>
      <name>Name -3</name>
   </contact>
</contacts>

List countries

Returns a list of countries supported when creating a configuration.

<?xml version="1.0" encoding="UTF-8"?>
<countries>
   <country>
      <country-code>AF</country-code>
      <country-name>AFGHANISTAN</country-name>
   </country>
   <country>
      <country-code>AL</country-code>
      <country-name>ALBANIA</country-name>
   </country>
   <country>
      <country-code>DZ</country-code>
      <country-name>ALGERIA</country-name>
   </country>
   <country>
      <country-code>AS</country-code>
      <country-name>AMERICAN SAMOA</country-name>
   </country>
   <country>
      <country-code>AD</country-code>
      <country-name>ANDORRA</country-name>
   </country>
   <country>
      <country-code>AO</country-code>
      <country-name>ANGOLA</country-name>
   </country>
   <country>
      <country-code>AI</country-code>
      <country-name>ANGUILLA</country-name>
   </country>
   <country>
      <country-code>AQ</country-code>
      <country-name>ANTARCTICA</country-name>
   </country>
   <country>
      <country-code>ZW</country-code>
      <country-name>ZIMBABWE</country-name>
   </country>
</countries>

List CP codes

Returns a list of HD Live and NetStorage CPCodes available to be used for provisioning.

<?xml version="1.0" encoding="UTF-8"?>
<available-cpcode-list>
   <reporting-cpcode-list>
      <cpcode-list>
         <cpcode>1234</cpcode>
         <cpcode-name>CPCODE-NAME</cpcode-name>
         <network-service-list>
            <USS_LIVE_SERVICE_TYPES>HD_Live::Universal_Streaming</USS_LIVE_SERVICE_TYPES>
            <USS_LIVE_SERVICE_TYPES>HD_Live::Flash</USS_LIVE_SERVICE_TYPES>
            <USS_LIVE_SERVICE_TYPES>Live_Str::HD_Flash</USS_LIVE_SERVICE_TYPES>
            <IPHONE_LIVE_SERVICE_TYPES>HD_Live::iDevices</IPHONE_LIVE_SERVICE_TYPES>
            <NS_SERVICE_TYPES>NetStorage::NetStorage</NS_SERVICE_TYPES>
            <NS_SERVICE_TYPES>ACS_HTTP</NS_SERVICE_TYPES>
            <NS_SERVICE_TYPES>ACS_FTP</NS_SERVICE_TYPES>
            <network-service>
               <service>NetStorage (Legacy)</service>
            </network-service>
            <network-service>
               <service>Universal Streaming Live (Adobe Flash)</service>
            </network-service>
         </network-service-list>
         <top-level-group-list>
            <top-level-group>1-ABCDEF</top-level-group>
         </top-level-group-list>
      </cpcode-list>
      <cpcode-list>
         <cpcode>12345</cpcode>
         <cpcode-name>CPCODE-NAME 2</cpcode-name>
         <network-service-list>
            <USS_LIVE_SERVICE_TYPES>HD_Live::Universal_Streaming</USS_LIVE_SERVICE_TYPES>
            <USS_LIVE_SERVICE_TYPES>HD_Live::Flash</USS_LIVE_SERVICE_TYPES>
            <USS_LIVE_SERVICE_TYPES>Live_Str::HD_Flash</USS_LIVE_SERVICE_TYPES>
            <IPHONE_LIVE_SERVICE_TYPES>HD_Live::iDevices</IPHONE_LIVE_SERVICE_TYPES>
            <NS_SERVICE_TYPES>NetStorage::NetStorage</NS_SERVICE_TYPES>
            <NS_SERVICE_TYPES>ACS_HTTP</NS_SERVICE_TYPES>
            <NS_SERVICE_TYPES>ACS_FTP</NS_SERVICE_TYPES>
            <network-service>
               <service>HD iPhone Live</service>
            </network-service>
         </network-service-list>
         <top-level-group-list>
            <top-level-group>1-ABCDEF</top-level-group>
         </top-level-group-list>
      </cpcode-list>
   </reporting-cpcode-list>
   <netstorage-cpcode-list />
</available-cpcode-list>

List delivery formats

Returns a list of delivery formats available for provisioning.

<?xml version="1.0" encoding="UTF-8"?>
<delivery-format-list>
   <hd-flash-1.0 />
   <adobe-hds />
   <apple-hls />
</delivery-format-list>

List ingest formats

Returns a list of ingest formats available for provisioning.

<?xml version="1.0" encoding="UTF-8"?>
<ingest-format-list>
   <hd-flash />
   <apple-idevices />
</ingest-format-list>

List configurations

Retrieves a set of all RTMP configurations available to you.

{
    "configurations": [
        {
            "swfLocation": "123456.download.example.com/123456/",
            "isSecure": false,
            "isHDConfig": false,
            "name": "testConfig",
            "cpcode": 654321,
            "usePreSpreadSerial": true,
            "hostAliases": [
                "default.host.net (default)"
            ],
            "isRtmpe": true,
            "isMbr": true
        }
    ]
}

Create a configuration

Provisions a new RTMP configuration.

{
    "name": "testConfig123",
    "cpcode": 12345,
    "usePreSpreadSerial": true,
    "hostAliases": [
        "testHost1",
        "testHost2",
        "testHost3"
    ],
    "isRtmpe": false,
    "isMbr": false,
    "isSecure": true,
    "swfPath": "temp",
    "swfLocation": "123456.download.example.com/123456/",
    "authProfiles": [
        {
            "eTokenType": "NEW",
            "requireIP": true,
            "requirePath": true,
            "requirePayload": true,
            "name": "temp",
            "password": "abc123",
            "cidr": "1.2.3.4/32"
        }
    ]
}

Location: /configuration/123

Get a configuration

Retrieves detailed information about the requested RTMP configuration.

{
    "name": "samplename",
    "cpcode": 12345,
    "isSecure": true,
    "authProfiles": [
        {
            "name": "temp",
            "password": "abc123",
            "eTokenType": "NO_CHANGE",
            "requireIP": true,
            "requirePath": false,
            "requirePayload": true,
            "cidr": "1.2.3.4-4.5.6.7"
        }
    ],
    "usePreSpreadSerial": true,
    "hostAliases": [
        "default.hostname.net (default)",
        "testHost1.com",
        "testHost2.com"
    ],
    "swfPath": "check123",
    "swfLocation": "654321.download.example.com/654321/",
    "isRtmpe": true,
    "isMbr": true
}

Update a configuration

Updates certain fields of an existing RTMP configuration.

{
    "name": "sampleConfig",
    "cpcode": 1234,
    "usePreSpreadSerial": true,
    "isRtmpe": true,
    "isMbr": true,
    "isSecure": true,
    "hostAliases": [
        "testHost1",
        "testHost2"
    ],
    "swfPath": "check123",
    "swfLocation": "654321.download.example.com/654321/",
    "authProfiles": [
        {
            "name": "tempAuthProf",
            "password": "abc123",
            "eTokenType": "NO_CHANGE",
            "requireIP": true,
            "requirePath": true,
            "requirePayload": true,
            "cidr": "1.2.3.4-1.2.3.4"
        }
    ]
}

Delete a configuration

Deletes an existing RTMP configuration.

List RTMP CP codes

Obtains available CP codes for new RTMP configurations.

{
    "used": [
        {
            "cpcode": 12345,
            "name": "cpcode1"
        },
        {
            "cpcode": 54321,
            "name": "cpcode2"
        },
        {
            "cpcode": 67890,
            "name": "cpcode3"
        }
    ],
    "unused": [
        {
            "cpcode": 24680,
            "name": "cpcode4"
        },
        {
            "cpcode": 13579,
            "name": "cpcode5"
        },
        {
            "cpcode": 21345,
            "name": "cpcode6"
        }
    ]
}

List RTMP contacts

Obtains a list of people in your organization to contact regarding entry point availability issues.

{
    "contact": [
        {
            "name": "User1"
        },
        {
            "name": "User2"
        }
    ]
}

List RTMP streams

Retrieves a list of all RTMP streams available to a user.

{
    "streams": [
        {
            "isSecure": false,
            "createdDate": "2015-02-26T01:06:21.000Z",
            "primaryEntrypoint": "rtmp://p.ep123456.i.exampleentrypoint.net/EntryPoint",
            "backupEntrypoint": "rtmp://b.ep123456.i.exampleentrypoint.net/EntryPoint",
            "playbackSettings": [
                {
                    "connectionUrl": "rtmp://exampleConnectionUrl.net/live/",
                    "playbackUrl": "testStream1@123456"
                }
            ],
            "status": "Provisioned",
            "blocked": false,
            "id": 123456,
            "cpcode": 654321,
            "name": "testStream1",
            "dynamic": true,
            "encoder": {
                "primaryEncoderIP": "12.34.56.78",
                "backupEncoderIP": "78.56.34.12",
                "password": "test1"
            },
            "contactDetails": {
                "primary": "Test User",
                "secondary": "Test User"
            }
        }
    ]
}

Create an RTMP stream

Provisions a new RTMP stream.

{
    "cpcode": 12345,
    "name": "testStream",
    "dynamic": true,
    "encoder": {
        "primaryEncoderIP": "1.1.1.1",
        "backupEncoderIP": "1.1.1.1",
        "password": "test123"
    },
    "contactDetails": {
        "primary": "User test",
        "secondary": "User test"
    },
    "email": "abc@example.com",
    "isSecure": true,
    "streamEndDate": "2019-02-27T18:30:00.000Z",
    "authProfiles": [
        {
            "eTokenType": "NEW",
            "requireIP": true,
            "requirePath": true,
            "requirePayload": true,
            "name": "temp",
            "password": "abc123",
            "cidr": "1.2.3.4-1.2.3.4"
        }
    ]
}

Location: /stream/123

Get an RTMP stream

Retrieves detailed information about the requested RTMP stream.

{
    "isSecure": true,
    "createdDate": "2018-10-15T10:18:23.000Z",
    "primaryEntrypoint": "rtmp://p.ep123456.i.exampleentrypoint.net/EntryPoint",
    "backupEntrypoint": "rtmp://b.ep123456.i.exampleentrypoint.net/EntryPoint",
    "playbackSettings": [
        {
            "connectionUrl": "rtmp://exampleConnectionUrl.net/live/",
            "playbackUrl": "StreamTemp123@s123456"
        }
    ],
    "status": "Not Yet Provisioned",
    "email": "user@example.com",
    "blocked": false,
    "id": 123456,
    "cpcode": 65432,
    "name": "StreamTemp123",
    "dynamic": true,
    "encoder": {
        "primaryEncoderIP": "1.1.1.1",
        "backupEncoderIP": "198.199.26.36",
        "password": "abc123"
    },
    "streamEndDate": "2019-03-30T18:30:00.000Z",
    "contactDetails": {
        "primary": "Jack King",
        "secondary": "Aditya Sharma"
    },
    "authProfiles": [
        {
            "name": "abctemp",
            "password": "abc123",
            "eTokenType": "NO_CHANGE",
            "requireIP": true,
            "requirePath": true,
            "requirePayload": true,
            "cidr": "1.2.3.4/12"
        }
    ]
}

Update an RTMP stream

Modifies the specified RTMP stream.

{
    "cpcode": 123456,
    "name": "TempStream",
    "dynamic": true,
    "email": "abc@example.com",
    "streamEndDate": "2019-03-30T18:30:00.000Z",
    "encoder": {
        "password": "abc123",
        "primaryEncoderIP": "1.1.1.1",
        "backupEncoderIP": "1.1.1.1"
    },
    "contactDetails": {
        "primary": "user test",
        "secondary": "user test"
    },
    "authProfiles": [
        {
            "name": "abctemp",
            "password": "abc123",
            "eTokenType": "NO_CHANGE",
            "requireIP": true,
            "requirePath": true,
            "requirePayload": true,
            "cidr": "1.2.3.4/12"
        }
    ]
}

Delete an RTMP stream

Deletes the specified RTMP stream.

List storage groups

Provides a list of storage groups.

[
    {
        "cpcode": 123456,
        "downloadDomain": "123456.download.example.com",
        "location": "123456.download.example.com/123456/"
    },
    {
        "cpcode": 654321,
        "downloadDomain": "654321.download.example.com",
        "location": "654321.download.example.com/654321/"
    },
    {
        "cpcode": 246813,
        "downloadDomain": "246813.download.example.com",
        "location": "246813.download.example.com/246813/"
    }
]

Purge Flash content

Purges the HD content of format HD_FLASH on the production network by URL or CP codes. See Purge Flash content by URL or CP code for options.

{
    "requestName": "",
    "urlPurge": {
        "url": "http://examplehost-f.akamaihd.net/flash/test.mp4"
    }
}

{
    "message": "Purge request successful",
    "requestId": 1223344,
    "supportId": "12AB34567879879951318-203203776",
    "estimatedSeconds": 5,
    "httpStatus": 201
}

Purge Flash content by URL or CP code

Steps:

1. Build a new PurgeRequest object.

2. POST the object to /config-media-live/v1/vod/purge/HD_FLASH.

3. The operation responds with a PurgeResponse object.

Sample CP code purge request:

{
  "requestName": "PurgeRequest",
  "cpcode": [
    123456,
    234566
  ]
}

Sample URL purge request:

{
  "requestName": "",
  "urlPurge": {
    "url": "http://examplehost-f.akamaihd.net/flash/test.mp4"
  }
}

Purge HLS content

Purges the HD content of format HLS on the production network by URL, ARL, or CP codes. See Purge HLS content by URL or CP code for options.

{
    "requestName": "",
    "urlPurge": {
        "url": "http://iphone-i.akamaihd.net/i/examplehost/test.smil/master.m3u8",
        "file": [
            "test/test_220K_movies.mp4",
            "test/test_500K_movies.mp4"
        ]
    }
}

{
    "message": "Purge request successful",
    "requestId": 1223344,
    "supportId": "12AB34567879879951318-203203776",
    "estimatedSeconds": 5,
    "httpStatus": 201
}

Purge HLS content by URL or CP code

Steps:

1. Build a new PurgeRequest object.

2. POST the object to /config-media-live/v1/vod/purge/HLS.

3. The operation responds with a PurgeResponse object.

Sample CP code purge request:

{
  "requestName": "PurgeRequest",
  "cpcode": [
    123456,
    234566
  ]
}

Sample URL purge request:

{
  "requestName": "",
  "urlPurge": {
    "url": "http://iphone-i.akamaihd.net/i/examplehost/test.smil/master.m3u8",
    "file": [
      "test/test_220K_movies.mp4",
      "test/test_500K_movies.mp4"
    ]
  }
}

Purge HDS content

Purges the HD content of format HDS on the production network by URL, ARL, or CP codes. See Purge HDS content by URL or CP code for options.

{
    "requestName": "moviePurge",
    "urlPurge": {
        "url": "http://iphone-i.akamaihd.net/i/examplehost/test.smil/master.m3u8",
        "file": [
            "test/test_220K_movies.mp4",
            "test/test_500K_movies.mp4"
        ]
    }
}

{
    "message": "Purge request successful",
    "requestId": 1223344,
    "supportId": "12AB34567879879951318-203203776",
    "estimatedSeconds": 5,
    "httpStatus": 201
}

Purge HDS content by URL or CP code

Steps:

1. Build a new PurgeRequest object.

2. POST the object to /config-media-live/v1/vod/purge/HDS.

3. The operation responds with a PurgeResponse object.

Sample CP code purge request:

{
  "requestName": "PurgeRequest",
  "cpcode": [
    123456,
    234566
  ]
}

Sample URL purge request:

{
  "requestName": "",
  "urlPurge": {
    "url": "http://iphone-i.akamaihd.net/i/examplehost/test.smil/master.m3u8",
    "file": [
      "test/test_220K_movies.mp4",
      "test/test_500K_movies.mp4"
    ]
  }
}

Purge Silverlight content

Purges the HD content of format HD_SILVERLIGHT on the production network by URL, ARL, or CP codes. See Purge Silverlight content by URL or CP code for options.

{
    "requestName": "PurgeRequest",
    "urlPurge": {
        "url": "http://adobehttptest-f.akamaihd.net/z/example/test.smil/manifest.f4m",
        "file": [
            "test/test_adobe_http.f4m",
            "test/test_adobe_http_220kSeg1.f4x"
        ]
    }
}

{
    "message": "Purge request successful",
    "requestId": 1223344,
    "supportId": "12AB34567879879951318-203203776",
    "estimatedSeconds": 5,
    "httpStatus": 201
}

Purge RTMP content

Purges the RTMP content on the production network by URL, ARLs, or CP codes. See Purge RTMP content by URL or CP code for options.

{
    "requestName": "PurgeRequest",
    "urlPurge": {
        "file": [
            "rtmp://cp325140.edgefcs.net/ondemand/clips1/summit.mp4"
        ]
    },
    "delete": false
}

{
    "message": "Purge request successful",
    "requestId": 1223344,
    "supportId": "12AB34567879879951318-203203776",
    "estimatedSeconds": 5,
    "httpStatus": 201
}

Purge RTMP content by URL or CP code

Steps:

1. Build a new PurgeRequest object.

2. POST the object to /config-media-live/v1/vod/purge/rtmp/purge.

3. The operation responds with a PurgeResponse object.

Sample CP code purge request:

{
  "requestName": "Sample Request",
  "cpcode": [
    123456,
    654321
  ],
  "delete": false
}

Sample URL purge request:

{
  "requestName": "PurgeRequest",
  "urlPurge": {
    "file": [
      "rtmp://cp325140.edgefcs.net/ondemand/clips1/summit.mp4"
    ]
  },
  "delete": false
}

List purge formats

Obtains all HD purge formats for the corresponding scope tied to the current account. Fetches all possible formats based on the API client permissions. This operation lists the content of all formats that can be purged in the current managed account for which API client has been created. See Purge format parameters for details on how this operation’s response values correspond to parameter values.

{
    "format": [
        "HD Flash 1.0",
        "HLS",
        "HDS",
        "HD Silverlight",
        "RTMP"
    ]
}

Purge formats

The following table lists the CP code services for each streaming format.

List CP codes available for purge

Fetches all HD purge CP codes for corresponding CP code services in the current account. This operation can also fetch the CP codes for a specific account based on the given format.

{
    "allPurgeCpCodes": [
        {
            "cpCode": 123455,
            "description": "Flash CP code",
            "products": [
                {
                    "productName": "HD_On_Demand::Flash",
                    "productDescription": "Media Services On Demand Flash"
                },
                {
                    "productName": "On_Demand_Str::Flash",
                    "productDescription": "On demand Flash streaming"
                }
            ]
        },
        {
            "cpCode": 123456,
            "description": "HLS CP code",
            "products": [
                {
                    "productName": "HD_On_Demand::iDevices",
                    "productDescription": "On demand HLS streaming"
                }
            ]
        },
        {
            "cpCode": 123457,
            "description": "Silverlight CP code",
            "products": [
                {
                    "productName": "On_Demand_Str::HD_Silverlight",
                    "productDescription": "On demand Silverlight streaming"
                }
            ]
        }
    ]
}

XML Data

This section describes the XML-based data objects the Media Services API exchanges. See JSON Data for information on the JSON-based data the API’s RTMP operations exchange.

Media Services Live Stream Packaging and HLS/HDS/DASH ingest APIs support only XML. However, MSL RTMP Streaming supports JSON.

Domain

Domain resources enable you to view existing domain configurations, add new versions to existing domains, create new domains, and delete domains. You can also look at the activation status and activate a particular domain version in the staging and production environments.

Sample Stream Packaging Domain configuration:

<?xml version="1.0" encoding="UTF-8"?>
<domain>
    <configuration-details>
        <configuration-name>TestConfig</configuration-name>
        <hostname>hello1234-lh.akamaihd.net</hostname>
        <reporting-cpcode>125213</reporting-cpcode>
        <configuration-type>Universal Streaming Live</configuration-type>
        <access-control-group>C-SYPLCV</access-control-group>
    </configuration-details>
    <archive-configuration>
        <archive-cpcode>7338</archive-cpcode>
        <archive-storage-location>EU/US preferred</archive-storage-location>
    </archive-configuration>
    <domain-versions>
        <domain-version>
            <delivery-formats>
                <hd-flash-1.0>Disabled</hd-flash-1.0>
                <adobe-hds>Disabled</adobe-hds>
                <apple-hls>Enabled</apple-hls>
            </delivery-formats>
            <security>
                <securehd-policy-editor>Enabled</securehd-policy-editor>
                <securehd-policy-editor-default-policy>allow all (preset)</securehd-policy-editor-default-policy>
            </security>
            <advanced-configuration>
                <adobe-hds-advanced-config>
                    <hds-segment-duration>5</hds-segment-duration>
                </adobe-hds-advanced-config>
                <apple-hls-advanced-config>
                    <hls-segment-duration>10</hls-segment-duration>
                    <audio-only-stream-from-lowest-bitrate>Enabled</audio-only-stream-from-lowest-bitrate>
                </apple-hls-advanced-config>
            </advanced-configuration>
        </domain-version>
    </domain-versions>
</domain>

Sample HLS, HDS, and DASH Ingest Domain configuration

<?xml version="1.0" encoding="UTF-8"?>
<domain>
    <configuration-details>
        <configuration-name>TestConfig</configuration-name>
        <hostname>hello1234-i.akamaihd.net</hostname>
        <reporting-cpcode>125226</reporting-cpcode>
        <configuration-type>HD iPhone Live</configuration-type>
        <access-control-group>C-SYPLCV</access-control-group>
    </configuration-details>
    <archive-configuration>
        <archive-cpcode>22307</archive-cpcode>
        <archive-storage-location>Asia/EU preferred</archive-storage-location>
    </archive-configuration>
    <domain-versions>
        <domain-version>
            <segment-duration>11</segment-duration>
            <security>
                <securehd-policy-editor>Enabled</securehd-policy-editor>
                <securehd-policy-editor-default-policy>allow all (preset)</securehd-policy-editor-default-policy>
            </security>
            <ingest-settings>
                <encoder-ips-allow-all>Enabled</encoder-ips-allow-all>
                <encoder-ips-cidr-blocks-list>
                    <encoder-ips-cidr-block>
                        <ip-or-cidr-block>1.2.43.5</ip-or-cidr-block>
                    </encoder-ips-cidr-block>
                </encoder-ips-cidr-blocks-list>
            </ingest-settings>
        </domain-version>
    </domain-versions>
</domain>

Domain tags

Domain.archive-configuration

Contains details about the archive, such as archive CP code, archive name, domain name, and DVR pathname.

Domain.configuration-details

Contains details about the configuration, such as its name, hostname, reporting CP code, configuration type, and access control group.

DomainVersion

If you change the configuration’s security features, the system creates a new version of the configuration.

Sample Stream Packaging domain version configuration:

<?xml version="1.0" encoding="UTF-8"?>
<domain-version>
    <delivery-formats>
        <hd-flash-1.0>Disabled</hd-flash-1.0>
        <adobe-hds>Disabled</adobe-hds>
        <apple-hls>Enabled</apple-hls>
    </delivery-formats>
    <security>
        <securehd-policy-editor>Enabled</securehd-policy-editor>
        <securehd-policy-editor-default-policy>allow all (preset)</securehd-policy-editor-default-policy>
    </security>
    <advanced-configuration>
        <adobe-hds-advanced-config>
            <hds-segment-duration>6</hds-segment-duration>
        </adobe-hds-advanced-config>
        <apple-hls-advanced-config>
            <hls-segment-duration>10</hls-segment-duration>
            <audio-only-stream-from-lowest-bitrate>Enabled</audio-only-stream-from-lowest-bitrate>
        </apple-hls-advanced-config>
    </advanced-configuration>
</domain-version>

Sample HLS, HDS, and DASH ingest domain version configuration:

<?xml version="1.0" encoding="UTF-8"?>
<domain-version>
    <segment-duration>12</segment-duration>
    <security>
        <securehd-policy-editor>Enabled</securehd-policy-editor>
        <securehd-policy-editor-default-policy>allow all (preset)</securehd-policy-editor-default-policy>
    </security>
    <ingest-settings>
        <encoder-ips-allow-all>Enabled</encoder-ips-allow-all>
    </ingest-settings>
</domain-version>

DomainVersion tags

DomainVersion.advanced-configuration

Specifies advanced configuration for HDS and HLS. Required only for packaging streams.

DomainVersion.advanced-configuration-hds

DomainVersion.advanced-configuration-hls

DomainVersion.delivery-formats

Enables or disables one of the following delivery formats: hd-flash-1.0 to enable FLV-delivery URLs, adobe-hds to enable Adobe HTTP Dynamic Streaming, or apple-hls to enable Apple HTTP Live Streaming. Required only for packaging streams.

DomainVersion.security

Encapsulates security features for your configuration.

DomainVersion.security.hd-flash

Stream

Stream resources enable you to add a new stream for an existing domain, edit a stream, and delete a stream. The Stream object encapsulates data for both packaged and passthrough stream types, including the encoder-settings tag required only for packaged stream types.

Sample HLS, HDS, and DASH stream configuration:

<?xml version="1.0" encoding="UTF-8"?>
<stream>
    <stream-type>HD iPhone/iPad Live</stream-type>
    <stream-name>Streamhls</stream-name>
    <primary-contact-name>Jack King</primary-contact-name>
    <secondary-contact-name>Jane Doe</secondary-contact-name>
    <notification-email>jking@example.com</notification-email>
    <dvr-settings>
        <dvr>Enabled</dvr>
        <dvr-window>24</dvr-window>
    </dvr-settings>
</stream>

Sample Stream Packaging configuration, showing additional encoder-settings:

<?xml version="1.0" encoding="UTF-8"?>
<stream>
    <stream-type>Universal Streaming Live</stream-type>
    <stream-name>MyStream</stream-name>
    <primary-contact-name>Jack King</primary-contact-name>
    <secondary-contact-name>Jane Doe</secondary-contact-name>
    <notification-email>jking@example.com</notification-email>
    <encoder-settings>
        <primary-encoder-ip>1.2.3.4</primary-encoder-ip>
        <backup-encoder-ip>8.8.8.8</backup-encoder-ip>
        <password>secret</password>
    </encoder-settings>
    <dvr-settings>
        <dvr>Enabled</dvr>
        <dvr-window>36</dvr-window>
    </dvr-settings>
</stream>

Stream tags

Stream.dvr-settings

Specifies the amount of DVR time in your stream.

Stream.encoder-settings

Specifies the IP address of your primary and backup encoders used for the stream. Required for packaged stream types, not for passthrough streams.

Stream.entrypoints[]  

Specifies the IP address of the primary and backup entrypoints that are obtaining the stream on Media Services Live.

Stream.security–1.0

Specifies security features (such as player verification and token authorization) for your configuration.

Event

Event resources enable you to specify details about your streaming event.

Sample event configuration:

<?xml version="1.0" encoding="UTF-8"?>
<event>
    <stream-id>10005</stream-id>
    <event-name>news_event</event-name>
    <primary-event>
        <archive-start-time>05/14/2015 19:42:10 AM</archive-start-time>
        <archive-end-time>06/14/2015 07:37:42 PM</archive-end-time>
    </primary-event>
    <backup-event>
        <archive-start-time>05/13/2015 19:42:10 AM</archive-start-time>
        <archive-end-time>06/15/2015 07:37:42 PM</archive-end-time>
    </backup-event>
</event>

Event tags

Event.*

Specifies the primary or backup event start and end time.

Archive

Archive management resources enable you to view and update events for a stream.

Sample archive configuration:

<?xml version="1.0" encoding="UTF-8"?>
<archive-storage-locations>
    <archive-storage-location>
        <name>EU/EU preferred</name>
    </archive-storage-location>
</archive-storage-locations>

Archive tags

Contact

Use the contact tags to configure the name of the people responsible for the stream entrypoints.

Sample Contact configuration:

<?xml version="1.0" encoding="UTF-8"?>
<contacts>
    <contact>
        <name>John Doe</name>
    </contact>
</contacts>

Contact tags

Country

Use the country tag to specify the Country name and code.

Sample country configuration:

<?xml version="1.0" encoding="UTF-8"?>
<countries>
    <country>
        <country-code>AL</country-code>
        <country-name>ALBANIA</country-name>
    </country>
</countries>

Country tags

CPCode

CP code resources enable you to specify the Content Provider code associated with the stream. A Content Provider code is necessary to track all web traffic handled by Akamai servers. 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.

Sample CP code configuration:

<?xml version="1.0" encoding="UTF-8"?>
<available-cpcode-list>
    <reporting-cpcode-list>
        <cpcode-list>
            <cpcode>567891</cpcode>
            <cpcode-name>MYCPCODE - Media Services Live</cpcode-name>
            <network-service-list>
                <USS_LIVE_SERVICE_TYPES>HD_Live::Universal_Streaming</USS_LIVE_SERVICE_TYPES>
                <network-service>
                    <service>Universal Streaming Live (Adobe Flash)</service>
                </network-service>
            </network-service-list>
            <top-level-group-list>
                <top-level-group>1-ABCDEF</top-level-group>
            </top-level-group-list>
        </cpcode-list>
    </reporting-cpcode-list>
</available-cpcode-list>

CPCode tags

CPCode.network-service-list

CPCode.network-service-list.network-service

JSON Data

This section provides details on the JSON-based data types the API’s RTMP operations exchange. See XML Data for information on the XML-based data the API’s other operations exchange.

Download the JSON schemas for this API.

The data schema tables below list membership requirements as follows:

Configuration

Before you can create new streams, you must create at least one RTMP configuration to establish parameters for RTMP streams, such as the CP code and hostname. NetStorage is used with Media Services Live as your stream archive’s storage location. Therefore, you must have a NetStorage CP code set up and dedicated for use with Media Services Live, or you will be unable to create configurations. You can create as many configurations as you have CP codes available, depending on how you would like to have your streams reported and billed.

Download schema: postRTMPConfigurationDTO.json

Sample POST request:

{
    "name": "testConfig123",
    "cpcode": 12345,
    "usePreSpreadSerial": true,
    "hostAliases": [
        "testHost1",
        "testHost2",
        "testHost3"
    ],
    "isRtmpe": false,
    "isMbr": false,
    "isSecure": true,
    "swfPath": "temp",
    "swfLocation": "123456.download.example.com/123456/",
    "authProfiles": [
        {
            "eTokenType": "NEW",
            "requireIP": true,
            "requirePath": true,
            "requirePayload": true,
            "name": "temp",
            "password": "abc123",
            "cidr": "1.2.3.4/32"
        }
    ]
}

Configuration members

StorageGroup

You can keep your content for distribution in a storage group.

Download schema: RTMPStorageGroupDTO.json

Sample GET response:

[
    {
        "cpcode": 123456,
        "downloadDomain": "123456.download.example.com",
        "location": "123456.download.example.com/123456/"
    },
    {
        "cpcode": 654321,
        "downloadDomain": "654321.download.example.com",
        "location": "654321.download.example.com/654321/"
    },
    {
        "cpcode": 246813,
        "downloadDomain": "246813.download.example.com",
        "location": "246813.download.example.com/246813/"
    }
]

StorageGroup members

Stream

Creates a new RTMP stream.

Download schema: getRTMPStreamDTO.json

Sample PUT request:

{
    "cpcode": 123456,
    "name": "TempStream",
    "dynamic": true,
    "email": "abc@example.com",
    "streamEndDate": "2019-03-30T18:30:00.000Z",
    "encoder": {
        "password": "abc123",
        "primaryEncoderIP": "1.1.1.1",
        "backupEncoderIP": "1.1.1.1"
    },
    "contactDetails": {
        "primary": "user test",
        "secondary": "user test"
    },
    "authProfiles": [
        {
            "name": "abctemp",
            "password": "abc123",
            "eTokenType": "NO_CHANGE",
            "requireIP": true,
            "requirePath": true,
            "requirePayload": true,
            "cidr": "1.2.3.4/12"
        }
    ]
}

Stream members

CpCode

The list of used and unused Content Provider codes for creating RTMP configurations or streams.You use CP codes in the Akamai system to track and report delivered services. This CP code is based on JSON for RTMP ingest only. You cannot create two MSL RTMP configuration based on the same CP code.

Download schema: RTMPCpcodesDTO.json

Sample GET response:

{
    "used": [
        {
            "cpcode": 12345,
            "name": "cpcode1"
        },
        {
            "cpcode": 54321,
            "name": "cpcode2"
        },
        {
            "cpcode": 67890,
            "name": "cpcode3"
        }
    ],
    "unused": [
        {
            "cpcode": 24680,
            "name": "cpcode4"
        },
        {
            "cpcode": 13579,
            "name": "cpcode5"
        },
        {
            "cpcode": 21345,
            "name": "cpcode6"
        }
    ]
}

CpCode members

PurgeRequest

This describes the PurgeRequest object, which purges content based on either URLs or CP codes.

Download schema: postHDUrlPurgeRequest.json, postRtmpUrlPurgeRequest.json, postHDCpcodePurgeRequest.json, postRtmpCpcodePurgeRequest.json

Sample purge by URL:

{
    "requestName": "PurgeRequest",
    "urlPurge": {
        "file": [
            "rtmp://cp325140.edgefcs.net/ondemand/clips1/summit.mp4"
        ]
    },
    "delete": false
}

Sample purge by CP code:

{
    "requestName": "Sample Request",
    "cpcode": [
        123456,
        654321
    ],
    "delete": false
}

PurgeRequest members

PurgeResponse

Response to the purge request.

Download schema: HDPurgeStatusInfo.json

Sample POST response:

{
    "message": "Purge request successful",
    "requestId": 1223344,
    "supportId": "12AB34567879879951318-203203776",
    "estimatedSeconds": 5,
    "httpStatus": 201
}

PurgeResponse members

PurgeableCpCodes

Provides a set of HD purge CP codes for the corresponding CP code services in the current account. The List CP codes available for purge operation can also fetch the CP codes for specific accounts based on the given format.

Download schema: getCCUCpcodesList.json

Sample GET response:

{
    "allPurgeCpCodes": [
        {
            "cpCode": 123455,
            "description": "Flash CP code",
            "products": [
                {
                    "productName": "HD_On_Demand::Flash",
                    "productDescription": "Media Services On Demand Flash"
                },
                {
                    "productName": "On_Demand_Str::Flash",
                    "productDescription": "On demand Flash streaming"
                }
            ]
        },
        {
            "cpCode": 123456,
            "description": "HLS CP code",
            "products": [
                {
                    "productName": "HD_On_Demand::iDevices",
                    "productDescription": "On demand HLS streaming"
                }
            ]
        },
        {
            "cpCode": 123457,
            "description": "Silverlight CP code",
            "products": [
                {
                    "productName": "On_Demand_Str::HD_Silverlight",
                    "productDescription": "On demand Silverlight streaming"
                }
            ]
        }
    ]
}

PurgeableCpCodes members

Errors

This section details the Media Services API error response formats, lists specific error messages you might encounter, and the API’s complete range of HTTP response codes.

Error responses

This API’s error responses conform to the JSON problem specification. The following shows a typical Media Services API error response:

{
    "type": "https://problems.luna.akamaiapis.net/-/resource-impl/forward-origin-error",
    "title": "Bad Request",
    "status": 400,
    "instance": "https://akab-we62bufgzvfmaj5f-3rtepafiil5ulp4p.luna.akamaiapis.net/config-media-live/v1/live/abcd-lh.akamaihd.n1et/stream",
    "method": "GET",
    "serverIp": "184.1.2.3",
    "clientIp": "60.2.3.4",
    "requestId": "14d35d3a",
    "requestTime": "2016-04-19T13:04:20Z"
}

Errors when adding a domain

The following errors might appear if the API fails while adding a domain:

• Empty Configuration Name.
• Maximum Configuration Name: (30)
• HostName must be specified.
• Reporting CP code is required.
• Version details missing.
• CP code not available for creating domain configuration.
• User does not have edit permission for CP code.
• Hostname should not be more than 18 characters.
• Archive configuration missing.
• Multiple archive feature currently not supported.
• Storage Group CP code missing.
• No CP codes available to create a storage group.
• The archive CP code is not available.
• Hostname format is not valid.

Errors when creating a new domain version

The following errors might appear if the API fails while creating a new domain version:

• Domain cannot be empty.
• Please specify only a single activate environment either staging or production.
• Invalid activate environment. Please specify either staging or production.
• Domain has been converted to ‘advanced configuration’. You cannot add new versions to this domain.

Errors when activating domain versions

The following errors might appear if the API fails while activating a domain version and getting the version status:

• Invalid version ID
• Please specify a valid environment.
• Environment must be either production or staging.

Errors when deleting domains

The following errors might appear if the API fails while deleting a domain:

• Domain cannot be empty.
• Domain Name must be specified.

Errors when creating streams

The following errors might appear if the API fails while creating a stream:

• Domain Name must be specified.
• For creating new stream, please do not specify a stream ID.
• Stream Format does not match with domain supported stream format.
• No configuration found for specified domain.
• User does not have permission to create IPhone streams.
• User does not have permission to create Flash streams.
• Unable to find Storage group from configuration.
• The stream end date should be later than today.
• Please specify stream end date between tomorrow and 5 years from today.
• Please specify a valid value for DVR window.
• DVR window should be between 5 and 30 minutes.
• DVR window should be less than 30 minutes when Netstorage is disabled.
• Please enter stream name.
• Please re-enter stream name in the valid format.
• Please do not specify the username field.
• For IPhone streams please do not specify the primary or backup encoder IP
• Please specify a valid value for Segment Interval (Integer no less than 2).
• Please enter a valid primary encoder IP. This IP is restricted.
• Please enter a valid secondary encoder IP. This IP is restricted.
• Please specify a password in encoder settings.
• Please specify a primary contact.
• Unable to find Primary Contact. Please check your input.
• Please specify a secondary contact
• Unable to find Secondary Contact. Please check your input.
• Please specify a Notification Email.
• Invalid Notification email format. Please specify a valid email address.

Errors when editing or deleting streams

The following error might appear if the API fails while editing or deleting a stream:

• Incorrect Stream ID

HTTP status codes

The API produces the following set of HTTP status codes for both success and failure scenarios.

Last modified: 8/21/2019