Learn more:

• Media Services Live

• Media Services Live Stream Provisioning API v1

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

Overview

The Media Services Live (MSL) Stream Provisioning API lets you publish live content and retrieve it for delivery either through Akamai or any content delivery network (CDN). You use MSL primarily for over-the-top (OTT) applications, but you can also use it for other live streaming events. To publish content, you push media content directly from encoders into a live origin through the Akamai ingest server. To deliver it, you pull the content into the origin through a CDN.

The API mirrors the functionality of MSL 4 available in the Luna Control Center.

This API supports the multiple CDN feature, which lets you use any CDN to deliver your media content, while using Akamai for ingest and origination. It also supports multi-account access, which allows you to use origin keys to deliver streams defined in one Akamai account in other account configurations, to better syndicate your content for all your customers.

In MSL 4.1, Media Services Live is split from Adaptive Media Delivery, so that you can use MSL 4 with all AMD features. The multi-account feature further allows you to deploy many AMD configurations for many customer accounts, all from a single MSL origin.

Who should use this API

Use this API to access and provision media streaming using customized interfaces.

Getting started

To configure this API for the first time:

• Contact your Akamai representative to enable it for your account.

• Ensure that your contract includes MediaServicesLive4::MediaServicesLive4.

• 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.

• Choose the API service named Media Streaming, and set the access level to READ-WRITE.

Rate limiting

The MSL Stream Provisioning API imposes a rate limiting constraint. Exceeding that limit results in a 429 error response. Consider this especially when calling successive operations as part of a loop.

Responses contain these headers to specify rate limit information:

• X-RateLimit-Limit: The maximum number of tokens allowed.

• X-RateLimit-Remaining: The number of tokens remaining.

Once X-RateLimit-Remaining becomes 0, you get a 429 error the next time you make an API call. The response header also displays the time when you can make one more request. For example: X-RateLimit-Next: 2018-05-11T07:04:40.004Z.

If you do not make any more API calls after you receive a 429 error, the X-RateLimit-Remaining gradually increases and becomes equal to X-RateLimit-Limit.

API workflow

Follow these steps to use the MSL Stream Provisioning API:

1. Create a new MSL origin and optionally use MSL features such as multi-account and multi-CDN.

2. Create a stream using the origin that you created. Get all of the origins from List live origins and provide the CP code associated with the origin in the stream creation request. The encoder zone should also match the origin location.

Alternatively, create a stream with a new MSL origin along with the stream settings. Get an unused CP code from List CP codes and provide it in the stream creation request.

1. Create the Adaptive Media Delivery (AMD) property with the Origin Type as Media Services Live in the Origin Server Behavior section.

You can retrieve these fields to create a stream:

• Run List CP codes to get the value of the CP code. Apply the unused parameter to retrieve an unused CP code.

• Run List contracts to get the value of the contractId.

• Run Generate a key to obtain the key.

• Run List CDNs to obtain the CDN code.

To disable the multi-account and multi-CDN features, make a PUT call with an empty object in the request body.

NOTE: These endpoints are deprecated. Do not use them:

• /msl-origin/origins/{id}/versions
• /msl-origin/origins/{id}/versions/{version}/activate

Resources

You deal with various conceptual objects when interacting with the MSL Stream Provisioning API.

• Streams. Contains configuration details for ingest streams. Stream resources let you create an ingest stream, get a list of streams, get stream details, edit a stream, and delete a stream. See the Stream object type.

• Origins. Contains configuration for the origin of a stream. With the Media Services Live origin feature, you can publish live content, and retrieve it for delivery through the Akamai content delivery network (CDN). The feature is targeted primarily for OTT applications, but can also be used for other live specific events. Live origin has a publishing workflow and a delivery workflow. See the Origin object type. In the publishing workflow, you can directly push content from encoders into the live origin through the Akamai ingest server. In the delivery workflow, you can pull the content that was earlier published into origin through a CDN.

• Versions. Contains the Media Services live origin version.

• Activations. Contains activation information for the live origin version.

• Contracts. Contains information about MSL contracts.

• CDN providers. Contains the list of CDN providers.

