List all certificates

GET https://api.ucdn.com/v4/certificates

Examples

• curl
• Response

curl -X GET "https://api.ucdn.com/v4/certificates/?token=acf0230d03f5b71d7252e336106f7338"

HTTP/1.1 200 OK
Date: Mon, 29 Jun 2015 08:03:15 GMT
Server: Apache
X-Powered-By: PHP/5.6.8-pl0-gentoo
X-Cache: hit
Vary: Accept-Encoding
Content-Length: 320
Content-Type: application/json; charset=utf-8

[
    {
        "id": 18,
        "hostname": "cdn.section9.com",
        "fingerprint": "3d284b5326388d22f9bfb15600917ebc1dfa96cd",
        "used_in_zones": [
            {
                "zone_id": 1,
                "domain": "cdn.section9.com",
                "cdn_domain": "a1-121.so.clients.cdn13.com"
            }
        ]
    },
    {
        "id": 35,
        "hostname": "cdn3.section9.co.jp",
        "fingerprint": "0f382f59b8ee80950c9663042190008927a6012f",
        "used_in_zones": []
    }
]

Single certificate information

GET https://api.ucdn.com/v4/certificate/{crt_id}

Examples

• curl
• Response

curl -X GET "https://api.ucdn.com/v4/certificate/18/?token=acf0230d03f5b71d7252e336106f7338"

HTTP/1.1 200 OK
Date: Mon, 29 Jun 2015 08:03:15 GMT
Server: Apache
X-Powered-By: PHP/5.6.8-pl0-gentoo
X-Cache: hit
Vary: Accept-Encoding
Content-Length: 199
Content-Type: application/json; charset=utf-8

{
    "id": 18,
    "hostname": "cdn.section9.com",
    "fingerprint": "3d284b5326388d22f9bfb15600917ebc1dfa96cd",
    "used_in_zones": [
        {
            "zone_id": 1,
            "domain": "cdn.section9.com",
            "cdn_domain": "a1-121.so.clients.cdn13.com"
        }
    ]
}

Upload certificate

POST https://api.ucdn.com/v4/certificate/

Examples

• curl
• Response

curl -X POST "https://api.ucdn.com/v4/certificate/?token=acf0230d03f5b71d7252e336106f7338" --header "Content-Type: application/json" -d '{"key": "-----BEGIN RSA PRIVATE KEY-----\nMIICXAIBAAKBgQDc95uOOiAJNKaoZBvTqIaMjCRVWhGjiZcHkmM+rENyW4xOuai1\nY2WUyj59jYsHzusu31NmaWgNTSzeYhI0oSBPCmitIEDmp7mGzfqadwFlbtQuAsaK\nR2QkvdpTHkPJaiT0N58Isq2J3M2jjwHnX2npYQILxgndWwt+syeXFoDauwIDAQAB\nAoGAEijfRd8NBvSmxawEhW6SMDbMPZ97V59VJDApq9roaBuR+l5TuSSEEqhUXmkl\nhezBc0azSfVbscwn5dbVfDHJv84Y5BcPyvzBqtrUhzO64HPefFICQh6HpE4t/rke\npSl9KeznWpiQqMq5AQwQo1IHeINnXdp7ZLDp9mCGOJV4Y3ECQQDwIL7kM7Q0nhZ/\nOO4yYzL+AMAYvs1hvhR2Ij7bWYuqJ+Pb/8aV8IrjDQMujFcfS2GwKDEPed42oQZl\n79hQjvavAkEA65Kjzck51prvMNdwv1abcq66COXLf8EdyY74QqjrtKknEweQclQs\nihCt0x47O+YiB1zJ/VLpW845EBCfUpbftQJAI7s7rIllD09W2aeHCkholhNWglgi\nB6FZOhrub4Vrmu5Eob/1tOoOQKr3Bj4r2KRG7QeOBVeFEWv0n8aI0bP0UQJBAKY9\n+LzbmaZ59fxIvTc5/j9DUOPAjwicFtJLw6T/Ij9+86U5PFWCU2AnfxOyjOirci4x\n7BWKckYoVRqiMF0PPdUCQEeq3IancNy8/5s7N6PKxEtnJ6G/Odty03pZ5xwSReM9\njBYtqogXMe6BSm9HlVSPYfA8gs4vynFtJlt0Cdc1A/c=\n-----END RSA PRIVATE KEY-----", "certificate": "-----BEGIN CERTIFICATE-----\nMIICLTCCAZYCCQCl/56DTdFTUDANBgkqhkiG9w0BAQUFADBbMQswCQYDVQQGEwJB\nVTETMBEGA1UECAwKU29tZS1TdGF0ZTEhMB8GA1UECgwYSW50ZXJuZXQgV2lkZ2l0\ncyBQdHkgTHRkMRQwEgYDVQQDDAtleGFtcGxlLmNvbTAeFw0xNTAxMjYxNjIzMTla\nFw0xNjAxMjYxNjIzMTlaMFsxCzAJBgNVBAYTAkFVMRMwEQYDVQQIDApTb21lLVN0\nYXRlMSEwHwYDVQQKDBhJbnRlcm5ldCBXaWRnaXRzIFB0eSBMdGQxFDASBgNVBAMM\nC2V4YW1wbGUuY29tMIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQDc95uOOiAJ\nNKaoZBvTqIaMjCRVWhGjiZcHkmM+rENyW4xOuai1Y2WUyj59jYsHzusu31NmaWgN\nTSzeYhI0oSBPCmitIEDmp7mGzfqadwFlbtQuAsaKR2QkvdpTHkPJaiT0N58Isq2J\n3M2jjwHnX2npYQILxgndWwt+syeXFoDauwIDAQABMA0GCSqGSIb3DQEBBQUAA4GB\nAAEQreWBJw7zReaELu2Pn+IUnXd8N6hJBjp3SX1jCO6LjodjKd33sqyvFvRhZOSg\nevp0wiADmAoVE9jToxPEO5ZxJ1j6dtycog60IRbMGskWeh10m/cUzaKGWYnatYqE\nZsNWvi3ahdovfzM7ukkecn9SDrUD+74+qNIhL6QDqhOD\n-----END CERTIFICATE-----"}'

HTTP/1.1 200 OK
Date: Mon, 29 Jun 2015 08:10:29 GMT
Server: Apache
X-Powered-By: PHP/5.6.8-pl0-gentoo
Vary: Accept-Encoding
Content-Length: 39
Content-Type: application/json; charset=utf-8

{
    "message": "Certificate saved",
    "id": 41
}

Delete certificate

DELETE https://api.ucdn.com/v4/certificate/{crt_id}

Examples

• curl
• Response

curl -X DELETE "https://api.ucdn.com/v4/certificate/20/?token=acf0230d03f5b71d7252e336106f7338"

HTTP/1.1 200 OK
Date: Mon, 29 Jun 2015 08:10:28 GMT
Server: Apache
X-Powered-By: PHP/5.6.8-pl0-gentoo
Vary: Accept-Encoding
Content-Length: 33
Content-Type: application/json; charset=utf-8

{
    "message": "Certificate 43 was deleted"
}

Usage report

GET https://api.ucdn.com/v4/reports?zone_name=...&zone_type=...&date_from=...&date_to=...

Examples

• curl
• Response

curl -X GET "https://api.ucdn.com/v4/reports?zone_name=test-zone&zone_type=objects&date_from=2015-08-12&date_to=2015-08-13&token=acf0230d03f5b71d7252e336106f7338"

HTTP/1.1 200 OK
Date: Wed, 12 Aug 2015 13:21:34 GMT
Server: Apache
Vary: Accept-Encoding
Content-Length: 49
Content-Type: application/json; charset=utf-8

{
    "hits": 72223298971,
    "bytes_served": 1031761416566
}

Bandwidth

GET https://api.ucdn.com/v4/reports/get_bandwidth?zone_name=...&zone_type=...&date_from=...&date_to=...

Examples

• curl
• Response

curl -X GET 'https://api.ucdn.com/v4/reports/get_bandwidth?date_from=1711539900&date_to=1711549800&zone_name=test_livestream&zone_type=livestream&token=acf0230d03f5b71d7252e336106f7338'

{
   "1394571600": 19.29,
   "1394571900": 9.29,
   "1394572200": 7.00,
   "1394572500": 11.35,
   "1394572800": 17.65,
   "1394573100": 18.21,
   "1394573400": 11.14,
   "1394573700": 13.32,
   "1394574000": 19.84
}