• CP codes. Displays the CP codes tied to the MSL contract.

• Keys. Shared keys with partners enable authentication between the Origin Shield and the Adaptive Media Delivery (AMD) configuration.

API summary

Download the RAML descriptors for this API.

List streams

Retrieves a list of all streams available to a user. Supports optional URL Parameters for pagination and sorting of the results.

{
    "totalSize": 5,
    "page": 1,
    "pageSize": 10,
    "streams": [
        {
            "id": 123456,
            "name": "DemoStream1",
            "format": "HLS",
            "cpcode": 234567,
            "originHostName": "demo-host1.akamaiorigin.net",
            "modifiedDate": "2017-05-25T07:38:18.003Z",
            "dvrWindowInMin": -1,
            "provisionDetail": {
                "status": "PROVISIONED",
                "message": "Provisioned"
            },
            "encoderZone": "EUROPE",
            "backupStorageCpcode": null,
            "primaryStorageCpcode": 514779,
            "createdDate": "2017-11-14T07:06:25.794Z",
            "createdBy": "abcd",
            "modifiedBy": "def"
        },
        {
            "id": 232123,
            "name": "DemoStream2",
            "format": "HLS",
            "cpcode": 987654,
            "originHostName": "demo-host2.akamaiorigin.net",
            "modifiedDate": "2017-05-25T06:30:48.215Z",
            "dvrWindowInMin": 5,
            "provisionDetail": {
                "status": "FAILED",
                "message": "Stream provisioning failed"
            },
            "encoderZone": "EUROPE",
            "backupStorageCpcode": null,
            "primaryStorageCpcode": 558239,
            "createdDate": "2017-11-14T07:06:25.794Z",
            "createdBy": "abcd",
            "modifiedBy": "def"
        },
        {
            "id": 324453,
            "name": "DemoStream3",
            "format": "HLS",
            "cpcode": 123455,
            "originHostName": "demo-host3.akamaiorigin.net",
            "modifiedDate": "2017-05-25T06:13:13.436Z",
            "dvrWindowInMin": 9,
            "provisionDetail": {
                "status": "PENDING"
            },
            "encoderZone": "EUROPE",
            "backupStorageCpcode": null,
            "primaryStorageCpcode": 678779,
            "createdDate": "2017-11-14T07:06:25.794Z",
            "createdBy": "abcd",
            "modifiedBy": "def"
        }
    ]
}

Create a stream

Provisions a new stream.

{
    "name": "Demostream",
    "contractId": "ABC-123",
    "format": "HLS",
    "cpcode": 123445,
    "ingestAccelerated": false,
    "allowedIps": [
        "1.2.3.4"
    ],
    "encoderZone": "EUROPE",
    "backupEncoderZone": "AUSTRALIA",
    "origin": {
        "hostName": "demo-host1",
        "cpcode": 412342
    },
    "additionalEmailIds": [
        "xyz@akamai1.com"
    ],
    "isDedicatedOrigin": false,
    "activeArchiveDurationInDays": 2
}

Location: /streams/123

Get a stream

Retrieves detailed information about the requested stream.

{
    "id": 745645,
    "name": "DemoStream",
    "format": "HLS",
    "cpcode": 123321,
    "ingestAccelerated": false,
    "dvrWindow": 5,
    "allowedIps": [],
    "encoderZone": "EUROPE",
    "backupEncoderZone": "AUSTRALIA",
    "origin": {
        "hostName": "demo-host1.akamaiorigin.net"
    },
    "backupOrigin": {
        "hostName": "demo-host2.akamaiorigin.net"
    },
    "events": [],
    "createdDate": "2017-11-14T07:06:25.794Z",
    "modifiedDate": "2017-11-14T07:20:12.359Z",
    "createdBy": "abc",
    "modifiedBy": "def",
    "provisionDetail": {
        "streamId": 745645,
        "status": "PENDING"
    },
    "additionalEmailIds": [
        "xyz@akamai1.com"
    ],
    "storageGroup": {
        "cpcode": 125334
    },
    "backupStorageGroup": {
        "cpcode": 124
    },
    "primaryPublishingUrl": "test1.akamaientrypoint.net",
    "backupPublishingUrl": "test2.akamaientrypoint.net",
    "isDedicatedOrigin": false
}

Update a stream

Modifies an existing stream. In the request, include the same type of Stream object available from the Get a stream operation’s response.

{
    "id": 723456,
    "name": "DemostreamEdit",
    "format": "HLS",
    "cpcode": 123456,
    "ingestAccelerated": true,
    "password": 346789999,
    "dvrWindow": 10,
    "allowedIps": [
        "1.2.3.4",
        "2.5.6.7"
    ],
    "encoderZone": "US_EAST",
    "origin": {
        "hostName": "demoHost.akamaiorigin.net",
        "cpcode": 412342
    },
    "additionalEmailIds": [
        "xyz@akamai1.com",
        "efg@akamai.com"
    ]
}

Remove a stream

Deletes the specified stream.

List live origins

Retrieves a list of all live origins associated with the profile by default, or optionally filtered live origins.

[
    {
        "hostName": "demoHost1.akamaiorigin.net",
        "hostNameIdentifier": "demoHost1",
        "cpcode": 938401,
        "id": 7345,
        "storageCpcode": 0,
        "location": "EUROPE",
        "resourceGroup": "resGrp01",
        "createdDate": "2018-03-12T13:14:02.607Z",
        "modifiedDate": "2018-03-12T13:14:02.607Z",
        "createdBy": "user123",
        "modifiedBy": "user123",
        "otherCdnCpcode": 978902,
        "backupOriginHost": {
            "storageCpcode": null,
            "location": "AUSTRALIA",
            "backupHostName": "demoHost2.akamaiorigin.net"
        }
    },
    {
        "hostName": "demo-host3.akamaiorigin.net",
        "hostNameIdentifier": "demo-host3",
        "cpcode": 966957,
        "id": 5909,
        "storageCpcode": 978765,
        "location": "EUROPE",
        "resourceGroup": "resGrp01",
        "createdDate": "2017-06-09T20:46:34.000Z",
        "modifiedDate": "2017-06-09T20:46:34.000Z",
        "createdBy": "user456",
        "modifiedBy": "user456",
        "otherCdnCpcode": 954371,
        "backupOriginHost": {
            "storageCpcode": null,
            "location": "GERMANY",
            "backupHostName": "demo-host4.akamaiorigin.net"
        }
    }
]

Create a new origin

Create a Media Services live origin for the stream. You can associate this origin hostname with an Adaptive Media Delivery configuration.

{
    "contractId": "C-Contract-123",
    "hostName": "demohost",
    "cpcode": 123456,
    "encoderZone": "US_EAST",
    "backupEncoderZone": "EUROPE",
    "thirdPartyCdnCpcode": 654321,
    "sharedKeys": [
        {
            "type": "AKAMAI",
            "authMethod": "MSL_MULTI_ACCOUNT",
            "name": "SomeName01",
            "key": "7153f558f89e058ae",
            "enabled": true
        },
        {
            "type": "AKAMAI",
            "authMethod": "MSL_MULTI_ACCOUNT",
            "name": "nonce2",
            "key": "2557f557f39e025db",
            "enabled": false
        },
        {
            "type": "THIRD_PARTY",
            "authMethod": "SIMPLE_AKAMAI_HEADER_VERIFICATION",
            "name": "SomeName03",
            "cdnCode": "dn00x",
            "enabled": false,
            "guid": "402254d3-e75e-4501-8709-5a3a2211f79",
            "key": "h0BhBScF1Wb3y1r8clJqqg==",
            "expiryDate": "2018-12-12T06:15:00.000Z"
        },
        {
            "type": "THIRD_PARTY",
            "authMethod": "SIMPLE_AKAMAI_HEADER_VERIFICATION",
            "name": "SomeName04",
            "cdnCode": "dn00x",
            "enabled": true,
            "guid": "105254f3-e75e-4501-8709-5a3a2277d09",
            "key": "h2MhYEcH1Wu3z1r9clJoob==",
            "expiryDate": "2017-09-25T18:33:00.000Z"
        }
    ]
}