Bandwidth 95th percentile

GET https://api.ucdn.com/v4/reports/get_bandwidth_95th?year=...&month=...&region=...

Examples

• curl
• Response

curl -X GET 'https://api.ucdn.com/v4/reports/get_bandwidth_95th?year=2024&month=01&token=acf0230d03f5b71d7252e336106f7338'

{
    "2024-01": {
        "Asia-Pacific": "16.44",
        "Asia": "15.94",
        "United States": "8.39",
        "Europe": "12.47"
    }
}

Bytes served via SSL

GET https://api.ucdn.com/v4/reports/bytes/ssl?from=...&to=...&zones=...&zones_type=...&by=...

Examples

• curl
• Response

curl -X GET 'https://api.ucdn.com/v4/reports/bytes/ssl?from=2021-01-03&to=2024-01-03&zones_type=objects&zones=test-zone&token=acf0230d03f5b71d7252e336106f7338'

{
    "element_description": [
        "unix timestamp of the time slot start",
        "bytes served in this time slot"
    ],
    "element_duration": 3600,
    "elements": [
        [
            1609632000,
            0
        ],
        [
            1609635600,
            0
        ],
        [
            1609639200,
            0
        ],
        [
            1609642800,
            0
        ],
        [
            1609646400,
            0
        ],
        [
            1609650000,
            0
        ],
        [
            1609653600,
            0
        ],
        [
            1609657200,
            0
        ],
        [
            1609660800,
            0
        ],
        [
            1609664400,
            0
        ],
        [
            1609668000,
            0
        ],
        [
            1609671600,
            0
        ],
        [
            1609675200,
            0
        ],
        [
            1609678800,
            0
        ]
    ]
}

Hits SSL

GET https://api.ucdn.com/v4/reports/hits/ssl?from=...&to=...&zones=...&zones_type=...&by=...

Examples

• curl
• Response

curl -X GET 'https://api.ucdn.com/v4/reports/hits/ssl?from=2021-01-03&to=2024-01-03&zones_type=objects&zones=test-zone&token=acf0230d03f5b71d7252e336106f7338'

{
    "element_description": [
        "unix timestamp of the time slot start",
        "bytes served in this time slot"
    ],
    "element_duration": 3600,
    "elements": [
        [
            1609632000,
            0
        ],
        [
            1609635600,
            0
        ],
        [
            1609639200,
            0
        ],
        [
            1609642800,
            0
        ],
        [
            1609646400,
            0
        ],
        [
            1609650000,
            0
        ],
        [
            1609653600,
            0
        ],
        [
            1609657200,
            0
        ],
        [
            1609660800,
            0
        ],
        [
            1609664400,
            0
        ],
        [
            1609668000,
            0
        ],
        [
            1609671600,
            0
        ],
        [
            1609675200,
            0
        ],
        [
            1609678800,
            0
        ]
    ]
}

Bytes served

GET https://api.ucdn.com/v4/reports/bytes?from=...&to=...&zones=...&zones_type=...&by=...

Examples

• curl
• Response

curl -X GET "https://api.ucdn.com/v4/reports/bytes/?from=2015-08-12&to=2015-08-13&token=acf0230d03f5b71d7252e336106f7338&zones=test-zone,test-zone-1"

HTTP/1.1 200 OK
Date: Wed, 12 Aug 2015 13:21:35 GMT
Server: Apache
Vary: Accept-Encoding
Content-Length: 602
Content-Type: application/json; charset=utf-8

{
    "element_description": [
        "unix timestamp of the time slot start",
        "bytes served in this time slot"
    ],
    "element_duration": 3600,
    "elements": [
        [
            1439337600,
            0
        ],
        [
            1439341200,
            105885510745
        ],
        [
            1439344800,
            114271292947
        ],
        [
            1439348400,
            124036006918
        ],
        [
            1439352000,
            120396189741
        ],
        [
            1439355600,
            101645584874
        ],
        [
            1439359200,
            80206732783
        ],
        [
            1439362800,
            69543285192
        ],
        [
            1439366400,
            68522904965
        ],
        [
            1439370000,
            73195626735
        ],
        [
            1439373600,
            67897186868
        ],
        [
            1439377200,
            0
        ],
        [
            1439380800,
            0
        ],
        [
            1439384400,
            0
        ],
        [
            1439388000,
            0
        ],
        [
            1439391600,
            0
        ],
        [
            1439395200,
            0
        ],
        [
            1439398800,
            0
        ],
        [
            1439402400,
            0
        ],
        [
            1439406000,
            0
        ],
        [
            1439409600,
            0
        ],
        [
            1439413200,
            0
        ],
        [
            1439416800,
            0
        ],
        [
            1439420400,
            0
        ]
    ]
}

Countries

GET https://api.ucdn.com/v4/reports/countries?from=...&to=...&zones=...&zones_type=...&countries=...

Examples

• curl
• Response

curl -X GET "https://api.ucdn.com/v4/reports/countries?from=2021-01-03&to=2024-01-03&zones_type=objects&zones=test-zone&token=acf0230d03f5b71d7252e336106f7338"

HTTP/1.1 200 OK
Date: Wed, 12 Aug 2015 11:04:50 GMT
Server: Apache
Vary: Accept-Encoding
Content-Length: 4406
Content-Type: application/json; charset=utf-8

{
    "element_description": [
        "unix timestamp of the time slot start",
        "hits from this country",
        "bytes served to this country"
    ],
    "element_duration": 86400,
    "elements": {
        "CH": [
            [
                1439290800,
                0,
                0
            ],
            [
                1439294400,
                384465,
                19224985
            ],
            [
                1439298000,
                373860,
                18694275
            ],
            [
                1439301600,
                367775,
                18390470
            ]
        ],
        "GB": [
            [
                1439290800,
                0,
                0
            ],
            [
                1439294400,
                427190,
                21361100
            ],
            [
                1439298000,
                415390,
                20771405
            ],
            [
                1439301600,
                408645,
                20433865
            ],
            [
                1439305200,
                407865,
                20394660
            ],
            [
                1439308800,
                415540,
                20778725
            ],
            [
                1439312400,
                439510,
                21977240
            ],
            [
                1439316000,
                476520,
                23827165
            ],
            [
                1439319600,
                515800,
                25791430
            ],
            [
                1439323200,
                531010,
                26551560
            ]
        ],
        "MX": [
            [
                1439290800,
                0,
                0
            ],
            [
                1439294400,
                261435,
                13072990
            ],
            [
                1439298000,
                254210,
                12712090
            ],
            [
                1439301600,
                250090,
                12505515
            ]
        ],
        "RU": [
            [
                1439290800,
                0,
                0
            ]
        ],
        "US": [
            [
                1439290800,
                0,
                0
            ],
            [
                1439294400,
                449685,
                22485365
            ],
            [
                1439298000,
                437260,
                21864645
            ],
            [
                1439301600,
                430150,
                21509335
            ],
            [
                1439305200,
                429335,
                21468070
            ]
        ],
        "VN": [
            [
                1439290800,
                0,
                0
            ],
            [
                1439294400,
                196060,
                9804735
            ],
            [
                1439298000,
                190655,
                9534070
            ],
            [
                1439301600,
                187550,
                9379120
            ],
            [
                1439305200,
                187185,
                9361135
            ]
        ]
    }
}

Storages

GET https://api.ucdn.com/v4/reports/storages?from=...&to=...&by=...

Examples

• curl
• Response

curl -X GET "https://api.ucdn.com/v4/reports/storages/?from=2015-08-12&to=2015-08-13&by=hour&token=acf0230d03f5b71d7252e336106f7338"

HTTP/1.1 200 OK
Date: Wed, 12 Aug 2015 11:04:52 GMT
Server: Apache
Vary: Accept-Encoding
Content-Length: 698
Content-Type: application/json; charset=utf-8