Location: /api/v2/origins/123

Get an origin

Retrieves detailed information about the requested origin.

{
    "id": 101,
    "hostName": "001-dn001-demohost.akamaiorigin.net",
    "backupHostName": "003-dn001-demohost.akamaiorigin.net",
    "cpcode": 123456,
    "encoderZone": "US_EAST",
    "backupEncoderZone": "EUROPE",
    "format": "HLS",
    "status": "SUCCEEDED",
    "modifiedDate": "2017-03-04T02:41:27.964Z",
    "modifiedBy": "ddinakar",
    "activeVersion": "3",
    "thirdPartyCdnCpcode": 654321,
    "sharedKeys": [
        {
            "type": "AKAMAI",
            "authMethod": "MSL_MULTI_ACCOUNT",
            "name": "SomeName01",
            "key": "7153f558f89e058ae",
            "enabled": true
        },
        {
            "type": "AKAMAI",
            "authMethod": "MSL_MULTI_ACCOUNT",
            "name": "nonce2",
            "key": "2557f557f39e025db",
            "enabled": false
        },
        {
            "type": "THIRD_PARTY",
            "authMethod": "SIMPLE_AKAMAI_HEADER_VERIFICATION",
            "name": "SomeName03",
            "cdnCode": "dn00x",
            "enabled": false,
            "guid": "402254d3-e75e-4501-8709-5a3a2211f79",
            "key": "h0BhBScF1Wb3y1r8clJqqg==",
            "expiryDate": "2018-12-12T06:15:00.000Z",
            "previousKey": "a2BhDFcH1Wu6y1r8clJllm==",
            "previousKeyExpiryDate": "2017-11-22T12:33:00.000Z",
            "hostName": "001-dn00x-demohost.akamaiorigin.net",
            "backupHostName": "003-dn00x-demohost.akamaiorigin.net"
        },
        {
            "type": "THIRD_PARTY",
            "authMethod": "SIMPLE_AKAMAI_HEADER_VERIFICATION",
            "name": "SomeName04",
            "cdnCode": "dn00x",
            "enabled": true,
            "guid": "105254f3-e75e-4501-8709-5a3a2277d09",
            "key": "h2MhYEcH1Wu3z1r9clJoob==",
            "expiryDate": "2017-09-25T18:33:00.000Z",
            "hostName": "001-dn00x-demohost.akamaiorigin.net",
            "backupHostName": "003-dn00x-demohost.akamaiorigin.net"
        }
    ]
}

Update an origin

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.

{
    "id": 101,
    "sharedKeys": [
        {
            "type": "AKAMAI",
            "authMethod": "MSL_MULTI_ACCOUNT",
            "name": "SomeName01",
            "key": "7153f558f89e058ae",
            "enabled": true
        },
        {
            "type": "AKAMAI",
            "authMethod": "MSL_MULTI_ACCOUNT",
            "name": "nonce2",
            "key": "2557f557f39e025db",
            "enabled": false
        },
        {
            "type": "THIRD_PARTY",
            "authMethod": "SIMPLE_AKAMAI_HEADER_VERIFICATION",
            "name": "SomeName03",
            "cdnCode": "dn00x",
            "enabled": false,
            "guid": "402254d3-e75e-4501-8709-5a3a2211f79",
            "key": "h0BhBScF1Wb3y1r8clJqqg==",
            "expiryDate": "2018-12-12T06:15:00.000Z",
            "previousKey": "a2BhDFcH1Wu6y1r8clJllm==",
            "previousKeyExpiryDate": "2017-11-22T12:33:00.000Z"
        },
        {
            "type": "THIRD_PARTY",
            "authMethod": "SIMPLE_AKAMAI_HEADER_VERIFICATION",
            "name": "SomeName04",
            "cdnCode": "dn00x",
            "enabled": true,
            "guid": "105254f3-e75e-4501-8709-5a3a2277d09",
            "key": "h2MhYEcH1Wu3z1r9clJoob==",
            "expiryDate": "2017-09-25T18:33:00.000Z"
        }
    ]
}

List CP codes per origin

Fetches available CP codes for a new origin.