{
    "element_description": [
        "unix timestamp of the time slot start",
        "used size in bytes"
    ],
    "element_duration": 3600,
    "elements": [
        [
            1439290800,
            0
        ],
        [
            1439294400,
            2887995255
        ],
        [
            1439298000,
            2887995255
        ],
        [
            1439301600,
            2887995255
        ],
        [
            1439305200,
            2887995255
        ],
        [
            1439308800,
            2887995255
        ],
        [
            1439312400,
            2887995255
        ],
        [
            1439316000,
            2887995255
        ],
        [
            1439319600,
            2887995255
        ],
        [
            1439323200,
            2887995255
        ],
        [
            1439326800,
            2887995255
        ],
        [
            1439330400,
            2887995255
        ],
        [
            1439334000,
            2887995255
        ],
        [
            1439337600,
            2887995255
        ],
        [
            1439341200,
            2887995255
        ],
        [
            1439344800,
            2887995255
        ],
        [
            1439348400,
            2887995255
        ],
        [
            1439352000,
            2887995255
        ],
        [
            1439355600,
            2887995255
        ],
        [
            1439359200,
            2887995255
        ],
        [
            1439362800,
            2887995255
        ],
        [
            1439366400,
            2887995255
        ],
        [
            1439370000,
            2887995255
        ],
        [
            1439373600,
            0
        ],
        [
            1439377200,
            0
        ]
    ]
}

Status codes

GET https://api.ucdn.com/v4/reports/status/codes?from=...&to=...&zones=...&zones_type=...&by=...&code=...

Examples

• curl
• Response

curl -X GET "https://api.ucdn.com/v4/reports/status/codes/?from=2015-08-12&to=2015-08-13&token=acf0230d03f5b71d7252e336106f7338&code=404"

HTTP/1.1 200 OK
Date: Wed, 12 Aug 2015 13:21:34 GMT
Server: Apache
Vary: Accept-Encoding
Content-Length: 643
Content-Type: application/json; charset=utf-8

{
    "element_description": [
        "unix timestamp of the time slot start",
        "hits",
        "percents of all"
    ],
    "element_duration": 3600,
    "elements": {
        "404": [
            [
                1439337600,
                0,
                0
            ],
            [
                1439341200,
                181058,
                0
            ],
            [
                1439344800,
                195398,
                0
            ],
            [
                1439348400,
                212096,
                0
            ],
            [
                1439352000,
                205871,
                0
            ],
            [
                1439355600,
                173808,
                0
            ],
            [
                1439359200,
                137148,
                0
            ],
            [
                1439362800,
                118913,
                0
            ],
            [
                1439366400,
                117169,
                0
            ],
            [
                1439370000,
                125157,
                0
            ],
            [
                1439373600,
                116099,
                0
            ],
            [
                1439377200,
                0,
                0
            ],
            [
                1439380800,
                0,
                0
            ],
            [
                1439384400,
                0,
                0
            ],
            [
                1439388000,
                0,
                0
            ],
            [
                1439391600,
                0,
                0
            ],
            [
                1439395200,
                0,
                0
            ],
            [
                1439398800,
                0,
                0
            ],
            [
                1439402400,
                0,
                0
            ],
            [
                1439406000,
                0,
                0
            ],
            [
                1439409600,
                0,
                0
            ],
            [
                1439413200,
                0,
                0
            ],
            [
                1439416800,
                0,
                0
            ],
            [
                1439420400,
                0,
                0
            ]
        ]
    }
}

Hits

GET https://api.ucdn.com/v4/reports/hits?from=...&to=...&zones=...&zones_type=...&by=...

Examples

• curl
• Response

curl -X GET "https://api.ucdn.com/v4/reports/hits?from=2021-01-03&to=2024-01-03&zones_type=objects&zones=test-zone&token=acf0230d03f5b71d7252e336106f7338"

HTTP/1.1 200 OK
Date: Wed, 12 Aug 2015 11:04:50 GMT
Server: Apache
Vary: Accept-Encoding
Content-Length: 602
Content-Type: application/json; charset=utf-8

{
    "element_description": [
        "unix timestamp of the time slot start",
        "hits"
    ],
    "element_duration": 3600,
    "elements": [
        [
            1439290800,
            0
        ],
        [
            1439294400,
            739857
        ],
        [
            1439298000,
            719431
        ],
        [
            1439301600,
            707736
        ],
        [
            1439305200,
            706384
        ],
        [
            1439308800,
            719685
        ],
        [
            1439312400,
            761199
        ],
        [
            1439316000,
            825275
        ],
        [
            1439319600,
            893314
        ],
        [
            1439323200,
            919642
        ],
        [
            1439326800,
            984416
        ],
        [
            1439330400,
            962014
        ],
        [
            1439334000,
            919178
        ],
        [
            1439337600,
            873281
        ],
        [
            1439341200,
            871015
        ],
        [
            1439344800,
            939998
        ],
        [
            1439348400,
            1020329
        ],
        [
            1439352000,
            990386
        ],
        [
            1439355600,
            836136
        ],
        [
            1439359200,
            659778
        ],
        [
            1439362800,
            572053
        ],
        [
            1439366400,
            563661
        ],
        [
            1439370000,
            602095
        ],
        [
            1439373600,
            558520
        ],
        [
            1439377200,
            0
        ]
    ]
}

Hits via HTTP2

GET https://api.ucdn.com/v4/reports/hits/http2?from=...&to=...&zones=...&zones_type=...&by=...

Examples

• curl
• Response

curl -X GET 'https://api.ucdn.com/v4/reports/hits/http2?from=2021-01-03&to=2024-01-03&zones_type=objects&zones=test-zone&token=acf0230d03f5b71d7252e336106f7338'

{
    "element_description": [
        "unix timestamp of the time slot start",
        "bytes served in this time slot"
    ],
    "element_duration": 3600,
    "elements": [
        [
            1609632000,
            0
        ],
        [
            1609635600,
            0
        ],
        [
            1609639200,
            0
        ],
        [
            1609642800,
            0
        ],
        [
            1609646400,
            0
        ],
        [
            1609650000,
            0
        ],
        [
            1609653600,
            0
        ],
        [
            1609657200,
            0
        ],
        [
            1609660800,
            0
        ],
        [
            1609664400,
            0
        ],
        [
            1609668000,
            0
        ],
        [
            1609671600,
            0
        ],
        [
            1609675200,
            0
        ],
        [
            1609678800,
            0
        ]
    ]
}

Bytes served via HTTP2

GET https://api.ucdn.com/v4/reports/bytes/http2?from=...&to=...&zones=...&zones_type=...&by=...

Examples

• curl
• Response

curl -k -X GET 'https://api.ucdn.com/v4/reports/bytes/http2?from=2021-01-03&to=2024-01-03&zones_type=objects&zones=test-zone&token=acf0230d03f5b71d7252e336106f7338'

{
    "element_description": [
        "unix timestamp of the time slot start",
        "bytes served in this time slot"
    ],
    "element_duration": 3600,
    "elements": [
        [
            1609632000,
            0
        ],
        [
            1609635600,
            0
        ],
        [
            1609639200,
            0
        ],
        [
            1609642800,
            0
        ],
        [
            1609646400,
            0
        ],
        [
            1609650000,
            0
        ],
        [
            1609653600,
            0
        ],
        [
            1609657200,
            0
        ],
        [
            1609660800,
            0
        ],
        [
            1609664400,
            0
        ],
        [
            1609668000,
            0
        ],
        [
            1609671600,
            0
        ],
        [
            1609675200,
            0
        ],
        [
            1609678800,
            0
        ]
    ]
}

Purge files

POST https://api.ucdn.com/v4/purge/zone?zone_name=...&zone_type=.../

Examples

• curl
• Response

curl --include --request POST "https://api.ucdn.com/v4/purge/zone?zone_name=test-zone&zone_type=objects&token=acf0230d03f5b71d7252e336106f7338" --header "Content-Type: application/json" -d '{"files":"/example/logo.png\n/second/file"}'

HTTP/1.1 200 OK
Date: Wed, 12 Aug 2015 13:21:34 GMT
Server: Apache
Vary: Accept-Encoding
Content-Length: 80
Content-Type: application/json; charset=utf-8

{
    "message": "Purge request received",
    "job_id": "3cfb478531097f1830056a828752cbdd"
}

View purge job

GET https://api.ucdn.com/v4/purge/job/{job_id}/

Examples

• curl
• Response

curl --include "https://api.ucdn.com/v4/purge/job/2170dd23decc45691adf28987282d0bc/?token=acf0230d03f5b71d7252e336106f7338"

HTTP/1.1 200 OK
Date: Wed, 12 Aug 2015 13:21:33 GMT
Server: Apache
Vary: Accept-Encoding
Content-Length: 210
Content-Type: application/json; charset=utf-8

{
    "job_id": "2170dd23decc45691adf28987282d0bc",
    "files": [
        "http:\/\/a1-121.so.clients.cdn13.com\/example\/logo.png",
        "http:\/\/a1-121.so.clients.cdn13.com\/second\/file"
    ],
    "status": "finished",
    "created_at": 1435318980
}

List purge jobs

GET https://api.ucdn.com/v4/purge?status=...&count=...

Examples

• curl
• Response

curl --include "https://api.ucdn.com/v4/purge/?status=finished&token=acf0230d03f5b71d7252e336106f7338"

HTTP/1.1 200 OK
Date: Wed, 12 Aug 2015 13:21:33 GMT
Server: Apache
Vary: Accept-Encoding
Content-Length: 1900
Content-Type: application/json; charset=utf-8

[
    {
        "job_id": "ed74f89ab1469b4942fa6fee32832c31",
        "files": [
            "http:\/\/a1-121.so.clients.cdn13.com\/example\/logo.png",
            "http:\/\/a1-121.so.clients.cdn13.com\/second\/file"
        ],
        "status": "finished",
        "created_at": 1439377493
    },
    {
        "job_id": "58432bcd7c38551ab1c3552315962a39",
        "files": [
            "http:\/\/a1-121.so.clients.cdn13.com\/example\/logo.png",
            "http:\/\/a1-121.so.clients.cdn13.com\/second\/file"
        ],
        "status": "finished",
        "created_at": 1435565013
    },
    {
        "job_id": "ae2f114aa4ee1940fe960a2dca2d2d4d",
        "files": [
            "http:\/\/a1-121.so.clients.cdn13.com\/example\/logo.png",
            "http:\/\/a1-121.so.clients.cdn13.com\/second\/file"
        ],
        "status": "finished",
        "created_at": 1435564159
    },
    {
        "job_id": "e2a311eaaf6408621c6ba10d37b0a17f",
        "files": [
            "http:\/\/a1-121.so.clients.cdn13.com\/example\/logo.png",
            "http:\/\/a1-121.so.clients.cdn13.com\/second\/file"
        ],
        "status": "finished",
        "created_at": 1435564105
    },
    {
        "job_id": "2170dd23decc45691adf28987282d0bc",
        "files": [
            "http:\/\/a1-121.so.clients.cdn13.com\/example\/logo.png",
            "http:\/\/a1-121.so.clients.cdn13.com\/second\/file"
        ],
        "status": "finished",
        "created_at": 1435318980
    },
    {
        "job_id": "cd704ed605964e55a2a3c64162f94b05",
        "files": [
            "http:\/\/a1-121.so.clients.cdn13.com\/example\/logo.png",
            "http:\/\/a1-121.so.clients.cdn13.com\/second\/file"
        ],
        "status": "finished",
        "created_at": 1435317428
    },
    {
        "job_id": "a301e0571b0402a5fca1b6271612612b",
        "files": [
            "http:\/\/a1-121.so.clients.cdn13.com\/example\/logo.png",
            "http:\/\/a1-121.so.clients.cdn13.com\/second\/file"
        ],
        "status": "finished",
        "created_at": 1435317395
    },
    {
        "job_id": "9dfb57172bbbdc33abeb66862bb995d4",
        "files": [
            "http:\/\/a1-121.so.clients.cdn13.com\/example\/logo.png",
            "http:\/\/a1-121.so.clients.cdn13.com\/second\/file"
        ],
        "status": "finished",
        "created_at": 1435317350
    },
    {
        "job_id": "72709f187f5b5759d1db5055ac3c1340",
        "files": [
            "http:\/\/a1-121.so.clients.cdn13.com\/example\/logo.png",
            "http:\/\/a1-121.so.clients.cdn13.com\/second\/file"
        ],
        "status": "finished",
        "created_at": 1435317296
    }
]

Delete a purge job

DELETE https://api.ucdn.com/v4/purge/job/{job_id}

Examples

• curl
• Response

curl --include --request DELETE "https://api.ucdn.com/v4/purge/job/cd704ed605964e55a2a3c64162f94b05/?token=acf0230d03f5b71d7252e336106f7338"

HTTP/1.1 200 OK
Date: Wed, 12 Aug 2015 13:21:40 GMT
Server: Apache
Vary: Accept-Encoding
Content-Length: 39
Content-Type: application/json; charset=utf-8

{
    "message": "The purge job was removed"
}

Create storage

POST https://api.ucdn.com/v4/storage

Examples

• curl
• Response

curl -X POST "https://api.ucdn.com/v4/storage/?token=acf0230d03f5b71d7252e336106f7338" --header "Content-Type: application/json" -d '{"region":"north-america", "name": "level-4-logs"}'

HTTP/1.1 200 OK
Date: Mon, 29 Jun 2015 08:10:29 GMT
Server: Apache
X-Powered-By: PHP/5.6.8-pl0-gentoo
Vary: Accept-Encoding
Content-Length: 36
Content-Type: application/json; charset=utf-8

{
    "message": "Storage Created",
    "id": 3
}

List storages

GET https://api.ucdn.com/v4/storages

Examples

• curl
• Response

curl -X GET "https://api.ucdn.com/v4/storages/?token=acf0230d03f5b71d7252e336106f7338"

HTTP/1.1 200 OK
Date: Mon, 29 Jun 2015 08:03:11 GMT
Server: Apache
X-Powered-By: PHP/5.3.10-1ubuntu3.16
X-Cache: miss
Vary: Accept-Encoding
Content-Length: 388
Content-Type: application/json; charset=utf-8

[
    {
        "id": 2,
        "container": "despensable",
        "ftp_host": "europe.upload.cdn13.com",
        "ftp_user": "1000121.1000121",
        "ftp_password": "ftppassword",
        "region": "europe",
        "synchronized_with_storage": null
    },
    {
        "id": 1,
        "container": "level-3-logs",
        "ftp_host": "north-america.upload.cdn13.com",
        "ftp_user": "1000121.1000121",
        "ftp_password": "ftppassword",
        "region": "north-america",
        "synchronized_with_storage": null
    }
]

Reconfigure storages

PATCH https://api.ucdn.com/v4/storages

Examples

• curl
• Response

curl -X PATCH "https://api.ucdn.com/v4/storages/?token=acf0230d03f5b71d7252e336106f7338" --header "Content-Type: application/json" -d '{"action":"change_ftp_password", "region": "north-america"}'

HTTP/1.1 200 OK
Date: Tue, 24 Nov 2015 11:03:39 GMT
Server: Apache/2.4.7 (Ubuntu)
X-Powered-By: PHP/5.5.9-1ubuntu4.14
Content-Length: 41
Content-Type: application/json; charset=utf-8

{
    "new_ftp_password": "dd9028f5f3ed79408e"
}

Storage FTP

GET https://api.ucdn.com/v4/storage/{id}

Examples

• curl
• Response

curl -X GET "https://api.ucdn.com/v4/storage/1/?token=acf0230d03f5b71d7252e336106f7338"

HTTP/1.1 200 OK
Date: Mon, 29 Jun 2015 08:03:12 GMT
Server: Apache
X-Powered-By: PHP/5.6.8-pl0-gentoo
X-Cache: hit
Vary: Accept-Encoding
Content-Length: 200
Content-Type: application/json; charset=utf-8

{
    "id": 1,
    "container": "level-3-logs",
    "ftp_host": "north-america.upload.cdn13.com",
    "ftp_user": "1000121.1000121",
    "ftp_password": "ftppassword",
    "region": "north-america",
    "synchronized_with_storage": null
}

Storage consumed size

GET https://api.ucdn.com/v4/storage/{id}/size

Examples

• curl
• Response

curl -X GET "https://api.ucdn.com/v4/storage/1/size/?token=acf0230d03f5b71d7252e336106f7338"

HTTP/1.1 200 OK
Date: Mon, 29 Jun 2015 08:03:11 GMT
Server: Apache
X-Powered-By: PHP/5.3.10-1ubuntu3.16
X-Cache: miss
Vary: Accept-Encoding
Content-Length: 23
Content-Type: application/json; charset=utf-8

{
    "bytes": 0,
    "objects": 0
}

Remove storage

DELETE https://api.ucdn.com/v4/storage/{id}

Examples

• curl
• Response

curl -X DELETE "https://api.ucdn.com/v4/storage/2/?token=acf0230d03f5b71d7252e336106f7338"