[
    {
        "id": 321234,
        "name": "Test",
        "contracts": [
            {
                "contractId": "Z-AAAVOB"
            }
        ],
        "isUsed": false
    }
]

List contracts

Retrieve MSL contracts and use it to create streams, origins, or CP codes. The system filters the ingest CP code based on the contract ID.

[
    {
        "contractId": "A-225678B",
        "accountId": "E-A-VC678R",
        "parentContractId": null,
        "contractTypeId": "R-T746",
        "expired": false,
        "childContractIds": null
    },
    {
        "contractId": "A-BVIUED",
        "accountId": "K-J-CA909R",
        "parentContractId": null,
        "contractTypeId": "I-K1YX",
        "expired": false,
        "childContractIds": null
    }
]

List CDNs

Fetch predefined list of CDN providers. You can configure your MSL origin to include multiple CDN providers.

[
    {
        "code": "dn002",
        "name": "L3"
    },
    {
        "code": "dn003",
        "name": "Fastly"
    },
    {
        "code": "dn004",
        "name": "Cloudfront"
    }
]

Generate a key

Specify either AKAMAI or THIRD_PARTY key format.

{
    "key": "Ab+DgsTEL6t5Trcv5KYUZw=="
}

List CP codes

Obtains the CP code based on the service. You need a CP code to create a stream or an origin.

[
    {
        "id": 321234,
        "name": "Test",
        "contracts": [
            {
                "contractId": "Z-AAAVOB"
            }
        ],
        "isUsed": false
    }
]

Create CP code

Creates a new MSL CP code. You need a CP code to create a stream or an origin.

{
    "name": "Cpcode 1",
    "contractId": "A-BCDE12-3"
}

{
    "id": 12345,
    "name": "Cpcode 1",
    "contractId": "A-BCDE12-3"
}

List publishing locations

Get valid encoder locations.

[
    {
        "location": "EUROPE",
        "code": "001",
        "netstorageZone": "europe"
    },
    {
        "location": "NORTH_AMERICA",
        "code": "002",
        "netstorageZone": "us"
    },
    {
        "location": "LATIN_AMERICA",
        "code": "003",
        "netstorageZone": "us"
    },
    {
        "location": "SOUTH_AMERICA",
        "code": "004",
        "netstorageZone": "us"
    },
    {
        "location": "NORDICS",
        "code": "005",
        "netstorageZone": "europe"
    },
    {
        "location": "ASIA_PACIFIC",
        "code": "006",
        "netstorageZone": "asia"
    },
    {
        "location": "OTHER_AMERICAS",
        "code": "007",
        "netstorageZone": "us"
    },
    {
        "location": "OTHER_APJ",
        "code": "008",
        "netstorageZone": "asia"
    },
    {
        "location": "OTHER_EMEA",
        "code": "009",
        "netstorageZone": "europe"
    },
    {
        "location": "GERMANY",
        "code": "011",
        "netstorageZone": "europe"
    },
    {
        "location": "INDIA",
        "code": "012",
        "netstorageZone": "asia"
    },
    {
        "location": "ITALY",
        "code": "013",
        "netstorageZone": "europe"
    },
    {
        "location": "JAPAN",
        "code": "014",
        "netstorageZone": "asia"
    },
    {
        "location": "MEXICO",
        "code": "015",
        "netstorageZone": "us"
    },
    {
        "location": "TAIWAN",
        "code": "016",
        "netstorageZone": "asia"
    },
    {
        "location": "UNITED_KINGDOM",
        "code": "017",
        "netstorageZone": "europe"
    },
    {
        "location": "US_EAST",
        "code": "018",
        "netstorageZone": "useast"
    },
    {
        "location": "US_CENTRAL",
        "code": "019",
        "netstorageZone": "useast"
    },
    {
        "location": "US_WEST",
        "code": "020",
        "netstorageZone": "us"
    },
    {
        "location": "AUSTRALIA",
        "code": "010",
        "netstorageZone": "AU"
    }
]

Data

This section provides you with the data model for the Media Services Live Stream Provisioning API.

Download the JSON schemas for this API.