HTTP/1.1 200 OK
Date: Mon, 29 Jun 2015 08:10:35 GMT
Server: Apache
X-Powered-By: PHP/5.6.8-pl0-gentoo
Vary: Accept-Encoding
Content-Length: 33
Content-Type: application/json; charset=utf-8

{
    "message": "Storage was deleted"
}

Check user credentials

POST https://api.ucdn.com/v4/check/login/

Examples

• curl
• Response

curl -X POST "https://api.ucdn.com/v4/check/login/" --header "Content-Type: application/json" -d '{"email":"major@section9.co.jp", "password": "password"}'

HTTP/1.1 200 OK
Date: Mon, 29 Jun 2015 08:03:16 GMT
Server: Apache
X-Powered-By: PHP/5.6.8-pl0-gentoo
Vary: Accept-Encoding
Content-Length: 118
Content-Type: application/json; charset=utf-8

{
    "authenticated": true,
    "user_id": 121,
    "reason": "Login credentials are valid",
    "token": "acf0230d03f5b71d7252e336106f7338"
}

Fetch account info

GET https://api.ucdn.com/v4/account

Examples

• curl
• Response

curl -X GET "https://api.ucdn.com/v4/account/?token=acf0230d03f5b71d7252e336106f7338"

HTTP/1.1 200 OK
Date: Mon, 29 Jun 2015 08:03:08 GMT
Server: Apache
X-Powered-By: PHP/5.3.10-1ubuntu3.16
X-Cache: miss
Vary: Accept-Encoding
Content-Length: 127
Content-Type: application/json; charset=utf-8

{
    "id": "121",
    "username": "kusanagi",
    "email": "major@section9.co.jp",
    "name": "Motoko Kusanagi",
    "timezone": "Asia\/Tokyo",
    "trial": "0"
}

Fetch subaccounts list

GET https://api.ucdn.com/v4/subaccounts

Examples

• curl
• Response

curl -X GET "https://api.ucdn.com/v4/subaccounts/?token=acf0230d03f5b71d7252e336106f7338"

{
      "address" : null,
      "api_key" : "acf0230d03f5b71d7252e336106f7338",
      "api_secret" : "e2425f9c4df5614821009bce90cc384a",
      "billing_currency" : "USD",
      "billing_methodology" : "bandwidth",
      "bonus_balance" : "0.00000000",
      "cache_objects" : "873813",
      "cache_quota" : "0",
      "can_be_suspend" : "1",
      "check_origin" : "1",
      "city" : null,
      "company_name" : null,
      "company_type" : "corporate",
      "confirmed_mail" : "1",
      "country" : null,
      "create_ts" : "1708416831",
      "delete_ts" : "0",
      "domain_base" : "cdn13.com",
      "email" : "test_email@gmail.com",
      "expiration_2fa" : null,
      "first_name" : null,
      "id" : "13956",
      "l2_cache_objects" : "500000",
      "l2_cache_objects_small" : "1000000",
      "l2_cache_quota" : "0",
      "l2_cache_quota_small" : "0",
      "l3_cache_objects" : "1000000",
      "l3_cache_objects_small" : "2000000",
      "l3_cache_quota" : "0",
      "l3_cache_quota_small" : "0",
      "last_name" : null,
      "last_updated" : "2024-02-20 08:13:51",
      "manager_id" : "0",
      "max_zones" : "512",
      "name" : "test123",
      "notes" : null,
      "origin_quota" : "0",
      "parent_id" : "13863",
      "password" : "$2y$11$y6NtNjdaeTKKx.SGAPbjm.qhECzOI5KVNcaCDxkLaHOfaeTDWbYMu",
      "payment_method" : "9",
      "secret_key_2fa" : null,
      "state" : null,
      "status" : "active",
      "storage_price" : "0.000000",
      "suspended" : "0",
      "suspended_for_payment" : "0",
      "tax_info" : null,
      "timezone" : "Europe/London",
      "traffic_bps" : "0",
      "trial" : "0",
      "type_2fa" : null,
      "type_switch_ts" : "0",
      "update_ts" : "1708416831",
      "username" : "test123",
      "zip_code" : null
}

Create zone

POST https://api.ucdn.com/v4/account/post_zone

Zone parameters are described below.

location_of_files

ucdn_storage

custom_location

files_at

http_authentication

access_origin_host_header

aws_s3

with_signing_key

with_secret_key

limit_access

by_referer

by_country

by_secret_key

by_ip

cache

cache_for_limited_time

reuse_cache_from_other_zone

limit_download_speed

by_constant_rate

error_pages

cors

Examples

• curl
• Response

-- with minimum params (aws_s3 location)

curl -X POST 'https://api.ucdn.com/v4/account/post_zone?token=acf0230d03f5b71d7252e336106f7338' \
  --header "Content-Type: application/json" \
  --data '{
    "name": "test-zone",
    "location_of_files": {
        "aws_s3": {
            "protocol": "HTTP",
            "location": "mydomain.com",
            "bucket_name": "bucketName",
            "access_key": "x4dE",
            "with_signing_key": {
                "key_scope": "key",
                "signing_key": "signing_key"
            },
            "with_secret_key": {
                "secret_key": "x4SASX42",
                "region": "region"
            }
        }
    }
}'

-- with maximum params (custom_location)

curl -X POST 'https://api.ucdn.com/v4/account/post_zone?token=acf0230d03f5b71d7252e336106f7338' \
  --header "Content-Type: application/json" \
  --data '{
   "name": "test-zone",
   "cnames": [
       "first.cname.name",
       "second.cname.name"
   ],
   "location_of_files": {
       "custom_location": {
           "protocol": "HTTP",
           "files_at": {
               "primary_urls": {
                   "first-domain.com": {
                       "port": "80",
                       "weight": "100"
                   },
                   "second-domain.com": {
                       "port": "90",
                       "weight": "80"
                   }
               },
               "bacckup_urls": {
                   "third-domain.com": {
                       "port": "80",
                       "weight": "100"
                   }
               }
           },
           "http_authentication": {
               "enabled": true,
               "username": "userName",
               "password": "passWord"
           },
           "access_origin_host_header": {
               "enabled": true,
               "host_header": "header"
           }
       }
   },
   "limit_access": {
       "by_referer": {
           "enabled": true,
           "use_origin_if_no_referer": true,
           "allowed_domains": [
               "test.1",
               "test.2"
           ]
       },
       "by_country": {
           "enabled": true,
           "type": "deny",
           "countries": [
               "us",
               "ru"
           ]
       },
       "by_secret_key": {
           "enabled": true,
           "hash_secret_key": "12345_key",
           "hash_algorithm": "sha1",
           "hash_time_to_live_mins": 37
       },
       "by_ip": {
           "enabled": true,
           "type": "allow",
           "ip_list": [
               "174.202.97.102"
           ]
       }
   },
   "cache": {
       "cache_for_limited_time": {
           "enabled": true,
           "cache_expire_time_min": 21
       },
       "reuse_cache_from_other_zone": {
           "enabled": true,
           "zone_name": "any-zone-name"
       }
   },
   "limit_download_speed": {
       "enabled": true,
       "by_constant_rate": {
           "unit": "MB",
           "rate": 25
       }
   },
   "error_pages": {
       "402": "http://error-402.net",
       "403": "http://error-403.net",
       "404": "http://error-404.net",
       "405": "http://error-405.net",
       "500": "http://error-500.net",
       "502": "http://error-502.net"
   },
   "cors": {
       "mode": "advanced",
       "allow_origin_mode": "csv",
       "allow_origin_csv": "http://test.test",
       "allow_origin_regexp": "",
       "allow_methods": "GET,HEAD,POST,OPTIONS",
       "allow_credentials": "true",
       "allow_headers": "HEADER-1,HEADER-2",
       "expose_headers": "HEADER-3,HEADER-4",
       "max_age": 123
   }
}'

{
    "message": "Zone created succesfully.",
    "zone_name": "test-zone"
}

Edit zone

PATCH https://api.ucdn.com/v4/account/patch_zone?zone_name=...

Examples

• curl
• Response

-- change location to ucdn_storage

curl -X PATCH 'https://api.ucdn.com/v4/account/patch_zone?zone_name=test-zone&token=acf0230d03f5b71d7252e336106f7338' \
  --header "Content-Type: application/json" \
  --data '{
    "location_of_files": {
       "ucdn_storage": {
           "storage_name": "TestingContainer",
           "region": "north-america"
       }
    }
}'

-- disable reuse_cache_from_other_zone

curl -X PATCH 'https://api.ucdn.com/v4/account/patch_zone?zone_name=test-zone&token=acf0230d03f5b71d7252e336106f7338' \
  --header "Content-Type: application/json" \
  --data '{
    "cache": {
        "reuse_cache_from_other_zone": {
            "enabled": false,
            "zone_name": "test-zone"
        }
    }
}'

-- disable error_page for status code 403

curl -X PATCH 'https://api.ucdn.com/v4/account/patch_zone?zone_name=test-zone&token=acf0230d03f5b71d7252e336106f7338' \
  --header "Content-Type: application/json" \
  --data '{
    "error_pages": {
        "403": ""
    }
}'

{
    "message": "Zone patched"
}

Get zone

GET https://api.ucdn.com/v4/account/get_zone?zone_name=...

Examples

• curl
• Response

curl -X GET 'https://api.ucdn.com/v4/account/get_zone?zone_name=test-zone&token=acf0230d03f5b71d7252e336106f7338'

{
   "name": "test-zone",
   "cnames": [
       "first.cname.name",
       "second.cname.name"
   ],
   "location_of_files": {
       "custom_location": {
           "protocol": "HTTP",
           "files_at": {
               "primary_urls": {
                   "first-domain.com": {
                       "port": 80,
                       "weight": 100
                   },
                   "second-domain.com": {
                       "port": 90,
                       "weight": 80
                   }
               },
               "bacckup_urls": {
                   "third-domain.com": {
                       "port": 80,
                       "weight": 100
                   }
               }
           },
           "http_authentication": {
               "enabled": true,
               "username": "userName",
               "password": "passWord"
           },
           "access_origin_host_header": {
               "enabled": true,
               "host_header": "header"
           }
       }
   },
   "limit_access": {
       "by_referer": {
           "enabled": true,
           "use_origin_if_no_referer": true,
           "allowed_domains": [
               "test.1",
               "test.2"
           ]
       },
       "by_country": {
           "enabled": true,
           "type": "deny",
           "countries": [
               "us",
               "ru"
           ]
       },
       "by_secret_key": {
           "enabled": true,
           "hash_secret_key": "12345_key",
           "hash_algorithm": "sha1",
           "hash_time_to_live_mins": 37
       },
       "by_ip": {
           "enabled": true,
           "type": "allow",
           "ip_list": [
               "174.202.97.102"
           ]
       }
   },
   "cache": {
       "cache_for_limited_time": {
           "enabled": true,
           "cache_expire_time_min": 21
       },
       "reuse_cache_from_other_zone": {
           "enabled": true,
           "zone_name": "any-zone-name"
       }
   },
   "limit_download_speed": {
       "enabled": true,
       "by_constant_rate": {
           "unit": "MB",
           "rate": 25
       }
   },
   "error_pages": {
       "402": "http://error-402.net",
       "403": "http://error-403.net",
       "404": "http://error-404.net",
       "405": "http://error-405.net",
       "500": "http://error-500.net",
       "502": "http://error-502.net"
   },
   "cors": {
       "mode": "advanced",
       "allow_origin_mode": "csv",
       "allow_origin_csv": "http://test.test",
       "allow_origin_regexp": "",
       "allow_methods": "GET,HEAD,POST,OPTIONS",
       "allow_credentials": "true",
       "allow_headers": "HEADER-1,HEADER-2",
       "expose_headers": "HEADER-3,HEADER-4",
       "max_age": 123
   }
}

Get zone status

GET https://api.ucdn.com/v4/account/check_zone_status?zone_name=...

Examples

• curl
• Response

curl -X GET 'https://api.ucdn.com/v4/account/check_zone_status?token=acf0230d03f5b71d7252e336106f7338'

{
    "zone_active": "1"
}

Delete zone

DELETE https://api.ucdn.com/v4/account/delete_zone?zone_name=...

Examples

• curl
• Response

curl -X DELETE 'https://api.ucdn.com/v4/account/delete_zone?zone_name=test-zone&token=acf0230d03f5b71d7252e336106f7338'

{
    "message": "Zone deleted successfully."
}

Delete origin

DELETE https://api.ucdn.com/v4/account/delete_origin?zone_name=...&domain=...

Examples

• curl
• Response

curl -X DELETE 'https://api.ucdn.com/v4/account/delete_origin?zone_name=test-zone&domain=first-domain.com&token=acf0230d03f5b71d7252e336106f7338'

{
    "message": "Domain deleted succesfully."
}

Activate letsencrypt

POST https://api.ucdn.com/v4/account/activate_letsencrypt?zone_name=...

Examples

• curl
• Response

curl -X POST 'https://api.ucdn.com/v4/account/activate_letsencrypt?zone_name=test-zone&token=acf0230d03f5b71d7252e336106f7338'

{
    "message": "Successfully activated letsencrypt."
}

Deactivate letsencrypt

POST https://api.ucdn.com/v4/account/deactivate_letsencrypt?zone_name=...

Examples

• curl
• Response

curl -X DELETE 'https://api.ucdn.com/v4/account/deactivate_letsencrypt?zone_name=test-zone&token=acf0230d03f5b71d7252e336106f7338'

{
    "message": "Successfully deactivated letsencrypt."
}

Get letsencrypt status

GET https://api.ucdn.com/v4/account/check_letsencrypt_status?zone_name=...

Examples

• curl
• Response

curl -X GET 'https://api.ucdn.com/v4/account/check_letsencrypt_status?token=acf0230d03f5b71d7252e336106f7338'

{
    "letsencrypt_active": "0"
}

Activate zone

PATCH https://api.ucdn.com/v4/account/toggle_zone_status?zone_name=...

Examples

• curl
• Response

curl -X PATCH 'https://api.ucdn.com/v4/account/toggle_zone_status?zone_name=test-zone&token=acf0230d03f5b71d7252e336106f7338' \
  --header "Content-Type: application/json" \
  --data '{"enable": true}'

{
    "message": "Zone enabled"
}

Deactivate zone

PATCH https://api.ucdn.com/v4/account/toggle_zone_status?zone_name=...

Examples

• curl
• Response

curl -X PATCH 'https://api.ucdn.com/v4/account/toggle_zone_status?zone_name=test-zone&token=acf0230d03f5b71d7252e336106f7338' \
  --header "Content-Type: application/json" \
  --data '{"disable": true}'

{
    "message": "Zone disabled"
}

Create livestreaming zones

POST https://api.ucdn.com/v4/livestreaming/post_livestream_zone

Examples

• curl
• Response

-- with minimum params

curl -X POST 'https://api.ucdn.com/v4/livestreaming/post_livestream_zone?token=acf0230d03f5b71d7252e336106f7338' \
  --header "Content-Type: application/json" \
  --data '{"name": "any-zone-name"}'

-- with maximum params

curl -X POST 'https://api.ucdn.com/v4/livestreaming/post_livestream_zone?token=acf0230d03f5b71d7252e336106f7338' \
  --header "Content-Type: application/json" \
  -- data '{
    "name": "any-zone-name",
    "hls_via_cdn": true,
    "include_base_stream_in_master_playlist": true,
    "recording": {
        "keep_copy_of_base_stream_as_mp4": true,
        "storage_name": "storage EU",
        "region": "europe",
        "target_duration_per_file": 60
    },
    "dvr": {
        "enabled": true,
        "keep_full_stream": true,
        "dvr_session_timeout": "60",
        "stream_rewind_window": "720"
    },
    "streams": {
        "base": {
            "restreams": {}
        },
        "1080p-30": {
            "transcode": {
                "enabled": true,
                "upload_on": true,
                "framerate": 45,
                "video_bitrate": 1234000,
                "profile": "high",
                "resolution": "720p",
                "audio_bitrate": 120000
            },
            "restreams": {
                "youtube_restream": {
                    "enabled": true,
                    "new_name": "youtube_restream_new",
                    "publish_url": "rtmp://b.com",
                    "stream_key": "12345654321"
                }
            },
            "new_name": "1080p-30-new"
        }
    },
    "cnames": [
        "some.cname.name",
        "some1.cname.name"
    ],
    "limit_access": {
        "by_referer": {
            "enabled": true,
            "use_origin_if_no_referer": true,
            "allowed_domains": [
                "test.1",
                "test.2"
            ]
        },
        "by_country": {
            "enabled": true,
            "type": "allow|deny",
            "countries:": [
                "us",
                "ru"
            ]
        },
        "by_secret_key": {
            "enabled": true,
            "hash_secret_key": "12345_key",
            "hash_algorithm": "md5|sha1",
            "hash_time_to_live_mins": 37
        },
        "by_ip": {
            "enabled": true,
            "type": "allow|block",
            "ip_list": [
                "192.168.0.1",
                "102.102.102.102"
            ]
        }
    },
    "cors": {
        "mode": "advanced",
        "allow_origin_mode": "csv",
        "allow_origin_csv": ["http://test.test"],
        "allow_origin_regexp": "",
        "allow_methods": "GET,HEAD,POST,OPTIONS",
        "allow_credentials": "true",
        "allow_headers": "HEADER-1,HEADER-2",
        "expose_headers": "HEADER-3,HEADER-4",
        "max_age": 123
    }
}'