The data schema tables below list membership requirements as follows:

Stream

Encapsulates stream configuration and version information. You can list, create, edit, delete, and get stream details.

Download schema: StreamDetailsPostDTO.json, StreamDetailsDTO.json, StreamDetailsPutDTO.json

Sample GET response:

{
    "id": 745645,
    "name": "DemoStream",
    "format": "HLS",
    "cpcode": 123321,
    "ingestAccelerated": false,
    "dvrWindow": 5,
    "allowedIps": [],
    "encoderZone": "EUROPE",
    "backupEncoderZone": "AUSTRALIA",
    "origin": {
        "hostName": "demo-host1.akamaiorigin.net"
    },
    "backupOrigin": {
        "hostName": "demo-host2.akamaiorigin.net"
    },
    "events": [],
    "createdDate": "2017-11-14T07:06:25.794Z",
    "modifiedDate": "2017-11-14T07:20:12.359Z",
    "createdBy": "abc",
    "modifiedBy": "def",
    "provisionDetail": {
        "streamId": 745645,
        "status": "PENDING"
    },
    "additionalEmailIds": [
        "xyz@akamai1.com"
    ],
    "storageGroup": {
        "cpcode": 125334
    },
    "backupStorageGroup": {
        "cpcode": 124
    },
    "primaryPublishingUrl": "test1.akamaientrypoint.net",
    "backupPublishingUrl": "test2.akamaientrypoint.net",
    "isDedicatedOrigin": false
}

Stream members

Origin

Configures a Media Services Live origin for the stream and lets you share the origin with partner accounts within Akamai (using multi-account) as well as third-party delivery providers (using multi-CDN).

Download schema: OriginDetailDTOV2Post.json, OriginDetailDTOV2.json, OriginDetailDTOV2Put.json

Sample GET response:

{
    "id": 101,
    "hostName": "001-dn001-demohost.akamaiorigin.net",
    "backupHostName": "003-dn001-demohost.akamaiorigin.net",
    "cpcode": 123456,
    "encoderZone": "US_EAST",
    "backupEncoderZone": "EUROPE",
    "format": "HLS",
    "status": "SUCCEEDED",
    "modifiedDate": "2017-03-04T02:41:27.964Z",
    "modifiedBy": "ddinakar",
    "activeVersion": "3",
    "thirdPartyCdnCpcode": 654321,
    "sharedKeys": [
        {
            "type": "AKAMAI",
            "authMethod": "MSL_MULTI_ACCOUNT",
            "name": "SomeName01",
            "key": "7153f558f89e058ae",
            "enabled": true
        },
        {
            "type": "AKAMAI",
            "authMethod": "MSL_MULTI_ACCOUNT",
            "name": "nonce2",
            "key": "2557f557f39e025db",
            "enabled": false
        },
        {
            "type": "THIRD_PARTY",
            "authMethod": "SIMPLE_AKAMAI_HEADER_VERIFICATION",
            "name": "SomeName03",
            "cdnCode": "dn00x",
            "enabled": false,
            "guid": "402254d3-e75e-4501-8709-5a3a2211f79",
            "key": "h0BhBScF1Wb3y1r8clJqqg==",
            "expiryDate": "2018-12-12T06:15:00.000Z",
            "previousKey": "a2BhDFcH1Wu6y1r8clJllm==",
            "previousKeyExpiryDate": "2017-11-22T12:33:00.000Z",
            "hostName": "001-dn00x-demohost.akamaiorigin.net",
            "backupHostName": "003-dn00x-demohost.akamaiorigin.net"
        },
        {
            "type": "THIRD_PARTY",
            "authMethod": "SIMPLE_AKAMAI_HEADER_VERIFICATION",
            "name": "SomeName04",
            "cdnCode": "dn00x",
            "enabled": true,
            "guid": "105254f3-e75e-4501-8709-5a3a2277d09",
            "key": "h2MhYEcH1Wu3z1r9clJoob==",
            "expiryDate": "2017-09-25T18:33:00.000Z",
            "hostName": "001-dn00x-demohost.akamaiorigin.net",
            "backupHostName": "003-dn00x-demohost.akamaiorigin.net"
        }
    ]
}