{
    "message": "Livestream zone created succesfully.",
    "zone_name": "any-zone-name"
}

Livestream parameters are described below.

recording

DVR

streams

transcode

restreams

limit_access

by_referer

by_country

by_secret_key

by_ip

cors

Zone parameters are described below.

location_of_files

ucdn_storage

custom_location

files_at

http_authentication

access_origin_host_header

aws_s3

with_signing_key

with_secret_key

limit_access

by_referer

by_country

by_secret_key

by_ip

cache

cache_for_limited_time

reuse_cache_from_other_zone

limit_download_speed

by_constant_rate

error_pages

cors

Edit livestreaming zones

PATCH https://api.ucdn.com/v4/livestreaming/patch_livestream_zone/?zone_name=...

Zone parameters are described below.

location_of_files

ucdn_storage

custom_location

files_at

http_authentication

access_origin_host_header

aws_s3

with_signing_key

with_secret_key

limit_access

by_referer

by_country

by_secret_key

by_ip

cache

cache_for_limited_time

reuse_cache_from_other_zone

limit_download_speed

by_constant_rate

error_pages

cors

Examples

• curl
• Response

-- change the resolution of the stream 'my-transcode'

curl -X PATCH 'https://api.ucdn.com/v4/livestreaming/patch_livestream_zone/?zone_name=any-zone-name&token=acf0230d03f5b71d7252e336106f7338' \
  --header "Content-Type: application/json" \
  --data '{"streams":{"my-transcode":{"transcode":{"resolution":"360p"}}}}'


-- add a restream to stream 'my-transcode'

curl -X PATCH 'https://api.ucdn.com/v4/livestreaming/patch_livestream_zone/?zone_name=any-zone-name&token=acf0230d03f5b71d7252e336106f7338' \
  --header "Content-Type: application/json" \
  --data '{"streams": {"my-transcode": {"restreams": {"third-restream": {"enabled": false,"publish_url": "rtmp://test-url-new.com","stream_key": "12345678"}}}}}'

{
    "message": "Zone patched"
}

Get livestreaming zones

GET https://api.ucdn.com/v4/livestreaming/get_livestream_zone?zone_name=...

Examples

• curl
• Response

curl -X GET 'https://api.ucdn.com/v4/livestreaming/get_livestream_zone?zone_name=any-zone-name&token=acf0230d03f5b71d7252e336106f7338'

{
    "name": "any-zone-name",
    "hls_via_cdn": true,
    "include_base_stream_in_master_playlist": true,
    "recording": {
        "keep_copy_of_base_stream_as_mp4": true,
        "storage_name": "TestingContainer",
        "target_duration_per_file": "60"
    },
    "dvr": {
        "enabled": true,
        "keep_full_stream": true,
        "dvr_session_timeout": "30",
        "stream_rewind_window": "120"
    },
    "streams": {
        "base": {
            "restreams": []
        },
        "1080p-60": {
            "transcode": {
                "enabled": true,
                "keep_copy_as_mp4": false,
                "framerate": 60,
                "video_bitrate_kbps": 25000000,
                "profile": "high",
                "resolution": "1080p",
                "audio_bitrate_kbps": 256000
            },
            "restreams": {
                "youtube_restream": {
                    "enabled": true,
                    "publish_url": "rtmp:\/\/b.com",
                    "stream_key": "123321"
                }
            }
        }
    },
    "cnames": [
        "my-domain.com"
    ],
    "limit_access": {
        "by_referer": {
            "enabled": true,
            "use_origin_if_no_referer": true,
            "allowed_domains": [
                "test-domain.com"
            ]
        },
        "by_country": {
            "enabled": true,
            "type": "deny",
            "countries": [
                "ro"
            ]
        },
        "by_secret_key": {
            "enabled": true,
            "hash_secret_key": "myKey2",
            "hash_algorithm": "md5",
            "hash_time_to_live_mins": "30"
        },
        "by_ip": {
            "enabled": true,
            "type": "deny",
            "ip_list": [
                "111.151.161.171"
            ]
        }
    },
    "cors": {
        "mode": "advanced",
        "allow_origin_mode": "any",
        "allow_origin_csv": "",
        "allow_origin_regexp": "",
        "allow_methods": "",
        "allow_credentials": "false",
        "allow_headers": "",
        "expose_headers": "",
        "max_age": ""
    }
}

Get livestreaming zone status

GET https://api.ucdn.com/v4/livestreaming/check_zone_status?zone_name=...

Examples

• curl
• Response

curl -X GET 'https://api.ucdn.com/v4/livestreaming/check_zone_status?token=acf0230d03f5b71d7252e336106f7338'

{
    "zone_active": "1"
}

Delete livestreaming zones

DELETE https://api.ucdn.com/v4/livestreaming/delete_livestream_zone?zone_name=...

Examples

• curl
• Response

curl -X DELETE 'https://api.ucdn.com/v4/livestreaming/delete_livestream_zone?zone_name=any-zone-name&token=acf0230d03f5b71d7252e336106f7338'

{
    "messgae": "Zone deleted succesfully",
}

Delete transcodings

DELETE https://api.ucdn.com/v4/livestreaming/delete_transcoding?zone_name=...&transcoding_name...

Examples

• curl
• Response

curl -X DELETE 'https://api.ucdn.com/v4/livestreaming/delete_transcoding?zone_name=any-zone-name&transcoding_name=my-transcode&token=acf0230d03f5b71d7252e336106f7338'

{
    "message": "Transcode deleted succesfully."
}

Delete restreams

DELETE https://api.ucdn.com/v4/livestreaming/delete_restream?zone_name=...&restream_name=...&transcoding_name=...

Examples

• curl
• Response

curl -X DELETE 'https://api.ucdn.com/v4/livestreaming/delete_restream?zone_name=any-zone-name&restream_name=first-restream&transcoding_name=my-transcoding&token=acf0230d03f5b71d7252e336106f7338'

{
    "message": "Restream deleted succesfully."
}

Get all livestreaming zones

GET https://api.ucdn.com/v4/livestreaming/get_zones?[zone_name=...]

Examples

• curl
• Response

curl -X GET "https://api.ucdn.com/v4/livestreaming/get_zones/?zone_name=any-zone-name&token=acf0230d03f5b71d7252e336106f7338"

[
    {
        "account_id": 11,
        "zone_id": 1,
        "config": {
            "name": "test_livestream",
            "publish_pop": "US-DAL",
            "enable_http_access": true,
            "upload": {
                "on": false,
                "max_file_duration_mins": 30
            },
            "dvr": {
                "on": false
            },
            "streams": {
                "base": {
                    "type": "base",
                    "transcode": [],
                    "upload": {
                        "on": false
                    },
                    "restreams": {
                        "c1a430c40d200d4015b1": {
                            "on": true,
                            "name": "test_base_restream",
                            "url": "rtmp:\/\/baserestream.com",
                            "key": "mlliasjdakbdakosixakdsfnalfjaf"
                        }
                    }
                },
                "360p-30": {
                    "type": "sub",
                    "transcode": {
                        "on": true,
                        "v_c": "h264",
                        "v_fps": 30,
                        "v_prof": "high",
                        "v_w": 640,
                        "v_h": 360,
                        "a_c": "aac",
                        "v_br": 500000,
                        "preset": "medium",
                        "a_br": 128000,
                        "v_kf": 2,
                        "v_cq": 23,
                        "f_mr": 550000
                    },
                    "upload": {
                        "on": false
                    },
                    "restreams": {
                        "179fb1a3a3a2b222cfe6": {
                            "on": true,
                            "name": "test_transc_restream",
                            "url": "rtmp:\/\/transc_restream.com",
                            "key": "lkjiasudkadmaslkjaslfjsalkfmasldkasldasmas"
                        }
                    }
                }
            },
            "publish_domains": [
                {
                    "domain": "11-1-0.lsp.cdn13.com"
                }
            ],
            "streamkey": "4fa7a28adb5b3380b0544d8bb2d9f4ba11ee031c",
            "rtmp_port": "2113",
            "http_port": "2114",
            "publish_rtmp_app": "ulive",
            "play_uri_prefix": "hls\/2b78db2098.ulive",
            "publish_hosts": [
                61
            ]
        }
    }
]

Get livestream events

GET https://api.ucdn.com/v4/livestreaming/get_events?[zone_name=...]

Examples

• curl
• Response

curl -X GET "https://api.ucdn.com/v4/livestreaming/get_events?zone_name=any-zone-name&token=acf0230d03f5b71d7252e336106f7338"

{
    "events": {
        "33a4e61a9f151497c9a92200cb75a2a7": [
            {
                "id": "1",
                "session_id": "33a4e61a9f151497c9a92200cb75a2a7",
                "session_group_id": "7c7728bdcce89cc609fee3c922746780",
                "stream_id": "base",
                "sub_id": "base",
                "event": "publish",
                "start_ts": "1688716033",
                "stop_ts": "0",
                "host_id": "1479",
                "pop_id": "4",
                "meta_info": {
                    "dvr": {
                        "on": false
                    }
                }
            },
            {
                "id": "2",
                "session_id": "33a4e61a9f151497c9a92200cb75a2a7",
                "session_group_id": "7c7728bdcce89cc609fee3c922746780",
                "stream_id": "360p-30",
                "sub_id": "base",
                "event": "transcode",
                "start_ts": "1688716033",
                "stop_ts": "0",
                "host_id": "1479",
                "pop_id": "4",
                "meta_info": {
                    "v_c": "h264",
                    "v_fps": 60,
                    "v_prof": "main",
                    "v_w": 1920,
                    "v_h": 1080,
                    "a_c": "aac",
                    "v_br": 3000000,
                    "preset": "medium",
                    "a_br": 128000,
                    "v_kf": 2,
                    "v_cq": 23,
                    "f_mr": 3300001
                }
            }
        ]
    }
}

Get current active session

GET https://api.ucdn.com/v4/livestreaming/get_active_session?zone_name=...include_session_group=true|false

Examples

• curl
• Response

curl -X GET "https://api.ucdn.com/v4/livestreaming/get_active_session?zone_name=any-zone-name&include_session_group=true&token=acf0230d03f5b71d7252e336106f7338"

{
    "1": {
        "id": "ec0331bcfee0a6e3165063bc952cdb66",
        "session_group_id": "2b41dd9f1dccf81fc0ef56842635dd55",
        "transcode": {
            "first-transcode": {
                "base": {
                    "id": "8",
                    "session_id": "ec0331bcfee0a6e3165063bc952cdb66",
                    "account_id": "1",
                    "event": "transcode",
                    "start_ts": "1695126124",
                    "stop_ts": "0",
                    "host_id": "1479",
                    "pop_id": "4",
                    "meta_info": {
                        "v_c": "h264",
                        "v_fps": 60,
                        "v_prof": "main",
                        "v_w": 1920,
                        "v_h": 1080,
                        "a_c": "aac",
                        "v_br": 3000000,
                        "preset": "medium",
                        "a_br": 128000,
                        "v_kf": 2,
                        "v_cq": 23,
                        "f_mr": 3300001
                    }
                }
            },
            "second-transcode": {
                "base": {
                    "id": "7",
                    "session_id": "ec0331bcfee0a6e3165063bc952cdb66",
                    "account_id": "1",
                    "event": "transcode",
                    "start_ts": "1695126124",
                    "stop_ts": "0",
                    "host_id": "1479",
                    "pop_id": "4",
                    "meta_info": {
                        "v_c": "h264",
                        "v_fps": 60,
                        "v_prof": "main",
                        "v_w": 1920,
                        "v_h": 1080,
                        "a_c": "aac",
                        "v_br": 3000000,
                        "preset": "medium",
                        "a_br": 128000,
                        "v_kf": 2,
                        "v_cq": 23,
                        "f_mr": 3300001
                    }
                }
            }
        },
        "publish": {
            "base": {
                "base": {
                    "id": "6",
                    "session_id": "ec0331bcfee0a6e3165063bc952cdb66",
                    "account_id": "1",
                    "event": "publish",
                    "start_ts": "1695126124",
                    "stop_ts": "0",
                    "host_id": "1479",
                    "pop_id": "4",
                    "meta_info": {
                        "dvr": {
                            "on": true,
                            "session_distinction_interval_mins": "240",
                            "max_window_duration_mins": "60",
                            "keep_full_playlist": false
                        }
                    }
                }
            }
        },
        "statuses": {
            "streams": {
                "base": {
                    "status": "live"
                },
                "first-transcode": {
                    "status": "live"
                },
                "second-transcode": {
                    "status": "live"
                }
            }
        },
        "session_group_active": true
    }
}

Get session group

GET https://api.ucdn.com/v4/livestreaming/get_session_group?[zone_name=...]&[session_group_id=...]

Examples

• curl
• Response

curl -X GET " https://api.ucdn.com/v4/livestreaming/get_session_group?zone_name=any-zone-name&session_group_id=621c21d50c340a26f6ea8806b82aea87&token=acf0230d03f5b71d7252e336106f7338"

{
    "session_group_id": "7c7728bdcce89cc609fee3c922746780",
    "account_id": "1",
    "start_ts": "1688716033",
    "stop_ts": "0"
}

Reset active session group

POST https://api.ucdn.com/v4/livestreaming/post_active_session_group_reset?[zone_name=...]

Examples

• curl
• Response

curl -X POST "https://api.ucdn.com/v4/livestreaming/post_active_session_group_reset?zone_name=any-zone-name&token=acf0230d03f5b71d7252e336106f7338" --header "Content-Type: application/json" --data ''

{
    "message": "OK"
}

Activate livestreaming zone

PATCH https://api.ucdn.com/v4/livestreaming/toggle_zone_status?[zone_name=...]

Examples

• curl
• Response

curl -X PATCH 'https://api.ucdn.com/v4/livestreaming/toggle_zone_status?zone_name=test-zone&token=acf0230d03f5b71d7252e336106f7338' \
  --header "Content-Type: application/json" \
  --data '{"enable": true}'

{
    "message": "Zone enabled"
}

Deactivate livestreaming zone

PATCH https://api.ucdn.com/v4/livestreaming/toggle_zone_status?[zone_name=...]

Examples

• curl
• Response

curl -X PATCH 'https://api.ucdn.com/v4/livestreaming/toggle_zone_status?zone_name=test-zone&token=acf0230d03f5b71d7252e336106f7338' \
  --header "Content-Type: application/json" \
  --data '{"disable": true}'

{
    "message": "Zone disabled"
}

Activate letsencrypt

POST https://api.ucdn.com/v4/livestreaming/activate_letsencrypt?zone_name=...

Examples

• curl
• Response

curl -X POST 'https://api.ucdn.com/v4/livestreaming/activate_letsencrypt?zone_name=test-zone&token=acf0230d03f5b71d7252e336106f7338'

{
    "message": "Successfully activated letsencrypt."
}

Deactivate letsencrypt

POST https://api.ucdn.com/v4/livestreaming/deactivate_letsencrypt?zone_name=...

Examples

• curl
• Response

curl -X DELETE 'https://api.ucdn.com/v4/livestreaming/deactivate_letsencrypt?zone_name=test-zone&token=acf0230d03f5b71d7252e336106f7338'

{
    "message": "Successfully deactivated letsencrypt."
}

Get letsencrypt status

GET https://api.ucdn.com/v4/livestreaming/check_letsencrypt_status?zone_name=...

Examples

• curl
• Response

curl -X GET 'https://api.ucdn.com/v4/livestreaming/check_letsencrypt_status?token=acf0230d03f5b71d7252e336106f7338'

{
    "letsencrypt_active": "0"
}