Origin members

Contract

Specify the contract ID to associate with the origin. The system filters the CP code based on the contract ID that you specify. It associates the NetStorage CP code (if created) with the same contract as the ingest CP code (the contract ID that you specify).

Download schema: BasicContractDTO.json

Sample GET response:

[
    {
        "contractId": "A-225678B",
        "accountId": "E-A-VC678R",
        "parentContractId": null,
        "contractTypeId": "R-T746",
        "expired": false,
        "childContractIds": null
    },
    {
        "contractId": "A-BVIUED",
        "accountId": "K-J-CA909R",
        "parentContractId": null,
        "contractTypeId": "I-K1YX",
        "expired": false,
        "childContractIds": null
    }
]

Contract members

CpCode

Specifies the origin CP code.

Download schema: CpcodeDTO.json

Sample GET response:

[
    {
        "id": 321234,
        "name": "Test",
        "contracts": [
            {
                "contractId": "Z-AAAVOB"
            }
        ],
        "isUsed": false
    }
]

CpCode members

PublishingLocation

Specifies details about the location where the stream is published from.

Download schema: PublishingLocationDTO.json

Sample GET response:

[
    {
        "location": "EUROPE",
        "code": "001",
        "netstorageZone": "europe"
    },
    {
        "location": "NORTH_AMERICA",
        "code": "002",
        "netstorageZone": "us"
    },
    {
        "location": "LATIN_AMERICA",
        "code": "003",
        "netstorageZone": "us"
    },
    {
        "location": "SOUTH_AMERICA",
        "code": "004",
        "netstorageZone": "us"
    },
    {
        "location": "NORDICS",
        "code": "005",
        "netstorageZone": "europe"
    },
    {
        "location": "ASIA_PACIFIC",
        "code": "006",
        "netstorageZone": "asia"
    },
    {
        "location": "OTHER_AMERICAS",
        "code": "007",
        "netstorageZone": "us"
    },
    {
        "location": "OTHER_APJ",
        "code": "008",
        "netstorageZone": "asia"
    },
    {
        "location": "OTHER_EMEA",
        "code": "009",
        "netstorageZone": "europe"
    },
    {
        "location": "GERMANY",
        "code": "011",
        "netstorageZone": "europe"
    },
    {
        "location": "INDIA",
        "code": "012",
        "netstorageZone": "asia"
    },
    {
        "location": "ITALY",
        "code": "013",
        "netstorageZone": "europe"
    },
    {
        "location": "JAPAN",
        "code": "014",
        "netstorageZone": "asia"
    },
    {
        "location": "MEXICO",
        "code": "015",
        "netstorageZone": "us"
    },
    {
        "location": "TAIWAN",
        "code": "016",
        "netstorageZone": "asia"
    },
    {
        "location": "UNITED_KINGDOM",
        "code": "017",
        "netstorageZone": "europe"
    },
    {
        "location": "US_EAST",
        "code": "018",
        "netstorageZone": "useast"
    },
    {
        "location": "US_CENTRAL",
        "code": "019",
        "netstorageZone": "useast"
    },
    {
        "location": "US_WEST",
        "code": "020",
        "netstorageZone": "us"
    },
    {
        "location": "AUSTRALIA",
        "code": "010",
        "netstorageZone": "AU"
    }
]

PublishingLocation members

Errors

This section provides details on the data object that reflect the API’s common response to error cases, and lists the API’s range of response status codes for both error and success cases.

Error responses

When the API encounters an error, it responds with a JSON object whose ok member is false. It also includes an error code and error message.

The following example shows the 400 error code:

{
  "type": "bad-request",
  "title": "Erroneous data input",
  "instance": "8ed959ae-bc22-43f4-893c-2f293518f258",
  "status": 400,
  "errors": [
    {
      "type": "bad-request",
      "title": "Bad Request",
      "instance": "1664e1a7-d916-4cf9-944f-2d9f6d176f8f",
      "detail": "Expiry Date of Previous Key is required"
    }
  ]
}

HTTP status codes

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

Last modified: 1/24/2019