MaxCDN API Docs

API Docs

MaxCDN API Docs

API Docs

MaxCDN API Docs

MaxCDN is a Content Delivery Network service.

Index

Zones API
Reports API
Raw Logs API
Reseller API
Origin Shield API

Overview

@@ -11074,7 +11076,473 @@

Code Samples

}, ] }, - "code": 201 + "code": 201 +

+ + +

Reseller API

+ + + +

Get Client Bandwidth

+Gets client bandwidth information +
+

GET +https://rws.maxcdn.com/{companyalias}/clients/{id}/bandwidth.json

+ +

Code Samples

+ +

+api.get("/clients/{id}/bandwidth.json")

api.get("/clients/{id}/bandwidth.json")

+$api->get('/clients/{id}/bandwidth.json');

+api.get('/clients/{id}/bandwidth.json', callback)
+function callback(err, response) {
+  if (err) return console.log(err)
+  console.log(response)
+}

+{
+    "code": 200,
+    "data": {
+        "account": {total": "1", 
+        "summary": [{
+            "valid_until": "Jun 07, 2011", 
+            "credit": "10", 
+            "still_valid": false, 
+            "base": 1000, 
+            "expiration": false, 
+            "purchased": "Jun 07, 2010", "debit": 11107173020
+            }]
+        }
+    }
+}

+ +

Get Storage Data

+ +

Gets relevant storage data

+ +

GET +https://rws.maxcdn.com/{companyalias}/clients/{id}/storage.json

+ +

Response Parameters

+ + + + + + + + +

Parameter	Description
zone_id	Zone ID
storage	Amount of Storage Used
storage_id	Storage ID
zone_type	Type of Zone
zone_name	Name of Zone
last_updated	Date Last Updated

+ +

Code Samples

+ +

+api.get("/clients/{id}/storage.json")

api.get("/clients/{id}/storage.json")

+$api->get('/clients/{id}/storage.json');

+api.get('/clients/{id}/storage.json', callback)
+function callback(err, response) {
+  if (err) return console.log(err)
+  console.log(response)
+}

+{
+    "code": 200, "data": {
+        "stats": [
+        {
+            "last_updated": "2014-11-13 18:39:19", 
+            "zone_id": "{zoneid}", 
+            "storage_used": "1234", 
+            "storage_id": "1", 
+            "zone_type": "1", 
+            "zone_name": "zonename"}, 
+        {
+            "last_updated": "2014-11-13 16:00:50", 
+            "zone_id": "zoneid", 
+            "storage_used": "5678", 
+            "storage_id": "2", 
+            "zone_type": "2", 
+            "zone_name": "zonename2"
+        }, 
+        {
+            "last_updated": "2014-11-13 16:00:08", 
+            "zone_id": "zoneid", 
+            "storage_used": "9012", 
+            "storage_id": "3", 
+            "zone_type": "3", 
+            "zone_name": "zonename3"
+        }, 
+        {
+            "last_updated": "2014-11-13 18:39:19", 
+            "zone_id": "zoneid", 
+            "storage_used": "3456", 
+            "storage_id": "4", 
+            "zone_type": "4", 
+            "zone_name": "zonename4"
+        }, 
+        {
+            "last_updated": "2014-11-13 16:00:50", 
+            "zone_id": "zoneid", 
+            "storage_used": "7890", 
+            "storage_id": "5", 
+            "zone_type": "5", 
+            "zone_name": "zonename"}
+        ], 
+    "page_size": "50", 
+    "pages": 1, 
+    "current_page_size": 1, 
+    "total": "1", 
+    "page": 1
+    }
+}
+

+ +

Get Storage Used

+ +

Gets the amount of storage that has currently been used.

+ +

GET +https://rws.maxcdn.com/{companyalias}/clients/{id}/storage/used.json

+ +

Code Samples

+ +

+api.get("/clients/{id}/storage/used.json")

api.get("/clients/{id}/storage/used.json")

+$api->get('/clients/{id}/storage/used.json');

+api.get('/clients/{id}/storage/used.json', callback)
+function callback(err, response) {
+  if (err) return console.log(err)
+  console.log(response)
+}

+{
+"code": 200, 
+"data": {
+    "storage": "1535815680"
+    }
+}

+ +

Account API

+ +

Get Account

+ +

Gets account information

+ +

GET +https://rws.maxcdn.com/{companyalias}/clients.json

+ +

Response Parameters

+ + + + + + + + + +

Parameter	Description
name	The Name of your Account
address_id	Address ID
alias	Company Alias
ssl_credits	SSL Credits
flex_credits	Flex Location Credits
date_created	Date Created
date_updated	Date Updated

+ +

Code Samples

+ +

+api.get("{/clients.json")

api.get("{/clients.json")

+$api->get('/clients.json');

+api.get('/clients.json', callback)
+function callback(err, response) {
+  if (err) return console.log(err)
+  console.log(response)
+}

+{
+    "code": 200,
+    "data": {
+        "current_page_size": 2,
+        "page": 1,
+        "page_size": "50",
+        "pages": 1,
+        "total": 2,
+        "users": [
+        {
+            "alias": "aliasname",
+            "date_created": "2013-05-15 17:32:30",
+            "date_updated": "2013-05-15 19:43:36",
+            "edgerules_credits": "0",
+            "flex_credits": "-1",
+            "id": "#####",
+            "name": "MaxCDN sampleCode",
+            "secure_token_pull_credits": "0",
+            "server_id": "18",
+            "ssl_credits": "1",
+            "status": "2",
+            "storage_quota": "107374182400",
+            "storage_server_id": "11",
+            "zone_credits": "-1"
+        },
+        {
+            "alias": "aliasname",
+            "date_created": "2013-05-15 17:32:30",
+            "date_updated": "2013-05-15 19:43:36",
+            "edgerules_credits": "0",
+            "flex_credits": "-1",
+            "id": "#####",
+            "name": "MaxCDN sampleCode",
+            "secure_token_pull_credits": "0",
+            "server_id": "18",
+            "ssl_credits": "1",
+            "status": "2",
+            "storage_quota": "107374182400",
+            "storage_server_id": "11",
+            "zone_credits": "-1"
+        }
+    ]}
+}

+ +

Users API

+ +

List Users

+ +

Returns a list of all users on the specified account

+ +

GET +https://rws.maxcdn.com/{companyalias}/clients/{id}/users.json

+ +

Response Parameters

+ + + + + + + + + + + + + +

Parameter	Description
id	User ID
email	E-mail Address
firstname	First Name
lastname	Last Name
phone	Phone Number
timezone	Users' Time Zone
date_last_login	The date and time the user last logged into the system
ip_last_long	The IP for the user at the last login
date_created	Date Created
date_uodated	Date Updated
roles	An array of roles for the given user

+ +

Code Samples

+ +

+api.get('/clients/{id}/users.json')

+api.get('/clients/{id}/users.json')

+$api->get('/clients/{id}/users.json');

+api.get('/clients/{id}/users.json', callback)
+function callback(err, response) {
+  if (err) return console.log(err)
+  console.log(response)
+}

+{
+    "code": 200,
+    "data": {
+        "current_page_size": 4,
+        "page": 1,
+        "page_size": "50",
+        "pages": 1,
+        "total": 4,
+        "users": [
+            {
+                "brand_id": "1",
+                "date_created": "2013-05-15 17:32:30",
+                "date_last_login": "2013-05-23 17:54:18",
+                "date_updated": "2013-05-15 17:33:09",
+                "default_company_id": "#####",
+                "email": "name@domain.com",
+                "firstname": "Given",
+                "id": "33706",
+                "ip_last_login": "12.13.90.183",
+                "isadmin": "0",
+                "isdisabled": "0",
+                "lastname": "Family",
+                "phone": "3235551400",
+                "roles": [
+                    "User",
+                    "Account Owner"
+                ],
+                "timezone": "Europe/London"
+            },
+            {
+                "brand_id": "1",
+                "date_created": "2013-05-15 20:16:34",
+                "date_last_login": null,
+                "date_updated": "0000-00-00 00:00:00",
+                "default_company_id": "19538",
+                "email": "caphammer1@hamcave.com",
+                "firstname": "Captain",
+                "id": "33714",
+                "ip_last_login": null,
+                "isadmin": "0",
+                "isdisabled": "0",
+                "lastname": "Hammer",
+                "phone": null,
+                "roles": [
+                    "User"
+                ],
+                "timezone": "Europe/London"
+            },
+            {
+                "brand_id": "1",
+                "date_created": "2013-05-15 20:20:03",
+                "date_last_login": null,
+                "date_updated": "2013-05-15 20:31:05",
+                "default_company_id": "19538",
+                "email": "drhorrible3@ele.net",
+                "firstname": "Billy",
+                "id": "33716",
+                "ip_last_login": null,
+                "isadmin": "0",
+                "isdisabled": "0",
+                "lastname": "Horrible",
+                "phone": null,
+                "roles": [
+                    "User"
+                ],
+                "timezone": "Europe/London"
+            }
+        ]
+    }
 }

@@ -11177,33 +11645,593 @@

Code Samples

] }, "code": 201 -} +

Create Client

Creates a new client on the specified account

Delete Origin Shield

Remove the active Origin Shield from your Pull Zone

DELETE -https://rws.maxcdn.com/{companyalias}/zones/pull/{zone_id}/zoneshields.json

POST +https://rws.maxcdn.com/{companyalias}/clients.json

Code Samples

Ruby
Python
PHP
Node
Response

Accepted Request Parameters

Parameter	Default Value	Validation	Description
companyname	-	required length: 1-255 chars	Company Name
companyalias	-	required length: 1-45 chars	Company Alias
group_id	-	required length: 1-11 chars	Group ID Number
package_id	-	required length: 1-11 chars	Package ID Number (Contact your sales representative to determine your Package ID Number)
account_owner	-	required A JSON Encoded Array including 'email', 'firstname', 'lastname', 'password', 'phone', 'order_status (active)	+ Account Owner Information: + + + + 'email' - Account Owner's Email + 'firstname' - Account Owner's First Name + 'lastname' - Account Owner's Last Name + 'password' - Account's Password + 'phone' - Account Owner's Phone Number + 'order_status' - Status of the Account (hard coded to 'active') + + +
address	-	required A JSON Encoded Array including street1, street2 (not required), City, State, ZIP / Postal Code, Country	Account Owner Address
paymentmethod	'mailin'	required	Payment Method "Hard code this to Mail-In Payment"
generateinvoice	'0'	required	Hard Code this to not generate an invoice with the parameter '0'
order_status	'active'	required	Hard Code this to active with 'Active'

Response Parameters

Parameter	Description
email	Email Address
firstname	First Name
lastname	Last Name
phone	Phone Number
companyname	Name of the Company
companyalias	Alias of the Company
group_id	Group ID Number
address1	Address, first line
city	City
state	Alias of the Company
postcode	City Post/ZIP Code
country	Country
phonenumber	Phone Number
password	Password
active	Whether or not the client is active

Code Samples

-id = '97167'
-api.delete('/zones/pull/'+id+'/zoneshields.json')

+ account_owner={ + "firstname"=>"First Name", + "lastname"=>"Last Name", + "email"=>"E-Mail", + "phone"=>"1234567890", + "password"=>"password", + "order_status"=>"Active" + } + + address={ + "street1"=>"Street One", + "street2"=>"Not Required", + "city"=>"City Name", + "state"=>"State", + "zip"=>"ZIP / Postal Code", + "country"=>"US (or country name)" + } + + params={ + "companyname"=>"Company Name", + "companyalias"=>"Company Alias", + "group_id"=>"Group ID", + "package_id"=>"x", + "account_owner"=>JSON.encode(account_owner), + "address"=>JSON.encode(address), + "paymentmethod"=>"mailin" + } + + api.post('/clients.json',params) + +

+        account_owner = {
+            'firstname':'First Name',
+            'lastname':'Last Name',
+            'email':'E-Mail',
+            'phone':'1234567890', 
+            'password':'password', 
+            'order_status':'Active'
+        }
+        
+        address = {
+            'street1':'Street One',
+            'street2':'Not Required',
+            'city':'City Name',
+            'state':'State', 
+            'zip':'ZIP / Postal Code', 
+            'country':'US (or country name)'
+        }
+        
+        params = {
+            'companyname":'Company Name',
+            'companyalias':'Company Alias',
+            'group_id':'Group ID',
+            'package_id':'x', 
+            'account_owner':json.dumps(account_owner), 
+            'address':json.dumps(address),
+            'paymentmethod':'mailin
+        }
+        
+        api.post('/clients.json',data=params)
+

+        
+        $account_owner = array(
+            'firstname' => 'john',
+            'lastname'  => 'doe',
+            'email'     => 'johndoe@gmail.com',
+            'phone'     => '555-555-5555',
+            'password'  => 'testpass',
+            'order_status'    => active
+        );
+        
+        
+        $address = array(
+            'street1' => '123 Fake St.',
+            'city'    => 'Los Angeles',
+            'state'   => 'California',
+            'zip'     => '90000',
+            'country' => 'US'
+        );
+        
+        $params = array(
+            'name'          => 'New Account Name',
+            'companyalias'         => 'newaccountalias',
+            'group_id'      => 27,
+            'package_id'    => x,
+            'account_owner' => json_encode($account_owner),
+            'address'       => json_encode($address)
+            'paymentmethod' => mailin
+        );
+        
+        $response = $api->post("/clients.json", $params);
+        
+

+    var account_owner = [ 
+        firstname:'First Name',
+        lastname:'Last Name',
+        email:'E-Mail',
+        phone:'1234567890', 
+        password:'password', 
+        order_status:'active'
+    ];
+    
+    var address = [ 
+        street1: '123 Fake St.',
+        city: 'Los Angeles',
+        state: 'California',
+        zip: '90000',
+        country: 'US'
+    ];
+    
+    var params = [ 
+        name => 'New Account Name',
+        companyalias => 'newaccountalias',
+        group_id => 27,
+        package_id => x,
+        account_owner => json_encode(account_owner),
+        address => json_encode(address),
+        paymentmethod => mailin
+    ];
+    
+    api.post('/clients.json' + params, callback)
+    function callback(err, response) {
+      if (err) return console.log(err)
+      console.log(response)
+    }
+

+        {
+            "code": 201,
+            "data": {
+                "Client": {
+                    "group_id": null,
+                    "company_id": "Company Name",
+                    "company_alias": "Company Alias"
+                    "date_created": "2013-05-23 18:22:11",
+                    "status": "Active",
+                    "date_last_login": null,
+                    "date_updated": null,
+                    "default_company_id": "19538",
+                    "email": "name@domain.com",
+                    "firstname": "Given",
+                    "ip_last_login": null,
+                    "isdisabled": 0,
+                    "lastname": "Family",
+                    "phone": null,
+                    "timezone": "America/Los_Angeles"
+                }
+            }
+        }
+

Create User

Creates a new user on the specified account

POST +https://rws.maxcdn.com/{companyalias}/clients/{id}/users.json

Accepted Request Parameters

Parameter	Default Value	Validation	Description
email	-	required length: 5-30 chars	Email Address
password	-	required length: 5-30 chars	Password
firstname	-	required length: 1-32 chars	First Name
lastname	-	required length: 1-32 chars	Last Name
phone	-	length: 7, 10, 11, or 14 chars; only digits considered	Phone Number
timezone	-	valid::timezone	Valid timezone (see [List of Supported Timezones](http://php.net/manual/en/timezones.php))

Response Parameters

Parameter	Description
email	Email Address
firstname	First Name
lastname	Last Name
phone	Phone Number
date_last_login	The date and time the user last logged into the system
ip_last_login	The IP for the user at the last login
date_created	Date Created
date_updated	Date Updated
roles	An array of roles for the given user

Code Samples

+params={"email"=>"name44@domain.com","password"=>"password","firstname"=>"Given","lastname"=>"Family"}
+api.post('/clients/{id}/users.json',params )

+params={'email':'name43@domain.com','password':'password','firstname':'Given','lastname':'Family'}
+api.post('/clients/{id}/users.json',data=params )

+$params = array("email"=>"name@domain.com","password"=>"password","firstname"=>"Given","lastname"=>"Family");
+$api->post('/clients/{id}/users.json',$params );

+api.post('/clients/{id}/users.json', { email: 'name@domain.com', password: 'password', firstname: 'Given', lastname: 'Family' }, callback)
+function callback(err, response) {
+  if (err) return console.log(err)
+  console.log(response)
+}

+{
+    "code": 201,
+    "data": {
+        "user": {
+            "brand_id": null,
+            "date_created": "2013-05-23 18:22:11",
+            "date_last_login": null,
+            "date_updated": null,
+            "default_company_id": "19538",
+            "email": "name@domain.com",
+            "firstname": "Given",
+            "id": 33941,
+            "ip_last_login": null,
+            "isadmin": 0,
+            "isdisabled": 0,
+            "lastname": "Family",
+            "phone": null,
+            "roles": [
+                "User"
+            ],
+            "timezone": "America/Los_Angeles"
+        }
+    }
+}

Get User

Gets a user specified by the {user_id} parameter

GET +https://rws.maxcdn.com/{companyalias}/clients/{id}/users.json/{user_id}

Response Parameters

Parameter	Description
id	Email Address
email	Email Address
firstname	First Name
lastname	Last Name
phone	Phone Number
timezone	User's Timezone

Code Samples

+id = '33706'
+api.get('/clients/{id}/users.json/'+id)

+id = '33706'
+api.get('/clients/{id}/users.json/'+id)

+$id = '33941';
+$api->get('/clients/{id}/users.json/'.$id);

+var id = '33941'
+api.get('/clients/{id}/users.json/' + id, callback)
+function callback(err, response) {
+  if (err) return console.log(err)
+  console.log(response)
+}

+{
+    "code": 200,
+    "data": {
+        "user": {
+            "brand_id": "1",
+            "date_created": "2013-05-23 18:22:11",
+            "date_last_login": null,
+            "date_updated": "0000-00-00 00:00:00",
+            "default_company_id": "19538",
+            "email": "name@domain.com",
+            "firstname": "Given",
+            "id": "33941",
+            "ip_last_login": null,
+            "isadmin": "0",
+            "isdisabled": "0",
+            "lastname": "Family",
+            "phone": null,
+            "roles": [
+                "User"
+            ],
+            "timezone": "Europe/London"
+        }
+    }
+}

Update User

Updates a user specified by the {user_id} parameter

PUT +https://rws.maxcdn.com/{companyalias}/clients/{id}/users.json/{user_id}

Accepted Request Parameters

Response Parameters

Parameter	Default Value	Validation	Description
email	-	length: 6-200 chars; valid email address	Email Address
firstname	-	length: 1-32 chars	First Name
lastname	-	length: 1-32 chars	Last Name
phone	-	length: 7, 10, 11, or 14 chars; only digits considered	Last Name
timezone	-	valid::timezone	Valid timezone (see [List of Supported Timezones](http://php.net/manual/en/timezones.php))

Parameter	Description
id	User ID
email	Email Address
firstname	First Name
lastname	Last Name
phone	Phone Number
last_updated	Date Last Updated
timezone	User's Timezone

Code Samples

+id = '33706'
+params={'firstname'=> 'name'}
+api.put('/clients/{id}/users.json/'+id,params)
+

+api.put('/clients/{id}/users.json/'+id,params={'firstname': 'name'})

+$id = '33941';
+$params =  array("firstname"=>"Billy");
+$api->put('/clients/{id}/users.json/'.$id,$params);

+var id = '33941'
+api.put('/clients/{id}/users.json/' + id, { firstname: 'Billy' }, callback)
+function callback(err, response) {
+  if (err) return console.log(err)
+  console.log(response)
+}

+{
+    "code": 200,
+    "data": {
+        "user": {
+            "brand_id": "1",
+            "date_created": "2013-05-23 18:22:11",
+            "date_last_login": null,
+            "date_updated": "2013-05-23 19:10:09",
+            "default_company_id": "19538",
+            "email": "name@domain.com",
+            "firstname": "Billy",
+            "id": "33941",
+            "ip_last_login": null,
+            "isadmin": "0",
+            "isdisabled": "0",
+            "lastname": "Family",
+            "phone": null,
+            "roles": [
+                "User"
+            ],
+            "timezone": "Europe/London"
+        }
+    }
+}

Delete Origin Shield

Remove the active Origin Shield from your Pull Zone

DELETE +https://rws.maxcdn.com/{companyalias}/zones/pull/{zone_id}/zoneshields.json

Code Samples

+id = '97167'
+api.delete('/zones/pull/'+id+'/zoneshields.json')

 id = '97167'
@@ -11228,6 +12256,6235 @@ Code Samples
 }

Delete User

Deletes a user specified by the {user_id} parameter

DELETE +https://rws.maxcdn.com/{companyalias}/clients/{id}/users.json/{user_id}

Code Samples

+id = '33706'
+api.delete('/clients/{id}/users.json/'+id)

+id = '33706'
+api.delete('/clients/{id}/users.json/'+id)

+$id = '33715';
+$api->delete('/clients/{id}/users.json/'.$id);

+var id = '33715'
+api.delete('/clients/{id}/users.json/' + id, callback)
+function callback(err, response) {
+  if (err) return console.log(err)
+  console.log(response)
+}

+{
+  "code":200
+}

Zones API

List Zones

Returns a list of all zones on the specified account

GET +https://rws.maxcdn.com/{companyalias}/clients/{id}/zones.json

Code Samples

+api.get('/clients/{id}/zones.json')

+api.get('/clients/{id}/zones.json')

+$api->get('/clients/{id}/zones.json');

+api.get('/clients/{id}/zones.json', function(err, response) {
+  console.log('err', err, 'response', response)
+})

+{
+    "code": 200,
+    "data": {
+        "current_page_size": 2,
+        "page": 1,
+        "page_size": "50",
+        "pages": 1,
+        "total": 2,
+        "zones": [
+            {
+                "cdn_url": "cdn.somedomain.com",
+                "creation_date": "2013-05-15 20:45:44",
+                "id": "#####",
+                "inactive": "0",
+                "label": "personal",
+                "locked": "0",
+                "name": "zoneName",
+                "suspend": "0",
+                "tmp_url": "zone.alias.netdna-cdn.com",
+                "type": "2"
+            },
+            {
+                "cdn_url": "newlivezone.somedomain.netdna-cdn.com",
+                "creation_date": "2013-05-16 16:23:49",
+                "id": "#####",
+                "inactive": "0",
+                "label": null,
+                "locked": "0",
+                "name": "newlivezone",
+                "suspend": "0",
+                "tmp_url": "newlivezone.alias.netdna-cdn.com",
+                "type": "5"
+            }
+        ]
+    }
+}

Get Zone Summary

Gets a summarized count of all zone types on the specified +account

GET +https://rws.maxcdn.com/{companyalias}/clients/{id}/zones.json/summary

Response Parameters

Parameter	Description
pull	The number of pull zones for your account
push	The number of push zones for your account
vod	The number of vod zones for your account

Code Samples

+api.get('/clients/{id}/zones.json/summary')

+api.get('/clients/{id}/zones.json/summary')

+$api->get('/clients/{id}/zones.json/summary');

+api.get('/clients/{id}/zones.json/summary', function(err, response) {
+  console.log('err', err, 'response', response)
+})

+{
+    "code": 200,
+    "data": {
+        "summary": {
+            "live": 1,
+            "pull": 1,
+            "push": 1,
+            "vod": 1
+        }
+    }
+}

Get Zone Count

Counts all zones on the specified account

GET +https://rws.maxcdn.com/{companyalias}/clients/{id}/zones.json/count

Response Parameters

Parameter	Description
count	The total number of content zones for your account

Code Samples

+api.get('/clients/{id}/zones.json/count')

+api.get('/clients/{id}/zones.json/count')

+$api->get('/clients/{id}/zones.json/count');

+api.get('/clients/{id}/zones.json/count', function(err, response) {
+  console.log('err', err, 'response', response)
+})

+{
+  "code":200,"data":
+    {
+      "count":"4"
+    }
+}

Pull Zone API

List Pull Zones

Returns a list of all pull zones on the specified account

GET +https://rws.maxcdn.com/{companyalias}/clients/{id}/zones/pull.json

Response Parameters

Parameter	Description
id	Pull Zone ID
name	Pull Zone name
url	Origin URL
port	Port
ip	IP address of the Origin URL
compress	Enables on the fly GZip compression of your files from our edge servers for the following file types: text/plain, text/html, text/javascript, text/css, text/xml, application/javascript, application/x-javascript, application/xml, text/x-component, application/json, application/xhtml+xml, application/rss+xml, application/atom+xml, app/vnd.ms-fontobject, image/svg+xml, application/x-font-ttf, font/opentype, application/octet-stream
backend_compress	Enables us to cache, from origin, GZip compressed versions of your files for the following file types: text/plain, text/html, text/javascript, text/css, text/xml, application/javascript, application/x-javascript, application/xml, text/x-component, application/json, + application/xhtml+xml, application/rss+xml, application/atom+xml, app/vnd.ms-fontobject, image/svg+xml, application/x-font-ttf, font/opentype
queries	Treat Query Strings as a separate cacheable item
cache_valid	Ignore the origin Cache-Control Header and set every request to have a Max-Age of 1d, 7d, 1M or 12M
ignore_setcookie_header	Ignore any cookies set by the origin in order to make the content consistently cacheable
ignore_cache_control	Ignore any max age values set by the origin and use the CDN set value instead
use_stale	Serve expired content while fetching new content. This will also cause the CDN to serve expired content in cases where the origin is down
proxy_cache_lock	When multiple requests for an uncached file are received, they will wait until the first response is received rather than sending each request back to the origin
label	Ignore any cookies set by the origin in order to make the content consistently cacheable
valid_referers	List of domains for http referrer protection (separated by space), only the domains in the list will be treated as valid referrers
expires	Set any request with a no "Cache-Control header" from the origin to stay on the server. Possible values are 1d, 7d, 1M, 12M
disallow_robots	Enable robots.txt
canonical_link_headers	Pass the canonical URL in the Link HTTP Header
content_disposition	Force files to download
pseudo_streaming	Enable the zone for pseudo streaming content
sslshared	Enable Shared SSL for your zone, so you can use HTTPS, using our SSL certificate for netdna-ssl.com
suspend	Flag denoting if the zone has been suspended
locked	Flag denoting if the zone has been locked
inactive	Flag denoting if the zone has been deleted
creation_date	Date Created
spdy	Flag denoting if the zone has the SPDY protocol enabled

Code Samples

+api.get('/clients/{id}/zones/pull.json')

+api.get('/clients/{id}/zones/pull.json')

+$api->get('/clients/{id}/zones/pull.json');

+api.get('/clients/{id}/zones/pull.json', function(err, response) {
+  console.log('err', err, 'response', response)
+})

+{
+    "code": 200,
+    "data": {
+        "current_page_size": 3,
+        "page": 1,
+        "page_size": "50",
+        "pages": 1,
+        "pullzones": [
+            {
+                "backend_compress": "0",
+                "cache_valid": "1d",
+                "canonical_link_headers": "0",
+                "cdn_url": "cdn.somedomain.com",
+                "compress": "1",
+                "content_disposition": "0",
+                "creation_date": "2013-05-15 20:45:44",
+                "disallow_robots": "0",
+                "disallow_robots_txt": null,
+                "dns_check": "1",
+                "expires": null,
+                "hide_setcookie_header": "0",
+                "id": "96061",
+                "ignore_cache_control": "0",
+                "ignore_setcookie_header": "0",
+                "inactive": "0",
+                "ip": "205.134.255.49",
+                "label": "personal",
+                "locked": "0",
+                "name": "somedomain",
+                "port": "80",
+                "proxy_cache_lock": "0",
+                "pseudo_streaming": "0",
+                "queries": "1",
+                "server_id": "18",
+                "set_host_header": null,
+                "sslshared": "0",
+                "suspend": "0",
+                "tmp_url": "somedomain.alias.netdna-cdn.com",
+                "type": "2",
+                "upstream_enabled": "0",
+                "url": "http://somedomain.net",
+                "use_stale": "0",
+                "valid_referers": null,
+                "spdy": 0
+            },
+            <...>,
+            {
+                "backend_compress": "0",
+                "cache_valid": "1d",
+                "canonical_link_headers": "0",
+                "cdn_url": "newpullzone3.alias.netdna-cdn.com",
+                "compress": "0",
+                "content_disposition": "0",
+                "creation_date": "2013-05-24 16:18:19",
+                "disallow_robots": "0",
+                "disallow_robots_txt": null,
+                "dns_check": "1",
+                "expires": null,
+                "hide_setcookie_header": "0",
+                "id": "97312",
+                "ignore_cache_control": "0",
+                "ignore_setcookie_header": "0",
+                "inactive": "0",
+                "ip": "205.134.255.49",
+                "label": null,
+                "locked": "0",
+                "name": "newpullzone3",
+                "port": "80",
+                "proxy_cache_lock": "0",
+                "pseudo_streaming": "0",
+                "queries": "1",
+                "server_id": "18",
+                "set_host_header": null,
+                "sslshared": "0",
+                "suspend": "0",
+                "tmp_url": "newpullzone3.alias.netdna-cdn.com",
+                "type": "2",
+                "upstream_enabled": "0",
+                "url": "http://somedomain.net",
+                "use_stale": "0",
+                "valid_referers": null,
+                "spdy": 1
+            }
+        ],
+        "total": 3
+    }
+}

Create Pull Zone

Creates a new pull zone

POST +https://rws.maxcdn.com/{companyalias}/clients/{id}/zones/pull.json

Accepted Request Parameters

Parameter	Default Value	Validation	Description
name	-	required length: 3-32 chars; only letters, digits, and dash (-)accepted	Pull Zone Name
url	-	required length: 4-100 chars; only valid URLs accepted	Origin URL
port	80	length: 1-5 chars; only digits accepted	Port
dns_check	1	only 0 or 1 accepted	This field determines how your Origin resolves. When set to 1, we automatically grab the origin's IP using DNS. Setting it to 0 allows you explicitly provide the IP of the origin.
ip	-	length: 1-10 chars, only digits accepted	Valid IP address of the Origin URL. Be sure to set `dns_check` to 0 to prevent this value from being overwritten.
compress	-	length: 1-5 chars; only digits accepted	only 0 or 1 accepted \| Enables on the fly GZip compression of your files from our edge servers for the following file types: text/plain, text/html, text/javascript, text/css, text/xml, application/javascript, application/x-javascript, application/xml, text/x-component, application/json, application/xhtml+xml, application/rss+xml, application/atom+xml, app/vnd.ms-fontobject, image/svg+xml, application/x-font-ttf, font/opentype
backend_compress	0	only 0 or 1 accepted	only 0 or 1 accepted \| Enables us to cache, from origin, GZip compressed versions of your files for the following file types: text/plain, text/html, text/javascript, text/css, text/xml, application/javascript, application/x-javascript, application/xml, text/x-component, application/json, application/xhtml+xml, application/rss+xml, application/atom+xml, app/vnd.ms-fontobject, image/svg+xml, application/x-font-ttf, font/opentype
queries	0	only 0 or 1 accepted	Treat Query Strings as a separate cacheable item
set_host_header	-	length: 4-100 chars; only valid URLs accepted	The URL to send as the Host in all HTTP Response Headers
cache_valid	1d	length: 1-30 chars; must be a number followed by one of s, m, h, d, M, or Y	Ignore the origin Cache-Control Header and set every request to have a Max-Age of 1d, 7d, 1M or 12M
ignore_setcookie_header	0	only 0 or 1 accepted	Ignore any cookies set by the origin in order to make the content consistently cacheable
ignore_cache_control	0	only 0 or 1 accepted	Ignore any max age values set by the origin and use the CDN set value instead
use_stale	0	only 0 or 1 accepted	Serve expired content while fetching new content. This will also cause the CDN to serve expired content in cases where the origin is down
proxy_cache_lock	0	only 0 or 1 accepted	When multiple requests for an uncached file are received, they will wait until the first response is received rather than sending each request back to the origin
label	-	length: 1-255 chars	Something that describes your zone
valid_referers	-	length: 1-100 chars	List of domains for http referrer protection (separated by space), only the domains in the list will be treated as valid referrers
expires	1d	length: 1-32 chars	Set any request with a no "Cache-Control header" from the origin to stay on the server. Possible values are 1d, 7d, 1M, 12M
disallow_robots	0	only 0 or 1 accepted	Enable robots.txt
disallow_robots_txt	-	length 1-255 chars	Use custom robots.txt
canonical_link_headers	1	only 0 or 1 accepted	Pass the canonical URL in the Link HTTP Header
content_disposition	0	only 0 or 1 accepted	Force files to download
x_forward_for	0	only 0 or 1 accepted	Add X-Forwarded-For (XFF) HTTP Header
pseudo_streaming	0	only 0 or 1 accepted	Enable the zone for pseudo streaming content
secret	-	length: 1 - 32 chars	Use a secret to protect your files from unwanted visitors
sslshared	0	only 0 or 1 accepted	Use a secret to protect your files from unwanted visitors
secret	-	length: 1 - 32 chars	Enable Shared SSL for your zone, so you can use HTTPS, using our SSL certificate for netdna-ssl.com
spdy	0	only 0 or 1 accepted	Enable SPDY protocol on the zone (requires SSL)

Response Parameters

Parameter	Description
id	Pull Zone ID
name	Pull Zone name
url	Origin URL
port	Port
ip	IP address of the Origin URL
backend_compress	Enables us to cache, from origin, GZip compressed versions of your files for the following file types: text/plain, text/html, text/javascript, text/css, text/xml, application/javascript, application/x-javascript, application/xml, text/x-component, application/json, application/xhtml+xml, application/rss+xml, application/atom+xml, app/vnd.ms-fontobject, image/svg+xml, application/x-font-ttf, font/opentype
queries	Treat Query Strings as a separate cacheable item
set_host_header	The URL sent as the Host in all HTTP Response Headers
cache_valid	Ignore the origin Cache-Control Header and set every request to have a Max-Age of 1d, 7d, 1M or 12M
ignore_setcookie_header	Ignore any cookies set by the origin in order to make the content consistently cacheable
ignore_cache_control	Ignore any max age values set by the origin and use the CDN set value instead
use_stale	Serve expired content while fetching new content. This will also cause the CDN to serve expired content in cases where the origin is down
proxy_cache_lock	When multiple requests for an uncached file are received, they will wait until the first response is received rather than sending each request back to the origin
label	List of domains for http referrer protection (separated by space), only the domains in the list will be treated as valid referrers
expires	Set any request with a no "Cache-Control header" from the origin to stay on the server. Possible values are 1d, 7d, 1M, 12M
disallow_robots	Enable robots.txt
disallow_robots_txt	Use custom robots.txt
canonical_link_headers	Pass the canonical URL in the Link HTTP Header
content_disposition	Force files to download
x_forward_for	Add X-Forwarded-For (XFF) HTTP Header
pseudo_streaming	Enable the zone for pseudo streaming content
sslshared	Enable Shared SSL for your zone, so you can use HTTPS, using our SSL certificate for netdna-ssl.com
suspend	Flag denoting if the zone has been suspended
locked	Flag denoting if the zone has been locked
inactive	Flag denoting if the zone has been deleted
creation_date	Date Created
spdy	Flag denoting if the zone has the SPDY protocol enabled

Code Samples

+params = {"name"=>"newPullZone6","url"=>"http://somedomain.com"}
+api.post('/clients/{id}/zones/pull.json',params)

+params = {"name":"newPullZone5","url":"http://somedomain.net"}
+api.post('/clients/{id}/zones/pull.json',data=params)

+$params =  array("name"=>"newPullZone2","url"=>"http://somedomain.net");
+$api->post('/clients/{id}/zones/pull.json',$params);

+api.post('/clients/{id}/zones/pull.json', { name: 'newPullZone2', url: 'http://somedomain.net' }, function(err, response) {
+  console.log('err', err, 'response', response)
+})

+{
+    "code": 201,
+    "data": {
+        "pullzone": {
+            "backend_compress": 0,
+            "cache_valid": "1d",
+            "canonical_link_headers": 1,
+            "cdn_url": "newpullzone3.alias.netdna-cdn.com",
+            "compress": 0,
+            "content_disposition": 0,
+            "creation_date": "2013-05-24 16:18:19",
+            "disallow_robots": 0,
+            "disallow_robots_txt": null,
+            "dns_check": 0,
+            "expires": null,
+            "hide_setcookie_header": 0,
+            "id": 97312,
+            "ignore_cache_control": 0,
+            "ignore_setcookie_header": 0,
+            "inactive": 0,
+            "ip": "205.134.255.49",
+            "label": null,
+            "locked": 0,
+            "name": "newpullzone3",
+            "port": 80,
+            "proxy_cache_lock": 0,
+            "pseudo_streaming": 0,
+            "queries": "1",
+            "server_id": "18",
+            "set_host_header": 1,
+            "sslshared": null,
+            "suspend": 0,
+            "tmp_url": "newpullzone3.alias.netdna-cdn.com",
+            "type": 2,
+            "upstream_enabled": 0,
+            "url": "http://somedomain.net",
+            "use_stale": 0,
+            "x_forward_for": 0,
+            "valid_referers": null,
+            "spdy": 1
+        }
+    }
+}

Get Pull Zones Count

Counts all pull zones on the specified account

GET +https://rws.maxcdn.com/{companyalias}/clients/{id}/zones/pull.json/count

Response Parameters

Parameter	Description
count	The number of pull zones on the specified account ID

Code Samples

+api.get('/clients/{id}/zones/pull.json/count')

+api.get('/clients/{id}/zones/pull.json/count')

+$api->get('/clients/{id}/zones/pull.json/count');

+api.get('/clients/{id}/zones/pull.json/count', function(err, response) {
+  console.log('err', err, 'response', response)
+})

+{
+  "code":200,"data":
+    {
+      "count": "3"
+    }
+}

Get Pull Zone

Gets a pull zone specified by the {zone_id} parameter

GET +https://rws.maxcdn.com/{companyalias}/clients/{id}/zones/pull.json/{zone_id}

Response Parameters

Parameter	Description
id	Pull Zone ID
name	Pull Zone name
url	Origin URL
port	Port
ip	IP address of the Origin URL
backend_compress	Enables us to cache, from origin, GZip compressed versions of your files for the following file types: text/plain, text/html, text/javascript, text/css, text/xml, application/javascript, application/x-javascript, application/xml, text/x-component, application/json, application/xhtml+xml, application/rss+xml, application/atom+xml, app/vnd.ms-fontobject, image/svg+xml, application/x-font-ttf, font/opentype
queries	Treat Query Strings as a separate cacheable item
set_host_header	The URL sent as the Host in all HTTP Response Headers
cache_valid	Ignore the origin Cache-Control Header and set every request to have a Max-Age of 1d, 7d, 1M or 12M
ignore_setcookie_header	Ignore any cookies set by the origin in order to make the content consistently cacheable
ignore_cache_control	Ignore any max age values set by the origin and use the CDN set value instead
use_stale	Serve expired content while fetching new content. This will also cause the CDN to serve expired content in cases where the origin is down
proxy_cache_lock	When multiple requests for an uncached file are received, they will wait until the first response is received rather than sending each request back to the origin
label	List of domains for http referrer protection (separated by space), only the domains in the list will be treated as valid referrers
expires	Set any request with a no "Cache-Control header" from the origin to stay on the server. Possible values are 1d, 7d, 1M, 12M
disallow_robots	Enable robots.txt
disallow_robots_txt	Use custom robots.txt
canonical_link_headers	Pass the canonical URL in the Link HTTP Header
content_disposition	Force files to download
x_forward_for	Add X-Forwarded-For (XFF) HTTP Header
pseudo_streaming	Enable the zone for pseudo streaming content
sslshared	Enable Shared SSL for your zone, so you can use HTTPS, using our SSL certificate for netdna-ssl.com
suspend	Flag denoting if the zone has been suspended
locked	Flag denoting if the zone has been locked
inactive	Flag denoting if the zone has been deleted
creation_date	Date Created
spdy	Flag denoting if the zone has the SPDY protocol enabled

Code Samples

+id = '97167'
+api.get('/clients/{id}/zones/pull.json/'+id)

+id = '97167'
+api.get('/clients/{id}/zones/pull.json/'+id)

+$id = '96076';
+$api->get('/clients/{id}/zones/pull.json/'.$id);

+var id = '96076'
+api.get('/clients/{id}/zones/pull.json' + id, function(err, response) {
+  console.log('err', err, 'response', response)
+})

+{
+    "code": 200,
+    "data": {
+        "pullzone": {
+            "backend_compress": "0",
+            "cache_valid": "1d",
+            "canonical_link_headers": "0",
+            "cdn_url": "cdn.somenewdomain.com",
+            "compress": "0",
+            "content_disposition": "0",
+            "creation_date": "2013-05-23 19:38:30",
+            "disallow_robots": "0",
+            "disallow_robots_txt": null,
+            "dns_check": "1",
+            "expires": null,
+            "hide_setcookie_header": "0",
+            "id": "97167",
+            "ignore_cache_control": "0",
+            "ignore_setcookie_header": "0",
+            "inactive": "0",
+            "ip": "205.134.255.49",
+            "label": "Some other description",
+            "locked": "0",
+            "name": "newpullzone2",
+            "port": "80",
+            "proxy_cache_lock": "0",
+            "pseudo_streaming": "0",
+            "queries": "1",
+            "server_id": "18",
+            "set_host_header": null,
+            "sslshared": "0",
+            "suspend": "0",
+            "tmp_url": "newpullzone2.alias.netdna-cdn.com",
+            "type": "2",
+            "upstream_enabled": "0",
+            "url": "http://somedomain.net",
+            "use_stale": "0",
+            "x_forward_for": "0",
+            "valid_referers": null,
+            "spdy": 1
+        }
+    }
+}

Update Pull Zone

Updates a pull zone specified by the {zone_id} parameter

PUT +https://rws.maxcdn.com/{companyalias}/clients/{id}/zones/pull.json/{zone_id}

Accepted Request Parameters

Parameter	Default Value	Validation	Description
name	-	required length: 3-32 chars; only letters, digits, and dash (-)accepted	Pull Zone Name
url	-	required length: 4-100 chars; only valid URLs accepted	Origin URL
port	80	length: 1-5 chars; only digits accepted	Port
dns_check	1	only 0 or 1 accepted	This field determines how your Origin resolves. When set to 1, we automatically grab the origin's IP using DNS. Setting it to 0 allows you explicitly provide the IP of the origin.
ip	-	length: 1-10 chars, only digits accepted	Valid IP address of the Origin URL. Be sure to set `dns_check` to 0 to prevent this value from being overwritten.
compress	-	length: 1-5 chars; only digits accepted	only 0 or 1 accepted \| Enables on the fly GZip compression of your files from our edge servers for the following file types: text/plain, text/html, text/javascript, text/css, text/xml, application/javascript, application/x-javascript, application/xml, text/x-component, application/json, application/xhtml+xml, application/rss+xml, application/atom+xml, app/vnd.ms-fontobject, image/svg+xml, application/x-font-ttf, font/opentype
backend_compress	0	only 0 or 1 accepted	only 0 or 1 accepted \| Enables us to cache, from origin, GZip compressed versions of your files for the following file types: text/plain, text/html, text/javascript, text/css, text/xml, application/javascript, application/x-javascript, application/xml, text/x-component, application/json, application/xhtml+xml, application/rss+xml, application/atom+xml, app/vnd.ms-fontobject, image/svg+xml, application/x-font-ttf, font/opentype
queries	0	only 0 or 1 accepted	Treat Query Strings as a separate cacheable item
set_host_header	-	length: 4-100 chars; only valid URLs accepted	The URL to send as the Host in all HTTP Response Headers
cache_valid	1d	length: 1-30 chars; must be a number followed by one of s, m, h, d, M, or Y	Ignore the origin Cache-Control Header and set every request to have a Max-Age of 1d, 7d, 1M or 12M
ignore_setcookie_header	0	only 0 or 1 accepted	Ignore any cookies set by the origin in order to make the content consistently cacheable
ignore_cache_control	0	only 0 or 1 accepted	Ignore any max age values set by the origin and use the CDN set value instead
use_stale	0	only 0 or 1 accepted	Serve expired content while fetching new content. This will also cause the CDN to serve expired content in cases where the origin is down
proxy_cache_lock	0	only 0 or 1 accepted	When multiple requests for an uncached file are received, they will wait until the first response is received rather than sending each request back to the origin
label	-	length: 1-255 chars	Something that describes your zone
valid_referers	-	length: 1-100 chars	List of domains for http referrer protection (separated by space), only the domains in the list will be treated as valid referrers
expires	1d	length: 1-32 chars	Set any request with a no "Cache-Control header" from the origin to stay on the server. Possible values are 1d, 7d, 1M, 12M
disallow_robots	0	only 0 or 1 accepted	Enable robots.txt
disallow_robots_txt	-	length 1-255 chars	Use custom robots.txt
canonical_link_headers	1	only 0 or 1 accepted	Pass the canonical URL in the Link HTTP Header
content_disposition	0	only 0 or 1 accepted	Force files to download
x_forward_for	0	only 0 or 1 accepted	Add X-Forwarded-For (XFF) HTTP Header
pseudo_streaming	0	only 0 or 1 accepted	Enable the zone for pseudo streaming content
secret	-	length: 1 - 32 chars	Use a secret to protect your files from unwanted visitors
sslshared	0	only 0 or 1 accepted	Use a secret to protect your files from unwanted visitors
secret	-	length: 1 - 32 chars	Enable Shared SSL for your zone, so you can use HTTPS, using our SSL certificate for netdna-ssl.com
spdy	0	only 0 or 1 accepted	Enable SPDY protocol on the zone (requires SSL)

Response Parameters

Parameter	Description
id	Pull Zone ID
name	Pull Zone name
url	Origin URL
port	Port
ip	IP address of the Origin URL
backend_compress	Enables us to cache, from origin, GZip compressed versions of your files for the following file types: text/plain, text/html, text/javascript, text/css, text/xml, application/javascript, application/x-javascript, application/xml, text/x-component, application/json, application/xhtml+xml, application/rss+xml, application/atom+xml, app/vnd.ms-fontobject, image/svg+xml, application/x-font-ttf, font/opentype
queries	Treat Query Strings as a separate cacheable item
set_host_header	The URL sent as the Host in all HTTP Response Headers
cache_valid	Ignore the origin Cache-Control Header and set every request to have a Max-Age of 1d, 7d, 1M or 12M
ignore_setcookie_header	Ignore any cookies set by the origin in order to make the content consistently cacheable
ignore_cache_control	Ignore any max age values set by the origin and use the CDN set value instead
use_stale	Serve expired content while fetching new content. This will also cause the CDN to serve expired content in cases where the origin is down
proxy_cache_lock	When multiple requests for an uncached file are received, they will wait until the first response is received rather than sending each request back to the origin
label	List of domains for http referrer protection (separated by space), only the domains in the list will be treated as valid referrers
expires	Set any request with a no "Cache-Control header" from the origin to stay on the server. Possible values are 1d, 7d, 1M, 12M
disallow_robots	Enable robots.txt
disallow_robots_txt	Use custom robots.txt
canonical_link_headers	Pass the canonical URL in the Link HTTP Header
content_disposition	Force files to download
x_forward_for	Add X-Forwarded-For (XFF) HTTP Header
pseudo_streaming	Enable the zone for pseudo streaming content
sslshared	Enable Shared SSL for your zone, so you can use HTTPS, using our SSL certificate for netdna-ssl.com
suspend	Flag denoting if the zone has been suspended
locked	Flag denoting if the zone has been locked
inactive	Flag denoting if the zone has been deleted
creation_date	Date Created
spdy	Flag denoting if the zone has the SPDY protocol enabled

Code Samples

+id = '97167'
+params = {"label"=>"Some other description"}
+api.put('/clients/{id}/zones/pull.json/'+id,params)

+id = '97167'
+params = {"label":"Some other description"}
+api.put('/clients/{id}/zones/pull.json/'+id,params=params)

+$id = '96167';
+$params = array("label"=>"Some other description");
+$api->put('/clients/{id}/zones/pull.json/'.$id, $params);

+var id = '96167'
+api.put('/clients/{id}/zones/pull.json' + id, { label: 'Some other description' }, function(err, response) {
+  console.log('err', err, 'response', response)
+})

+{
+    "code": 200,
+    "data": {
+        "pullzone": {
+            "backend_compress": "0",
+            "cache_valid": "1d",
+            "canonical_link_headers": "0",
+            "cdn_url": "cdn.somenewdomain.com",
+            "compress": "0",
+            "content_disposition": "0",
+            "creation_date": "2013-05-23 19:38:30",
+            "disallow_robots": "0",
+            "disallow_robots_txt": null,
+            "dns_check": "1",
+            "expires": null,
+            "hide_setcookie_header": "0",
+            "id": "97167",
+            "ignore_cache_control": "0",
+            "ignore_setcookie_header": "0",
+            "inactive": "0",
+            "ip": "205.134.255.49",
+            "label": "Some other description",
+            "locked": "0",
+            "name": "newpullzone2",
+            "port": "80",
+            "proxy_cache_lock": "0",
+            "pseudo_streaming": "0",
+            "queries": "1",
+            "server_id": "18",
+            "set_host_header": null,
+            "sslshared": "0",
+            "suspend": "0",
+            "tmp_url": "newpullzone2.alias.netdna-cdn.com",
+            "type": "2",
+            "upstream_enabled": "0",
+            "url": "http://somedomain.net",
+            "use_stale": "0",
+            "x_forward_for": "0",
+            "valid_referers": null,
+            "spdy": 1
+        }
+    }
+}

Delete Pull Zone

Deletes a pull zone specified by the {zone_id} parameter

DELETE +https://rws.maxcdn.com/{companyalias}/clients/{id}/zones/pull.json/{zone_id}

Code Samples

+id = '97167'
+api.delete('/clients/{id}/zones/pull.json/'+id)

+id = '97167'
+api.delete('/clients/{id}/zones/pull.json/'+id)

+$id = '97167';
+$api->delete('/clients/{id}/zones/pull.json/'.$id);

+var id = '97167'
+api.delete('/clients/{id}/zones/pull.json' + id, function(err, response) {
+  console.log('err', err, 'response', response)
+})

+{
+  "code":200
+}

Enable Pull Zone

Enables a pull zone specified by the {zone_id} parameter

PUT +https://rws.maxcdn.com/{companyalias}/clients/{id}/zones/pull/{zone_id}/enable.json

Code Samples

+id = '97167'
+api.put('/clients/{id}/zones/pull/'+id+'/enable.json')

+id = '97167'
+api.put('/clients/{id}/zones/pull/'+id+'/enable.json')

+$id = '97167';
+$api->put('/clients/{id}/zones/pull/'.$id.'/enable.json');

+var id = '97167'
+api.put('/clients/{id}/zones/pull/' + id + '/enable.json', function(err, response) {
+  console.log('err', err, 'response', response)
+})

+{
+  "code":200
+}
+

Disable Pull Zone

Disables a pull zone specified by the {zone_id} parameter

PUT +https://rws.maxcdn.com/{companyalias}/clients/{id}/zones/pull/{zone_id}/disable.json

Code Samples

+id = '97167'
+api.put('/clients/{id}/zones/pull/'+id+'/disable.json')

+id = '97167'
+api.put('/clients/{id}/zones/pull/'+id+'/disable.json')

+$id = '97167';
+$api->put('/clients/{id}/zones/pull'.$id.'disable.json);

+var id = '97167'
+api.put('/clients/{id}/zones/pull' + id + 'disable.json', function(err, response) {
+  console.log('err', err, 'response', response)
+})

+{
+  "code":200
+}

Purge Cache

Purges pull zone cache

DELETE +https://rws.maxcdn.com/{companyalias}/clients/{id}/zones/pull.json/{zone_id}/cache

Accepted Request Parameters

Parameter	Default Value	Validation	Description
files	-	-	An array containing relative paths of the files to purge (i.e./favicon.ico)

Code Samples

+#Purge Zone
+id = '97167'
+api.purge(id)
+
+#Purge File
+id = '97167'
+api.purge(id,'/file1.txt')
+
+#Purge Files
+id = '97167'
+api.purge(id, ['/file1.txt','/file2.txt'])

+#Purge Zone
+id = '97167'
+api.purge(id)
+
+#Purge File
+id = '97167'
+api.purge(id,'/file1.txt')
+
+#Purge Files
+id = '97167'
+api.purge(id, ['/file1.txt','/file2.txt'])

+//Purge Zone
+$id = '97792';
+$api->delete('/clients/{id}/zones/pull.json/'.$id.'/cache');
+
+//Purge File
+$id = '97792';
+$params = array('file'=>'/index.html');
+$api->delete('/clients/{id}/zones/pull.json/'.$id.'/cache',$params);
+
+//Purge Files
+$id = '97792';
+$params = array(
+    'files' => array(
+        '/file1.txt',
+        '/file2.txt'
+    )
+);
+$api->delete('/clients/{id}/zones/pull.json/'.$id.'/cache',$params);

+// Purge Zone
+var id = '96167'
+api.delete('/clients/{id}/zones/pull.json/' + id + '/cache', callback)
+function callback(err, response) {
+  if (err) return console.log(err)
+  console.log(response)
+}
+
+// Purge File
+var id = '96167'
+var file = '/file1.txt'
+api.delete('/clients/{id}/zones/pull.json/' + id + '/cache', file, callback)
+function callback(err, response) {
+  if (err) return console.log(err)
+  console.log(response)
+}
+
+// Purge File
+var id = '96167'
+var files = [ '/file1.txt', '/file2.txt' ]
+api.delete('/clients/{id}/zones/pull.json/' + id + '/cache', files, callback)
+function callback(err, response) {
+  if (err) return console.log(err)
+  console.log(response)
+}

+{
+    "code": 200
+}

Pull Zone Custom Domains API

List Custom Domains

Returns a list of all custom domains on the zone specified by +{zone_id}

GET +https://rws.maxcdn.com/{companyalias}/clients/{id}/zones/pull/{zone_id}/customdomains.json

Response Parameters

Parameter	Description
id	The id of the custom domain
bucket_id	The id of the zone the custom domain belongs to
custom_domain	A valid custom domain

Code Samples

+id = '97167'
+api.get('/clients/{id}/zones/pull/'+id+'/customdomains.json')

+id = '97167'
+api.get('/clients/{id}/zones/pull/'+id+'/customdomains.json')

+$id = '96061';
+$api->get('/clients/{id}/zones/pull/'.$id.'/customdomains.json');

+var id = '96061'
+api.get('/clients/{id}/zones/pull/' + id + '/customdomains.json', function(err, response) {
+  console.log('err', err, 'response', response)
+})

+{
+    "code": 200,
+    "data": {
+        "customdomains": [
+            {
+                "bucket_id": "97167",
+                "custom_domain": "cdn.somenewdomain.com",
+                "id": "79182",
+                "type": null
+            }
+        ],
+        "total": 1
+    }
+}

Create Custom Domain

Adds a new custom domain to {zone_id}

POST +https://rws.maxcdn.com/{companyalias}/clients/{id}/zones/pull/{zone_id}/customdomains.json

Accepted Request Parameters

Response Parameters

Parameter	Default Value	Validation	Description
custom_domain	-	required length: 5-30 chars	A valid custom domain

Parameter	Description
id	The id of the custom domain
bucket_id	The id of the zone the custom domain belongs to
custom_domain	The valid custom domain

Code Samples

+id = '97793'
+params = {"custom_domain"=>"cdn.somedomain19.com"}
+api.post('/clients/{id}/zones/pull/'+id+'/customdomains.json', params)

+id = '96182'
+params = {"custom_domain":"cdn.somedomain15.com"}
+api.post('/clients/{id}/zones/pull/'+id+'/customdomains.json', params)

+$id = '97181';
+$params = array("custom_domain"=>"cdn.somedomain2.net");
+$api->post('/clients/{id}/zones/pull/'.$id.'/customdomains.json', $params);

+var id = '97181'
+api.post('/clients/{id}/zones/pull/' + id + '/customdomains.json', { custom_domain: 'cdn.somedomain2.net' }, function(err, response) {
+  console.log('err', err, 'response', response)
+})

+{
+    "code": 201,
+    "data": {
+        "customdomain": {
+            "bucket_id": "97181",
+            "custom_domain": "cdn.somedomain4.net",
+            "id": 79283,
+        }
+    }
+}
+

Get Custom Domain

Gets a custom domain specified by the {zone_id} and +{customdomain_id} parameters

GET +https://rws.maxcdn.com/{companyalias}/clients/{id}/zones/pull/{zone_id}/customdomains.json/{customdomain_id}

Response Parameters

Parameter	Description
id	The id of the custom domain
bucket_id	The id of the zone the custom domain belongs to
custom_domain	The valid custom domain

Code Samples

+zoneId = '97167'
+domainId = '79182'
+api.get('/clients/{id}/zones/pull/'+zoneId+'/customdomains.json/'+domainId)

+zoneId = '97167'
+domainId = '79182'
+api.get('/clients/{id}/zones/pull/'+zoneId+'/customdomains.json/'+domainId)

+$zoneId = '97167';
+$domainId = '79182';
+$api->get('/clients/{id}/zones/pull/'.$zoneId.'/customdomains.json/'.$domainId);

+var id = '97167'
+var domainId = '79182'
+api.get('/clients/{id}/zones/pull/' + id + '/customdomains.json/' + domainId, function(err, response) {
+  console.log('err', err, 'response', response)
+})

+{
+    "code": 200,
+    "data": {
+        "customdomain": {
+            "bucket_id": "97167",
+            "custom_domain": "cdn.somenewdomain.com",
+            "id": "79182",
+            "type": null
+        }
+    }
+}
+

Update Custom Domain

Updates a custom domain specified by the id parameter

PUT +https://rws.maxcdn.com/{companyalias}/clients/{id}/zones/pull/{zone_id}/customdomains.json/{customdomain_id}

Accepted Request Parameters

Parameter	Default Value	Validation	Description
custom_domain	-	required length: 1-255 chars, valid: custom_domain, not valid: full_domain	A new valid custom domain

Response Parameters

Parameter	Description
id	The id of the custom domain
bucket_id	The id of the zone the custom domain belongs to
custom_domain	The new valid custom domain

Code Samples

+zoneId = '97167'
+domainId = '79182'
+params = {"custom_domain"=>"cdn.somenewdomain41.com"}
+api.put('/clients/{id}/zones/pull/'+zoneId+'/customdomains.json/'+domainId,params)

+zoneId = '97167'
+domainId = '79182'
+params = {"custom_domain":"cdn.somenewdomain41.com"}
+api.put('/clients/{id}/zones/pull/'+zoneId+'/customdomains.json/'+domainId,params=params)

+$zoneId = '97167';
+$domainId = '79182';
+$params = array("custom_domain"=>"cdn.somenewdomain.com");
+$api->put('/clients/{id}/zones/pull/'.$zoneId.'/customdomains.json/'.$domainId, $params);

+var zoneId = '97167'
+var domainId = '79182'
+api.put('/clients/{id}/zones/pull/' + zoneId + '/customdomains.json/' + domainId, { custom_domain: 'cdn.somenewdomain.com' }, function(err, response) {
+  console.log('err', err, 'response', response)
+})

+{
+    "code": 200,
+    "data": {
+        "customdomain": {
+            "bucket_id": "97167",
+            "custom_domain": "cdn.somenewdomain4.com",
+            "id": "79182",
+            "type": null
+        }
+    }
+}

Delete Custom Domain

Deletes a custom domain specified by the {zone_id} and +{customdomain_id} parameters

DELETE +https://rws.maxcdn.com/{companyalias}/clients/{id}/zones/pull/{zone_id}/customdomains.json/{customdomain_id}

Code Samples

+zoneId = '97167'
+domainId = '79182'
+api.delete('/clients/{id}/zones/pull/'+zoneId+'/customdomains.json/'+domainId)

+zoneId = '97167'
+domainId = '79182'
+api.delete('/clients/{id}/zones/pull/'+zoneId+'/customdomains.json/'+domainId)

+$zoneId = '97167';
+$domainId = '79182';
+$api->delete('/clients/{id}/zones/pull/'.$zoneId.'/customdomains.json/'.$domainId);

+var zoneId = '97167'
+var domainId = '79182'
+api.delete('/clients/{id}/zones/pull/' + zoneId + '/customdomains.json/' + domainId, function(err, response) {
+  console.log('err', err, 'response', response)
+})

+{
+  "code":200
+}

Push Zone API

GET +https://rws.maxcdn.com/{companyalias}/clients/{id}/zones/push.json

Response Parameters

Parameter	Description
id	Push Zone ID
name	Push Zone name
label	Something that describes your zone
valid_referers	List of domains for http referrer protection (separated by space), only the domains in the list will be treated as valid referrers
content_disposition	Force files to download
sslshared	Enable Shared SSL for your zone, so you can use HTTPS, using our SSL certificate for netdna-ssl.com
suspend	Flag denoting if the zone has been suspended
locked	Flag denoting if the zone has been locked
inactive	Flag denoting if the zone has been deleted
creation_date	Date Created
spdy	Flag denoting if the zone has the SPDY protocol enabled

Code Samples

+api.get('/clients/{id}/zones/push.json')

+api.get('/clients/{id}/zones/push.json')

+$api->get('/clients/{id}/zones/push.json');

+api.get('/clients/{id}/zones/push.json', function(err, response) {
+  console.log('err', err, 'response', response)
+})

+{
+    "code": 200,
+    "data": {
+        "current_page_size": 2,
+        "page": 1,
+        "page_size": "50",
+        "pages": 1,
+        "pushzones": [
+            {
+                "cdn_url": "cdn.somedomain.net",
+                "compress": "0",
+                "content_disposition": "0",
+                "creation_date": "2013-05-16 15:25:19",
+                "expires": null,
+                "ftp_url": "ftp.newpushzone2.alias.netdna-cdn.com",
+                "id": "96182",
+                "inactive": "0",
+                "label": null,
+                "locked": "0",
+                "name": "newpushzone2",
+                "server_id": "11",
+                "sslshared": "0",
+                "storage_updated": "2013-05-24 06:31:52",
+                "storage_used": "20480",
+                "suspend": "0",
+                "tmp_url": "newpushzone2.alias.netdna-cdn.com",
+                "type": "3",
+                "valid_referers": null,
+                "spdy": 1
+            },
+            {
+                "cdn_url": "cdn.somenewdomain2.com",
+                "compress": "0",
+                "content_disposition": "0",
+                "creation_date": "2013-05-23 21:01:39",
+                "expires": null,
+                "ftp_url": "ftp.newpushzone3.alias.netdna-cdn.com",
+                "id": "97181",
+                "inactive": "0",
+                "label": "Some other description",
+                "locked": "0",
+                "name": "newpushzone3",
+                "server_id": "11",
+                "sslshared": "0",
+                "storage_updated": "2013-05-24 06:31:52",
+                "storage_used": "20480",
+                "suspend": "0",
+                "tmp_url": "newpushzone3.alias.netdna-cdn.com",
+                "type": "3",
+                "valid_referers": null,
+                "spdy": 0
+            }
+        ],
+        "total": 2
+    }
+}

Create Push Zone

Creates a new push zone

POST +https://rws.maxcdn.com/{companyalias}/clients/{id}/zones/push.json

Accepted Request Parameters

Parameter	Default Value	Validation	Description
name	-	required length: 3-30 chars; only letters, digits, and dash (-) accepted	Push Zone name
password	-	required length: 5-30 chars	Password
label	-	length: 1-255 chars	Something that describes your zone
valid_referers	-	length: 1-200 chars	List of domains for http referrer protection (separated by space), only the domains in the list will be treated as valid referrers
content_disposition	0	length: 1-200 chars	List of domains for http referrer protection (separated by space), only the domains in the list will be treated as valid referrers
sslshared	0	only 0 or 1 accepted	Enable Shared SSL for your zone, so you can use HTTPS, using our SSL certificate for netdna-ssl.com
spdy	0	only 0 or 1 accepted	Enable SPDY protocol on the zone (requires SSL)

Response Parameters

Parameter	Description
id	Push Zone ID
name	Push Zone name
label	Something that describes your zone
valid_referers	List of domains for http referrer protection (separated by space), only the domains in the list will be treated as valid referrers
content_disposition	Force files to download
sslshared	Enable Shared SSL for your zone, so you can use HTTPS, using our SSL certificate for netdna-ssl.com
suspend	Flag denoting if the zone has been suspended
locked	Flag denoting if the zone has been locked
inactive	Flag denoting if the zone has been deleted
creation_date	Date Created
spdy	Flag denoting if the zone has the SPDY protocol enabled

Code Samples

+params = {"name"=>"newPushZone99","password"=>"password"}
+api.post('/clients/{id}/zones/push.json',params)

+params = {"name":"newPushZone6","password":"password"}
+api.post('/clients/{id}/zones/push.json',data=params)

+$params = array("name"=>"newPushZone","password"=>"password");
+$api->post('/clients/{id}/zones/push.json', $params);

+api.post('/clients/{id}/zones/push.json', { name: 'newPushZone', password: 'password' }, function(err, response) {
+  console.log('err', err, 'response', response)
+})

+{
+    "code": 201,
+    "data": {
+        "pushzone": {
+            "cdn_url": "newpushzone4.alias.netdna-cdn.com",
+            "compress": 0,
+            "content_disposition": 0,
+            "creation_date": "2013-05-24 16:41:53",
+            "expires": null,
+            "ftp_url": "ftp.newpushzone4.alias.netdna-cdn.com",
+            "id": 97317,
+            "inactive": 0,
+            "label": null,
+            "locked": 0,
+            "name": "newpushzone4",
+            "server_id": "11",
+            "sslshared": null,
+            "storage_updated": null,
+            "storage_used": null,
+            "suspend": 0,
+            "tmp_url": "newpushzone4.alias.netdna-cdn.com",
+            "type": 3,
+            "valid_referers": null,
+            "spdy": 1
+        }
+    }
+}

Get Push Zones Count

Counts all push zones on the specified account

GET +https://rws.maxcdn.com/{companyalias}/clients/{id}/zones/push.json/count

Response Parameters

Parameter	Description
count	The number of push zones on the specified account

Code Samples

+api.get('/clients/{id}/zones/push.json/count')

+api.get('/clients/{id}/zones/push.json/count')

+$api->get('/clients/{id}/zones/push.json/count');

+api.get('/clients/{id}/zones/push.json/count', function(err, response) {
+  console.log('err', err, 'response', response)
+})

+{
+    "code": 200,
+    "data": {
+        "count": "3"
+    }
+}
+

GET +https://rws.maxcdn.com/{companyalias}/clients/{id}/zones/push.json/{zone_id}

Response Parameters

Parameter	Description
id	Push Zone ID
name	Push Zone name
label	Something that describes your zone
valid_referers	List of domains for http referrer protection (separated by space), only the domains in the list will be treated as valid referrers
content_disposition	Force files to download
sslshared	Enable Shared SSL for your zone, so you can use HTTPS, using our SSL certificate for netdna-ssl.com
suspend	Flag denoting if the zone has been suspended
locked	Flag denoting if the zone has been locked
inactive	Flag denoting if the zone has been deleted
creation_date	Date Created
spdy	Flag denoting if the zone has the SPDY protocol enabled

Code Samples

+id = '97793'
+api.get('/clients/{id}/zones/push.json/'+id)

+id = '96182'
+api.get('/clients/{id}/zones/push.json/'+id)

+$id = '97181';
+$api->get('/clients/{id}/zones/push.json/'.$id);

+var id = '97182'
+api.get('/clients/{id}/zones/push.json/' + id, function(err, response) {
+  console.log('err', err, 'response', response)
+})

+{
+    "code": 200,
+    "data": {
+        "pushzone": {
+            "cdn_url": "cdn.somenewdomain2.com",
+            "compress": "0",
+            "content_disposition": "0",
+            "creation_date": "2013-05-23 21:01:39",
+            "expires": null,
+            "ftp_url": "ftp.newpushzone3.alias.netdna-cdn.com",
+            "id": "97181",
+            "inactive": "0",
+            "label": "Some other description",
+            "locked": "0",
+            "name": "newpushzone3",
+            "server_id": "11",
+            "sslshared": "0",
+            "storage_updated": "2013-05-24 06:31:52",
+            "storage_used": "20480",
+            "suspend": "0",
+            "tmp_url": "newpushzone3.alias.netdna-cdn.com",
+            "type": "3",
+            "valid_referers": null,
+            "spdy": 1
+        }
+    }
+}

Update Push Zone

Updates a push zone specified by the {zone_id} parameter

PUT +https://rws.maxcdn.com/{companyalias}/clients/{id}/zones/push.json/{zone_id}

Accepted Request Parameters

Parameter	Default Value	Validation	Description
label	-	required length: 1-255 chars	Something that describes your zone
valid_referers	-	required length: 1-100 chars	List of domains for http referrer protection (separated by space), only the domains in the list will be treated as valid referrers
content_disposition	0	only 0 or 1 accepted	Force files to download
sslshared	0	only 0 or 1 accepted	Enable Shared SSL for your zone, so you can use HTTPS, using our SSL certificate for netdna-ssl.com
spdy	0	only 0 or 1 accepted	Enable SPDY protocol on the zone (requires SSL

Response Parameters

Parameter	Description
id	Push Zone ID
name	Push Zone name
label	Something that describes your zone
valid_referers	List of domains for http referrer protection (separated by space), only the domains in the list will be treated as valid referrers
content_disposition	Force files to download
sslshared	Enable Shared SSL for your zone, so you can use HTTPS, using our SSL certificate for netdna-ssl.com
suspend	Flag denoting if the zone has been suspended
locked	Flag denoting if the zone has been locked
inactive	Flag denoting if the zone has been deleted
creation_date	Date Created
spdy	Flag denoting if the zone has the SPDY protocol enabled

Code Samples

+id = '97793'
+params = {"label"=>"Some other description"}
+api.put('/clients/{id}/zones/push.json/'+id,params)

+id = '96182'
+params = {"label":"Some other description"}
+api.put('/clients/{id}/zones/push.json/'+id,params=params)

+$id = '97181';
+$params = array("label"=>"Some other description");
+$api->put('/clients/{id}/zones/push.json/'.$id, $params);

+var id = '97182'
+api.get('/clients/{id}/zones/push.json/' + id, { label: 'Some other description' }, function(err, response) {
+  console.log('err', err, 'response', response)
+})

+{
+    "code": 200,
+    "data": {
+        "pushzone": {
+            "cdn_url": "cdn.somenewdomain2.com",
+            "compress": "0",
+            "content_disposition": "0",
+            "creation_date": "2013-05-23 21:01:39",
+            "expires": null,
+            "ftp_url": "ftp.newpushzone3.alias.netdna-cdn.com",
+            "id": "97181",
+            "inactive": "0",
+            "label": "Some other description",
+            "locked": "0",
+            "name": "newpushzone3",
+            "server_id": "11",
+            "sslshared": "0",
+            "storage_updated": "2013-05-24 06:31:52",
+            "storage_used": "20480",
+            "suspend": "0",
+            "tmp_url": "newpushzone3.alias.netdna-cdn.com",
+            "type": "3",
+            "valid_referers": null,
+            "spdy": 1
+        }
+    }
+}

Delete Push Zone

Deletes a push zone specified by the {zone_id} parameter

DELETE +https://rws.maxcdn.com/{companyalias}/clients/{id}/zones/push.json/{zone_id}

Code Samples

+id = '97793'
+api.delete('/clients/{id}/zones/push.json/'+id)

+id = '96182'
+api.delete('/clients/{id}/zones/push.json/'+id)

+$id = '97181';
+$api->delete('/clients/{id}/zones/push.json/'.$id);

+var id = '97181'
+api.delete('/clients/{id}/zones/push.json/' + id, function(err, response) {
+  console.log('err', err, 'response', response)
+})

+{
+  "code":200
+}

Enable Push Zone

Enables a push zone specified by the {zone_id} parameter

PUT +https://rws.maxcdn.com/{companyalias}/clients/{id}/zones/push/{zone_id}/enable.json

Code Samples

+id = '97793'
+api.put('/clients/{id}/zones/push/'+id+'/enable.json')

+id = '96182'
+api.put('/clients/{id}/zones/push/'+id+'/enable.json')

+$id = '97181';
+$api->put('/clients/{id}/zones/push/'.$id.'/enable.json');

+var id = '97181'
+api.put('/clients/{id}/zones/push/' + id + '/enable.json', function(err, response) {
+  console.log('err', err, 'response', response)
+})

+{
+  "code":200
+}

Disable Push Zone

Disables a push zone specified by the {zone_id} parameter

PUT +https://rws.maxcdn.com/{companyalias}/clients/{id}/zones/push/{zone_id}/disable.json

Code Samples

+id = '97793'
+api.put('/clients/{id}/zones/push/'+id+'/disable.json')

+id = '96182'
+api.put('/clients/{id}/zones/push/'+id+'/disable.json')

+$id = '97181';
+$api->put('/clients/{id}/zones/push/'.$id.'/disable.json');

+var id = '97181'
+api.put('/clients/{id}/zones/push/' + id + '/disable.json', function(err, response) {
+  console.log('err', err, 'response', response)
+})

+{
+  "code":200
+}

Push Zone Custom Domains API

List Custom Domains

Returns a list of all custom domains on the zone specified by +{zone_id}

GET +https://rws.maxcdn.com/{companyalias}/clients/{id}/zones/push/{zone_id}/customdomains.json

Response Parameters

Parameter	Description
id	Push Zone ID
bucket_id	The id of the zone the custom domain belongs to
custom_domain	A valid custom domain

Code Samples

+id = '97793'
+api.get('/clients/{id}/zones/push/'+id+'/customdomains.json')

+id = '96182'
+api.get('/clients/{id}/zones/push/'+id+'/customdomains.json')

+$id = '96061';
+$api->get('/clients/{id}/zones/push/'.$id.'/customdomains.json');

+var id = '96061'
+api.get('/clients/{id}/zones/push/' + id + '/customdomains.json', function(err, response) {
+  console.log('err', err, 'response', response)
+})

+{
+    "code": 200,
+    "data": {
+        "customdomains": [
+            {
+                "bucket_id": "96061",
+                "custom_domain": "cdn.somedomain.com",
+                "id": "78330",
+            }
+        ],
+        "total": 1
+    }
+}

Create Custom Domain

Adds a new custom domain to {zone_id}

POST +https://rws.maxcdn.com/{companyalias}/clients/{id}/zones/push/{zone_id}/customdomains.json

Accepted Request Parameters

Parameter	Default Value	Validation	Description
custom_domain	-	required length: 1-255 chars, valid: custom_domain, not valid: full_domain	A valid custom domain

Response Parameters

Parameter	Description
id	Push Zone ID
bucket_id	The id of the zone the custom domain belongs to
custom_domain	A valid custom domain

Code Samples

+id = '97793'
+params = {"custom_domain"=>"cdn.somedomain19.com"}
+api.post('/clients/{id}/zones/push/'+id+'/customdomains.json', params)

+id = '96182'
+params = {"custom_domain":"cdn.somedomain15.com"}
+api.post('/clients/{id}/zones/push/'+id+'/customdomains.json', params)

+$id = '97181';
+$params = array("custom_domain"=>"cdn.somedomain2.net");
+$api->post('/clients/{id}/zones/push/'.$id.'/customdomains.json', $params);

+var id = '97181'
+api.post('/clients/{id}/zones/push/' + id + '/customdomains.json', { custom_domain: 'cdn.somedomain2.net' }, function(err, response) {
+  console.log('err', err, 'response', response)
+})

+{
+    "code": 201,
+    "data": {
+        "customdomain": {
+            "bucket_id": "97181",
+            "custom_domain": "cdn.somedomain4.net",
+            "id": 79283,
+            "type": null
+        }
+    }
+}
+

Get Custom Domain

Gets a custom domain specified by the {zone_id} and +{customdomain_id} parameters

GET +https://rws.maxcdn.com/{companyalias}/clients/{id}/zones/push/{zone_id}/customdomains.json/{customdomain_id}

Response Parameters

Parameter	Description
id	Push Zone ID
bucket_id	The id of the zone the custom domain belongs to
custom_domain	A valid custom domain

Code Samples

+zoneId = '97793'
+domainId = '79747'
+api.get('/clients/{id}/zones/push/'+zoneId+'/customdomains.json/'+domainId)

+zoneId = '96182'
+domainId = '79320'
+api.get('/clients/{id}/zones/push/'+zoneId+'/customdomains.json/'+domainId)

+$zoneId = '97181';
+$domainId = '79188';
+$api->get('/clients/{id}/zones/push/'.$zoneId.'/customdomains.json/'.$domainId);

+var zoneId = '97181'
+var domainId = '79188'
+api.get('/clients/{id}/zones/push/' + zoneId + '/customdomains.json/' + domainId, function(err, response) {
+  console.log('err', err, 'response', response)
+})

+{
+    "code": 200,
+    "data": {
+        "customdomain": {
+            "bucket_id": "97181",
+            "custom_domain": "cdn.somenewdomain2.com",
+            "id": "79188",
+            "type": null
+        }
+    }
+}

Update Custom Domain

Updates a custom domain specified by the id parameter

PUT +https://rws.maxcdn.com/{companyalias}/clients/{id}/zones/push/{zone_id}/customdomains.json/{customdomain_id}

Accepted Request Parameters

Parameter	Default Value	Validation	Description
custom_domain	-	required length: 1-255 chars, valid: custom_domain, not valid: full_domain	A valid custom domain

Response Parameters

Parameter	Description
id	Push Zone ID
bucket_id	The id of the zone the custom domain belongs to
custom_domain	A valid custom domain

Code Samples

+zoneId = '97793'
+domainId = '79747'
+params = {"custom_domain"=>"cdn.somenewdomain41.com"}
+api.put('/clients/{id}/zones/push/'+zoneId+'/customdomains.json/'+domainId,params)

+zoneId = '96182'
+domainId = '79320'
+params = {"custom_domain":"cdn.somenewdomain40.com"}
+api.put('/clients/{id}/zones/push/'+zoneId+'/customdomains.json/'+domainId,params=params)

+$zoneId = '97181';
+$domainId = '79188';
+$params = array("custom_domain"=>"cdn.somenewdomain2.com");
+$api->put('/clients/{id}/zones/push/'.$zoneId.'/customdomains.json/'.$domainId, $params);
+

+var zoneId = '97181'
+var domainId = '79188'
+api.put('/clients/{id}/zones/push/' + zoneId + '/customdomains.json/' + domainId, { custom_domain: 'cdn.somenewdomain2.com' }, function(err, response) {
+  console.log('err', err, 'response', response)
+})

+{
+    "code": 200,
+    "data": {
+        "customdomain": {
+            "bucket_id": "97181",
+            "custom_domain": "cdn.somenewdomain12.com",
+            "id": "79188",
+            "type": null
+        }
+    }
+}

Delete Custom Domain

Deletes a custom domain specified by the {zone_id} and +{customdomain_id} parameters

DELETE +https://rws.maxcdn.com/{companyalias}/clients/{id}/zones/push/{zone_id}/customdomains.json/{customdomain_id}

Code Samples

+zoneId = '97793'
+domainId = '79747'
+api.delete('/clients/{id}/zones/push/'+zoneId+'/customdomains.json/'+domainId)

+zoneId = '96182'
+domainId = '79320'
+api.delete('/clients/{id}/zones/push/'+zoneId+'/customdomains.json/'+domainId)

+$zoneId = '97181';
+$domainId = '79188';
+$api->delete('/clients/{id}/zones/push/'.$zoneId.'/customdomains.json/'.$domainId);

+var zoneId = '97181'
+var domainId = '79188'
+api.delete('/clients/{id}/zones/push/' + zoneId + '/customdomains.json/' + domainId, function(err, response) {
+  console.log('err', err, 'response', response)
+})

+{
+  "code":200
+}

VOD Zone API

List VOD Zones

Returns a list of all VOD zones on the specified account

GET +https://rws.maxcdn.com/{companyalias}/clients/{id}/zones/vod.json

Response Parameters

Parameter	Description
id	Push Zone ID
name	Push Zone name
label	Something that describes your zone
suspend	Flag denoting if the zone has been suspended
locked	Flag denoting if the zone has been locked
inactive	Flag denoting if the zone has been deleted
creation_date	Date Created

Code Samples

+api.get('/clients/{id}/zones/vod.json')

+api.get('/clients/{id}/zones/vod.json')

+$api->get('/clients/{id}/zones/vod.json');

+api.get('/clients/{id}/zones/vod.json', function(err, response) {
+  console.log('err', err, 'response', response)
+})

+{
+    "code": 200,
+    "data": {
+        "current_page_size": 2,
+        "page": 1,
+        "page_size": "50",
+        "pages": 1,
+        "total": 2,
+        "vodzones": [
+            {
+                "cdn_url": "cdn.somedomain.com",
+                "creation_date": "2013-05-16 16:02:35",
+                "direct_url": "d.newvodzone.alias.netdna-cdn.com",
+                "ftp_url": "ftp.newvodzone.alias.netdna-cdn.com",
+                "id": "96187",
+                "inactive": "0",
+                "label": null,
+                "locked": "0",
+                "name": "newvodzone",
+                "pseudo_url": "p.newvodzone.alias.netdna-cdn.com",
+                "rtmp_url": "r.newvodzone.alias.netdna-cdn.com",
+                "server_id": "30",
+                "storage_updated": "2013-05-24 06:35:35",
+                "storage_used": "4096",
+                "suspend": "0",
+                "tmp_url": "newvodzone.alias.netdna-cdn.com",
+                "token": null,
+                "type": "4"
+            },
+            {
+                "cdn_url": "cdn.somenewdomain3.com",
+                "creation_date": "2013-05-23 21:25:44",
+                "direct_url": "d.newvodzone3.alias.netdna-cdn.com",
+                "ftp_url": "ftp.newvodzone3.alias.netdna-cdn.com",
+                "id": "97183",
+                "inactive": "0",
+                "label": "Some other description",
+                "locked": "0",
+                "name": "newvodzone3",
+                "pseudo_url": "p.newvodzone3.alias.netdna-cdn.com",
+                "rtmp_url": "r.newvodzone3.alias.netdna-cdn.com",
+                "server_id": "30",
+                "storage_updated": "2013-05-24 06:35:35",
+                "storage_used": "4096",
+                "suspend": "0",
+                "tmp_url": "newvodzone3.alias.netdna-cdn.com",
+                "token": null,
+                "type": "4"
+            }
+        ]
+    }
+}

Create VOD Zone

POST +https://rws.maxcdn.com/{companyalias}/clients/{id}/zones/vod.json

Accepted Request Parameters

Parameter	Default Value	Validation	Description
name	-	required length: 3-30 chars; only letters, digits, and dash (-)accepted	VOD Zone user name
password	-	required length: 5-30 chars	Your desired password
token	-	only 0 or 1 accepted	length: 1-64 chars \| The token value (shared secret) for secure streaming
label	-	required length: 1-255 chars	Something that describes your zone

Response Parameters

Parameter	Description
id	Push Zone ID
name	Push Zone name
label	Something that describes your zone
suspend	Flag denoting if the zone has been suspended
locked	Flag denoting if the zone has been locked
inactive	Flag denoting if the zone has been deleted
creation_date	Date Created

Code Samples

+params = {"name"=>"newVodZone99","password"=>"password"}
+api.post('/clients/{id}/zones/vod.json',params)

+params = {"name":"newvodZone7","password":"password"}
+api.post('/clients/{id}/zones/vod.json',data=params)

+$params = array("name"=>"newVODZone3","password"=>"password");
+$api->post('/clients/{id}/zones/vod.json',$params);

+api.post('/clients/{id}/zones/vod.json', { name: 'newVODZone3', password: 'password' }, function(err, response) {
+  console.log('err', err, 'response', response)
+})

+{
+    "code": 201,
+    "data": {
+        "vodzone": {
+            "cdn_url": "newvodzone4.alias.netdna-cdn.com",
+            "creation_date": "2013-05-24 16:50:18",
+            "direct_url": "d.newvodzone4.alias.netdna-cdn.com",
+            "ftp_url": "ftp.newvodzone4.alias.netdna-cdn.com",
+            "id": 97319,
+            "inactive": 0,
+            "label": null,
+            "locked": 0,
+            "name": "newvodzone4",
+            "pseudo_url": "p.newvodzone4.alias.netdna-cdn.com",
+            "rtmp_url": "r.newvodzone4.alias.netdna-cdn.com",
+            "server_id": "30",
+            "storage_updated": null,
+            "storage_used": null,
+            "suspend": 0,
+            "tmp_url": "newvodzone4.alias.netdna-cdn.com",
+            "token": null,
+            "type": 4
+        }
+    }
+}

Get VOD Zones Count

Counts all VOD zones on the specified account

GET +https://rws.maxcdn.com/{companyalias}/clients/{id}/zones/vod.json/count

Response Parameters

Parameter	Description
count	The number of VOD zones on the specified account

Code Samples

+api.get('/clients/{id}/zones/vod.json/count')

+api.get('/clients/{id}/zones/vod.json/count')

+$api->get('/clients/{id}/zones/vod.json/count');

+api.get('/clients/{id}/zones/vod.json/count', function(err, response) {
+  console.log('err', err, 'response', response)
+})

+{
+    "code": 200,
+    "data": {
+        "count": "4"
+    }
+}

Get VOD Zone

Gets a VOD zone specified by the {zone_id} parameter

GET +https://rws.maxcdn.com/{companyalias}/clients/{id}/zones/vod.json/{zone_id}

Response Parameters

Parameter	Description
id	Push Zone ID
name	Push Zone name
label	Something that describes your zone
suspend	Flag denoting if the zone has been suspended
locked	Flag denoting if the zone has been locked
inactive	Flag denoting if the zone has been deleted
creation_date	Date Created

Code Samples

+id = '97794'
+api.get('/clients/{id}/zones/vod.json/'+id)

+id = '96187'
+api.get('/clients/{id}/zones/vod.json/'+id)

+$id = '97183';
+$api->get('/clients/{id}/zones/vod.json/'.$id);

+var id = '97183'
+api.get('/clients/{id}/zones/vod.json/' + id, function(err, response) {
+  console.log('err', err, 'response', response)
+})

+{
+    "code": 200,
+    "data": {
+        "vodzone": {
+            "cdn_url": "cdn.somenewdomain3.com",
+            "creation_date": "2013-05-23 21:25:44",
+            "direct_url": "d.newvodzone3.alias.netdna-cdn.com",
+            "ftp_url": "ftp.newvodzone3.alias.netdna-cdn.com",
+            "id": "97183",
+            "inactive": "0",
+            "label": "Some other description",
+            "locked": "0",
+            "name": "newvodzone3",
+            "pseudo_url": "p.newvodzone3.alias.netdna-cdn.com",
+            "rtmp_url": "r.newvodzone3.alias.netdna-cdn.com",
+            "server_id": "30",
+            "storage_updated": "2013-05-24 06:35:35",
+            "storage_used": "4096",
+            "suspend": "0",
+            "tmp_url": "newvodzone3.alias.netdna-cdn.com",
+            "token": null,
+            "type": "4"
+        }
+    }
+}

Updates a VOD zone specified by the {zone_id} parameter

PUT +https://rws.maxcdn.com/{companyalias}/clients/{id}/zones/vod.json/{zone_id}

Accepted Request Parameters

password	-	required length: 5-30 chars	Your desired password
token	-	only 0 or 1 accepted	length: 1-64 chars \| The token value (shared secret) for secure streaming
label	-	required length: 1-255 chars	Something that describes your zone

Response Parameters

Parameter	Description
id	Push Zone ID
name	Push Zone name
label	Something that describes your zone
suspend	Flag denoting if the zone has been suspended
locked	Flag denoting if the zone has been locked
inactive	Flag denoting if the zone has been deleted
creation_date	Date Created

Code Samples

+id = '97794'
+params = {"label"=>"Some other description"}
+api.put('/clients/{id}/zones/vod.json/'+id,params)

+id = '96187'
+params = {"label":"Some other description"}
+api.put('/clients/{id}/zones/vod.json/'+id,params=params)

+$id = '97183';
+$params =  array("label"=>"Some other description");
+$api->put('/clients/{id}/zones/vod.json/'.$id,$params);

+var id = '97183'
+api.put('/clients/{id}/zones/vod.json/' + id, { label: 'Some other description' }, function(err, response) {
+  console.log('err', err, 'response', response)
+})

+{
+    "code": 200,
+    "data": {
+        "vodzone": {
+            "cdn_url": "cdn.somenewdomain3.com",
+            "creation_date": "2013-05-23 21:25:44",
+            "direct_url": "d.newvodzone3.alias.netdna-cdn.com",
+            "ftp_url": "ftp.newvodzone3.alias.netdna-cdn.com",
+            "id": "97183",
+            "inactive": "0",
+            "label": "Some other description",
+            "locked": "0",
+            "name": "newvodzone3",
+            "pseudo_url": "p.newvodzone3.alias.netdna-cdn.com",
+            "rtmp_url": "r.newvodzone3.alias.netdna-cdn.com",
+            "server_id": "30",
+            "storage_updated": "2013-05-24 06:35:35",
+            "storage_used": "4096",
+            "suspend": "0",
+            "tmp_url": "newvodzone3.alias.netdna-cdn.com",
+            "token": null,
+            "type": "4"
+        }
+    }
+}

Delete VOD Zone

Deletes a VOD zone specified by the {zone_id} parameter

DELETE +https://rws.maxcdn.com/{companyalias}/clients/{id}/zones/vod.json/{zone_id}

Code Samples

+id = '97794'
+api.delete('/clients/{id}/zones/vod.json/'+id)

+id = '96187'
+api.delete('/clients/{id}/zones/vod.json/'+id)

+$id = '97183';
+$api->delete('/clients/{id}/zones/vod.json/'.$id);

+var id = '97183'
+api.delete('/clients/{id}/zones/vod.json/' + id, function(err, response) {
+  console.log('err', err, 'response', response)
+})

+{
+  "code":200
+}

Enable VOD Zone

Enables a VOD zone specified by the {zone_id} parameter

PUT +https://rws.maxcdn.com/{companyalias}/clients/{id}/zones/vod/{zone_id}/enable.json

Code Samples

+id = '97794'
+api.put('/clients/{id}/zones/vod/'+id+'/enable.json')

+id = '96187'
+api.put('/clients/{id}/zones/vod/'+id+'/enable.json')

+$id = '96187';
+$api->put('/clients/{id}/zones/vod/'.$id.'/enable.json');

+var id = '96187'
+api.put('/clients/{id}/zones/vod/' + id + '/enable.json', function(err, response) {
+  console.log('err', err, 'response', response)
+})

+{
+  "code":200
+}

Disable VOD Zone

Disables a VOD zone specified by the {zone_id} parameter

PUT +https://rws.maxcdn.com/{companyalias}/clients/{id}/zones/vod/{zone_id}/disable.json

Code Samples

+id = '97794'
+api.put('/clients/{id}/zones/vod/'+id+'/disable.json')

+id = '96187'
+api.put('/clients/{id}/zones/vod/'+id+'/disable.json')

+$id = '96187';
+$api->put('/clients/{id}/zones/vod/'.$id.'/disable.json');

+var id = '96187'
+api.put('/clients/{id}/zones/vod/' + id + '/disable.json', function(err, response) {
+  console.log('err', err, 'response', response)
+})

+{
+  "code":200
+}

VOD Zone Custom Domains API

List Custom Domains

Returns a list of all custom domains on the zone specified by +{zone_id}

GET +https://rws.maxcdn.com/{companyalias}/clients/{id}/zones/vod/{zone_id}/customdomains.json

Response Parameters

Parameter	Description
id	Push Zone ID
bucket_id	The id of the zone the custom domain belongs to
custom_domain	A valid custom domain

Code Samples

+id = '97794'
+api.get('/clients/{id}/zones/vod/'+id+'/customdomains.json')

+id = '96187'
+api.get('/clients/{id}/zones/vod/'+id+'/customdomains.json')

+$id = '97183';
+$api->get('/clients/{id}/zones/vod/'.$id.'/customdomains.json');

+var id = '97183'
+api.get('/clients/{id}/zones/vod.json/' + id + '/customdomains.json, function(err, response) {
+  console.log('err', err, 'response', response)
+})

+{
+    "code": 200,
+    "data": {
+        "customdomains": [
+            {
+                "bucket_id": "97183",
+                "custom_domain": "cdn.somenewdomain3.com",
+                "id": "79191",
+                "type": "vod-rtmp"
+            }
+        ],
+        "total": 1
+    }
+}

Create Custom Domain

Adds a new custom domain to {zone_id}

POST +https://rws.maxcdn.com/{companyalias}/clients/{id}/zones/vod/{zone_id}/customdomains.json

Accepted Request Parameters

Parameter	Default Value	Validation	Description
custom_domain	-	required length: 1-255 chars, valid: custom_domain, not valid: full_domain	A valid custom domain
type	-	Applies only to VOD Zones and must be either 'vod-rtmp','vod-pseudo', 'vod-direct', or 'vod-ftp'	The type of custom domain being created

Response Parameters

Parameter	Description
id	The id of the custom domain
bucket_id	The id of the zone the custom domain belongs to
custom_domain	The valid custom domain

Code Samples

+id = '97794'
+params = {"custom_domain"=>"cdn.somedomain39.com","type"=>"vod-rtmp"}
+api.post('/clients/{id}/zones/vod/'+id+'/customdomains.json', params)

+id = '96187'
+params = {"custom_domain":"cdn.somedomain16.com","type":"vod-rtmp"}
+api.post('/clients/{id}/zones/vod/'+id+'/customdomains.json', params)

+$id = '97183';
+$params = array("custom_domain"=>"cdn.somedomain2.com","type"=>"vod-rtmp");
+$api->post('/clients/{id}/zones/vod/'.$id.'/customdomains.json', $params);

+var id = '97183'
+api.post('/clients/{id}/zones/vod/' + id + '/customdomains.json', { custom_domain: 'cdn.somedomain2.com', type: 'vod-rtmp' }, function(err, response) {
+  console.log('err', err, 'response', response)
+})

+{
+    "code": 201,
+    "data": {
+        "customdomain": {
+            "bucket_id": "97183",
+            "custom_domain": "cdn.somedomain2.com",
+            "id": 79284,
+            "type": "vod-rtmp"
+        }
+    }
+}

Get Custom Domain

Gets a custom domain specified by the {zone_id} and +{customdomain_id} parameters

GET +https://rws.maxcdn.com/{companyalias}/clients/{id}/zones/vod/{zone_id}/customdomains.json/{customdomain_id}

Response Parameters

Parameter	Description
id	Push Zone ID
bucket_id	The id of the zone the custom domain belongs to
custom_domain	A valid custom domain

Code Samples

+zoneId = '97794'
+domainId = '79748'
+api.get('/clients/{id}/zones/vod/'+zoneId+'/customdomains.json/'+domainId)

+zoneId = '96187'
+domainId = '79321'
+api.get('/clients/{id}/zones/vod/'+zoneId+'/customdomains.json/'+domainId)

+$zoneId = '97183';
+$domainId = '79191';
+$api->get('/clients/{id}/zones/vod/'.$zoneId.'/customdomains.json/'.$domainId);

+var zoneId = '97183'
+var domainId = '79191'
+api.get('/clients/{id}/zones/vod/' + zoneId + '/customdomains.json/' + domainId, function(err, response) {
+  console.log('err', err, 'response', response)
+})

+{
+    "code": 200,
+    "data": {
+        "customdomain": {
+            "bucket_id": "97183",
+            "custom_domain": "cdn.somenewdomain3.com",
+            "id": "79191",
+            "type": "vod-rtmp"
+        }
+    }
+}

Update Custom Domain

Updates a custom domain specified by the id parameter

PUT +https://rws.maxcdn.com/{companyalias}/clients/{id}/zones/vod/{zone_id}/customdomains.json/{customdomain_id}

Accepted Request Parameters

Parameter	Default Value	Validation	Description
custom_domain	-	required length: 1-255 chars, valid: custom_domain, not valid: full_domain	A valid custom domain

Response Parameters

Parameter	Description
id	Push Zone ID
bucket_id	The id of the zone the custom domain belongs to
custom_domain	A valid custom domain

Code Samples

+zoneId = '97794'
+domainId = '79748'
+params = {"custom_domain"=>"cdn.somenewdomain49.com"}
+api.put('/clients/{id}/zones/vod/'+zoneId+'/customdomains.json/'+domainId,params)

+zoneId = '96187'
+domainId = '79321'
+params = {"custom_domain":"cdn.somenewdomain401.com"}
+api.put('/clients/{id}/zones/vod/'+zoneId+'/customdomains.json/'+domainId,params=params)

+$zoneId = '97183';
+$domainId = '79191';
+$params = array("custom_domain"=>"cdn.somenewdomain3.com");
+$api->put('/clients/{id}/zones/vod/'.$zoneId.'/customdomains.json/'.$domainId, $params);

+var zoneId = '97183'
+var domainId = '79191'
+api.put('/clients/{id}/zones/vod/' + zoneId + '/customdomains.json/' + domainId, { custom_domain: 'cdn.somenewdomain3.com' }, function(err, response) {
+  console.log('err', err, 'response', response)
+})

+{
+    "code": 200,
+    "data": {
+        "customdomain": {
+            "bucket_id": "97183",
+            "custom_domain": "cdn.somenewdomain42.com",
+            "id": "79284",
+            "type": "vod-rtmp"
+        }
+    }
+}

Delete Custom Domain

Deletes a custom domain specified by the {zone_id} and +{customdomain_id} parameters

DELETE +https://rws.maxcdn.com/{companyalias}/clients/{id}/zones/vod/{zone_id}/customdomains.json/{customdomain_id}

Code Samples

+zoneId = '97794'
+domainId = '79748'
+api.delete('/clients/{id}/zones/vod/'+zoneId+'/customdomains.json/'+domainId)

+zoneId = '96187'
+domainId = '79321'
+api.delete('/clients/{id}/zones/vod/'+zoneId+'/customdomains.json/'+domainId)

+$zoneId = '97183';
+$domainId = '79191';
+$api->delete('/clients/{id}/zones/vod/'.$zoneId.'/customdomains.json/'.$domainId);

+var zoneId = '97183'
+var domainId = '79191'
+api.delete('/clients/{id}/zones/vod/' + zoneId + '/customdomains.json/' + domainId, function(err, response) {
+  console.log('err', err, 'response', response)
+})

+{
+  "code":200
+}

Zones SSL API

Get Zone's SSL Information

Get the SSL certificate for the specified {zone_type} and +{zone_id}.

GET +https://rws.maxcdn.com/{companyalias}/clients/{id}/zones/{zone_type}/{zone_id}/ssl.json

Code Samples

+id = '96061'
+type = 'pull'
+api.get('/clients/{id}/zones/'+type+'/'+id+'/ssl.json')

+id = '96061'
+type = 'pull'
+api.get('/clients/{id}/zones/'+type+'/'+id+'/ssl.json')

+$id = '96061';
+$type = 'pull';
+$api->get('/clients/{id}/zones/'.$type.'/'.$id.'/ssl.json');

+var id = '96061'
+var type = 'pull'
+api.get('/clients/{id}/zones/' + type + '/' + id + '/ssl.json', function(err, response) {
+  console.log('err', err, 'response', response)
+})

+{
+  "code":201,
+  "data":{
+    "ssl":{
+      "id":1459,
+      "ssl_crt":"-----BEGIN CERTIFICATE-----\n{ ... your certificate ... }\n-----END CERTIFICATE-----\n",
+      "ssl_key":"-----BEGIN RSA PRIVATE KEY-----\n{ ... your key ... }\n-----END RSA PRIVATE KEY-----",
+      "ssl_cabundle":null,
+      "date_expiration":"2014-01-24",
+      "anycast_ip_id":null,
+      "wildcard":1,
+      "domain":"*.idcreator.com"
+    }
+  }
+}
+

Install SSL on Zone

Upload an SSL certificate for the specified {zone_type} and +{zone_id}.

POST +https://rws.maxcdn.com/{companyalias}/clients/{id}/zones/{zone_type}/{zone_id}/ssl.json

Accepted Request Parameters

Parameter	Default Value	Validation	Description
ssl_crt	-	required	The SSL certificate you are installing.
ssl_key	-	required	The key for the SSL certificate you are installing.
ssl_cabundle	-	-	The CA Bundle for the SSL Certificate you are installing.
ssl_sni	0	only 0 or 1 accepted	f this flag is set to 1 your zone will use SNI to identify your certificate, rather than requiring a dedicated IP.

Response Parameters

Parameter	Description
id	The SSL Certificate ID.
ssl_crt	The SSL certificate.
ssl_key	The SSL Private Key.
ssl_cabundle	The CA Bundle for the certificate.
domain	The domain applicable to this certificate.
date_expiration	The date of expiration for the certificate.
wildcard	Flag to signify whether this is a wildcard certificate.

Code Samples

+id = '96061'
+type = 'pull'
+ssl_crt = "-----BEGIN CERTIFICATE-----\n{ ... your certificate ... }\n-----END CERTIFICATE-----\n"
+ssl_key = "-----BEGIN RSA PRIVATE KEY-----\n{ ... your key ... }\n-----END RSA PRIVATE KEY-----"
+params = {"ssl_crt"=> ssl_crt,"ssl_key"=> ssl_key}
+api.post('/clients/{id}/zones/'+type+'/'+id+'/ssl.json',params)

+id = '96061'
+type = 'pull'
+ssl_crt = "-----BEGIN CERTIFICATE-----\n{ ... your certificate ... }\n-----END CERTIFICATE-----\n"
+ssl_key = "-----BEGIN RSA PRIVATE KEY-----\n{ ... your key ... }\n-----END RSA PRIVATE KEY-----"
+params = {"ssl_crt": ssl_crt,"ssl_key": ssl_key}
+api.post('/clients/{id}/zones/'+type+'/'+id+'/ssl.json',params)

+$id = '96061';
+$type = 'pull';
+$ssl_crt = "-----BEGIN CERTIFICATE-----\n{ ... your certificate ... }\n-----END CERTIFICATE-----\n";
+$ssl_key = "-----BEGIN RSA PRIVATE KEY-----\n{ ... your key ... }\n-----END RSA PRIVATE KEY-----";
+$params = array("ssl_crt"=>$ssl_crt,"ssl_key"=>$ssl_key);
+$api->post('/clients/{id}/zones/'.$type.'/'.$id.'/ssl.json',$params);

+var id = '96061'
+var type = 'pull'
+var ssl_crt = "-----BEGIN CERTIFICATE-----\n{ ... your certificate ... }\n-----END CERTIFICATE-----\n"
+var ssl_key = "-----BEGIN RSA PRIVATE KEY-----\n{ ... your key ... }\n-----END RSA PRIVATE KEY-----"
+api.post('/clients/{id}/zones/' + type + '/' + id + '/ssl.json', { ssl_crt: ssl_crt, ssl_key: ssl_key }, function(err, response) {
+  console.log('err', err, 'response', response)
+})

+{
+  "code":201,
+  "data":{
+    "ssl":{
+      "id":1459,
+      "ssl_crt":"-----BEGIN CERTIFICATE-----\n{ ... your certificate ... }\n-----END CERTIFICATE-----\n",
+      "ssl_key":"-----BEGIN RSA PRIVATE KEY-----\n{ ... your key ... }\n-----END RSA PRIVATE KEY-----",
+      "ssl_cabundle":null,
+      "date_expiration":"2014-01-24",
+      "anycast_ip_id":null,
+      "wildcard":1,
+      "domain":"*.idcreator.com"
+    }
+  }
+}
+

Update Zone's SSL Information

Update the SSL certificate for the specified {zone_type} and +{zone_id}.

PUT +https://rws.maxcdn.com/{companyalias}/clients/{id}/zones/{zone_type}/{zone_id}/ssl.json

Accepted Request Parameters

Parameter	Default Value	Validation	Description
ssl_crt	-	required	The SSL certificate you are installing.
ssl_key	-	required	The key for the SSL certificate you are installing.
ssl_cabundle	-	-	The CA Bundle for the SSL Certificate you are installing.

Response Parameters

Parameter	Description
id	The SSL Certificate ID.
ssl_crt	The SSL certificate.
ssl_key	The SSL Private Key.
ssl_cabundle	The CA Bundle for the certificate.
domain	The domain applicable to this certificate.
date_expiration	The date of expiration for the certificate.
wildcard	Flag to signify whether this is a wildcard certificate.

Code Samples

+id = '96061'
+type = 'pull'
+ssl_crt = "-----BEGIN CERTIFICATE-----\n{ ... your certificate ... }\n-----END CERTIFICATE-----\n"
+ssl_key = "-----BEGIN RSA PRIVATE KEY-----\n{ ... your key ... }\n-----END RSA PRIVATE KEY-----"
+params = {"ssl_crt"=> ssl_crt,"ssl_key"=> ssl_key}
+api.put('/clients/{id}/zones/'+type+'/'+id+'/ssl.json',params)

+id = '96061'
+type = 'pull'
+ssl_crt = "-----BEGIN CERTIFICATE-----\n{ ... your certificate ... }\n-----END CERTIFICATE-----\n"
+ssl_key = "-----BEGIN RSA PRIVATE KEY-----\n{ ... your key ... }\n-----END RSA PRIVATE KEY-----"
+params = {"ssl_crt": ssl_crt,"ssl_key": ssl_key}
+api.put('/clients/{id}/zones/'+type+'/'+id+'/ssl.json',params)

+$id = '96061';
+$type = 'pull';
+$ssl_crt = "-----BEGIN CERTIFICATE-----\n{ ... your certificate ... }\n-----END CERTIFICATE-----\n";
+$ssl_key = "-----BEGIN RSA PRIVATE KEY-----\n{ ... your key ... }\n-----END RSA PRIVATE KEY-----";
+$ssl_key = "
+$params = array("ssl_crt"=>$ssl_crt,"ssl_key"=>$ssl_key);
+$api->put('/clients/{id}/zones/'.$type.'/'.$id.'/ssl.json',$params);

+var id = '96061'
+var type = 'pull'
+var ssl_crt = "-----BEGIN CERTIFICATE-----\n{ ... your certificate ... }\n-----END CERTIFICATE-----\n"
+var ssl_key = "-----BEGIN RSA PRIVATE KEY-----\n{ ... your key ... }\n-----END RSA PRIVATE KEY-----"
+api.put('/clients/{id}/zones/' + type + '/' + id + '/ssl.json', { ssl_crt: ssl_crt, ssl_key: ssl_key }, function(err, response) {
+  console.log('err', err, 'response', response)
+})

+{
+  "code":201,
+  "data":{
+    "ssl":{
+      "id":1459,
+      "ssl_crt":"-----BEGIN CERTIFICATE-----\n{ ... your certificate ... }\n-----END CERTIFICATE-----\n",
+      "ssl_key":"-----BEGIN RSA PRIVATE KEY-----\n{ ... your key ... }\n-----END RSA PRIVATE KEY-----",
+      "ssl_cabundle":null,
+      "date_expiration":"2014-01-24",
+      "anycast_ip_id":null,
+      "wildcard":1,
+      "domain":"*.idcreator.com"
+    }
+  }
+}
+

Remove Zone's SSL Information

Remove the SSL certificate for the specified {zone_type} and +{zone_id}.

DELETE +https://rws.maxcdn.com/{companyalias}/clients/{id}/zones/{zone_type}/{zone_id}/ssl.json

Code Samples

+id = '96061'
+type = 'pull'
+api.delete('/clients/{id}/zones/'+type+'/'+id+'/ssl.json')

+id = '96061'
+type = 'pull'
+api.delete('/clients/{id}/zones/'+type+'/'+id+'/ssl.json')

+$id = '96061';
+$type = 'pull';
+$api->delete('/clients/{id}/zones/'.$type.'/'.$id.'/ssl.json');

+var id = '96061'
+var type = 'pull'
+api.delete('/clients/{id}/zones/' + type + '/' + id + '/ssl.json', function(err, response) {
+  console.log('err', err, 'response', response)
+})

+{
+  "code":200,
+  "data":{
+    "zone":{
+      "id":"90652",
+      "name":"newpullzonec5",
+      "username":"username",
+      "company_id":"1234",
+      "url":"http:\/\/someplace.net",
+      "port":"80",
+      "ip":"123.0.0.49",
+      "vhost":"someplace.net",
+      "type":"2",
+      "compress":"0",
+      "backend_compress":"0",
+      "queries":"1",
+      "max_cache_size":"50000",
+      "suspend":"0",
+      "cache_valid":"1d",
+      "content_encoding":"1",
+      "label":"",
+      "inactive":"0",
+      "valid_referers":null,
+      "key_zone_size":"50m",
+      "expires":null,
+      "disallow_robots":"0",
+      "disallow_robots_txt":null,
+      "canonical_link_headers":"0",
+      "content_disposition":"0",
+      "custom_domain_limit":"7",
+      "locked":"0",
+      "server_id":"123",
+      "ssl":0,
+      "sslshared":"0",
+      "creation_date":"2013-07-22 19:00:54",
+      "dsa_ip":null,
+      "geo_enabled":"0",
+      "set_host_header":null,
+      "ssl_id":0,
+      "dns_check":"1",
+      "hit_bandwidth_by_dir":"0",
+      "hit_bandwidth_by_custom_domain":"0",
+      "hit_bandwidth_by_file_name_status_code":"0",
+      "cache_version":"0",
+      "ignore_setcookie_header":"0",
+      "hide_setcookie_header":"0",
+      "ignore_cache_control":"0",
+      "use_stale":"0",
+      "proxy_cache_lock":"0",
+      "pseudo_streaming":"0",
+      "secret":null,
+      "upstream_enabled":"0",
+      "cdn_url":"newpullzonec5.username.netdna-cdn.com",
+      "tmp_url":"newpullzonec5.nycacorp.netdna-cdn.com"
+    }
+  }
+}
+

Reports API

Get Account Stats

Gets the total usage statistics for your account, optionally broken up by +{report_type}. If no {report_type} is given the request will return +the total usage on your account.

GET +https://rws.maxcdn.com/{companyalias}/clients/{id}/reports/stats.json/{report_type}

Accepted Request Parameters

Parameter	Default Value	Validation	Description
date_from	now() - 1 month	Y-m-d (e.g. 2012-01-01)	Start date
date_to	now()	Y-m-d (e.g. 2012-01-01)	End date

Response Parameters

Parameter	Description
size	The amount of bytes transferred
hit	The number of times files were requested
noncache_hit	The number of times a requested file was not in cache
timestamp	The timestamp for the corresponding {report_type}

Code Samples

+reportType = '' #Valid input includes '/daily', '/hourly', '/monthly' or ''
+api.get('/clients/{id}/reports/stats.json'+reportType)

+reportType = '' #Valid input includes '/daily', '/hourly', '/monthly' or ''
+api.get('/clients/{id}/reports/stats.json'+reportType)

+$reportType = ''; //Vaild input includes '/daily', '/hourly', '/monthly' or ''
+$api->get('/clients/{id}/reports/stats.json/'.$reportType);

+var reportType = '' //Vaild input includes '/daily', '/hourly', '/monthly' or ''
+api.get('/clients/{id}/reports/stats.json/' + reportType, function(err, response) {
+  console.log('err', err, 'response', response)
+})

+{
+    "code": 200,
+    "data": {
+        "stats": {
+            "cache_hit": "0",
+            "hit": "20",
+            "noncache_hit": "20",
+            "size": "0"
+        },
+        "total": "1"
+    }
+}

Get All Zone Stats

Gets the total usage statistics for each of your zones, optionally broken up by +{report_type}. If no {report_type} is given the timestamp response parameter will be omitted.

GET +https://rws.maxcdn.com/{companyalias}/clients/{id}/reports/statsbyzone.json/{report_type}

Accepted Request Parameters

Parameter	Default Value	Validation	Description
date_from	now() - 1 month	Y-m-d (e.g. 2012-01-01)	Start date
date_to	now()	Y-m-d (e.g. 2012-01-01)	End date

Response Parameters

Parameter	Description
size	The amount of bytes transferred
hit	The number of times files were requested
noncache_hit	The number of times a requested file was not in cache
timestamp	The timestamp for the corresponding {report_type}

Code Samples

+reportType = '' #Valid input includes '/daily', '/hourly', '/monthly' or ''
+api.get('/clients/{id}/reports/statsbyzone.json'+reportType)

+reportType = '' #Valid input includes '/daily', '/hourly', '/monthly' or ''
+api.get('/clients/{id}/reports/statsbyzone.json'+reportType)

+$reportType = ''; //Vaild input includes '/daily', '/hourly', '/monthly' or ''
+$api->get('/clients/{id}/reports/statsbyzone.json/'.$reportType);

+var reportType = '' //Vaild input includes '/daily', '/hourly', '/monthly' or ''
+api.get('/clients/{id}/reports/statsbyzone.json/' + reportType, function(err, response) {
+  console.log('err', err, 'response', response)
+})

+{
+  "code": 200,
+  "data": {
+    "page": 1,
+    "pages": 262,
+    "page_size": 50,
+    "current_page_size": 50,
+    "total": 13097,
+    "stats": [
+      {
+        "zone_id": "4816",
+        "size": "20318527",
+        "hit": "280",
+        "cache_hit": "15",
+        "noncache_hit": "265"
+      },
+      {
+        "zone_id": "5023",
+        "size": "18032138",
+        "hit": "119120",
+        "cache_hit": "0",
+        "noncache_hit": "119120"
+      },
+      {
+        "zone_id": "5045",
+        "size": "10656749286",
+        "hit": "950640",
+        "cache_hit": "838432",
+        "noncache_hit": "112208"
+      },
+
+      ....
+
+    ],
+    "summary": {
+      "size": 5.7138288549144e+14,
+      "hit": 17093013874,
+      "cache_hit": 14815205275,
+      "noncache_hit": 2277808599
+    }
+  }
+}

Get a Zone's Stats

Gets the {zone_id} usage statistics optionally broken up by +{report_type}. If no {report_type} is given the request will return +the total usage for the zones.

GET +https://rws.maxcdn.com/{companyalias}/clients/{id}/reports/{zone_id}/stats.json/{report_type}

Accepted Request Parameters

Parameter	Default Value	Validation	Description
date_from	now() - 1 month	Y-m-d (e.g. 2012-01-01)	Start date
date_to	now()	Y-m-d (e.g. 2012-01-01)	End date

Response Parameters

Parameter	Description
size	The amount of bytes transferred
hit	The number of times files were requested
noncache_hit	The number of times a requested file was not in cache
timestamp	The timestamp for the corresponding {report_type}

Code Samples

+id = '96061'
+reportType = '' #Valid input includes '/daily', '/hourly', '/monthly' or ''
+api.get('/clients/{id}/reports/'+id+'/stats.json'+reportType)

+id = '96061'
+reportType = '' #Valid input includes '/daily', '/hourly', '/monthly' or ''
+api.get('/clients/{id}/reports/'+id+'/stats.json'+reportType)

+$id = '96061';
+$reportType = ''; //Vaild input includes '/daily', '/hourly', '/monthly' or ''
+$api->get('/clients/{id}/reports/'.$id.'/stats.json/'.$reportType);

+var id = '96061'
+var reportType = '' //Vaild input includes '/daily', '/hourly', '/monthly' or ''
+api.get('/clients/{id}/reports/' + id + '/stats.json/' + reportType, function(err, response) {
+  console.log('err', err, 'response', response)
+})

+{
+    "code": 200,
+    "data": {
+        "stats": {
+            "cache_hit": null,
+            "hit": null,
+            "noncache_hit": null,
+            "size": null
+        },
+        "summary": {
+            "cache_hit": null,
+            "hit": null,
+            "noncache_hit": null,
+            "size": null
+        },
+        "total": "0"
+    }
+}

Reports by Status Codes API

List Status Code Responses

Gets HTTP status code response statistics for your account

GET +https://rws.maxcdn.com/{companyalias}/clients/{id}/reports/statuscodes.json/{report_type}

Accepted Request Parameters

Parameter	Default Value	Validation	Description
date_from	now() - 1 month	Y-m-d (e.g. 2012-01-01)	Start date
date_to	now()	Y-m-d (e.g. 2012-01-01)	End date

Response Parameters

Parameter	Description
status_code	The HTTP status code for the response
hit	The number of times files were requested
definition	The definition for the status code

Code Samples

+reportType = '' #Valid input includes '/daily', '/hourly', '/monthly' or ''
+api.get('/clients/{id}/reports/statuscodes.json'+reportType)

+reportType = '' #Valid input includes '/daily', '/hourly', '/monthly' or ''
+api.get('/clients/{id}/reports/statuscodes.json'+reportType)

+$reportType = ''; //Vaild input includes '/daily', '/hourly', '/monthly' or ''
+$api->get('/clients/{id}/reports/statuscodes.json/'.$reportType);

+var reportType = '' //Valid input includes '/daily', '/hourly', '/monthly' or ''
+api.get('/clients/{id}/reports/statuscodes.json/' + reportType, function(err, response) {
+  console.log('err', err, 'response', response)
+})

+{
+    "code": 200,
+    "data": {
+        "statuscodes": [
+            {
+                "definition": "Not Found",
+                "hit": "20",
+                "status_code": "404"
+            }
+        ],
+        "summary": {
+            "hit": "20"
+        },
+        "total": "1"
+    }
+}

List Status Code Responses by Zone Id

Gets HTTP status code response statistics for a specific +{zone_id}

GET +https://rws.maxcdn.com/{companyalias}/clients/{id}/reports/{zone_id}/statuscodes.json/{report_type}

Accepted Request Parameters

Parameter	Default Value	Validation	Description
date_from	now() - 1 month	Y-m-d (e.g. 2012-01-01)	Start date
date_to	now()	Y-m-d (e.g. 2012-01-01)	End date

Response Parameters

Parameter	Description
status_code	The HTTP status code for the response
hit	The number of times files were requested
definition	The definition for the status code

Code Samples

+reportType = '' #Valid input includes '/daily', '/hourly', '/monthly' or ''
+id = '96061'
+api.get('/clients/{id}/reports/'+id+'/statuscodes.json'+reportType)

+reportType = '' #Valid input includes '/daily', '/hourly', '/monthly' or ''
+id = '96061'
+api.get('/clients/{id}/reports/'+id+'/statuscodes.json'+reportType)

+$reportType = ''; //Vaild input includes '/daily', '/hourly', '/monthly' or ''
+$id = '96061';
+$api->get('/clients/{id}/reports/'.$id.'/statuscodes.json/'.$reportType);

+var reportType = '' //Valid input includes '/daily', '/hourly', '/monthly' or ''
+var id = '96061'
+api.get('/clients/{id}/reports/' + id + '/statuscodes.json/' + reportType, function(err, response) {
+  console.log('err', err, 'response', response)
+})

+{
+    "code": 200,
+    "data": {
+        "statuscodes": [],
+        "summary": {
+            "hit": null
+        },
+        "total": "0"
+    }
+}

Reports by File Types API

List File Types

Gets file type statistics for your account

GET +https://rws.maxcdn.com/{companyalias}/clients/{id}/reports/filetypes.json/{report_type}

Accepted Request Parameters

Parameter	Default Value	Validation	Description
date_from	now() - 1 month	Y-m-d (e.g. 2012-01-01)	Start date
date_to	now()	Y-m-d (e.g. 2012-01-01)	End date

Response Parameters

Parameter	Description
file_type	The file type requested
hit	The number of times files were requested

Code Samples

+reportType = '' #Valid input includes '/daily', '/hourly', '/monthly' or ''
+api.get('/clients/{id}/reports/filetypes.json'+reportType)

+reportType = '' #Valid input includes '/daily', '/hourly', '/monthly' or ''
+api.get('/clients/{id}/reports/filetypes.json'+reportType)

+$reportType = ''; //Vaild input includes '/daily', '/hourly', '/monthly' or ''
+$api->get('/clients/{id}/reports/filetypes.json'.$reportType);

+var reportType = '' //Valid input includes '/daily', '/hourly', '/monthly' or ''
+api.get('/clients/{id}/reports/filetypes.json', function(err, response) {
+  console.log('err', err, 'response', response)
+})

+{
+    "code": 200,
+    "data": {
+        "current_page_size": 1,
+        "filetypes": [
+            {
+                "file_type": "txt",
+                "hit": "20"
+            }
+        ],
+        "page": 1,
+        "page_size": "50",
+        "pages": 1,
+        "summary": {
+            "hit": "20"
+        },
+        "total": "1"
+    }
+}

List File Types by Zone Id

Gets file type statistics for a specific {zone_id}

GET +https://rws.maxcdn.com/{companyalias}/clients/{id}/reports/{zone_id}/filetypes.json/{report_type}

Accepted Request Parameters

Parameter	Default Value	Validation	Description
date_from	now() - 1 month	Y-m-d (e.g. 2012-01-01)	Start date
date_to	now()	Y-m-d (e.g. 2012-01-01)	End date

Response Parameters

Parameter	Description
file_type	The file type requested
hit	The number of times files were requested

Code Samples

+reportType = '' #Valid input includes '/daily', '/hourly', '/monthly' or ''
+id = '96061'
+api.get('/clients/{id}/reports/'+id+'/filetypes.json'+reportType)

+reportType = '' #Valid input includes '/daily', '/hourly', '/monthly' or ''
+id = '96061'
+api.get('/clients/{id}/reports/'+id+'/filetypes.json'+reportType)

+$reportType = ''; //Vaild input includes '/daily', '/hourly', '/monthly' or ''
+$id = '96061';
+$api->get('/clients/{id}/reports/'.$id.'/filetypes.json/'.$reportType);

+var reportType = '' //Valid input includes '/daily', '/hourly', '/monthly' or ''
+var id = '96061'
+api.get('/clients/{id}/reports/' + id + '/filetypes.json/' + reportType, function(err, response) {
+  console.log('err', err, 'response', response)
+})

+{
+    "code": 200,
+    "data": {
+        "current_page_size": 0,
+        "filetypes": [],
+        "page": 1,
+        "page_size": "50",
+        "pages": 0,
+        "summary": {
+            "hit": null
+        },
+        "total": "0"
+    }
+}

Reports by File Size Ranges API

List File Sizes

Gets request statistics for your account based on file size +ranges

GET +https://rws.maxcdn.com/{companyalias}/clients/{id}/reports/filesizes.json/{report_type}

Accepted Request Parameters

Parameter	Default Value	Validation	Description
date_from	now() - 1 month	Y-m-d (e.g. 2012-01-01)	Start date
date_to	now()	Y-m-d (e.g. 2012-01-01)	End date

Response Parameters

Parameter	Description
le_10k_hits	The number of requests for files <= 10KB
le_50k_hits	The number of requests for files <= 50KB
le_100k_hits	The number of requests for files <= 100KB
le_500k_hits	The number of requests for files <= 500KB
le_1m_hits	The number of requests for files <= 1MB
le_10m_hits	The number of requests for files <= 10MB
le_100m_hits	The number of requests for files <= 100MB
gt_100m_hits	The number of requests for files > 100MB

Code Samples

+reportType = '' #Valid input includes '/daily', '/hourly', '/monthly' or ''
+zoneType = 'pull'
+id = '96061'
+api.get('/clients/{id}/reports/'+zoneType+'/'+id+'/filetypes.json'+reportType)

+reportType = '' #Valid input includes '/daily', '/hourly', '/monthly' or ''
+api.get('/clients/{id}/reports/filesizes.json'+reportType)

+$reportType = ''; //Vaild input includes '/daily', '/hourly', '/monthly' or ''
+$api->get('/clients/{id}/reports/filesizes.json/'.$reportType);

+var reportType = '' //Valid input includes '/daily', '/hourly', '/monthly' or ''
+api.get('/clients/{id}/reports/filesizes.json/' + reportType, function(err, response) {
+  console.log('err', err, 'response', response)
+})

+{
+    "code": 200,
+    "data": {
+        "filesizes": [
+            {
+                "gt_100m_hit": "0",
+                "le_100k_hit": "0",
+                "le_100m_hit": "0",
+                "le_10k_hit": "20",
+                "le_10m_hit": "0",
+                "le_1m_hit": "0",
+                "le_500k_hit": "0",
+                "le_50k_hit": "0"
+            }
+        ],
+        "summary": {
+            "hit": "20"
+        }
+    }
+}

List File Sizes by Zone Id

Gets request statistics for the specified {zone_id} based on +file size ranges

GET +https://rws.maxcdn.com/{companyalias}/clients/{id}/reports/{zone_id}/filesizes.json/{report_type}

Accepted Request Parameters

Parameter	Default Value	Validation	Description
date_from	now() - 1 month	Y-m-d (e.g. 2012-01-01)	Start date
date_to	now()	Y-m-d (e.g. 2012-01-01)	End date

Response Parameters

Parameter	Description
le_10k_hits	The number of requests for files <= 10KB
le_50k_hits	The number of requests for files <= 50KB
le_100k_hits	The number of requests for files <= 100KB
le_500k_hits	The number of requests for files <= 500KB
le_1m_hits	The number of requests for files <= 1MB
le_10m_hits	The number of requests for files <= 10MB
le_100m_hits	The number of requests for files <= 100MB
gt_100m_hits	The number of requests for files > 100MB

Code Samples

+reportType = '' #Valid input includes '/daily', '/hourly', '/monthly' or ''
+id = '96061'
+api.get('/clients/{id}/reports/'+id+'/filesizes.json'+reportType)

+reportType = '' #Valid input includes '/daily', '/hourly', '/monthly' or ''
+id = '96061'
+api.get('/clients/{id}/reports/'+id+'/filesizes.json'+reportType)

+$reportType = ''; //Vaild input includes '/daily', '/hourly', '/monthly' or ''
+$id = '96061';
+$api->get('/clients/{id}/reports/'.$id.'/filesizes.json/'.$reportType);

+var reportType = '' //Valid input includes '/daily', '/hourly', '/monthly' or ''
+var id = '96061'
+api.get('/clients/{id}/reports/' + id + '/filesizes.json/' + reportType, function(err, response) {
+  console.log('err', err, 'response', response)
+})

+{
+    "code": 200,
+    "data": {
+        "filesizes": [
+            {
+                "gt_100m_hit": null,
+                "le_100k_hit": null,
+                "le_100m_hit": null,
+                "le_10k_hit": null,
+                "le_10m_hit": null,
+                "le_1m_hit": null,
+                "le_500k_hit": null,
+                "le_50k_hit": null
+            }
+        ],
+        "summary": {
+            "hit": null
+        }
+    }
+}

Reports by Location API

List Nodes

Gets a list of all active nodes (locations)

GET +https://rws.maxcdn.com/{companyalias}/clients/{id}/reports/nodes.json

Response Parameters

Parameter	Description
id	Node Id
name	Node 3 letter code
description	Full node name

Code Samples

+api.get('/clients/{id}/reports/nodes.json')

+api.get('/clients/{id}/reports/nodes.json')

+$api->get('/clients/{id}/reports/nodes.json');

+api.get('/clients/{id}/reports/nodes.json', function(err, response) {
+  console.log('err', err, 'response', response)
+})

+{
+    "code": 200,
+    "data": {
+        "nodes": [
+            {
+                "description": "Los Angeles",
+                "id": "1",
+                "name": "lax"
+            },
+            {
+                "description": "New York",
+                "id": "3",
+                "name": "jfk"
+            },
+            {
+                "description": "Seattle",
+                "id": "2",
+                "name": "sea"
+            },
+            {
+                "description": "Atlanta",
+                "id": "4",
+                "name": "atl"
+            },
+            {
+                "description": "Amsterdam",
+                "id": "5",
+                "name": "ams"
+            },
+            {
+                "description": "Dallas",
+                "id": "6",
+                "name": "dal"
+            },
+            {
+                "description": "Chicago",
+                "id": "8",
+                "name": "chi"
+            },
+            {
+                "description": "Virginia",
+                "id": "9",
+                "name": "vir"
+            },
+            {
+                "description": "Miami",
+                "id": "7",
+                "name": "mia"
+            },
+            {
+                "description": "London",
+                "id": "12",
+                "name": "lhr"
+            },
+            {
+                "description": "San Francisco",
+                "id": "13",
+                "name": "sfo"
+            },
+            {
+                "description": "Los Angeles 3",
+                "id": "30",
+                "name": "lax"
+            }
+        ]
+    }
+}

List Nodes by Zone

Gets a list of all active nodes (locations) specified by the +{zone_id} parameter

GET +https://rws.maxcdn.com/{companyalias}/clients/{id}/reports/{zone_id}/nodes.json

Response Parameters

Parameter	Description
id	Node Id
name	Node 3 letter code
description	Full node name

Code Samples

+id = '96061'
+api.get('/clients/{id}/reports/'+id+'/nodes.json')

+id = '96061'
+api.get('/clients/{id}/reports/'+id+'/nodes.json')

+$id = '96061';
+$api->get('/clients/{id}/reports/'.$id.'/nodes.json');

+var id = '96061'
+api.get('/clients/{id}/reports/' + id + '/nodes.json', function(err, response) {
+  console.log('err', err, 'response', response)
+})

+{
+    "code": 200,
+    "data": {
+        "nodes": [
+            {
+                "description": "Dallas",
+                "id": "6",
+                "name": "dal"
+            },
+            {
+                "description": "Los Angeles",
+                "id": "1",
+                "name": "lax"
+            },
+            {
+                "description": "Seattle",
+                "id": "2",
+                "name": "sea"
+            },
+            {
+                "description": "New York",
+                "id": "3",
+                "name": "jfk"
+            },
+            {
+                "description": "Atlanta",
+                "id": "4",
+                "name": "atl"
+            },
+            {
+                "description": "Amsterdam",
+                "id": "5",
+                "name": "ams"
+            },
+            {
+                "description": "Chicago",
+                "id": "8",
+                "name": "chi"
+            },
+            {
+                "description": "Virginia",
+                "id": "9",
+                "name": "vir"
+            },
+            {
+                "description": "London",
+                "id": "12",
+                "name": "lhr"
+            },
+            {
+                "description": "San Francisco",
+                "id": "13",
+                "name": "sfo"
+            }
+        ]
+    }
+}

List Zone Node Stats by Report Type

Get usage statistics broken up by nodes and optionally +{report_type}. If no {report_type} is given the request will return +the total usage broken up by node.

GET +https://rws.maxcdn.com/{companyalias}/clients/{id}/reports/nodes.json/stats/{report_type}

Accepted Request Parameters

Parameter	Default Value	Validation	Description
date_from	now() - 1 month	Y-m-d (e.g. 2012-01-01)	Start date
date_to	now()	Y-m-d (e.g. 2012-01-01)	End date

Response Parameters

Parameter	Description
pop_id	Node Id
pop_name	Node 3 letter code, only returned when {report_type} is not empty
pop_description	Full node name, only returned when {report_type} is not empty
size	The amount of bytes transferred
hit	The number of times files were requested
noncache_hit	The number of times a requested file was not in cache
cache_hit	The number of times a requested file was already cached
timestamp	A timestamp corresponding to {report_type}, only returned when {report_type} is not empty

Code Samples

+reportType = '' #Valid input includes '/daily', '/hourly', '/monthly' or ''
+api.get('/clients/{id}/reports/nodes.json/stats'+reportType)

+reportType = '' #Valid input includes '/daily', '/hourly', '/monthly' or ''
+api.get('/clients/{id}/reports/nodes.json/stats'+reportType)

+$reportType = ''; //Vaild input includes '/daily', '/hourly', '/monthly' or ''
+$api->get('/clients/{id}/reports/nodes.json/stats/'.$reportType);

+var reportType = '' //Vaild input includes '/daily', '/hourly', '/monthly' or ''
+api.get('/clients/{id}/reports/nodes.json/stats/' + reportType, function(err, response) {
+  console.log('err', err, 'response', response)
+})

+{
+    "code": 200,
+    "data": {
+        "stats": [
+            {
+                "cache_hit": "0",
+                "hit": "2",
+                "noncache_hit": "2",
+                "pop_description": "Los Angeles",
+                "pop_id": "1",
+                "pop_name": "lax",
+                "size": "0"
+            },
+            {
+                "cache_hit": "0",
+                "hit": "2",
+                "noncache_hit": "2",
+                "pop_description": "Atlanta",
+                "pop_id": "4",
+                "pop_name": "atl",
+                "size": "0"
+            },
+            {
+                "cache_hit": "0",
+                "hit": "2",
+                "noncache_hit": "2",
+                "pop_description": "Chicago",
+                "pop_id": "8",
+                "pop_name": "chi",
+                "size": "0"
+            },
+            {
+                "cache_hit": "0",
+                "hit": "2",
+                "noncache_hit": "2",
+                "pop_description": "San Francisco",
+                "pop_id": "13",
+                "pop_name": "sfo",
+                "size": "0"
+            },
+            {
+                "cache_hit": "0",
+                "hit": "2",
+                "noncache_hit": "2",
+                "pop_description": "Seattle",
+                "pop_id": "2",
+                "pop_name": "sea",
+                "size": "0"
+            },
+            {
+                "cache_hit": "0",
+                "hit": "2",
+                "noncache_hit": "2",
+                "pop_description": "Amsterdam",
+                "pop_id": "5",
+                "pop_name": "ams",
+                "size": "0"
+            },
+            {
+                "cache_hit": "0",
+                "hit": "2",
+                "noncache_hit": "2",
+                "pop_description": "Virginia",
+                "pop_id": "9",
+                "pop_name": "vir",
+                "size": "0"
+            },
+            {
+                "cache_hit": "0",
+                "hit": "2",
+                "noncache_hit": "2",
+                "pop_description": "New York",
+                "pop_id": "3",
+                "pop_name": "jfk",
+                "size": "0"
+            },
+            {
+                "cache_hit": "0",
+                "hit": "2",
+                "noncache_hit": "2",
+                "pop_description": "Dallas",
+                "pop_id": "6",
+                "pop_name": "dal",
+                "size": "0"
+            },
+            {
+                "cache_hit": "0",
+                "hit": "2",
+                "noncache_hit": "2",
+                "pop_description": "London",
+                "pop_id": "12",
+                "pop_name": "lhr",
+                "size": "0"
+            }
+        ],
+        "summary": {
+            "cache_hit": "0",
+            "hit": "20",
+            "noncache_hit": "20",
+            "size": "0"
+        },
+        "total": "1"
+    }
+}

List Node Stats by Zone and Report Type

Get usage statistics for a particular {zone_id} broken up by +nodes and optionally {report_type}. If no {report_type} is given +the request will return the total usage broken up by node.

GET +https://rws.maxcdn.com/{companyalias}/clients/{id}/reports/{zone_id}/nodes.json/stats/{report_type}

Accepted Request Parameters

Parameter	Default Value	Validation	Description
date_from	now() - 1 month	Y-m-d (e.g. 2012-01-01)	Start date
date_to	now()	Y-m-d (e.g. 2012-01-01)	End date

Response Parameters

Parameter	Description
pop_id	Node Id
pop_name	Node 3 letter code, only returned when {report_type} is not empty
pop_description	Full node name, only returned when {report_type} is not empty
size	The amount of bytes transferred
hit	The number of times files were requested
noncache_hit	The number of times a requested file was not in cache
cache_hit	The number of times a requested file was already cached
timestamp	A timestamp corresponding to {report_type}, only returned when {report_type} is not empty

Code Samples

+id = '96061'
+reportType = '' #Valid input includes '/daily', '/hourly', '/monthly' or ''
+api.get('/clients/{id}/reports/'+id+'/nodes.json/stats'+reportType)

+id = '96061'
+reportType = '' #Valid input includes '/daily', '/hourly', '/monthly' or ''
+api.get('/clients/{id}/reports/'+id+'/nodes.json/stats'+reportType)

+$id = '96061';
+$reportType = ''; //Vaild input includes '/daily', '/hourly', '/monthly' or ''
+$api->get('/clients/{id}/reports/'.$id.'/nodes.json/stats/'.$reportType);

+var id = '96061'
+var reportType = '' //Vaild input includes '/daily', '/hourly', '/monthly' or ''
+api.get('/clients/{id}/reports/' + id + '/nodes.json/stats/' + reportType, function(err, response) {
+  console.log('err', err, 'response', response)
+})

+{
+    "code": 200,
+    "data": {
+        "stats": [],
+        "summary": {
+            "cache_hit": null,
+            "hit": null,
+            "noncache_hit": null,
+            "size": null
+        },
+        "total": null
+    }
+}

Get Zone Node

Gets the node information for the specified {node_id}

GET +https://rws.maxcdn.com/{companyalias}/clients/{id}/reports/nodes.json/{node_id}

Response Parameters

Parameter	Description
id	Node Id
name	Node 3 letter code
description	Full node name

Code Samples

+id = '1'
+api.get('/clients/{id}/reports/nodes.json/'+id)

+id = '1'
+api.get('/clients/{id}/reports/nodes.json/'+id)

+$id = '1';
+$api->get('/clients/{id}/reports/nodes.json/'.$id);

+var id = '1'
+api.get('/clients/{id}/reports/nodes.json/' + id, function(err, response) {
+  console.log('err', err, 'response', response)
+})

+{
+    "code": 200,
+    "data": {
+        "node": {
+            "description": "Los Angeles",
+            "id": "1",
+            "name": "lax"
+        }
+    }
+}
+

Get Node by Zone

Gets the node information for the specified {node_id} and +{zone_id}

GET +https://rws.maxcdn.com/{companyalias}/clients/{id}/reports/{zone_id}/nodes.json/{node_id}

Response Parameters

Parameter	Description
id	Node Id
name	Node 3 letter code
description	Full node name

Code Samples

+zoneId = '96061'
+nodeId = '1'
+api.get('/clients/{id}/reports/'+zoneId+'/nodes.json/'+nodeId)

+zoneId = '96061'
+nodeId = '1'
+api.get('/clients/{id}/reports/'+zoneId+'/nodes.json/'+nodeId)

+$zoneId = '96061';
+$nodeId = '1';
+$api->get('/clients/{id}/reports/'.$zoneId.'/nodes.json/'.$nodeId);

+var zoneId = '96061'
+var nodeId = '1'
+api.get('/clients/{id}/reports/' + zoneId + '/nodes.json/' + nodeId, function(err, response) {
+  console.log('err', err, 'response', response)
+})

+{
+    "code": 200,
+    "data": {
+        "stats": [],
+        "summary": {
+            "cache_hit": null,
+            "hit": null,
+            "noncache_hit": null,
+            "size": null
+        },
+        "total": null
+    }
+}

Get Zone Node Stats by Report Type

Get usage statistics for a particular {node_id} optionally +broken up by {report_type}. If no {report_type} is given the +request will return the total usage for the node.

GET +https://rws.maxcdn.com/{companyalias}/clients/{id}/reports/nodes.json/{node_id}/stats/{report_type}

Accepted Request Parameters

Parameter	Default Value	Validation	Description
date_from	now() - 1 month	Y-m-d (e.g. 2012-01-01)	Start date
date_to	now()	Y-m-d (e.g. 2012-01-01)	End date

Response Parameters

Parameter	Description
size	The amount of bytes transferred
hit	The number of times files were requested
noncache_hit	SThe number of times a requested file was not in cache
timestamp	The timestamp for the corresponding {report_type}

Code Samples

+id = '1'
+reportType = '' #Valid input includes '/daily', '/hourly', '/monthly' or ''
+api.get('/clients/{id}/reports/nodes.json/'+id+'/stats'+reportType)

+id = '1'
+reportType = '' #Valid input includes '/daily', '/hourly', '/monthly' or ''
+api.get('/clients/{id}/reports/nodes.json/'+id+'/stats'+reportType)

+$id = '1';
+$reportType = ''; //Vaild input includes '/daily', '/hourly', '/monthly' or ''
+$api->get('/clients/{id}/reports/nodes.json/'.$id.'/stats/'.$reportType);

+var id = '1'
+var reportType = '' //Valid input includes '/daily', '/hourly', '/monthly' or ''
+api.get('/clients/{id}/reports/nodes.json/' + id + '/stats/' + reportType, function(err, response) {
+  console.log('err', err, 'response', response)
+})

+{
+    "code": 200,
+    "data": {
+        "stats": [
+            {
+                "cache_hit": "0",
+                "hit": "2",
+                "noncache_hit": "2",
+                "size": "0"
+            }
+        ],
+        "total": "1"
+    }
+}

Get Node Stats by Zone and Report Type

Get usage statistics for a particular {node_id} and {zone_id}, +optionally broken up by {report_type}. If no {report_type} is given +the request will return the total usage for the node.

GET +https://rws.maxcdn.com/{companyalias}/clients/{id}/reports/{zone_id}/nodes.json/{node_id}/stats/{report_type}

Accepted Request Parameters

Parameter	Default Value	Validation	Description
date_from	now() - 1 month	Y-m-d (e.g. 2012-01-01)	Start date
date_to	now()	Y-m-d (e.g. 2012-01-01)	End date

Response Parameters

Parameter	Description
size	The amount of bytes transferred
hit	The number of times files were requested
noncache_hit	SThe number of times a requested file was not in cache
timestamp	The timestamp for the corresponding {report_type}

Code Samples

+zoneId='96061'
+nodeId='1'
+reportType = '' #Valid input includes '/daily', '/hourly', '/monthly' or ''
+api.get('/clients/{id}/reports/'+zoneId+'/nodes.json/'+nodeId+'/stats'+reportType)

+zoneId='96061'
+nodeId='1'
+reportType = '' #Valid input includes '/daily', '/hourly', '/monthly' or ''
+api.get('/clients/{id}/reports/'+zoneId+'/nodes.json/'+nodeId+'/stats'+reportType)

+$zoneId='96061';
+$nodeId='1';
+$reportType = ''; //Vaild input includes '/daily', '/hourly', '/monthly' or ''
+$api->get('/clients/{id}/reports/'.$zoneId.'/nodes.json/'.$nodeId.'/stats/'.$reportType);

+var zoneId = '96061'
+var nodeId = '1'
+var reportType = '' //Valid input includes '/daily', '/hourly', '/monthly' or ''
+api.get('/clients/{id}/reports/' + zoneId + '/nodes.json/' + nodeId + '/stats/' + reportType, function(err, response) {
+  console.log('err', err, 'response', response)
+})

+{
+    "code": 200,
+    "data": {
+        "stats": [
+            {
+                "cache_hit": null,
+                "hit": null,
+                "noncache_hit": null,
+                "size": null
+            }
+        ],
+        "total": "0"
+    }
+}

Reports by Popular Files API

List Popular Files

Gets the most popularly requested files for your account, +grouped into daily statistics

GET +https://rws.maxcdn.com/{companyalias}/clients/{id}/reports/{zone_id}/popularfiles.json

Accepted Request Parameters

Parameter	Default Value	Validation	Description
date_from	now() - 1 month	Y-m-d (e.g. 2012-01-01)	Start date
date_to	now()	Y-m-d (e.g. 2012-01-01)	End date

Response Parameters

Parameter	Description
bucket_id	The Zone ID for the popular file
uri	The URI for the requested popular file
hit	The number of times the file was requested
size	The amount of bytes transferred for the given file
vhost	The CDN URL for the corresponding zone
timestamp	The amount of bytes transferred

Code Samples

+api.get('/clients/{id}/reports/popularfiles.json')

+api.get('/clients/{id}/reports/popularfiles.json')

+$api->get('/clients/{id}/reports/popularfiles.json');

+api.get('/clients/{id}/reports/popularfiles.json', function(err, response) {
+  console.log('err', err, 'response', response)
+})

+{
+    "code": 200,
+    "data": {
+        "current_page_size": 0,
+        "page": 1,
+        "page_size": "50",
+        "pages": 0,
+        "popularfiles": [],
+        "summary": {
+            "hit": null,
+            "size": null
+        },
+        "total": "0"
+    }
+}

List Popular Files By Zone Type

GET +https://rws.maxcdn.com/{companyalias}/clients/{id}/reports/{zone_type}/popularfiles.json

Accepted Request Parameters

Parameter	Default Value	Validation	Description
date_from	now() - 1 month	Y-m-d (e.g. 2012-01-01)	Start date
date_to	now()	Y-m-d (e.g. 2012-01-01)	End date

Response Parameters

Parameter	Description
bucket_id	The Zone ID for the popular file
uri	The URI for the requested popular file
hit	The number of times the file was requested
size	The amount of bytes transferred for the given file
vhost	The CDN URL for the corresponding zone
timestamp	The timestamp for the corresponding {report_type}

Code Samples

+type='pull'
+api.get('/clients/{id}/reports/'+type+'/popularfiles.json')

+type='pull'
+api.get('/clients/{id}/reports/'+type+'/popularfiles.json')

+$type='pull';
+$api->get('/clients/{id}/reports/'.$type.'/popularfiles.json');

+var type = 'pull'
+api.get('/clients/{id}/reports/' + type + '/popularfiles.json', function(err, response) {
+  console.log('err', err, 'response', response)
+})

+{
+    "code": 200,
+    "data": {
+        "current_page_size": 0,
+        "page": 1,
+        "page_size": "50",
+        "pages": 0,
+        "popularfiles": [],
+        "summary": {
+            "hit": null,
+            "size": null
+        },
+        "total": "0"
+    }
+}

Reports By Directory API

List Stats By Directory

Gets usage statistics by directory for your account. (This +report has to be enabled by Sales).

GET +https://rws.maxcdn.com/{companyalias}/clients/{id}/reports/statsbydir.json/{report_type}

Accepted Request Parameters

Parameter	Default Value	Validation	Description
date_from	now() - 1 month	Y-m-d (e.g. 2012-01-01)	Start date
date_to	now()	Y-m-d (e.g. 2012-01-01)	End date

Response Parameters

Parameter	Description
bucket_id	The Zone ID for the top level directory
dir	The name of the directory
hit	The number of requests made to files within this directory
size	The amount of bytes transferred from within this directory

Code Samples

+reportType = '' #Valid input includes '/daily', '/hourly', '/monthly' or ''
+api.get('/clients/{id}/reports/statsbydir.json'+reportType)

+reportType = '' #Valid input includes '/daily', '/hourly', '/monthly' or ''
+api.get('/clients/{id}/reports/statsbydir.json'+reportType)

+$reportType = ''; //Vaild input includes '/daily', '/hourly', '/monthly' or ''
+$api->get('/clients/{id}/reports/statsbydir.json/'.$reportType);

+var reportType = '' //Valid input includes '/daily', '/hourly', '/monthly' or ''
+api.get('/clients/{id}/reports/statsbydir.json/' + reportType, function(err, response) {
+  console.log('err', err, 'response', response)
+})

+{
+    "code": 200,
+    "data": {
+        "current_page_size": 0,
+        "page": 1,
+        "page_size": "50",
+        "pages": 0,
+        "statsbydir": [],
+        "summary": {
+            "hit": null,
+            "size": null
+        },
+        "total": "0"
+    }
+}

Gets usage statistics by directory for the specified {zone_id}. +(This report has to be enabled by Sales).

GET +https://rws.maxcdn.com/{companyalias}/clients/{id}/reports/{zone_id}/statsbydir.json/{report_type}

Accepted Request Parameters

Parameter	Default Value	Validation	Description
date_from	now() - 1 month	Y-m-d (e.g. 2012-01-01)	Start date
date_to	now()	Y-m-d (e.g. 2012-01-01)	End date

Response Parameters

Parameter	Description
bucket_id	The Zone ID for the top level directory
dir	The name of the directory
hit	The number of requests made to files within this directory
size	The amount of bytes transferred from within this directory

Response Parameters

+reportType = '' #Valid input includes '/daily', '/hourly', '/monthly' or ''
+id = '96061'
+api.get('/clients/{id}/reports/'+id+'/statsbydir.json'+reportType)

+reportType = '' #Valid input includes '/daily', '/hourly', '/monthly' or ''
+id = '96061'
+api.get('/clients/{id}/reports/'+id+'/statsbydir.json'+reportType)

+$reportType = ''; //Vaild input includes '/daily', '/hourly', '/monthly' or ''
+$id = '96061';
+$api->get('/clients/{id}/reports/'.$id.'/statsbydir.json/'.$reportType);

+var reportType = '' //Valid input includes '/daily', '/hourly', '/monthly' or ''
+var id = '96061'
+api.get('/clients/{id}/reports/' + id + '/' + '/statsbydir.json/' + reportType, function(err, response) {
+  console.log('err', err, 'response', response)
+})

+{
+    "code": 200,
+    "data": {
+        "current_page_size": 0,
+        "page": 1,
+        "page_size": "50",
+        "pages": 0,
+        "statsbydir": [],
+        "summary": {
+            "hit": null,
+            "size": null
+        },
+        "total": "0"
+    }
+}

Raw Logs API

Get Raw Logs

Retrieve up to five days of raw log data

GET +https://rws.maxcdn.com/{companyalias}/clients/{id}/v3/reporting/logs.json

Accepted Request Parameters

Parameter	Default Value	Validation	Description
start	now() - 1 hour	ISO-8601 formatted date/time	The start of the range for requests to pull.
end	now()	ISO-8601 formatted date/time	The end of the range for requests to pull
zones	-	CSV of ints	The specific zones whose requests you want to pull. Separate multiple zone ids by comma
uri	-	string	Use this filter to view requests made for a specific resource (or group of resources). You can do a literal match or regular expression in this field (i.e. '/images/header.png' or 'regex:/images/')
status	-	CSV of ints	The specific HTTP status code responses you want to pull. Separate multiple HTTP status codes by comma (i.e. 200,201,304)
ssl	both	enum(nossl, ssl, both)	Use this filter to distinguish between SSL and non-SSL traffic (choose nossl, ssl or both)
user_agent	-	string	Filter logs by specific user agents. You can do a literal match or regular expression in this field (i.e. 'Python MaxCDN API Client' or 'regex:Chrome')
referer	-	string	Filter logs by a specific referer. You can do a literal match or regular expression in this field (i.e. 'www.maxcdn.com' or 'regex:maxcdn.com')
pop	-	CSV of strings	Filter logs by specific POPs (Points Of Presence), use comma separation for multiple POPs. Possible values: ams, atl, aus, chi, dal, den, fra, hkg, jfk, lax, lhr, mia, sea, sfo, sin, sjc, slc, tko, vir
query_string	-	string	Filter logs by a specific query string. You can do a literal match or regular expression in this field (i.e. 'width=600' or 'regex:width')
limit	100	int	How many records should be retrieved per page. Maximum is 1000
start_key	-	string	String-based key for next page of records to return, for easy pagination or streaming. This key will be provided in the "next_page_key" from a response.
sort	recent	enum(recent, oldest)	Display records sorted by newest first or oldest first

Response Parameters

Parameter	Description
limit	The maximum number of records retrieved
page	The current page of records retrieved
noncache_hit	The number of times a requested file was not in cache
request_time	Time in milliseconds for request to complete
next_page_key	Number string that can be used to load the next page
records	Total records displayed
bytes	Total bytes of request
client_asn	Visitor's "access network" (ISP)
client_city	Visitor's city
client_continent	Visitor's continent
client_country	Visitor's country
client_dma	Visitor's "designated market area"
client_ip	Visitor's public IP
client_latitude	Visitor's geographical latitude (roughly)
client_longitude	Visitor's geographical longitude (roughly)
client_state	Visitor's state
company_id	Your company ID
cache_status	CDN status of the file (HIT, MISS)
hostname	Domain name that was visited
method	HTTP request method
origin_time	How long it takes MaxCDN to retrieve the file (if cache status was a MISS)
pop	Point Of Presence that was hit (LAX, LHR, TYO, etc.)
protocol	HTTP protocol used
query_string	Query string attached to a file (ex. ver=1.2)
referer	Referring site
scheme	HTTP or HTTPS
status	HTTP status code (200, 404, 302, etc.)
time	UTC timestamp of the request
uri	File requested
user_agent	Text identifying the visitor's browser
zone_id	ID of the Push/Pull/VOD zone hit

Response Parameters

Parameter	Description
size	The amount of bytes transferred
hit	The number of times files were requested
noncache_hit	The number of times a requested file was not in cache
timestamp	The timestamp for the corresponding {report_type}

Code Samples

+api.get('/clients/{id}/v3/reporting/logs.json?start=2014-01-30&end=2014-01-31&status=200')

+params = {"start":"2014-01-30", "end":"2014-01-31", "status":"200"}
+api.get('/clients/{id}/v3/reporting/logs.json', data=params)

+$params = array("start"=>"2014-01-30", "end"=>"2014-01-31", "status"=>"200")
+$api->get('/clients/{id}/v3/reporting/logs.json', $params)

+api.get('/clients/{id}/v3/reporting/logs.json?start=2014-01-30&end=2014-01-31&status=200', function(err, response) {
+  console.log(response);
+});

+{
+  "limit":1000,
+  "page":1,
+  "total":3,
+  "next_page_key":"1234abcdef",
+  "records":[
+    {
+      "bytes":175953,
+      "asn":"AS4804 Microplex PTY LTD",
+      "city":"Brisbane",
+      "continent":"OC",
+      "country":"AU",
+      "dma":"0",
+      "ip":"127.0.0.1",
+      "latitude":0,
+      "longitude":1.2345,
+      "cache_status":"HIT",
+      "hostname":"cdn.example.com",
+      "method":"GET",
+      "origin_time":"0",
+      "pop":"lax",
+      "protocol":"HTTP/1.1",
+      "query_string":"",
+      "scheme":"https",
+      "status_code":200,
+      "request_time":"2014-01-30T17:00:12Z",
+      "uri":"/content.png",
+      "user_agent":"Opera/9.80 (Windows NT 5.1; Edition DriverPack) Presto/2.12.388 Version/12.16",
+      "zone":"example"
+    },
+    {
+      "bytes":175953,
+      "asn":"AS4804 Microplex PTY LTD",
+      "city":"Brisbane",
+      "continent":"OC",
+      "country":"AU",
+      "dma":"0",
+      "ip":"127.0.0.1",
+      "latitude":0.0,
+      "longitude":0.12345,
+      "cache_status":"HIT",
+      "hostname":"cdn.example.com",
+      "method":"GET",
+      "origin_time":"0",
+      "pop":"lax",
+      "protocol":"HTTP/1.1",
+      "query_string":"ver=1.2",
+      "scheme":"https",
+      "status_code":200,
+      "request_time":"2014-01-30T17:00:12Z",
+      "uri":"/sample/test.swf",
+      "user_agent":"Opera/9.80 (Windows NT 5.1; Edition DriverPack) Presto/2.12.388 Version/12.16",
+      "zone":"example"
+    }
+  ]
+}

+ })(document,"script","hs-analytics",300000); From b166ee7af26aef728fa524a7c9454f8944e2d78f Mon Sep 17 00:00:00 2001 From: Ivan Dabic Date: Fri, 29 May 2015 23:45:43 +0200 Subject: [PATCH 2/3] Added Perl Intro --- README.md | 1 + public/index.html | 7292 +-------------------------------------------- 2 files changed, 19 insertions(+), 7274 deletions(-) diff --git a/README.md b/README.md index 0b55eca..f3076de 100644 --- a/README.md +++ b/README.md @@ -24,6 +24,7 @@ * Integrate with our RESTful API using a language wrapper: * [Node](https://github.com/maxcdn/node-maxcdn) * [Ruby](https://github.com/maxcdn/ruby-maxcdn) + * [Perl](https://github.com/maxcdn/perl-maxcdn) * [Python](https://github.com/maxcdn/python-maxcdn) * [PHP](https://github.com/MaxCDN/php-maxcdn) * [.NET](https://github.com/MaxCDN/dotnet-maxcdn) diff --git a/public/index.html b/public/index.html index 1a2827a..2dc6d9c 100644 --- a/public/index.html +++ b/public/index.html @@ -1,7 +1,6 @@ MaxCDN - API Docs

API Docs

MaxCDN API Docs

API Docs

MaxCDN API Docs

API Docs

MaxCDN API Docs

MaxCDN is a Content Delivery Network service.

Index

Zones API
Reports API
Raw Logs API
Reseller API
Origin Shield API

Overview

@@ -27,6 +25,7 @@

Overview

Node
Ruby
Perl
Python
PHP
.NET

Code Samples

- - -

Reseller API

- - - -

Get Client Bandwidth

-Gets client bandwidth information -
-

GET -https://rws.maxcdn.com/{companyalias}/clients/{id}/bandwidth.json

- -

Code Samples

- -

-api.get("/clients/{id}/bandwidth.json")

api.get("/clients/{id}/bandwidth.json")

-$api->get('/clients/{id}/bandwidth.json');

-api.get('/clients/{id}/bandwidth.json', callback)
-function callback(err, response) {
-  if (err) return console.log(err)
-  console.log(response)
-}

-{
-    "code": 200,
-    "data": {
-        "account": {total": "1", 
-        "summary": [{
-            "valid_until": "Jun 07, 2011", 
-            "credit": "10", 
-            "still_valid": false, 
-            "base": 1000, 
-            "expiration": false, 
-            "purchased": "Jun 07, 2010", "debit": 11107173020
-            }]
-        }
-    }
-}

- -

Get Storage Data

- -

Gets relevant storage data

- -

GET -https://rws.maxcdn.com/{companyalias}/clients/{id}/storage.json

- -

Response Parameters

- - - - - - - - -

Parameter	Description
zone_id	Zone ID
storage	Amount of Storage Used
storage_id	Storage ID
zone_type	Type of Zone
zone_name	Name of Zone
last_updated	Date Last Updated

- -

Code Samples

- -

-api.get("/clients/{id}/storage.json")

api.get("/clients/{id}/storage.json")

-$api->get('/clients/{id}/storage.json');

-api.get('/clients/{id}/storage.json', callback)
-function callback(err, response) {
-  if (err) return console.log(err)
-  console.log(response)
-}

-{
-    "code": 200, "data": {
-        "stats": [
-        {
-            "last_updated": "2014-11-13 18:39:19", 
-            "zone_id": "{zoneid}", 
-            "storage_used": "1234", 
-            "storage_id": "1", 
-            "zone_type": "1", 
-            "zone_name": "zonename"}, 
-        {
-            "last_updated": "2014-11-13 16:00:50", 
-            "zone_id": "zoneid", 
-            "storage_used": "5678", 
-            "storage_id": "2", 
-            "zone_type": "2", 
-            "zone_name": "zonename2"
-        }, 
-        {
-            "last_updated": "2014-11-13 16:00:08", 
-            "zone_id": "zoneid", 
-            "storage_used": "9012", 
-            "storage_id": "3", 
-            "zone_type": "3", 
-            "zone_name": "zonename3"
-        }, 
-        {
-            "last_updated": "2014-11-13 18:39:19", 
-            "zone_id": "zoneid", 
-            "storage_used": "3456", 
-            "storage_id": "4", 
-            "zone_type": "4", 
-            "zone_name": "zonename4"
-        }, 
-        {
-            "last_updated": "2014-11-13 16:00:50", 
-            "zone_id": "zoneid", 
-            "storage_used": "7890", 
-            "storage_id": "5", 
-            "zone_type": "5", 
-            "zone_name": "zonename"}
-        ], 
-    "page_size": "50", 
-    "pages": 1, 
-    "current_page_size": 1, 
-    "total": "1", 
-    "page": 1
-    }
-}
-

- -

Get Storage Used

- -

Gets the amount of storage that has currently been used.

- -

GET -https://rws.maxcdn.com/{companyalias}/clients/{id}/storage/used.json

- -

Code Samples

- -

-api.get("/clients/{id}/storage/used.json")

api.get("/clients/{id}/storage/used.json")

-$api->get('/clients/{id}/storage/used.json');

-api.get('/clients/{id}/storage/used.json', callback)
-function callback(err, response) {
-  if (err) return console.log(err)
-  console.log(response)
-}

-{
-"code": 200, 
-"data": {
-    "storage": "1535815680"
-    }
-}

- -

Account API

- -

Get Account

- -

Gets account information

- -

GET -https://rws.maxcdn.com/{companyalias}/clients.json

- -

Response Parameters

- - - - - - - - - -

Parameter	Description
name	The Name of your Account
address_id	Address ID
alias	Company Alias
ssl_credits	SSL Credits
flex_credits	Flex Location Credits
date_created	Date Created
date_updated	Date Updated

- -

Code Samples

- -

-api.get("{/clients.json")

api.get("{/clients.json")

-$api->get('/clients.json');

-api.get('/clients.json', callback)
-function callback(err, response) {
-  if (err) return console.log(err)
-  console.log(response)
-}

-{
-    "code": 200,
-    "data": {
-        "current_page_size": 2,
-        "page": 1,
-        "page_size": "50",
-        "pages": 1,
-        "total": 2,
-        "users": [
-        {
-            "alias": "aliasname",
-            "date_created": "2013-05-15 17:32:30",
-            "date_updated": "2013-05-15 19:43:36",
-            "edgerules_credits": "0",
-            "flex_credits": "-1",
-            "id": "#####",
-            "name": "MaxCDN sampleCode",
-            "secure_token_pull_credits": "0",
-            "server_id": "18",
-            "ssl_credits": "1",
-            "status": "2",
-            "storage_quota": "107374182400",
-            "storage_server_id": "11",
-            "zone_credits": "-1"
-        },
-        {
-            "alias": "aliasname",
-            "date_created": "2013-05-15 17:32:30",
-            "date_updated": "2013-05-15 19:43:36",
-            "edgerules_credits": "0",
-            "flex_credits": "-1",
-            "id": "#####",
-            "name": "MaxCDN sampleCode",
-            "secure_token_pull_credits": "0",
-            "server_id": "18",
-            "ssl_credits": "1",
-            "status": "2",
-            "storage_quota": "107374182400",
-            "storage_server_id": "11",
-            "zone_credits": "-1"
-        }
-    ]}
-}

- -

Users API

- -

List Users

- -

Returns a list of all users on the specified account

- -

GET -https://rws.maxcdn.com/{companyalias}/clients/{id}/users.json

- -

Response Parameters

- - - - - - - - - - - - - -

Parameter	Description
id	User ID
email	E-mail Address
firstname	First Name
lastname	Last Name
phone	Phone Number
timezone	Users' Time Zone
date_last_login	The date and time the user last logged into the system
ip_last_long	The IP for the user at the last login
date_created	Date Created
date_uodated	Date Updated
roles	An array of roles for the given user

- -

Code Samples

- -

-api.get('/clients/{id}/users.json')

-api.get('/clients/{id}/users.json')

-$api->get('/clients/{id}/users.json');

-api.get('/clients/{id}/users.json', callback)
-function callback(err, response) {
-  if (err) return console.log(err)
-  console.log(response)
-}

-{
-    "code": 200,
-    "data": {
-        "current_page_size": 4,
-        "page": 1,
-        "page_size": "50",
-        "pages": 1,
-        "total": 4,
-        "users": [
-            {
-                "brand_id": "1",
-                "date_created": "2013-05-15 17:32:30",
-                "date_last_login": "2013-05-23 17:54:18",
-                "date_updated": "2013-05-15 17:33:09",
-                "default_company_id": "#####",
-                "email": "name@domain.com",
-                "firstname": "Given",
-                "id": "33706",
-                "ip_last_login": "12.13.90.183",
-                "isadmin": "0",
-                "isdisabled": "0",
-                "lastname": "Family",
-                "phone": "3235551400",
-                "roles": [
-                    "User",
-                    "Account Owner"
-                ],
-                "timezone": "Europe/London"
-            },
-            {
-                "brand_id": "1",
-                "date_created": "2013-05-15 20:16:34",
-                "date_last_login": null,
-                "date_updated": "0000-00-00 00:00:00",
-                "default_company_id": "19538",
-                "email": "caphammer1@hamcave.com",
-                "firstname": "Captain",
-                "id": "33714",
-                "ip_last_login": null,
-                "isadmin": "0",
-                "isdisabled": "0",
-                "lastname": "Hammer",
-                "phone": null,
-                "roles": [
-                    "User"
-                ],
-                "timezone": "Europe/London"
-            },
-            {
-                "brand_id": "1",
-                "date_created": "2013-05-15 20:20:03",
-                "date_last_login": null,
-                "date_updated": "2013-05-15 20:31:05",
-                "default_company_id": "19538",
-                "email": "drhorrible3@ele.net",
-                "firstname": "Billy",
-                "id": "33716",
-                "ip_last_login": null,
-                "isadmin": "0",
-                "isdisabled": "0",
-                "lastname": "Horrible",
-                "phone": null,
-                "roles": [
-                    "User"
-                ],
-                "timezone": "Europe/London"
-            }
-        ]
-    }
+  "code": 201
 }

@@ -11645,589 +11178,29 @@

Code Samples

] }, "code": 201 - -

Create Client

Creates a new client on the specified account

Delete Origin Shield

Remove the active Origin Shield from your Pull Zone

POST -https://rws.maxcdn.com/{companyalias}/clients.json

DELETE +https://rws.maxcdn.com/{companyalias}/zones/pull/{zone_id}/zoneshields.json

Accepted Request Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Parameter	Default Value	Validation	Description
companyname	-	required length: 1-255 chars	Company Name
companyalias	-	required length: 1-45 chars	Company Alias
group_id	-	required length: 1-11 chars	Group ID Number
package_id	-	required length: 1-11 chars	Package ID Number (Contact your sales representative to determine your Package ID Number)
account_owner	-	required A JSON Encoded Array including 'email', 'firstname', 'lastname', 'password', 'phone', 'order_status (active)	- Account Owner Information: - - - - 'email' - Account Owner's Email - 'firstname' - Account Owner's First Name - 'lastname' - Account Owner's Last Name - 'password' - Account's Password - 'phone' - Account Owner's Phone Number - 'order_status' - Status of the Account (hard coded to 'active') - - -
address	-	required A JSON Encoded Array including street1, street2 (not required), City, State, ZIP / Postal Code, Country	Account Owner Address
paymentmethod	'mailin'	required	Payment Method "Hard code this to Mail-In Payment"
generateinvoice	'0'	required	Hard Code this to not generate an invoice with the parameter '0'
order_status	'active'	required	Hard Code this to active with 'Active'

Response Parameters

- - - - - - - - - - - - - - - - - - -

Parameter	Description
email	Email Address
firstname	First Name
lastname	Last Name
phone	Phone Number
companyname	Name of the Company
companyalias	Alias of the Company
group_id	Group ID Number
address1	Address, first line
city	City
state	Alias of the Company
postcode	City Post/ZIP Code
country	Country
phonenumber	Phone Number
password	Password
active	Whether or not the client is active

- -

Code Samples

- -

Ruby
Python
PHP
Node
Response

Code Samples

-        account_owner={
-            "firstname"=>"First Name",
-            "lastname"=>"Last Name",
-            "email"=>"E-Mail",
-            "phone"=>"1234567890", 
-            "password"=>"password", 
-            "order_status"=>"Active"
-        }
-        
-        address={
-            "street1"=>"Street One",
-            "street2"=>"Not Required",
-            "city"=>"City Name",
-            "state"=>"State", 
-            "zip"=>"ZIP / Postal Code", 
-            "country"=>"US (or country name)"
-        }
-        
-        params={
-            "companyname"=>"Company Name",
-            "companyalias"=>"Company Alias",
-            "group_id"=>"Group ID",
-            "package_id"=>"x", 
-            "account_owner"=>JSON.encode(account_owner), 
-            "address"=>JSON.encode(address),
-            "paymentmethod"=>"mailin"
-        }
-        
-        api.post('/clients.json',params)
-

-        account_owner = {
-            'firstname':'First Name',
-            'lastname':'Last Name',
-            'email':'E-Mail',
-            'phone':'1234567890', 
-            'password':'password', 
-            'order_status':'Active'
-        }
-        
-        address = {
-            'street1':'Street One',
-            'street2':'Not Required',
-            'city':'City Name',
-            'state':'State', 
-            'zip':'ZIP / Postal Code', 
-            'country':'US (or country name)'
-        }
-        
-        params = {
-            'companyname":'Company Name',
-            'companyalias':'Company Alias',
-            'group_id':'Group ID',
-            'package_id':'x', 
-            'account_owner':json.dumps(account_owner), 
-            'address':json.dumps(address),
-            'paymentmethod':'mailin
-        }
-        
-        api.post('/clients.json',data=params)
-

-        
-        $account_owner = array(
-            'firstname' => 'john',
-            'lastname'  => 'doe',
-            'email'     => 'johndoe@gmail.com',
-            'phone'     => '555-555-5555',
-            'password'  => 'testpass',
-            'order_status'    => active
-        );
-        
-        
-        $address = array(
-            'street1' => '123 Fake St.',
-            'city'    => 'Los Angeles',
-            'state'   => 'California',
-            'zip'     => '90000',
-            'country' => 'US'
-        );
-        
-        $params = array(
-            'name'          => 'New Account Name',
-            'companyalias'         => 'newaccountalias',
-            'group_id'      => 27,
-            'package_id'    => x,
-            'account_owner' => json_encode($account_owner),
-            'address'       => json_encode($address)
-            'paymentmethod' => mailin
-        );
-        
-        $response = $api->post("/clients.json", $params);
-        
-

-    var account_owner = [ 
-        firstname:'First Name',
-        lastname:'Last Name',
-        email:'E-Mail',
-        phone:'1234567890', 
-        password:'password', 
-        order_status:'active'
-    ];
-    
-    var address = [ 
-        street1: '123 Fake St.',
-        city: 'Los Angeles',
-        state: 'California',
-        zip: '90000',
-        country: 'US'
-    ];
-    
-    var params = [ 
-        name => 'New Account Name',
-        companyalias => 'newaccountalias',
-        group_id => 27,
-        package_id => x,
-        account_owner => json_encode(account_owner),
-        address => json_encode(address),
-        paymentmethod => mailin
-    ];
-    
-    api.post('/clients.json' + params, callback)
-    function callback(err, response) {
-      if (err) return console.log(err)
-      console.log(response)
-    }
-

-        {
-            "code": 201,
-            "data": {
-                "Client": {
-                    "group_id": null,
-                    "company_id": "Company Name",
-                    "company_alias": "Company Alias"
-                    "date_created": "2013-05-23 18:22:11",
-                    "status": "Active",
-                    "date_last_login": null,
-                    "date_updated": null,
-                    "default_company_id": "19538",
-                    "email": "name@domain.com",
-                    "firstname": "Given",
-                    "ip_last_login": null,
-                    "isdisabled": 0,
-                    "lastname": "Family",
-                    "phone": null,
-                    "timezone": "America/Los_Angeles"
-                }
-            }
-        }
-

Create User

Creates a new user on the specified account

POST -https://rws.maxcdn.com/{companyalias}/clients/{id}/users.json

Accepted Request Parameters

Parameter	Default Value	Validation	Description
email	-	required length: 5-30 chars	Email Address
password	-	required length: 5-30 chars	Password
firstname	-	required length: 1-32 chars	First Name
lastname	-	required length: 1-32 chars	Last Name
phone	-	length: 7, 10, 11, or 14 chars; only digits considered	Phone Number
timezone	-	valid::timezone	Valid timezone (see [List of Supported Timezones](http://php.net/manual/en/timezones.php))

Response Parameters

Parameter	Description
email	Email Address
firstname	First Name
lastname	Last Name
phone	Phone Number
date_last_login	The date and time the user last logged into the system
ip_last_login	The IP for the user at the last login
date_created	Date Created
date_updated	Date Updated
roles	An array of roles for the given user

Code Samples

-params={"email"=>"name44@domain.com","password"=>"password","firstname"=>"Given","lastname"=>"Family"}
-api.post('/clients/{id}/users.json',params )

-params={'email':'name43@domain.com','password':'password','firstname':'Given','lastname':'Family'}
-api.post('/clients/{id}/users.json',data=params )

-$params = array("email"=>"name@domain.com","password"=>"password","firstname"=>"Given","lastname"=>"Family");
-$api->post('/clients/{id}/users.json',$params );

-api.post('/clients/{id}/users.json', { email: 'name@domain.com', password: 'password', firstname: 'Given', lastname: 'Family' }, callback)
-function callback(err, response) {
-  if (err) return console.log(err)
-  console.log(response)
-}

-{
-    "code": 201,
-    "data": {
-        "user": {
-            "brand_id": null,
-            "date_created": "2013-05-23 18:22:11",
-            "date_last_login": null,
-            "date_updated": null,
-            "default_company_id": "19538",
-            "email": "name@domain.com",
-            "firstname": "Given",
-            "id": 33941,
-            "ip_last_login": null,
-            "isadmin": 0,
-            "isdisabled": 0,
-            "lastname": "Family",
-            "phone": null,
-            "roles": [
-                "User"
-            ],
-            "timezone": "America/Los_Angeles"
-        }
-    }
-}

Get User

Gets a user specified by the {user_id} parameter

GET -https://rws.maxcdn.com/{companyalias}/clients/{id}/users.json/{user_id}

Response Parameters

Parameter	Description
id	Email Address
email	Email Address
firstname	First Name
lastname	Last Name
phone	Phone Number
timezone	User's Timezone

Code Samples

-id = '33706'
-api.get('/clients/{id}/users.json/'+id)

-id = '33706'
-api.get('/clients/{id}/users.json/'+id)

-$id = '33941';
-$api->get('/clients/{id}/users.json/'.$id);

-var id = '33941'
-api.get('/clients/{id}/users.json/' + id, callback)
-function callback(err, response) {
-  if (err) return console.log(err)
-  console.log(response)
-}

-{
-    "code": 200,
-    "data": {
-        "user": {
-            "brand_id": "1",
-            "date_created": "2013-05-23 18:22:11",
-            "date_last_login": null,
-            "date_updated": "0000-00-00 00:00:00",
-            "default_company_id": "19538",
-            "email": "name@domain.com",
-            "firstname": "Given",
-            "id": "33941",
-            "ip_last_login": null,
-            "isadmin": "0",
-            "isdisabled": "0",
-            "lastname": "Family",
-            "phone": null,
-            "roles": [
-                "User"
-            ],
-            "timezone": "Europe/London"
-        }
-    }
-}

Update User

Updates a user specified by the {user_id} parameter

PUT -https://rws.maxcdn.com/{companyalias}/clients/{id}/users.json/{user_id}

Accepted Request Parameters

Response Parameters

Parameter	Default Value	Validation	Description
email	-	length: 6-200 chars; valid email address	Email Address
firstname	-	length: 1-32 chars	First Name
lastname	-	length: 1-32 chars	Last Name
phone	-	length: 7, 10, 11, or 14 chars; only digits considered	Last Name
timezone	-	valid::timezone	Valid timezone (see [List of Supported Timezones](http://php.net/manual/en/timezones.php))

Parameter	Description
id	User ID
email	Email Address
firstname	First Name
lastname	Last Name
phone	Phone Number
last_updated	Date Last Updated
timezone	User's Timezone

Code Samples

-id = '33706'
-params={'firstname'=> 'name'}
-api.put('/clients/{id}/users.json/'+id,params)
-

-api.put('/clients/{id}/users.json/'+id,params={'firstname': 'name'})

-$id = '33941';
-$params =  array("firstname"=>"Billy");
-$api->put('/clients/{id}/users.json/'.$id,$params);

-var id = '33941'
-api.put('/clients/{id}/users.json/' + id, { firstname: 'Billy' }, callback)
-function callback(err, response) {
-  if (err) return console.log(err)
-  console.log(response)
-}

-{
-    "code": 200,
-    "data": {
-        "user": {
-            "brand_id": "1",
-            "date_created": "2013-05-23 18:22:11",
-            "date_last_login": null,
-            "date_updated": "2013-05-23 19:10:09",
-            "default_company_id": "19538",
-            "email": "name@domain.com",
-            "firstname": "Billy",
-            "id": "33941",
-            "ip_last_login": null,
-            "isadmin": "0",
-            "isdisabled": "0",
-            "lastname": "Family",
-            "phone": null,
-            "roles": [
-                "User"
-            ],
-            "timezone": "Europe/London"
-        }
-    }
-}

Delete Origin Shield

Remove the active Origin Shield from your Pull Zone

DELETE -https://rws.maxcdn.com/{companyalias}/zones/pull/{zone_id}/zoneshields.json

Code Samples

 id = '97167'
 api.delete('/zones/pull/'+id+'/zoneshields.json')

@@ -12256,6235 +11229,6 @@

Code Samples

}

Delete User

- -

Deletes a user specified by the {user_id} parameter

- -

DELETE -https://rws.maxcdn.com/{companyalias}/clients/{id}/users.json/{user_id}

- - -

Code Samples

- -

-id = '33706'
-api.delete('/clients/{id}/users.json/'+id)

-id = '33706'
-api.delete('/clients/{id}/users.json/'+id)

-$id = '33715';
-$api->delete('/clients/{id}/users.json/'.$id);

-var id = '33715'
-api.delete('/clients/{id}/users.json/' + id, callback)
-function callback(err, response) {
-  if (err) return console.log(err)
-  console.log(response)
-}

-{
-  "code":200
-}

- - -

Zones API

- -

List Zones

- -

Returns a list of all zones on the specified account

- -

GET -https://rws.maxcdn.com/{companyalias}/clients/{id}/zones.json

- -

Code Samples

- -

-api.get('/clients/{id}/zones.json')

-api.get('/clients/{id}/zones.json')

-$api->get('/clients/{id}/zones.json');

-api.get('/clients/{id}/zones.json', function(err, response) {
-  console.log('err', err, 'response', response)
-})

-{
-    "code": 200,
-    "data": {
-        "current_page_size": 2,
-        "page": 1,
-        "page_size": "50",
-        "pages": 1,
-        "total": 2,
-        "zones": [
-            {
-                "cdn_url": "cdn.somedomain.com",
-                "creation_date": "2013-05-15 20:45:44",
-                "id": "#####",
-                "inactive": "0",
-                "label": "personal",
-                "locked": "0",
-                "name": "zoneName",
-                "suspend": "0",
-                "tmp_url": "zone.alias.netdna-cdn.com",
-                "type": "2"
-            },
-            {
-                "cdn_url": "newlivezone.somedomain.netdna-cdn.com",
-                "creation_date": "2013-05-16 16:23:49",
-                "id": "#####",
-                "inactive": "0",
-                "label": null,
-                "locked": "0",
-                "name": "newlivezone",
-                "suspend": "0",
-                "tmp_url": "newlivezone.alias.netdna-cdn.com",
-                "type": "5"
-            }
-        ]
-    }
-}

- - -

Get Zone Summary

- -

Gets a summarized count of all zone types on the specified -account

- -

GET -https://rws.maxcdn.com/{companyalias}/clients/{id}/zones.json/summary

- -

Response Parameters

- - - - - -

Parameter	Description
pull	The number of pull zones for your account
push	The number of push zones for your account
vod	The number of vod zones for your account

- -

Code Samples

- -

-api.get('/clients/{id}/zones.json/summary')

-api.get('/clients/{id}/zones.json/summary')

-$api->get('/clients/{id}/zones.json/summary');

-api.get('/clients/{id}/zones.json/summary', function(err, response) {
-  console.log('err', err, 'response', response)
-})

-{
-    "code": 200,
-    "data": {
-        "summary": {
-            "live": 1,
-            "pull": 1,
-            "push": 1,
-            "vod": 1
-        }
-    }
-}

- - -

Get Zone Count

- -

Counts all zones on the specified account

- -

GET -https://rws.maxcdn.com/{companyalias}/clients/{id}/zones.json/count

- -

Response Parameters

- - - -

Parameter	Description
count	The total number of content zones for your account

- -

Code Samples

- -

-api.get('/clients/{id}/zones.json/count')

-api.get('/clients/{id}/zones.json/count')

-$api->get('/clients/{id}/zones.json/count');

-api.get('/clients/{id}/zones.json/count', function(err, response) {
-  console.log('err', err, 'response', response)
-})

-{
-  "code":200,"data":
-    {
-      "count":"4"
-    }
-}

- - -

Pull Zone API

- -

List Pull Zones

- -

Returns a list of all pull zones on the specified account

- -

GET -https://rws.maxcdn.com/{companyalias}/clients/{id}/zones/pull.json

- -

Response Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Parameter	Description
id	Pull Zone ID
name	Pull Zone name
url	Origin URL
port	Port
ip	IP address of the Origin URL
compress	Enables on the fly GZip compression of your files from our edge servers for the following file types: text/plain, text/html, text/javascript, text/css, text/xml, application/javascript, application/x-javascript, application/xml, text/x-component, application/json, application/xhtml+xml, application/rss+xml, application/atom+xml, app/vnd.ms-fontobject, image/svg+xml, application/x-font-ttf, font/opentype, application/octet-stream
backend_compress	Enables us to cache, from origin, GZip compressed versions of your files for the following file types: text/plain, text/html, text/javascript, text/css, text/xml, application/javascript, application/x-javascript, application/xml, text/x-component, application/json, - application/xhtml+xml, application/rss+xml, application/atom+xml, app/vnd.ms-fontobject, image/svg+xml, application/x-font-ttf, font/opentype
queries	Treat Query Strings as a separate cacheable item
cache_valid	Ignore the origin Cache-Control Header and set every request to have a Max-Age of 1d, 7d, 1M or 12M
ignore_setcookie_header	Ignore any cookies set by the origin in order to make the content consistently cacheable
ignore_cache_control	Ignore any max age values set by the origin and use the CDN set value instead
use_stale	Serve expired content while fetching new content. This will also cause the CDN to serve expired content in cases where the origin is down
proxy_cache_lock	When multiple requests for an uncached file are received, they will wait until the first response is received rather than sending each request back to the origin
label	Ignore any cookies set by the origin in order to make the content consistently cacheable
valid_referers	List of domains for http referrer protection (separated by space), only the domains in the list will be treated as valid referrers
expires	Set any request with a no "Cache-Control header" from the origin to stay on the server. Possible values are 1d, 7d, 1M, 12M
disallow_robots	Enable robots.txt
canonical_link_headers	Pass the canonical URL in the Link HTTP Header
content_disposition	Force files to download
pseudo_streaming	Enable the zone for pseudo streaming content
sslshared	Enable Shared SSL for your zone, so you can use HTTPS, using our SSL certificate for netdna-ssl.com
suspend	Flag denoting if the zone has been suspended
locked	Flag denoting if the zone has been locked
inactive	Flag denoting if the zone has been deleted
creation_date	Date Created
spdy	Flag denoting if the zone has the SPDY protocol enabled

- - -

Code Samples

- -

-api.get('/clients/{id}/zones/pull.json')

-api.get('/clients/{id}/zones/pull.json')

-$api->get('/clients/{id}/zones/pull.json');

-api.get('/clients/{id}/zones/pull.json', function(err, response) {
-  console.log('err', err, 'response', response)
-})

-{
-    "code": 200,
-    "data": {
-        "current_page_size": 3,
-        "page": 1,
-        "page_size": "50",
-        "pages": 1,
-        "pullzones": [
-            {
-                "backend_compress": "0",
-                "cache_valid": "1d",
-                "canonical_link_headers": "0",
-                "cdn_url": "cdn.somedomain.com",
-                "compress": "1",
-                "content_disposition": "0",
-                "creation_date": "2013-05-15 20:45:44",
-                "disallow_robots": "0",
-                "disallow_robots_txt": null,
-                "dns_check": "1",
-                "expires": null,
-                "hide_setcookie_header": "0",
-                "id": "96061",
-                "ignore_cache_control": "0",
-                "ignore_setcookie_header": "0",
-                "inactive": "0",
-                "ip": "205.134.255.49",
-                "label": "personal",
-                "locked": "0",
-                "name": "somedomain",
-                "port": "80",
-                "proxy_cache_lock": "0",
-                "pseudo_streaming": "0",
-                "queries": "1",
-                "server_id": "18",
-                "set_host_header": null,
-                "sslshared": "0",
-                "suspend": "0",
-                "tmp_url": "somedomain.alias.netdna-cdn.com",
-                "type": "2",
-                "upstream_enabled": "0",
-                "url": "http://somedomain.net",
-                "use_stale": "0",
-                "valid_referers": null,
-                "spdy": 0
-            },
-            <...>,
-            {
-                "backend_compress": "0",
-                "cache_valid": "1d",
-                "canonical_link_headers": "0",
-                "cdn_url": "newpullzone3.alias.netdna-cdn.com",
-                "compress": "0",
-                "content_disposition": "0",
-                "creation_date": "2013-05-24 16:18:19",
-                "disallow_robots": "0",
-                "disallow_robots_txt": null,
-                "dns_check": "1",
-                "expires": null,
-                "hide_setcookie_header": "0",
-                "id": "97312",
-                "ignore_cache_control": "0",
-                "ignore_setcookie_header": "0",
-                "inactive": "0",
-                "ip": "205.134.255.49",
-                "label": null,
-                "locked": "0",
-                "name": "newpullzone3",
-                "port": "80",
-                "proxy_cache_lock": "0",
-                "pseudo_streaming": "0",
-                "queries": "1",
-                "server_id": "18",
-                "set_host_header": null,
-                "sslshared": "0",
-                "suspend": "0",
-                "tmp_url": "newpullzone3.alias.netdna-cdn.com",
-                "type": "2",
-                "upstream_enabled": "0",
-                "url": "http://somedomain.net",
-                "use_stale": "0",
-                "valid_referers": null,
-                "spdy": 1
-            }
-        ],
-        "total": 3
-    }
-}

- - -

Create Pull Zone

- -

Creates a new pull zone

- -

POST -https://rws.maxcdn.com/{companyalias}/clients/{id}/zones/pull.json

- -

Accepted Request Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Parameter	Default Value	Validation	Description
name	-	required length: 3-32 chars; only letters, digits, and dash (-)accepted	Pull Zone Name
url	-	required length: 4-100 chars; only valid URLs accepted	Origin URL
port	80	length: 1-5 chars; only digits accepted	Port
dns_check	1	only 0 or 1 accepted	This field determines how your Origin resolves. When set to 1, we automatically grab the origin's IP using DNS. Setting it to 0 allows you explicitly provide the IP of the origin.
ip	-	length: 1-10 chars, only digits accepted	Valid IP address of the Origin URL. Be sure to set `dns_check` to 0 to prevent this value from being overwritten.
compress	-	length: 1-5 chars; only digits accepted	only 0 or 1 accepted \| Enables on the fly GZip compression of your files from our edge servers for the following file types: text/plain, text/html, text/javascript, text/css, text/xml, application/javascript, application/x-javascript, application/xml, text/x-component, application/json, application/xhtml+xml, application/rss+xml, application/atom+xml, app/vnd.ms-fontobject, image/svg+xml, application/x-font-ttf, font/opentype
backend_compress	0	only 0 or 1 accepted	only 0 or 1 accepted \| Enables us to cache, from origin, GZip compressed versions of your files for the following file types: text/plain, text/html, text/javascript, text/css, text/xml, application/javascript, application/x-javascript, application/xml, text/x-component, application/json, application/xhtml+xml, application/rss+xml, application/atom+xml, app/vnd.ms-fontobject, image/svg+xml, application/x-font-ttf, font/opentype
queries	0	only 0 or 1 accepted	Treat Query Strings as a separate cacheable item
set_host_header	-	length: 4-100 chars; only valid URLs accepted	The URL to send as the Host in all HTTP Response Headers
cache_valid	1d	length: 1-30 chars; must be a number followed by one of s, m, h, d, M, or Y	Ignore the origin Cache-Control Header and set every request to have a Max-Age of 1d, 7d, 1M or 12M
ignore_setcookie_header	0	only 0 or 1 accepted	Ignore any cookies set by the origin in order to make the content consistently cacheable
ignore_cache_control	0	only 0 or 1 accepted	Ignore any max age values set by the origin and use the CDN set value instead
use_stale	0	only 0 or 1 accepted	Serve expired content while fetching new content. This will also cause the CDN to serve expired content in cases where the origin is down
proxy_cache_lock	0	only 0 or 1 accepted	When multiple requests for an uncached file are received, they will wait until the first response is received rather than sending each request back to the origin
label	-	length: 1-255 chars	Something that describes your zone
valid_referers	-	length: 1-100 chars	List of domains for http referrer protection (separated by space), only the domains in the list will be treated as valid referrers
expires	1d	length: 1-32 chars	Set any request with a no "Cache-Control header" from the origin to stay on the server. Possible values are 1d, 7d, 1M, 12M
disallow_robots	0	only 0 or 1 accepted	Enable robots.txt
disallow_robots_txt	-	length 1-255 chars	Use custom robots.txt
canonical_link_headers	1	only 0 or 1 accepted	Pass the canonical URL in the Link HTTP Header
content_disposition	0	only 0 or 1 accepted	Force files to download
x_forward_for	0	only 0 or 1 accepted	Add X-Forwarded-For (XFF) HTTP Header
pseudo_streaming	0	only 0 or 1 accepted	Enable the zone for pseudo streaming content
secret	-	length: 1 - 32 chars	Use a secret to protect your files from unwanted visitors
sslshared	0	only 0 or 1 accepted	Use a secret to protect your files from unwanted visitors
secret	-	length: 1 - 32 chars	Enable Shared SSL for your zone, so you can use HTTPS, using our SSL certificate for netdna-ssl.com
spdy	0	only 0 or 1 accepted	Enable SPDY protocol on the zone (requires SSL)

- -

Response Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Parameter	Description
id	Pull Zone ID
name	Pull Zone name
url	Origin URL
port	Port
ip	IP address of the Origin URL
backend_compress	Enables us to cache, from origin, GZip compressed versions of your files for the following file types: text/plain, text/html, text/javascript, text/css, text/xml, application/javascript, application/x-javascript, application/xml, text/x-component, application/json, application/xhtml+xml, application/rss+xml, application/atom+xml, app/vnd.ms-fontobject, image/svg+xml, application/x-font-ttf, font/opentype
queries	Treat Query Strings as a separate cacheable item
set_host_header	The URL sent as the Host in all HTTP Response Headers
cache_valid	Ignore the origin Cache-Control Header and set every request to have a Max-Age of 1d, 7d, 1M or 12M
ignore_setcookie_header	Ignore any cookies set by the origin in order to make the content consistently cacheable
ignore_cache_control	Ignore any max age values set by the origin and use the CDN set value instead
use_stale	Serve expired content while fetching new content. This will also cause the CDN to serve expired content in cases where the origin is down
proxy_cache_lock	When multiple requests for an uncached file are received, they will wait until the first response is received rather than sending each request back to the origin
label	List of domains for http referrer protection (separated by space), only the domains in the list will be treated as valid referrers
expires	Set any request with a no "Cache-Control header" from the origin to stay on the server. Possible values are 1d, 7d, 1M, 12M
disallow_robots	Enable robots.txt
disallow_robots_txt	Use custom robots.txt
canonical_link_headers	Pass the canonical URL in the Link HTTP Header
content_disposition	Force files to download
x_forward_for	Add X-Forwarded-For (XFF) HTTP Header
pseudo_streaming	Enable the zone for pseudo streaming content
sslshared	Enable Shared SSL for your zone, so you can use HTTPS, using our SSL certificate for netdna-ssl.com
suspend	Flag denoting if the zone has been suspended
locked	Flag denoting if the zone has been locked
inactive	Flag denoting if the zone has been deleted
creation_date	Date Created
spdy	Flag denoting if the zone has the SPDY protocol enabled

- -

Code Samples

- -

-params = {"name"=>"newPullZone6","url"=>"http://somedomain.com"}
-api.post('/clients/{id}/zones/pull.json',params)

-params = {"name":"newPullZone5","url":"http://somedomain.net"}
-api.post('/clients/{id}/zones/pull.json',data=params)

-$params =  array("name"=>"newPullZone2","url"=>"http://somedomain.net");
-$api->post('/clients/{id}/zones/pull.json',$params);

-api.post('/clients/{id}/zones/pull.json', { name: 'newPullZone2', url: 'http://somedomain.net' }, function(err, response) {
-  console.log('err', err, 'response', response)
-})

-{
-    "code": 201,
-    "data": {
-        "pullzone": {
-            "backend_compress": 0,
-            "cache_valid": "1d",
-            "canonical_link_headers": 1,
-            "cdn_url": "newpullzone3.alias.netdna-cdn.com",
-            "compress": 0,
-            "content_disposition": 0,
-            "creation_date": "2013-05-24 16:18:19",
-            "disallow_robots": 0,
-            "disallow_robots_txt": null,
-            "dns_check": 0,
-            "expires": null,
-            "hide_setcookie_header": 0,
-            "id": 97312,
-            "ignore_cache_control": 0,
-            "ignore_setcookie_header": 0,
-            "inactive": 0,
-            "ip": "205.134.255.49",
-            "label": null,
-            "locked": 0,
-            "name": "newpullzone3",
-            "port": 80,
-            "proxy_cache_lock": 0,
-            "pseudo_streaming": 0,
-            "queries": "1",
-            "server_id": "18",
-            "set_host_header": 1,
-            "sslshared": null,
-            "suspend": 0,
-            "tmp_url": "newpullzone3.alias.netdna-cdn.com",
-            "type": 2,
-            "upstream_enabled": 0,
-            "url": "http://somedomain.net",
-            "use_stale": 0,
-            "x_forward_for": 0,
-            "valid_referers": null,
-            "spdy": 1
-        }
-    }
-}

- - -

Get Pull Zones Count

- -

Counts all pull zones on the specified account

- -

GET -https://rws.maxcdn.com/{companyalias}/clients/{id}/zones/pull.json/count

- -

Response Parameters

- - - -

Parameter	Description
count	The number of pull zones on the specified account ID

- -

Code Samples

- -

-api.get('/clients/{id}/zones/pull.json/count')

-api.get('/clients/{id}/zones/pull.json/count')

-$api->get('/clients/{id}/zones/pull.json/count');

-api.get('/clients/{id}/zones/pull.json/count', function(err, response) {
-  console.log('err', err, 'response', response)
-})

-{
-  "code":200,"data":
-    {
-      "count": "3"
-    }
-}

- - -

Get Pull Zone

- -

Gets a pull zone specified by the {zone_id} parameter

- -

GET -https://rws.maxcdn.com/{companyalias}/clients/{id}/zones/pull.json/{zone_id}

- -

Response Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Parameter	Description
id	Pull Zone ID
name	Pull Zone name
url	Origin URL
port	Port
ip	IP address of the Origin URL
backend_compress	Enables us to cache, from origin, GZip compressed versions of your files for the following file types: text/plain, text/html, text/javascript, text/css, text/xml, application/javascript, application/x-javascript, application/xml, text/x-component, application/json, application/xhtml+xml, application/rss+xml, application/atom+xml, app/vnd.ms-fontobject, image/svg+xml, application/x-font-ttf, font/opentype
queries	Treat Query Strings as a separate cacheable item
set_host_header	The URL sent as the Host in all HTTP Response Headers
cache_valid	Ignore the origin Cache-Control Header and set every request to have a Max-Age of 1d, 7d, 1M or 12M
ignore_setcookie_header	Ignore any cookies set by the origin in order to make the content consistently cacheable
ignore_cache_control	Ignore any max age values set by the origin and use the CDN set value instead
use_stale	Serve expired content while fetching new content. This will also cause the CDN to serve expired content in cases where the origin is down
proxy_cache_lock	When multiple requests for an uncached file are received, they will wait until the first response is received rather than sending each request back to the origin
label	List of domains for http referrer protection (separated by space), only the domains in the list will be treated as valid referrers
expires	Set any request with a no "Cache-Control header" from the origin to stay on the server. Possible values are 1d, 7d, 1M, 12M
disallow_robots	Enable robots.txt
disallow_robots_txt	Use custom robots.txt
canonical_link_headers	Pass the canonical URL in the Link HTTP Header
content_disposition	Force files to download
x_forward_for	Add X-Forwarded-For (XFF) HTTP Header
pseudo_streaming	Enable the zone for pseudo streaming content
sslshared	Enable Shared SSL for your zone, so you can use HTTPS, using our SSL certificate for netdna-ssl.com
suspend	Flag denoting if the zone has been suspended
locked	Flag denoting if the zone has been locked
inactive	Flag denoting if the zone has been deleted
creation_date	Date Created
spdy	Flag denoting if the zone has the SPDY protocol enabled

- -

Code Samples

- -

-id = '97167'
-api.get('/clients/{id}/zones/pull.json/'+id)

-id = '97167'
-api.get('/clients/{id}/zones/pull.json/'+id)

-$id = '96076';
-$api->get('/clients/{id}/zones/pull.json/'.$id);

-var id = '96076'
-api.get('/clients/{id}/zones/pull.json' + id, function(err, response) {
-  console.log('err', err, 'response', response)
-})

-{
-    "code": 200,
-    "data": {
-        "pullzone": {
-            "backend_compress": "0",
-            "cache_valid": "1d",
-            "canonical_link_headers": "0",
-            "cdn_url": "cdn.somenewdomain.com",
-            "compress": "0",
-            "content_disposition": "0",
-            "creation_date": "2013-05-23 19:38:30",
-            "disallow_robots": "0",
-            "disallow_robots_txt": null,
-            "dns_check": "1",
-            "expires": null,
-            "hide_setcookie_header": "0",
-            "id": "97167",
-            "ignore_cache_control": "0",
-            "ignore_setcookie_header": "0",
-            "inactive": "0",
-            "ip": "205.134.255.49",
-            "label": "Some other description",
-            "locked": "0",
-            "name": "newpullzone2",
-            "port": "80",
-            "proxy_cache_lock": "0",
-            "pseudo_streaming": "0",
-            "queries": "1",
-            "server_id": "18",
-            "set_host_header": null,
-            "sslshared": "0",
-            "suspend": "0",
-            "tmp_url": "newpullzone2.alias.netdna-cdn.com",
-            "type": "2",
-            "upstream_enabled": "0",
-            "url": "http://somedomain.net",
-            "use_stale": "0",
-            "x_forward_for": "0",
-            "valid_referers": null,
-            "spdy": 1
-        }
-    }
-}

- - -

Update Pull Zone

- -

Updates a pull zone specified by the {zone_id} parameter

- -

PUT -https://rws.maxcdn.com/{companyalias}/clients/{id}/zones/pull.json/{zone_id}

- -

Accepted Request Parameters

Parameter	Default Value	Validation	Description
name	-	required length: 3-32 chars; only letters, digits, and dash (-)accepted	Pull Zone Name
url	-	required length: 4-100 chars; only valid URLs accepted	Origin URL
port	80	length: 1-5 chars; only digits accepted	Port
dns_check	1	only 0 or 1 accepted	This field determines how your Origin resolves. When set to 1, we automatically grab the origin's IP using DNS. Setting it to 0 allows you explicitly provide the IP of the origin.
ip	-	length: 1-10 chars, only digits accepted	Valid IP address of the Origin URL. Be sure to set `dns_check` to 0 to prevent this value from being overwritten.
compress	-	length: 1-5 chars; only digits accepted	only 0 or 1 accepted \| Enables on the fly GZip compression of your files from our edge servers for the following file types: text/plain, text/html, text/javascript, text/css, text/xml, application/javascript, application/x-javascript, application/xml, text/x-component, application/json, application/xhtml+xml, application/rss+xml, application/atom+xml, app/vnd.ms-fontobject, image/svg+xml, application/x-font-ttf, font/opentype
backend_compress	0	only 0 or 1 accepted	only 0 or 1 accepted \| Enables us to cache, from origin, GZip compressed versions of your files for the following file types: text/plain, text/html, text/javascript, text/css, text/xml, application/javascript, application/x-javascript, application/xml, text/x-component, application/json, application/xhtml+xml, application/rss+xml, application/atom+xml, app/vnd.ms-fontobject, image/svg+xml, application/x-font-ttf, font/opentype
queries	0	only 0 or 1 accepted	Treat Query Strings as a separate cacheable item
set_host_header	-	length: 4-100 chars; only valid URLs accepted	The URL to send as the Host in all HTTP Response Headers
cache_valid	1d	length: 1-30 chars; must be a number followed by one of s, m, h, d, M, or Y	Ignore the origin Cache-Control Header and set every request to have a Max-Age of 1d, 7d, 1M or 12M
ignore_setcookie_header	0	only 0 or 1 accepted	Ignore any cookies set by the origin in order to make the content consistently cacheable
ignore_cache_control	0	only 0 or 1 accepted	Ignore any max age values set by the origin and use the CDN set value instead
use_stale	0	only 0 or 1 accepted	Serve expired content while fetching new content. This will also cause the CDN to serve expired content in cases where the origin is down
proxy_cache_lock	0	only 0 or 1 accepted	When multiple requests for an uncached file are received, they will wait until the first response is received rather than sending each request back to the origin
label	-	length: 1-255 chars	Something that describes your zone
valid_referers	-	length: 1-100 chars	List of domains for http referrer protection (separated by space), only the domains in the list will be treated as valid referrers
expires	1d	length: 1-32 chars	Set any request with a no "Cache-Control header" from the origin to stay on the server. Possible values are 1d, 7d, 1M, 12M
disallow_robots	0	only 0 or 1 accepted	Enable robots.txt
disallow_robots_txt	-	length 1-255 chars	Use custom robots.txt
canonical_link_headers	1	only 0 or 1 accepted	Pass the canonical URL in the Link HTTP Header
content_disposition	0	only 0 or 1 accepted	Force files to download
x_forward_for	0	only 0 or 1 accepted	Add X-Forwarded-For (XFF) HTTP Header
pseudo_streaming	0	only 0 or 1 accepted	Enable the zone for pseudo streaming content
secret	-	length: 1 - 32 chars	Use a secret to protect your files from unwanted visitors
sslshared	0	only 0 or 1 accepted	Use a secret to protect your files from unwanted visitors
secret	-	length: 1 - 32 chars	Enable Shared SSL for your zone, so you can use HTTPS, using our SSL certificate for netdna-ssl.com
spdy	0	only 0 or 1 accepted	Enable SPDY protocol on the zone (requires SSL)

- -

Response Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Parameter	Description
id	Pull Zone ID
name	Pull Zone name
url	Origin URL
port	Port
ip	IP address of the Origin URL
backend_compress	Enables us to cache, from origin, GZip compressed versions of your files for the following file types: text/plain, text/html, text/javascript, text/css, text/xml, application/javascript, application/x-javascript, application/xml, text/x-component, application/json, application/xhtml+xml, application/rss+xml, application/atom+xml, app/vnd.ms-fontobject, image/svg+xml, application/x-font-ttf, font/opentype
queries	Treat Query Strings as a separate cacheable item
set_host_header	The URL sent as the Host in all HTTP Response Headers
cache_valid	Ignore the origin Cache-Control Header and set every request to have a Max-Age of 1d, 7d, 1M or 12M
ignore_setcookie_header	Ignore any cookies set by the origin in order to make the content consistently cacheable
ignore_cache_control	Ignore any max age values set by the origin and use the CDN set value instead
use_stale	Serve expired content while fetching new content. This will also cause the CDN to serve expired content in cases where the origin is down
proxy_cache_lock	When multiple requests for an uncached file are received, they will wait until the first response is received rather than sending each request back to the origin
label	List of domains for http referrer protection (separated by space), only the domains in the list will be treated as valid referrers
expires	Set any request with a no "Cache-Control header" from the origin to stay on the server. Possible values are 1d, 7d, 1M, 12M
disallow_robots	Enable robots.txt
disallow_robots_txt	Use custom robots.txt
canonical_link_headers	Pass the canonical URL in the Link HTTP Header
content_disposition	Force files to download
x_forward_for	Add X-Forwarded-For (XFF) HTTP Header
pseudo_streaming	Enable the zone for pseudo streaming content
sslshared	Enable Shared SSL for your zone, so you can use HTTPS, using our SSL certificate for netdna-ssl.com
suspend	Flag denoting if the zone has been suspended
locked	Flag denoting if the zone has been locked
inactive	Flag denoting if the zone has been deleted
creation_date	Date Created
spdy	Flag denoting if the zone has the SPDY protocol enabled

- - -

Code Samples

- -

-id = '97167'
-params = {"label"=>"Some other description"}
-api.put('/clients/{id}/zones/pull.json/'+id,params)

-id = '97167'
-params = {"label":"Some other description"}
-api.put('/clients/{id}/zones/pull.json/'+id,params=params)

-$id = '96167';
-$params = array("label"=>"Some other description");
-$api->put('/clients/{id}/zones/pull.json/'.$id, $params);

-var id = '96167'
-api.put('/clients/{id}/zones/pull.json' + id, { label: 'Some other description' }, function(err, response) {
-  console.log('err', err, 'response', response)
-})

-{
-    "code": 200,
-    "data": {
-        "pullzone": {
-            "backend_compress": "0",
-            "cache_valid": "1d",
-            "canonical_link_headers": "0",
-            "cdn_url": "cdn.somenewdomain.com",
-            "compress": "0",
-            "content_disposition": "0",
-            "creation_date": "2013-05-23 19:38:30",
-            "disallow_robots": "0",
-            "disallow_robots_txt": null,
-            "dns_check": "1",
-            "expires": null,
-            "hide_setcookie_header": "0",
-            "id": "97167",
-            "ignore_cache_control": "0",
-            "ignore_setcookie_header": "0",
-            "inactive": "0",
-            "ip": "205.134.255.49",
-            "label": "Some other description",
-            "locked": "0",
-            "name": "newpullzone2",
-            "port": "80",
-            "proxy_cache_lock": "0",
-            "pseudo_streaming": "0",
-            "queries": "1",
-            "server_id": "18",
-            "set_host_header": null,
-            "sslshared": "0",
-            "suspend": "0",
-            "tmp_url": "newpullzone2.alias.netdna-cdn.com",
-            "type": "2",
-            "upstream_enabled": "0",
-            "url": "http://somedomain.net",
-            "use_stale": "0",
-            "x_forward_for": "0",
-            "valid_referers": null,
-            "spdy": 1
-        }
-    }
-}

- - -

Delete Pull Zone

- -

Deletes a pull zone specified by the {zone_id} parameter

- -

DELETE -https://rws.maxcdn.com/{companyalias}/clients/{id}/zones/pull.json/{zone_id}

- - -

Code Samples

- -

-id = '97167'
-api.delete('/clients/{id}/zones/pull.json/'+id)

-id = '97167'
-api.delete('/clients/{id}/zones/pull.json/'+id)

-$id = '97167';
-$api->delete('/clients/{id}/zones/pull.json/'.$id);

-var id = '97167'
-api.delete('/clients/{id}/zones/pull.json' + id, function(err, response) {
-  console.log('err', err, 'response', response)
-})

-{
-  "code":200
-}

- - -

Enable Pull Zone

- -

Enables a pull zone specified by the {zone_id} parameter

- -

PUT -https://rws.maxcdn.com/{companyalias}/clients/{id}/zones/pull/{zone_id}/enable.json

- - -

Code Samples

- -

-id = '97167'
-api.put('/clients/{id}/zones/pull/'+id+'/enable.json')

-id = '97167'
-api.put('/clients/{id}/zones/pull/'+id+'/enable.json')

-$id = '97167';
-$api->put('/clients/{id}/zones/pull/'.$id.'/enable.json');

-var id = '97167'
-api.put('/clients/{id}/zones/pull/' + id + '/enable.json', function(err, response) {
-  console.log('err', err, 'response', response)
-})

-{
-  "code":200
-}
-

- - -

Disable Pull Zone

- -

Disables a pull zone specified by the {zone_id} parameter

- -

PUT -https://rws.maxcdn.com/{companyalias}/clients/{id}/zones/pull/{zone_id}/disable.json

- - -

Code Samples

- -

-id = '97167'
-api.put('/clients/{id}/zones/pull/'+id+'/disable.json')

-id = '97167'
-api.put('/clients/{id}/zones/pull/'+id+'/disable.json')

-$id = '97167';
-$api->put('/clients/{id}/zones/pull'.$id.'disable.json);

-var id = '97167'
-api.put('/clients/{id}/zones/pull' + id + 'disable.json', function(err, response) {
-  console.log('err', err, 'response', response)
-})

-{
-  "code":200
-}

- - -

Purge Cache

- -

Purges pull zone cache

- -

DELETE -https://rws.maxcdn.com/{companyalias}/clients/{id}/zones/pull.json/{zone_id}/cache

- -

Accepted Request Parameters

- - - -

Parameter	Default Value	Validation	Description
files	-	-	An array containing relative paths of the files to purge (i.e./favicon.ico)

- -

Code Samples

- -

-#Purge Zone
-id = '97167'
-api.purge(id)
-
-#Purge File
-id = '97167'
-api.purge(id,'/file1.txt')
-
-#Purge Files
-id = '97167'
-api.purge(id, ['/file1.txt','/file2.txt'])

-#Purge Zone
-id = '97167'
-api.purge(id)
-
-#Purge File
-id = '97167'
-api.purge(id,'/file1.txt')
-
-#Purge Files
-id = '97167'
-api.purge(id, ['/file1.txt','/file2.txt'])

-//Purge Zone
-$id = '97792';
-$api->delete('/clients/{id}/zones/pull.json/'.$id.'/cache');
-
-//Purge File
-$id = '97792';
-$params = array('file'=>'/index.html');
-$api->delete('/clients/{id}/zones/pull.json/'.$id.'/cache',$params);
-
-//Purge Files
-$id = '97792';
-$params = array(
-    'files' => array(
-        '/file1.txt',
-        '/file2.txt'
-    )
-);
-$api->delete('/clients/{id}/zones/pull.json/'.$id.'/cache',$params);

-// Purge Zone
-var id = '96167'
-api.delete('/clients/{id}/zones/pull.json/' + id + '/cache', callback)
-function callback(err, response) {
-  if (err) return console.log(err)
-  console.log(response)
-}
-
-// Purge File
-var id = '96167'
-var file = '/file1.txt'
-api.delete('/clients/{id}/zones/pull.json/' + id + '/cache', file, callback)
-function callback(err, response) {
-  if (err) return console.log(err)
-  console.log(response)
-}
-
-// Purge File
-var id = '96167'
-var files = [ '/file1.txt', '/file2.txt' ]
-api.delete('/clients/{id}/zones/pull.json/' + id + '/cache', files, callback)
-function callback(err, response) {
-  if (err) return console.log(err)
-  console.log(response)
-}

-{
-    "code": 200
-}

- - -

Pull Zone Custom Domains API

- -

List Custom Domains

- -

Returns a list of all custom domains on the zone specified by -{zone_id}

- -

GET -https://rws.maxcdn.com/{companyalias}/clients/{id}/zones/pull/{zone_id}/customdomains.json

- -

Response Parameters - -

Response Parameters

- - - - - -

Parameter	Description
id	The id of the custom domain
bucket_id	The id of the zone the custom domain belongs to
custom_domain	A valid custom domain

- -

Code Samples

- -

-id = '97167'
-api.get('/clients/{id}/zones/pull/'+id+'/customdomains.json')

-id = '97167'
-api.get('/clients/{id}/zones/pull/'+id+'/customdomains.json')

-$id = '96061';
-$api->get('/clients/{id}/zones/pull/'.$id.'/customdomains.json');

-var id = '96061'
-api.get('/clients/{id}/zones/pull/' + id + '/customdomains.json', function(err, response) {
-  console.log('err', err, 'response', response)
-})

-{
-    "code": 200,
-    "data": {
-        "customdomains": [
-            {
-                "bucket_id": "97167",
-                "custom_domain": "cdn.somenewdomain.com",
-                "id": "79182",
-                "type": null
-            }
-        ],
-        "total": 1
-    }
-}

- -

Create Custom Domain

- -

Adds a new custom domain to {zone_id}

- -

POST -https://rws.maxcdn.com/{companyalias}/clients/{id}/zones/pull/{zone_id}/customdomains.json

- -

Accepted Request Parameters

- - - - -

Response Parameters

Parameter	Default Value	Validation	Description
custom_domain	-	required length: 5-30 chars	A valid custom domain

- - - - -

Parameter	Description
id	The id of the custom domain
bucket_id	The id of the zone the custom domain belongs to
custom_domain	The valid custom domain

- -

Code Samples

- -

-id = '97793'
-params = {"custom_domain"=>"cdn.somedomain19.com"}
-api.post('/clients/{id}/zones/pull/'+id+'/customdomains.json', params)

-id = '96182'
-params = {"custom_domain":"cdn.somedomain15.com"}
-api.post('/clients/{id}/zones/pull/'+id+'/customdomains.json', params)

-$id = '97181';
-$params = array("custom_domain"=>"cdn.somedomain2.net");
-$api->post('/clients/{id}/zones/pull/'.$id.'/customdomains.json', $params);

-var id = '97181'
-api.post('/clients/{id}/zones/pull/' + id + '/customdomains.json', { custom_domain: 'cdn.somedomain2.net' }, function(err, response) {
-  console.log('err', err, 'response', response)
-})

-{
-    "code": 201,
-    "data": {
-        "customdomain": {
-            "bucket_id": "97181",
-            "custom_domain": "cdn.somedomain4.net",
-            "id": 79283,
-        }
-    }
-}
-

- - -

Get Custom Domain

- -

Gets a custom domain specified by the {zone_id} and -{customdomain_id} parameters

- -

GET -https://rws.maxcdn.com/{companyalias}/clients/{id}/zones/pull/{zone_id}/customdomains.json/{customdomain_id}

- -

Response Parameters

- - - - - -

Parameter	Description
id	The id of the custom domain
bucket_id	The id of the zone the custom domain belongs to
custom_domain	The valid custom domain

- -

Code Samples

- -

-zoneId = '97167'
-domainId = '79182'
-api.get('/clients/{id}/zones/pull/'+zoneId+'/customdomains.json/'+domainId)

-zoneId = '97167'
-domainId = '79182'
-api.get('/clients/{id}/zones/pull/'+zoneId+'/customdomains.json/'+domainId)

-$zoneId = '97167';
-$domainId = '79182';
-$api->get('/clients/{id}/zones/pull/'.$zoneId.'/customdomains.json/'.$domainId);

-var id = '97167'
-var domainId = '79182'
-api.get('/clients/{id}/zones/pull/' + id + '/customdomains.json/' + domainId, function(err, response) {
-  console.log('err', err, 'response', response)
-})

-{
-    "code": 200,
-    "data": {
-        "customdomain": {
-            "bucket_id": "97167",
-            "custom_domain": "cdn.somenewdomain.com",
-            "id": "79182",
-            "type": null
-        }
-    }
-}
-

- - -

Update Custom Domain

- -

Updates a custom domain specified by the id parameter

- -

PUT -https://rws.maxcdn.com/{companyalias}/clients/{id}/zones/pull/{zone_id}/customdomains.json/{customdomain_id}

- -

Accepted Request Parameters

- - - -

Parameter	Default Value	Validation	Description
custom_domain	-	required length: 1-255 chars, valid: custom_domain, not valid: full_domain	A new valid custom domain

- -### Response Parameters - -Parameter | Description | ---- | --- | --- -`id` | The id of the custom domain | -`bucket_id` | The id of the zone the custom domain belongs to | -`custom_domain` | The new valid custom domain | - -

Response Parameters

- - - - - -

Parameter	Description
id	The id of the custom domain
bucket_id	The id of the zone the custom domain belongs to
custom_domain	The new valid custom domain

- -

Code Samples

- -

-zoneId = '97167'
-domainId = '79182'
-params = {"custom_domain"=>"cdn.somenewdomain41.com"}
-api.put('/clients/{id}/zones/pull/'+zoneId+'/customdomains.json/'+domainId,params)

-zoneId = '97167'
-domainId = '79182'
-params = {"custom_domain":"cdn.somenewdomain41.com"}
-api.put('/clients/{id}/zones/pull/'+zoneId+'/customdomains.json/'+domainId,params=params)

-$zoneId = '97167';
-$domainId = '79182';
-$params = array("custom_domain"=>"cdn.somenewdomain.com");
-$api->put('/clients/{id}/zones/pull/'.$zoneId.'/customdomains.json/'.$domainId, $params);

-var zoneId = '97167'
-var domainId = '79182'
-api.put('/clients/{id}/zones/pull/' + zoneId + '/customdomains.json/' + domainId, { custom_domain: 'cdn.somenewdomain.com' }, function(err, response) {
-  console.log('err', err, 'response', response)
-})

-{
-    "code": 200,
-    "data": {
-        "customdomain": {
-            "bucket_id": "97167",
-            "custom_domain": "cdn.somenewdomain4.com",
-            "id": "79182",
-            "type": null
-        }
-    }
-}

- - -

Delete Custom Domain

- -

Deletes a custom domain specified by the {zone_id} and -{customdomain_id} parameters

- -

DELETE -https://rws.maxcdn.com/{companyalias}/clients/{id}/zones/pull/{zone_id}/customdomains.json/{customdomain_id}

- -

Code Samples

- -

-zoneId = '97167'
-domainId = '79182'
-api.delete('/clients/{id}/zones/pull/'+zoneId+'/customdomains.json/'+domainId)

-zoneId = '97167'
-domainId = '79182'
-api.delete('/clients/{id}/zones/pull/'+zoneId+'/customdomains.json/'+domainId)

-$zoneId = '97167';
-$domainId = '79182';
-$api->delete('/clients/{id}/zones/pull/'.$zoneId.'/customdomains.json/'.$domainId);

-var zoneId = '97167'
-var domainId = '79182'
-api.delete('/clients/{id}/zones/pull/' + zoneId + '/customdomains.json/' + domainId, function(err, response) {
-  console.log('err', err, 'response', response)
-})

-{
-  "code":200
-}

- - -

Push Zone API

- -

List Push Zones - -Returns a list of all push zones on the specified account - -

GET -https://rws.maxcdn.com/{companyalias}/clients/{id}/zones/push.json

- -

Response Parameters

- - - - - - - - - - - - - -

Parameter	Description
id	Push Zone ID
name	Push Zone name
label	Something that describes your zone
valid_referers	List of domains for http referrer protection (separated by space), only the domains in the list will be treated as valid referrers
content_disposition	Force files to download
sslshared	Enable Shared SSL for your zone, so you can use HTTPS, using our SSL certificate for netdna-ssl.com
suspend	Flag denoting if the zone has been suspended
locked	Flag denoting if the zone has been locked
inactive	Flag denoting if the zone has been deleted
creation_date	Date Created
spdy	Flag denoting if the zone has the SPDY protocol enabled

- -

Code Samples

- -

-api.get('/clients/{id}/zones/push.json')

-api.get('/clients/{id}/zones/push.json')

-$api->get('/clients/{id}/zones/push.json');

-api.get('/clients/{id}/zones/push.json', function(err, response) {
-  console.log('err', err, 'response', response)
-})

-{
-    "code": 200,
-    "data": {
-        "current_page_size": 2,
-        "page": 1,
-        "page_size": "50",
-        "pages": 1,
-        "pushzones": [
-            {
-                "cdn_url": "cdn.somedomain.net",
-                "compress": "0",
-                "content_disposition": "0",
-                "creation_date": "2013-05-16 15:25:19",
-                "expires": null,
-                "ftp_url": "ftp.newpushzone2.alias.netdna-cdn.com",
-                "id": "96182",
-                "inactive": "0",
-                "label": null,
-                "locked": "0",
-                "name": "newpushzone2",
-                "server_id": "11",
-                "sslshared": "0",
-                "storage_updated": "2013-05-24 06:31:52",
-                "storage_used": "20480",
-                "suspend": "0",
-                "tmp_url": "newpushzone2.alias.netdna-cdn.com",
-                "type": "3",
-                "valid_referers": null,
-                "spdy": 1
-            },
-            {
-                "cdn_url": "cdn.somenewdomain2.com",
-                "compress": "0",
-                "content_disposition": "0",
-                "creation_date": "2013-05-23 21:01:39",
-                "expires": null,
-                "ftp_url": "ftp.newpushzone3.alias.netdna-cdn.com",
-                "id": "97181",
-                "inactive": "0",
-                "label": "Some other description",
-                "locked": "0",
-                "name": "newpushzone3",
-                "server_id": "11",
-                "sslshared": "0",
-                "storage_updated": "2013-05-24 06:31:52",
-                "storage_used": "20480",
-                "suspend": "0",
-                "tmp_url": "newpushzone3.alias.netdna-cdn.com",
-                "type": "3",
-                "valid_referers": null,
-                "spdy": 0
-            }
-        ],
-        "total": 2
-    }
-}

- - -

Create Push Zone

- -

Creates a new push zone

- -

POST -https://rws.maxcdn.com/{companyalias}/clients/{id}/zones/push.json

- -

Accepted Request Parameters

- - - - - - - - - -

Parameter	Default Value	Validation	Description
name	-	required length: 3-30 chars; only letters, digits, and dash (-) accepted	Push Zone name
password	-	required length: 5-30 chars	Password
label	-	length: 1-255 chars	Something that describes your zone
valid_referers	-	length: 1-200 chars	List of domains for http referrer protection (separated by space), only the domains in the list will be treated as valid referrers
content_disposition	0	length: 1-200 chars	List of domains for http referrer protection (separated by space), only the domains in the list will be treated as valid referrers
sslshared	0	only 0 or 1 accepted	Enable Shared SSL for your zone, so you can use HTTPS, using our SSL certificate for netdna-ssl.com
spdy	0	only 0 or 1 accepted	Enable SPDY protocol on the zone (requires SSL)

- -

Response Parameters

- - - - - - - - - - - - - -

Parameter	Description
id	Push Zone ID
name	Push Zone name
label	Something that describes your zone
valid_referers	List of domains for http referrer protection (separated by space), only the domains in the list will be treated as valid referrers
content_disposition	Force files to download
sslshared	Enable Shared SSL for your zone, so you can use HTTPS, using our SSL certificate for netdna-ssl.com
suspend	Flag denoting if the zone has been suspended
locked	Flag denoting if the zone has been locked
inactive	Flag denoting if the zone has been deleted
creation_date	Date Created
spdy	Flag denoting if the zone has the SPDY protocol enabled

- -

Code Samples

- -

-params = {"name"=>"newPushZone99","password"=>"password"}
-api.post('/clients/{id}/zones/push.json',params)

-params = {"name":"newPushZone6","password":"password"}
-api.post('/clients/{id}/zones/push.json',data=params)

-$params = array("name"=>"newPushZone","password"=>"password");
-$api->post('/clients/{id}/zones/push.json', $params);

-api.post('/clients/{id}/zones/push.json', { name: 'newPushZone', password: 'password' }, function(err, response) {
-  console.log('err', err, 'response', response)
-})

-{
-    "code": 201,
-    "data": {
-        "pushzone": {
-            "cdn_url": "newpushzone4.alias.netdna-cdn.com",
-            "compress": 0,
-            "content_disposition": 0,
-            "creation_date": "2013-05-24 16:41:53",
-            "expires": null,
-            "ftp_url": "ftp.newpushzone4.alias.netdna-cdn.com",
-            "id": 97317,
-            "inactive": 0,
-            "label": null,
-            "locked": 0,
-            "name": "newpushzone4",
-            "server_id": "11",
-            "sslshared": null,
-            "storage_updated": null,
-            "storage_used": null,
-            "suspend": 0,
-            "tmp_url": "newpushzone4.alias.netdna-cdn.com",
-            "type": 3,
-            "valid_referers": null,
-            "spdy": 1
-        }
-    }
-}

- - -

Get Push Zones Count

- -

Counts all push zones on the specified account

- -

GET -https://rws.maxcdn.com/{companyalias}/clients/{id}/zones/push.json/count

- -

Response Parameters

- - - -

Parameter	Description
count	The number of push zones on the specified account

- -

Code Samples

- -

-api.get('/clients/{id}/zones/push.json/count')

-api.get('/clients/{id}/zones/push.json/count')

-$api->get('/clients/{id}/zones/push.json/count');

-api.get('/clients/{id}/zones/push.json/count', function(err, response) {
-  console.log('err', err, 'response', response)
-})

-{
-    "code": 200,
-    "data": {
-        "count": "3"
-    }
-}
-

- - -## Get Push Zone - -Gets a push zone specified by the {zone_id} parameter - -

GET -https://rws.maxcdn.com/{companyalias}/clients/{id}/zones/push.json/{zone_id}

- -

Response Parameters

- - - - - - - - - - - - - -

Parameter	Description
id	Push Zone ID
name	Push Zone name
label	Something that describes your zone
valid_referers	List of domains for http referrer protection (separated by space), only the domains in the list will be treated as valid referrers
content_disposition	Force files to download
sslshared	Enable Shared SSL for your zone, so you can use HTTPS, using our SSL certificate for netdna-ssl.com
suspend	Flag denoting if the zone has been suspended
locked	Flag denoting if the zone has been locked
inactive	Flag denoting if the zone has been deleted
creation_date	Date Created
spdy	Flag denoting if the zone has the SPDY protocol enabled

- -

Code Samples

- -

-id = '97793'
-api.get('/clients/{id}/zones/push.json/'+id)

-id = '96182'
-api.get('/clients/{id}/zones/push.json/'+id)

-$id = '97181';
-$api->get('/clients/{id}/zones/push.json/'.$id);

-var id = '97182'
-api.get('/clients/{id}/zones/push.json/' + id, function(err, response) {
-  console.log('err', err, 'response', response)
-})

-{
-    "code": 200,
-    "data": {
-        "pushzone": {
-            "cdn_url": "cdn.somenewdomain2.com",
-            "compress": "0",
-            "content_disposition": "0",
-            "creation_date": "2013-05-23 21:01:39",
-            "expires": null,
-            "ftp_url": "ftp.newpushzone3.alias.netdna-cdn.com",
-            "id": "97181",
-            "inactive": "0",
-            "label": "Some other description",
-            "locked": "0",
-            "name": "newpushzone3",
-            "server_id": "11",
-            "sslshared": "0",
-            "storage_updated": "2013-05-24 06:31:52",
-            "storage_used": "20480",
-            "suspend": "0",
-            "tmp_url": "newpushzone3.alias.netdna-cdn.com",
-            "type": "3",
-            "valid_referers": null,
-            "spdy": 1
-        }
-    }
-}

- - -

Update Push Zone

- -

Updates a push zone specified by the {zone_id} parameter

- -

PUT -https://rws.maxcdn.com/{companyalias}/clients/{id}/zones/push.json/{zone_id}

- -

Accepted Request Parameters

- - - - - - - -

Parameter	Default Value	Validation	Description
label	-	required length: 1-255 chars	Something that describes your zone
valid_referers	-	required length: 1-100 chars	List of domains for http referrer protection (separated by space), only the domains in the list will be treated as valid referrers
content_disposition	0	only 0 or 1 accepted	Force files to download
sslshared	0	only 0 or 1 accepted	Enable Shared SSL for your zone, so you can use HTTPS, using our SSL certificate for netdna-ssl.com
spdy	0	only 0 or 1 accepted	Enable SPDY protocol on the zone (requires SSL

- - -

Response Parameters

- - - - - - - - - - - - - -

Parameter	Description
id	Push Zone ID
name	Push Zone name
label	Something that describes your zone
valid_referers	List of domains for http referrer protection (separated by space), only the domains in the list will be treated as valid referrers
content_disposition	Force files to download
sslshared	Enable Shared SSL for your zone, so you can use HTTPS, using our SSL certificate for netdna-ssl.com
suspend	Flag denoting if the zone has been suspended
locked	Flag denoting if the zone has been locked
inactive	Flag denoting if the zone has been deleted
creation_date	Date Created
spdy	Flag denoting if the zone has the SPDY protocol enabled

- -

Code Samples

- -

-id = '97793'
-params = {"label"=>"Some other description"}
-api.put('/clients/{id}/zones/push.json/'+id,params)

-id = '96182'
-params = {"label":"Some other description"}
-api.put('/clients/{id}/zones/push.json/'+id,params=params)

-$id = '97181';
-$params = array("label"=>"Some other description");
-$api->put('/clients/{id}/zones/push.json/'.$id, $params);

-var id = '97182'
-api.get('/clients/{id}/zones/push.json/' + id, { label: 'Some other description' }, function(err, response) {
-  console.log('err', err, 'response', response)
-})

-{
-    "code": 200,
-    "data": {
-        "pushzone": {
-            "cdn_url": "cdn.somenewdomain2.com",
-            "compress": "0",
-            "content_disposition": "0",
-            "creation_date": "2013-05-23 21:01:39",
-            "expires": null,
-            "ftp_url": "ftp.newpushzone3.alias.netdna-cdn.com",
-            "id": "97181",
-            "inactive": "0",
-            "label": "Some other description",
-            "locked": "0",
-            "name": "newpushzone3",
-            "server_id": "11",
-            "sslshared": "0",
-            "storage_updated": "2013-05-24 06:31:52",
-            "storage_used": "20480",
-            "suspend": "0",
-            "tmp_url": "newpushzone3.alias.netdna-cdn.com",
-            "type": "3",
-            "valid_referers": null,
-            "spdy": 1
-        }
-    }
-}

- - -

Delete Push Zone

- -

Deletes a push zone specified by the {zone_id} parameter

- -

DELETE -https://rws.maxcdn.com/{companyalias}/clients/{id}/zones/push.json/{zone_id}

- -

Code Samples

- -

-id = '97793'
-api.delete('/clients/{id}/zones/push.json/'+id)

-id = '96182'
-api.delete('/clients/{id}/zones/push.json/'+id)

-$id = '97181';
-$api->delete('/clients/{id}/zones/push.json/'.$id);

-var id = '97181'
-api.delete('/clients/{id}/zones/push.json/' + id, function(err, response) {
-  console.log('err', err, 'response', response)
-})

-{
-  "code":200
-}

- - -

Enable Push Zone

- -

Enables a push zone specified by the {zone_id} parameter

- -

PUT -https://rws.maxcdn.com/{companyalias}/clients/{id}/zones/push/{zone_id}/enable.json

- -

Code Samples

- -

-id = '97793'
-api.put('/clients/{id}/zones/push/'+id+'/enable.json')

-id = '96182'
-api.put('/clients/{id}/zones/push/'+id+'/enable.json')

-$id = '97181';
-$api->put('/clients/{id}/zones/push/'.$id.'/enable.json');

-var id = '97181'
-api.put('/clients/{id}/zones/push/' + id + '/enable.json', function(err, response) {
-  console.log('err', err, 'response', response)
-})

-{
-  "code":200
-}

- - -

Disable Push Zone

- -

Disables a push zone specified by the {zone_id} parameter

- -

PUT -https://rws.maxcdn.com/{companyalias}/clients/{id}/zones/push/{zone_id}/disable.json

- - -

Code Samples

- -

-id = '97793'
-api.put('/clients/{id}/zones/push/'+id+'/disable.json')

-id = '96182'
-api.put('/clients/{id}/zones/push/'+id+'/disable.json')

-$id = '97181';
-$api->put('/clients/{id}/zones/push/'.$id.'/disable.json');

-var id = '97181'
-api.put('/clients/{id}/zones/push/' + id + '/disable.json', function(err, response) {
-  console.log('err', err, 'response', response)
-})

-{
-  "code":200
-}

- - -

Push Zone Custom Domains API

- -

List Custom Domains

- -

Returns a list of all custom domains on the zone specified by -{zone_id}

- -

GET -https://rws.maxcdn.com/{companyalias}/clients/{id}/zones/push/{zone_id}/customdomains.json

- -

Response Parameters

- - - - - -

Parameter	Description
id	Push Zone ID
bucket_id	The id of the zone the custom domain belongs to
custom_domain	A valid custom domain

- -

Code Samples

- -

-id = '97793'
-api.get('/clients/{id}/zones/push/'+id+'/customdomains.json')

-id = '96182'
-api.get('/clients/{id}/zones/push/'+id+'/customdomains.json')

-$id = '96061';
-$api->get('/clients/{id}/zones/push/'.$id.'/customdomains.json');

-var id = '96061'
-api.get('/clients/{id}/zones/push/' + id + '/customdomains.json', function(err, response) {
-  console.log('err', err, 'response', response)
-})

-{
-    "code": 200,
-    "data": {
-        "customdomains": [
-            {
-                "bucket_id": "96061",
-                "custom_domain": "cdn.somedomain.com",
-                "id": "78330",
-            }
-        ],
-        "total": 1
-    }
-}

- - -

Create Custom Domain

- -

Adds a new custom domain to {zone_id}

- -

POST -https://rws.maxcdn.com/{companyalias}/clients/{id}/zones/push/{zone_id}/customdomains.json

- -

Accepted Request Parameters

- - - -

Parameter	Default Value	Validation	Description
custom_domain	-	required length: 1-255 chars, valid: custom_domain, not valid: full_domain	A valid custom domain

- - -

Response Parameters

- - - - - -

Parameter	Description
id	Push Zone ID
bucket_id	The id of the zone the custom domain belongs to
custom_domain	A valid custom domain

- -

Code Samples

- -

-id = '97793'
-params = {"custom_domain"=>"cdn.somedomain19.com"}
-api.post('/clients/{id}/zones/push/'+id+'/customdomains.json', params)

-id = '96182'
-params = {"custom_domain":"cdn.somedomain15.com"}
-api.post('/clients/{id}/zones/push/'+id+'/customdomains.json', params)

-$id = '97181';
-$params = array("custom_domain"=>"cdn.somedomain2.net");
-$api->post('/clients/{id}/zones/push/'.$id.'/customdomains.json', $params);

-var id = '97181'
-api.post('/clients/{id}/zones/push/' + id + '/customdomains.json', { custom_domain: 'cdn.somedomain2.net' }, function(err, response) {
-  console.log('err', err, 'response', response)
-})

-{
-    "code": 201,
-    "data": {
-        "customdomain": {
-            "bucket_id": "97181",
-            "custom_domain": "cdn.somedomain4.net",
-            "id": 79283,
-            "type": null
-        }
-    }
-}
-

- - -

Get Custom Domain

- -

Gets a custom domain specified by the {zone_id} and -{customdomain_id} parameters

- -

GET -https://rws.maxcdn.com/{companyalias}/clients/{id}/zones/push/{zone_id}/customdomains.json/{customdomain_id}

- -

Response Parameters

- - - - - -

Parameter	Description
id	Push Zone ID
bucket_id	The id of the zone the custom domain belongs to
custom_domain	A valid custom domain

- -

Code Samples

- -

-zoneId = '97793'
-domainId = '79747'
-api.get('/clients/{id}/zones/push/'+zoneId+'/customdomains.json/'+domainId)

-zoneId = '96182'
-domainId = '79320'
-api.get('/clients/{id}/zones/push/'+zoneId+'/customdomains.json/'+domainId)

-$zoneId = '97181';
-$domainId = '79188';
-$api->get('/clients/{id}/zones/push/'.$zoneId.'/customdomains.json/'.$domainId);

-var zoneId = '97181'
-var domainId = '79188'
-api.get('/clients/{id}/zones/push/' + zoneId + '/customdomains.json/' + domainId, function(err, response) {
-  console.log('err', err, 'response', response)
-})

-{
-    "code": 200,
-    "data": {
-        "customdomain": {
-            "bucket_id": "97181",
-            "custom_domain": "cdn.somenewdomain2.com",
-            "id": "79188",
-            "type": null
-        }
-    }
-}

- - -

Update Custom Domain

- -

Updates a custom domain specified by the id parameter

- -

PUT -https://rws.maxcdn.com/{companyalias}/clients/{id}/zones/push/{zone_id}/customdomains.json/{customdomain_id}

- -

Accepted Request Parameters

- - - -

Parameter	Default Value	Validation	Description
custom_domain	-	required length: 1-255 chars, valid: custom_domain, not valid: full_domain	A valid custom domain

- -

Response Parameters

- - - - - -

Parameter	Description
id	Push Zone ID
bucket_id	The id of the zone the custom domain belongs to
custom_domain	A valid custom domain

- -

Code Samples

- -

-zoneId = '97793'
-domainId = '79747'
-params = {"custom_domain"=>"cdn.somenewdomain41.com"}
-api.put('/clients/{id}/zones/push/'+zoneId+'/customdomains.json/'+domainId,params)

-zoneId = '96182'
-domainId = '79320'
-params = {"custom_domain":"cdn.somenewdomain40.com"}
-api.put('/clients/{id}/zones/push/'+zoneId+'/customdomains.json/'+domainId,params=params)

-$zoneId = '97181';
-$domainId = '79188';
-$params = array("custom_domain"=>"cdn.somenewdomain2.com");
-$api->put('/clients/{id}/zones/push/'.$zoneId.'/customdomains.json/'.$domainId, $params);
-

-var zoneId = '97181'
-var domainId = '79188'
-api.put('/clients/{id}/zones/push/' + zoneId + '/customdomains.json/' + domainId, { custom_domain: 'cdn.somenewdomain2.com' }, function(err, response) {
-  console.log('err', err, 'response', response)
-})

-{
-    "code": 200,
-    "data": {
-        "customdomain": {
-            "bucket_id": "97181",
-            "custom_domain": "cdn.somenewdomain12.com",
-            "id": "79188",
-            "type": null
-        }
-    }
-}

- - -

Delete Custom Domain

- -

Deletes a custom domain specified by the {zone_id} and -{customdomain_id} parameters

- -

DELETE -https://rws.maxcdn.com/{companyalias}/clients/{id}/zones/push/{zone_id}/customdomains.json/{customdomain_id}

- -

Code Samples

- -

-zoneId = '97793'
-domainId = '79747'
-api.delete('/clients/{id}/zones/push/'+zoneId+'/customdomains.json/'+domainId)

-zoneId = '96182'
-domainId = '79320'
-api.delete('/clients/{id}/zones/push/'+zoneId+'/customdomains.json/'+domainId)

-$zoneId = '97181';
-$domainId = '79188';
-$api->delete('/clients/{id}/zones/push/'.$zoneId.'/customdomains.json/'.$domainId);

-var zoneId = '97181'
-var domainId = '79188'
-api.delete('/clients/{id}/zones/push/' + zoneId + '/customdomains.json/' + domainId, function(err, response) {
-  console.log('err', err, 'response', response)
-})

-{
-  "code":200
-}

- - -

VOD Zone API

- -

List VOD Zones

- -

Returns a list of all VOD zones on the specified account

- -

GET -https://rws.maxcdn.com/{companyalias}/clients/{id}/zones/vod.json

- -

Response Parameters

- - - - - - - - - -

Parameter	Description
id	Push Zone ID
name	Push Zone name
label	Something that describes your zone
suspend	Flag denoting if the zone has been suspended
locked	Flag denoting if the zone has been locked
inactive	Flag denoting if the zone has been deleted
creation_date	Date Created

- -

Code Samples

- -

-api.get('/clients/{id}/zones/vod.json')

-api.get('/clients/{id}/zones/vod.json')

-$api->get('/clients/{id}/zones/vod.json');

-api.get('/clients/{id}/zones/vod.json', function(err, response) {
-  console.log('err', err, 'response', response)
-})

-{
-    "code": 200,
-    "data": {
-        "current_page_size": 2,
-        "page": 1,
-        "page_size": "50",
-        "pages": 1,
-        "total": 2,
-        "vodzones": [
-            {
-                "cdn_url": "cdn.somedomain.com",
-                "creation_date": "2013-05-16 16:02:35",
-                "direct_url": "d.newvodzone.alias.netdna-cdn.com",
-                "ftp_url": "ftp.newvodzone.alias.netdna-cdn.com",
-                "id": "96187",
-                "inactive": "0",
-                "label": null,
-                "locked": "0",
-                "name": "newvodzone",
-                "pseudo_url": "p.newvodzone.alias.netdna-cdn.com",
-                "rtmp_url": "r.newvodzone.alias.netdna-cdn.com",
-                "server_id": "30",
-                "storage_updated": "2013-05-24 06:35:35",
-                "storage_used": "4096",
-                "suspend": "0",
-                "tmp_url": "newvodzone.alias.netdna-cdn.com",
-                "token": null,
-                "type": "4"
-            },
-            {
-                "cdn_url": "cdn.somenewdomain3.com",
-                "creation_date": "2013-05-23 21:25:44",
-                "direct_url": "d.newvodzone3.alias.netdna-cdn.com",
-                "ftp_url": "ftp.newvodzone3.alias.netdna-cdn.com",
-                "id": "97183",
-                "inactive": "0",
-                "label": "Some other description",
-                "locked": "0",
-                "name": "newvodzone3",
-                "pseudo_url": "p.newvodzone3.alias.netdna-cdn.com",
-                "rtmp_url": "r.newvodzone3.alias.netdna-cdn.com",
-                "server_id": "30",
-                "storage_updated": "2013-05-24 06:35:35",
-                "storage_used": "4096",
-                "suspend": "0",
-                "tmp_url": "newvodzone3.alias.netdna-cdn.com",
-                "token": null,
-                "type": "4"
-            }
-        ]
-    }
-}

- - -

Create VOD Zone

- -

Creates a new VOD zone - -

POST -https://rws.maxcdn.com/{companyalias}/clients/{id}/zones/vod.json

- -

Accepted Request Parameters

- - - - - - -

Parameter	Default Value	Validation	Description
name	-	required length: 3-30 chars; only letters, digits, and dash (-)accepted	VOD Zone user name
password	-	required length: 5-30 chars	Your desired password
token	-	only 0 or 1 accepted	length: 1-64 chars \| The token value (shared secret) for secure streaming
label	-	required length: 1-255 chars	Something that describes your zone

- - -

Response Parameters

- - - - - - - - - -

Parameter	Description
id	Push Zone ID
name	Push Zone name
label	Something that describes your zone
suspend	Flag denoting if the zone has been suspended
locked	Flag denoting if the zone has been locked
inactive	Flag denoting if the zone has been deleted
creation_date	Date Created

- -

Code Samples

- -

-params = {"name"=>"newVodZone99","password"=>"password"}
-api.post('/clients/{id}/zones/vod.json',params)

-params = {"name":"newvodZone7","password":"password"}
-api.post('/clients/{id}/zones/vod.json',data=params)

-$params = array("name"=>"newVODZone3","password"=>"password");
-$api->post('/clients/{id}/zones/vod.json',$params);

-api.post('/clients/{id}/zones/vod.json', { name: 'newVODZone3', password: 'password' }, function(err, response) {
-  console.log('err', err, 'response', response)
-})

-{
-    "code": 201,
-    "data": {
-        "vodzone": {
-            "cdn_url": "newvodzone4.alias.netdna-cdn.com",
-            "creation_date": "2013-05-24 16:50:18",
-            "direct_url": "d.newvodzone4.alias.netdna-cdn.com",
-            "ftp_url": "ftp.newvodzone4.alias.netdna-cdn.com",
-            "id": 97319,
-            "inactive": 0,
-            "label": null,
-            "locked": 0,
-            "name": "newvodzone4",
-            "pseudo_url": "p.newvodzone4.alias.netdna-cdn.com",
-            "rtmp_url": "r.newvodzone4.alias.netdna-cdn.com",
-            "server_id": "30",
-            "storage_updated": null,
-            "storage_used": null,
-            "suspend": 0,
-            "tmp_url": "newvodzone4.alias.netdna-cdn.com",
-            "token": null,
-            "type": 4
-        }
-    }
-}

- - -

Get VOD Zones Count

- -

Counts all VOD zones on the specified account

- -

GET -https://rws.maxcdn.com/{companyalias}/clients/{id}/zones/vod.json/count

- -

Response Parameters

- - - -

Parameter	Description
count	The number of VOD zones on the specified account

- -

Code Samples

- -

-api.get('/clients/{id}/zones/vod.json/count')

-api.get('/clients/{id}/zones/vod.json/count')

-$api->get('/clients/{id}/zones/vod.json/count');

-api.get('/clients/{id}/zones/vod.json/count', function(err, response) {
-  console.log('err', err, 'response', response)
-})

-{
-    "code": 200,
-    "data": {
-        "count": "4"
-    }
-}

- - -

Get VOD Zone

- -

Gets a VOD zone specified by the {zone_id} parameter

- -

GET -https://rws.maxcdn.com/{companyalias}/clients/{id}/zones/vod.json/{zone_id}

- -

Response Parameters

- - - - - - - - - -

Parameter	Description
id	Push Zone ID
name	Push Zone name
label	Something that describes your zone
suspend	Flag denoting if the zone has been suspended
locked	Flag denoting if the zone has been locked
inactive	Flag denoting if the zone has been deleted
creation_date	Date Created

- -

Code Samples

- -

-id = '97794'
-api.get('/clients/{id}/zones/vod.json/'+id)

-id = '96187'
-api.get('/clients/{id}/zones/vod.json/'+id)

-$id = '97183';
-$api->get('/clients/{id}/zones/vod.json/'.$id);

-var id = '97183'
-api.get('/clients/{id}/zones/vod.json/' + id, function(err, response) {
-  console.log('err', err, 'response', response)
-})

-{
-    "code": 200,
-    "data": {
-        "vodzone": {
-            "cdn_url": "cdn.somenewdomain3.com",
-            "creation_date": "2013-05-23 21:25:44",
-            "direct_url": "d.newvodzone3.alias.netdna-cdn.com",
-            "ftp_url": "ftp.newvodzone3.alias.netdna-cdn.com",
-            "id": "97183",
-            "inactive": "0",
-            "label": "Some other description",
-            "locked": "0",
-            "name": "newvodzone3",
-            "pseudo_url": "p.newvodzone3.alias.netdna-cdn.com",
-            "rtmp_url": "r.newvodzone3.alias.netdna-cdn.com",
-            "server_id": "30",
-            "storage_updated": "2013-05-24 06:35:35",
-            "storage_used": "4096",
-            "suspend": "0",
-            "tmp_url": "newvodzone3.alias.netdna-cdn.com",
-            "token": null,
-            "type": "4"
-        }
-    }
-}

- - -

Update VOD Zone - -

Updates a VOD zone specified by the {zone_id} parameter

- -

PUT -https://rws.maxcdn.com/{companyalias}/clients/{id}/zones/vod.json/{zone_id}

- -

Accepted Request Parameters

- - - - -

password	-	required length: 5-30 chars	Your desired password
token	-	only 0 or 1 accepted	length: 1-64 chars \| The token value (shared secret) for secure streaming
label	-	required length: 1-255 chars	Something that describes your zone

- - -

Response Parameters

- - - - - - - - - -

Parameter	Description
id	Push Zone ID
name	Push Zone name
label	Something that describes your zone
suspend	Flag denoting if the zone has been suspended
locked	Flag denoting if the zone has been locked
inactive	Flag denoting if the zone has been deleted
creation_date	Date Created

- -

Code Samples

- -

-id = '97794'
-params = {"label"=>"Some other description"}
-api.put('/clients/{id}/zones/vod.json/'+id,params)

-id = '96187'
-params = {"label":"Some other description"}
-api.put('/clients/{id}/zones/vod.json/'+id,params=params)

-$id = '97183';
-$params =  array("label"=>"Some other description");
-$api->put('/clients/{id}/zones/vod.json/'.$id,$params);

-var id = '97183'
-api.put('/clients/{id}/zones/vod.json/' + id, { label: 'Some other description' }, function(err, response) {
-  console.log('err', err, 'response', response)
-})

-{
-    "code": 200,
-    "data": {
-        "vodzone": {
-            "cdn_url": "cdn.somenewdomain3.com",
-            "creation_date": "2013-05-23 21:25:44",
-            "direct_url": "d.newvodzone3.alias.netdna-cdn.com",
-            "ftp_url": "ftp.newvodzone3.alias.netdna-cdn.com",
-            "id": "97183",
-            "inactive": "0",
-            "label": "Some other description",
-            "locked": "0",
-            "name": "newvodzone3",
-            "pseudo_url": "p.newvodzone3.alias.netdna-cdn.com",
-            "rtmp_url": "r.newvodzone3.alias.netdna-cdn.com",
-            "server_id": "30",
-            "storage_updated": "2013-05-24 06:35:35",
-            "storage_used": "4096",
-            "suspend": "0",
-            "tmp_url": "newvodzone3.alias.netdna-cdn.com",
-            "token": null,
-            "type": "4"
-        }
-    }
-}

- - -

Delete VOD Zone

- -

Deletes a VOD zone specified by the {zone_id} parameter

- -

DELETE -https://rws.maxcdn.com/{companyalias}/clients/{id}/zones/vod.json/{zone_id}

- -

Code Samples

- -

-id = '97794'
-api.delete('/clients/{id}/zones/vod.json/'+id)

-id = '96187'
-api.delete('/clients/{id}/zones/vod.json/'+id)

-$id = '97183';
-$api->delete('/clients/{id}/zones/vod.json/'.$id);

-var id = '97183'
-api.delete('/clients/{id}/zones/vod.json/' + id, function(err, response) {
-  console.log('err', err, 'response', response)
-})

-{
-  "code":200
-}

- - -

Enable VOD Zone

- -

Enables a VOD zone specified by the {zone_id} parameter

- -

PUT -https://rws.maxcdn.com/{companyalias}/clients/{id}/zones/vod/{zone_id}/enable.json

- -

Code Samples

- -

-id = '97794'
-api.put('/clients/{id}/zones/vod/'+id+'/enable.json')

-id = '96187'
-api.put('/clients/{id}/zones/vod/'+id+'/enable.json')

-$id = '96187';
-$api->put('/clients/{id}/zones/vod/'.$id.'/enable.json');

-var id = '96187'
-api.put('/clients/{id}/zones/vod/' + id + '/enable.json', function(err, response) {
-  console.log('err', err, 'response', response)
-})

-{
-  "code":200
-}

- - -

Disable VOD Zone

- -

Disables a VOD zone specified by the {zone_id} parameter

- -

PUT -https://rws.maxcdn.com/{companyalias}/clients/{id}/zones/vod/{zone_id}/disable.json

- -

Code Samples

- -

-id = '97794'
-api.put('/clients/{id}/zones/vod/'+id+'/disable.json')

-id = '96187'
-api.put('/clients/{id}/zones/vod/'+id+'/disable.json')

-$id = '96187';
-$api->put('/clients/{id}/zones/vod/'.$id.'/disable.json');

-var id = '96187'
-api.put('/clients/{id}/zones/vod/' + id + '/disable.json', function(err, response) {
-  console.log('err', err, 'response', response)
-})

-{
-  "code":200
-}

- - -

VOD Zone Custom Domains API

- -

List Custom Domains

- -

Returns a list of all custom domains on the zone specified by -{zone_id}

- -

GET -https://rws.maxcdn.com/{companyalias}/clients/{id}/zones/vod/{zone_id}/customdomains.json

- -

Response Parameters

- - - - - -

Parameter	Description
id	Push Zone ID
bucket_id	The id of the zone the custom domain belongs to
custom_domain	A valid custom domain

- -

Code Samples

- -

-id = '97794'
-api.get('/clients/{id}/zones/vod/'+id+'/customdomains.json')

-id = '96187'
-api.get('/clients/{id}/zones/vod/'+id+'/customdomains.json')

-$id = '97183';
-$api->get('/clients/{id}/zones/vod/'.$id.'/customdomains.json');

-var id = '97183'
-api.get('/clients/{id}/zones/vod.json/' + id + '/customdomains.json, function(err, response) {
-  console.log('err', err, 'response', response)
-})

-{
-    "code": 200,
-    "data": {
-        "customdomains": [
-            {
-                "bucket_id": "97183",
-                "custom_domain": "cdn.somenewdomain3.com",
-                "id": "79191",
-                "type": "vod-rtmp"
-            }
-        ],
-        "total": 1
-    }
-}

- - -

Create Custom Domain

- -

Adds a new custom domain to {zone_id}

- -

POST -https://rws.maxcdn.com/{companyalias}/clients/{id}/zones/vod/{zone_id}/customdomains.json

- -

Accepted Request Parameters

- - - - -

Parameter	Default Value	Validation	Description
custom_domain	-	required length: 1-255 chars, valid: custom_domain, not valid: full_domain	A valid custom domain
type	-	Applies only to VOD Zones and must be either 'vod-rtmp','vod-pseudo', 'vod-direct', or 'vod-ftp'	The type of custom domain being created

- -

Response Parameters

- - - - - - -

Parameter	Description
id	The id of the custom domain
bucket_id	The id of the zone the custom domain belongs to
custom_domain	The valid custom domain

- -

Code Samples

- -

-id = '97794'
-params = {"custom_domain"=>"cdn.somedomain39.com","type"=>"vod-rtmp"}
-api.post('/clients/{id}/zones/vod/'+id+'/customdomains.json', params)

-id = '96187'
-params = {"custom_domain":"cdn.somedomain16.com","type":"vod-rtmp"}
-api.post('/clients/{id}/zones/vod/'+id+'/customdomains.json', params)

-$id = '97183';
-$params = array("custom_domain"=>"cdn.somedomain2.com","type"=>"vod-rtmp");
-$api->post('/clients/{id}/zones/vod/'.$id.'/customdomains.json', $params);

-var id = '97183'
-api.post('/clients/{id}/zones/vod/' + id + '/customdomains.json', { custom_domain: 'cdn.somedomain2.com', type: 'vod-rtmp' }, function(err, response) {
-  console.log('err', err, 'response', response)
-})

-{
-    "code": 201,
-    "data": {
-        "customdomain": {
-            "bucket_id": "97183",
-            "custom_domain": "cdn.somedomain2.com",
-            "id": 79284,
-            "type": "vod-rtmp"
-        }
-    }
-}

- - -

Get Custom Domain

- -

Gets a custom domain specified by the {zone_id} and -{customdomain_id} parameters

- -

GET -https://rws.maxcdn.com/{companyalias}/clients/{id}/zones/vod/{zone_id}/customdomains.json/{customdomain_id}

- -

Response Parameters

- - - - - -

Parameter	Description
id	Push Zone ID
bucket_id	The id of the zone the custom domain belongs to
custom_domain	A valid custom domain

- -

Code Samples

- -

-zoneId = '97794'
-domainId = '79748'
-api.get('/clients/{id}/zones/vod/'+zoneId+'/customdomains.json/'+domainId)

-zoneId = '96187'
-domainId = '79321'
-api.get('/clients/{id}/zones/vod/'+zoneId+'/customdomains.json/'+domainId)

-$zoneId = '97183';
-$domainId = '79191';
-$api->get('/clients/{id}/zones/vod/'.$zoneId.'/customdomains.json/'.$domainId);

-var zoneId = '97183'
-var domainId = '79191'
-api.get('/clients/{id}/zones/vod/' + zoneId + '/customdomains.json/' + domainId, function(err, response) {
-  console.log('err', err, 'response', response)
-})

-{
-    "code": 200,
-    "data": {
-        "customdomain": {
-            "bucket_id": "97183",
-            "custom_domain": "cdn.somenewdomain3.com",
-            "id": "79191",
-            "type": "vod-rtmp"
-        }
-    }
-}

- - -

Update Custom Domain

- -

Updates a custom domain specified by the id parameter

- -

PUT -https://rws.maxcdn.com/{companyalias}/clients/{id}/zones/vod/{zone_id}/customdomains.json/{customdomain_id}

- -

Accepted Request Parameters

- - - -

Parameter	Default Value	Validation	Description
custom_domain	-	required length: 1-255 chars, valid: custom_domain, not valid: full_domain	A valid custom domain

- -

Response Parameters

- - - - - -

Parameter	Description
id	Push Zone ID
bucket_id	The id of the zone the custom domain belongs to
custom_domain	A valid custom domain

- -

Code Samples

- -

-zoneId = '97794'
-domainId = '79748'
-params = {"custom_domain"=>"cdn.somenewdomain49.com"}
-api.put('/clients/{id}/zones/vod/'+zoneId+'/customdomains.json/'+domainId,params)

-zoneId = '96187'
-domainId = '79321'
-params = {"custom_domain":"cdn.somenewdomain401.com"}
-api.put('/clients/{id}/zones/vod/'+zoneId+'/customdomains.json/'+domainId,params=params)

-$zoneId = '97183';
-$domainId = '79191';
-$params = array("custom_domain"=>"cdn.somenewdomain3.com");
-$api->put('/clients/{id}/zones/vod/'.$zoneId.'/customdomains.json/'.$domainId, $params);

-var zoneId = '97183'
-var domainId = '79191'
-api.put('/clients/{id}/zones/vod/' + zoneId + '/customdomains.json/' + domainId, { custom_domain: 'cdn.somenewdomain3.com' }, function(err, response) {
-  console.log('err', err, 'response', response)
-})

-{
-    "code": 200,
-    "data": {
-        "customdomain": {
-            "bucket_id": "97183",
-            "custom_domain": "cdn.somenewdomain42.com",
-            "id": "79284",
-            "type": "vod-rtmp"
-        }
-    }
-}

- - -

Delete Custom Domain

- -

Deletes a custom domain specified by the {zone_id} and -{customdomain_id} parameters

- -

DELETE -https://rws.maxcdn.com/{companyalias}/clients/{id}/zones/vod/{zone_id}/customdomains.json/{customdomain_id}

- - -

Code Samples

- -

-zoneId = '97794'
-domainId = '79748'
-api.delete('/clients/{id}/zones/vod/'+zoneId+'/customdomains.json/'+domainId)

-zoneId = '96187'
-domainId = '79321'
-api.delete('/clients/{id}/zones/vod/'+zoneId+'/customdomains.json/'+domainId)

-$zoneId = '97183';
-$domainId = '79191';
-$api->delete('/clients/{id}/zones/vod/'.$zoneId.'/customdomains.json/'.$domainId);

-var zoneId = '97183'
-var domainId = '79191'
-api.delete('/clients/{id}/zones/vod/' + zoneId + '/customdomains.json/' + domainId, function(err, response) {
-  console.log('err', err, 'response', response)
-})

-{
-  "code":200
-}

- - -

Zones SSL API

- -

Get Zone's SSL Information

- -

Get the SSL certificate for the specified {zone_type} and -{zone_id}.

- -

GET -https://rws.maxcdn.com/{companyalias}/clients/{id}/zones/{zone_type}/{zone_id}/ssl.json

- -

Code Samples

- -

-id = '96061'
-type = 'pull'
-api.get('/clients/{id}/zones/'+type+'/'+id+'/ssl.json')

-id = '96061'
-type = 'pull'
-api.get('/clients/{id}/zones/'+type+'/'+id+'/ssl.json')

-$id = '96061';
-$type = 'pull';
-$api->get('/clients/{id}/zones/'.$type.'/'.$id.'/ssl.json');

-var id = '96061'
-var type = 'pull'
-api.get('/clients/{id}/zones/' + type + '/' + id + '/ssl.json', function(err, response) {
-  console.log('err', err, 'response', response)
-})

-{
-  "code":201,
-  "data":{
-    "ssl":{
-      "id":1459,
-      "ssl_crt":"-----BEGIN CERTIFICATE-----\n{ ... your certificate ... }\n-----END CERTIFICATE-----\n",
-      "ssl_key":"-----BEGIN RSA PRIVATE KEY-----\n{ ... your key ... }\n-----END RSA PRIVATE KEY-----",
-      "ssl_cabundle":null,
-      "date_expiration":"2014-01-24",
-      "anycast_ip_id":null,
-      "wildcard":1,
-      "domain":"*.idcreator.com"
-    }
-  }
-}
-

- - -

Install SSL on Zone

- -

Upload an SSL certificate for the specified {zone_type} and -{zone_id}.

- -

POST -https://rws.maxcdn.com/{companyalias}/clients/{id}/zones/{zone_type}/{zone_id}/ssl.json

- -

Accepted Request Parameters

- - - - - - -

Parameter	Default Value	Validation	Description
ssl_crt	-	required	The SSL certificate you are installing.
ssl_key	-	required	The key for the SSL certificate you are installing.
ssl_cabundle	-	-	The CA Bundle for the SSL Certificate you are installing.
ssl_sni	0	only 0 or 1 accepted	f this flag is set to 1 your zone will use SNI to identify your certificate, rather than requiring a dedicated IP.

- -

Response Parameters

- - - - - - - - - -

Parameter	Description
id	The SSL Certificate ID.
ssl_crt	The SSL certificate.
ssl_key	The SSL Private Key.
ssl_cabundle	The CA Bundle for the certificate.
domain	The domain applicable to this certificate.
date_expiration	The date of expiration for the certificate.
wildcard	Flag to signify whether this is a wildcard certificate.

- -

Code Samples

- -

-id = '96061'
-type = 'pull'
-ssl_crt = "-----BEGIN CERTIFICATE-----\n{ ... your certificate ... }\n-----END CERTIFICATE-----\n"
-ssl_key = "-----BEGIN RSA PRIVATE KEY-----\n{ ... your key ... }\n-----END RSA PRIVATE KEY-----"
-params = {"ssl_crt"=> ssl_crt,"ssl_key"=> ssl_key}
-api.post('/clients/{id}/zones/'+type+'/'+id+'/ssl.json',params)

-id = '96061'
-type = 'pull'
-ssl_crt = "-----BEGIN CERTIFICATE-----\n{ ... your certificate ... }\n-----END CERTIFICATE-----\n"
-ssl_key = "-----BEGIN RSA PRIVATE KEY-----\n{ ... your key ... }\n-----END RSA PRIVATE KEY-----"
-params = {"ssl_crt": ssl_crt,"ssl_key": ssl_key}
-api.post('/clients/{id}/zones/'+type+'/'+id+'/ssl.json',params)

-$id = '96061';
-$type = 'pull';
-$ssl_crt = "-----BEGIN CERTIFICATE-----\n{ ... your certificate ... }\n-----END CERTIFICATE-----\n";
-$ssl_key = "-----BEGIN RSA PRIVATE KEY-----\n{ ... your key ... }\n-----END RSA PRIVATE KEY-----";
-$params = array("ssl_crt"=>$ssl_crt,"ssl_key"=>$ssl_key);
-$api->post('/clients/{id}/zones/'.$type.'/'.$id.'/ssl.json',$params);

-var id = '96061'
-var type = 'pull'
-var ssl_crt = "-----BEGIN CERTIFICATE-----\n{ ... your certificate ... }\n-----END CERTIFICATE-----\n"
-var ssl_key = "-----BEGIN RSA PRIVATE KEY-----\n{ ... your key ... }\n-----END RSA PRIVATE KEY-----"
-api.post('/clients/{id}/zones/' + type + '/' + id + '/ssl.json', { ssl_crt: ssl_crt, ssl_key: ssl_key }, function(err, response) {
-  console.log('err', err, 'response', response)
-})

-{
-  "code":201,
-  "data":{
-    "ssl":{
-      "id":1459,
-      "ssl_crt":"-----BEGIN CERTIFICATE-----\n{ ... your certificate ... }\n-----END CERTIFICATE-----\n",
-      "ssl_key":"-----BEGIN RSA PRIVATE KEY-----\n{ ... your key ... }\n-----END RSA PRIVATE KEY-----",
-      "ssl_cabundle":null,
-      "date_expiration":"2014-01-24",
-      "anycast_ip_id":null,
-      "wildcard":1,
-      "domain":"*.idcreator.com"
-    }
-  }
-}
-

- - -

Update Zone's SSL Information

- -

Update the SSL certificate for the specified {zone_type} and -{zone_id}.

- -

PUT -https://rws.maxcdn.com/{companyalias}/clients/{id}/zones/{zone_type}/{zone_id}/ssl.json

- -

Accepted Request Parameters

- - - - - -

Parameter	Default Value	Validation	Description
ssl_crt	-	required	The SSL certificate you are installing.
ssl_key	-	required	The key for the SSL certificate you are installing.
ssl_cabundle	-	-	The CA Bundle for the SSL Certificate you are installing.

- -

Response Parameters

- - - - - - - - - -

Parameter	Description
id	The SSL Certificate ID.
ssl_crt	The SSL certificate.
ssl_key	The SSL Private Key.
ssl_cabundle	The CA Bundle for the certificate.
domain	The domain applicable to this certificate.
date_expiration	The date of expiration for the certificate.
wildcard	Flag to signify whether this is a wildcard certificate.

- -

Code Samples

- -

-id = '96061'
-type = 'pull'
-ssl_crt = "-----BEGIN CERTIFICATE-----\n{ ... your certificate ... }\n-----END CERTIFICATE-----\n"
-ssl_key = "-----BEGIN RSA PRIVATE KEY-----\n{ ... your key ... }\n-----END RSA PRIVATE KEY-----"
-params = {"ssl_crt"=> ssl_crt,"ssl_key"=> ssl_key}
-api.put('/clients/{id}/zones/'+type+'/'+id+'/ssl.json',params)

-id = '96061'
-type = 'pull'
-ssl_crt = "-----BEGIN CERTIFICATE-----\n{ ... your certificate ... }\n-----END CERTIFICATE-----\n"
-ssl_key = "-----BEGIN RSA PRIVATE KEY-----\n{ ... your key ... }\n-----END RSA PRIVATE KEY-----"
-params = {"ssl_crt": ssl_crt,"ssl_key": ssl_key}
-api.put('/clients/{id}/zones/'+type+'/'+id+'/ssl.json',params)

-$id = '96061';
-$type = 'pull';
-$ssl_crt = "-----BEGIN CERTIFICATE-----\n{ ... your certificate ... }\n-----END CERTIFICATE-----\n";
-$ssl_key = "-----BEGIN RSA PRIVATE KEY-----\n{ ... your key ... }\n-----END RSA PRIVATE KEY-----";
-$ssl_key = "
-$params = array("ssl_crt"=>$ssl_crt,"ssl_key"=>$ssl_key);
-$api->put('/clients/{id}/zones/'.$type.'/'.$id.'/ssl.json',$params);

-var id = '96061'
-var type = 'pull'
-var ssl_crt = "-----BEGIN CERTIFICATE-----\n{ ... your certificate ... }\n-----END CERTIFICATE-----\n"
-var ssl_key = "-----BEGIN RSA PRIVATE KEY-----\n{ ... your key ... }\n-----END RSA PRIVATE KEY-----"
-api.put('/clients/{id}/zones/' + type + '/' + id + '/ssl.json', { ssl_crt: ssl_crt, ssl_key: ssl_key }, function(err, response) {
-  console.log('err', err, 'response', response)
-})

-{
-  "code":201,
-  "data":{
-    "ssl":{
-      "id":1459,
-      "ssl_crt":"-----BEGIN CERTIFICATE-----\n{ ... your certificate ... }\n-----END CERTIFICATE-----\n",
-      "ssl_key":"-----BEGIN RSA PRIVATE KEY-----\n{ ... your key ... }\n-----END RSA PRIVATE KEY-----",
-      "ssl_cabundle":null,
-      "date_expiration":"2014-01-24",
-      "anycast_ip_id":null,
-      "wildcard":1,
-      "domain":"*.idcreator.com"
-    }
-  }
-}
-

- - -

Remove Zone's SSL Information

- -

Remove the SSL certificate for the specified {zone_type} and -{zone_id}.

- -

DELETE -https://rws.maxcdn.com/{companyalias}/clients/{id}/zones/{zone_type}/{zone_id}/ssl.json

- -

Code Samples

- -

-id = '96061'
-type = 'pull'
-api.delete('/clients/{id}/zones/'+type+'/'+id+'/ssl.json')

-id = '96061'
-type = 'pull'
-api.delete('/clients/{id}/zones/'+type+'/'+id+'/ssl.json')

-$id = '96061';
-$type = 'pull';
-$api->delete('/clients/{id}/zones/'.$type.'/'.$id.'/ssl.json');

-var id = '96061'
-var type = 'pull'
-api.delete('/clients/{id}/zones/' + type + '/' + id + '/ssl.json', function(err, response) {
-  console.log('err', err, 'response', response)
-})

-{
-  "code":200,
-  "data":{
-    "zone":{
-      "id":"90652",
-      "name":"newpullzonec5",
-      "username":"username",
-      "company_id":"1234",
-      "url":"http:\/\/someplace.net",
-      "port":"80",
-      "ip":"123.0.0.49",
-      "vhost":"someplace.net",
-      "type":"2",
-      "compress":"0",
-      "backend_compress":"0",
-      "queries":"1",
-      "max_cache_size":"50000",
-      "suspend":"0",
-      "cache_valid":"1d",
-      "content_encoding":"1",
-      "label":"",
-      "inactive":"0",
-      "valid_referers":null,
-      "key_zone_size":"50m",
-      "expires":null,
-      "disallow_robots":"0",
-      "disallow_robots_txt":null,
-      "canonical_link_headers":"0",
-      "content_disposition":"0",
-      "custom_domain_limit":"7",
-      "locked":"0",
-      "server_id":"123",
-      "ssl":0,
-      "sslshared":"0",
-      "creation_date":"2013-07-22 19:00:54",
-      "dsa_ip":null,
-      "geo_enabled":"0",
-      "set_host_header":null,
-      "ssl_id":0,
-      "dns_check":"1",
-      "hit_bandwidth_by_dir":"0",
-      "hit_bandwidth_by_custom_domain":"0",
-      "hit_bandwidth_by_file_name_status_code":"0",
-      "cache_version":"0",
-      "ignore_setcookie_header":"0",
-      "hide_setcookie_header":"0",
-      "ignore_cache_control":"0",
-      "use_stale":"0",
-      "proxy_cache_lock":"0",
-      "pseudo_streaming":"0",
-      "secret":null,
-      "upstream_enabled":"0",
-      "cdn_url":"newpullzonec5.username.netdna-cdn.com",
-      "tmp_url":"newpullzonec5.nycacorp.netdna-cdn.com"
-    }
-  }
-}
-

- -

Reports API

- -

Get Account Stats

- -

Gets the total usage statistics for your account, optionally broken up by -{report_type}. If no {report_type} is given the request will return -the total usage on your account.

- -

GET -https://rws.maxcdn.com/{companyalias}/clients/{id}/reports/stats.json/{report_type}

- -

Accepted Request Parameters

- - - - -

Parameter	Default Value	Validation	Description
date_from	now() - 1 month	Y-m-d (e.g. 2012-01-01)	Start date
date_to	now()	Y-m-d (e.g. 2012-01-01)	End date

- -

Response Parameters

- - - - - - -

Parameter	Description
size	The amount of bytes transferred
hit	The number of times files were requested
noncache_hit	The number of times a requested file was not in cache
timestamp	The timestamp for the corresponding {report_type}

- -

Code Samples

- -

-reportType = '' #Valid input includes '/daily', '/hourly', '/monthly' or ''
-api.get('/clients/{id}/reports/stats.json'+reportType)

-reportType = '' #Valid input includes '/daily', '/hourly', '/monthly' or ''
-api.get('/clients/{id}/reports/stats.json'+reportType)

-$reportType = ''; //Vaild input includes '/daily', '/hourly', '/monthly' or ''
-$api->get('/clients/{id}/reports/stats.json/'.$reportType);

-var reportType = '' //Vaild input includes '/daily', '/hourly', '/monthly' or ''
-api.get('/clients/{id}/reports/stats.json/' + reportType, function(err, response) {
-  console.log('err', err, 'response', response)
-})

-{
-    "code": 200,
-    "data": {
-        "stats": {
-            "cache_hit": "0",
-            "hit": "20",
-            "noncache_hit": "20",
-            "size": "0"
-        },
-        "total": "1"
-    }
-}

- - -

Get All Zone Stats

- -

Gets the total usage statistics for each of your zones, optionally broken up by -{report_type}. If no {report_type} is given the timestamp response parameter will be omitted.

- -

GET -https://rws.maxcdn.com/{companyalias}/clients/{id}/reports/statsbyzone.json/{report_type}

- -

Accepted Request Parameters

- - - - -

Parameter	Default Value	Validation	Description
date_from	now() - 1 month	Y-m-d (e.g. 2012-01-01)	Start date
date_to	now()	Y-m-d (e.g. 2012-01-01)	End date

- -

Response Parameters

- - - - - - -

Parameter	Description
size	The amount of bytes transferred
hit	The number of times files were requested
noncache_hit	The number of times a requested file was not in cache
timestamp	The timestamp for the corresponding {report_type}

- -

Code Samples

- -

-reportType = '' #Valid input includes '/daily', '/hourly', '/monthly' or ''
-api.get('/clients/{id}/reports/statsbyzone.json'+reportType)

-reportType = '' #Valid input includes '/daily', '/hourly', '/monthly' or ''
-api.get('/clients/{id}/reports/statsbyzone.json'+reportType)

-$reportType = ''; //Vaild input includes '/daily', '/hourly', '/monthly' or ''
-$api->get('/clients/{id}/reports/statsbyzone.json/'.$reportType);

-var reportType = '' //Vaild input includes '/daily', '/hourly', '/monthly' or ''
-api.get('/clients/{id}/reports/statsbyzone.json/' + reportType, function(err, response) {
-  console.log('err', err, 'response', response)
-})

-{
-  "code": 200,
-  "data": {
-    "page": 1,
-    "pages": 262,
-    "page_size": 50,
-    "current_page_size": 50,
-    "total": 13097,
-    "stats": [
-      {
-        "zone_id": "4816",
-        "size": "20318527",
-        "hit": "280",
-        "cache_hit": "15",
-        "noncache_hit": "265"
-      },
-      {
-        "zone_id": "5023",
-        "size": "18032138",
-        "hit": "119120",
-        "cache_hit": "0",
-        "noncache_hit": "119120"
-      },
-      {
-        "zone_id": "5045",
-        "size": "10656749286",
-        "hit": "950640",
-        "cache_hit": "838432",
-        "noncache_hit": "112208"
-      },
-
-      ....
-
-    ],
-    "summary": {
-      "size": 5.7138288549144e+14,
-      "hit": 17093013874,
-      "cache_hit": 14815205275,
-      "noncache_hit": 2277808599
-    }
-  }
-}

- - -

Get a Zone's Stats

- -

Gets the {zone_id} usage statistics optionally broken up by -{report_type}. If no {report_type} is given the request will return -the total usage for the zones.

- -

GET -https://rws.maxcdn.com/{companyalias}/clients/{id}/reports/{zone_id}/stats.json/{report_type}

- -

Accepted Request Parameters

- - - - -

Parameter	Default Value	Validation	Description
date_from	now() - 1 month	Y-m-d (e.g. 2012-01-01)	Start date
date_to	now()	Y-m-d (e.g. 2012-01-01)	End date

- -

Response Parameters

- - - - - - -

Parameter	Description
size	The amount of bytes transferred
hit	The number of times files were requested
noncache_hit	The number of times a requested file was not in cache
timestamp	The timestamp for the corresponding {report_type}

- -

Code Samples

- -

-id = '96061'
-reportType = '' #Valid input includes '/daily', '/hourly', '/monthly' or ''
-api.get('/clients/{id}/reports/'+id+'/stats.json'+reportType)

-id = '96061'
-reportType = '' #Valid input includes '/daily', '/hourly', '/monthly' or ''
-api.get('/clients/{id}/reports/'+id+'/stats.json'+reportType)

-$id = '96061';
-$reportType = ''; //Vaild input includes '/daily', '/hourly', '/monthly' or ''
-$api->get('/clients/{id}/reports/'.$id.'/stats.json/'.$reportType);

-var id = '96061'
-var reportType = '' //Vaild input includes '/daily', '/hourly', '/monthly' or ''
-api.get('/clients/{id}/reports/' + id + '/stats.json/' + reportType, function(err, response) {
-  console.log('err', err, 'response', response)
-})

-{
-    "code": 200,
-    "data": {
-        "stats": {
-            "cache_hit": null,
-            "hit": null,
-            "noncache_hit": null,
-            "size": null
-        },
-        "summary": {
-            "cache_hit": null,
-            "hit": null,
-            "noncache_hit": null,
-            "size": null
-        },
-        "total": "0"
-    }
-}

- -

Reports by Status Codes API

- -

List Status Code Responses

- -

Gets HTTP status code response statistics for your account

- -

GET -https://rws.maxcdn.com/{companyalias}/clients/{id}/reports/statuscodes.json/{report_type}

- -

Accepted Request Parameters

- - - - -

Parameter	Default Value	Validation	Description
date_from	now() - 1 month	Y-m-d (e.g. 2012-01-01)	Start date
date_to	now()	Y-m-d (e.g. 2012-01-01)	End date

- -

Response Parameters

- - - - - -

Parameter	Description
status_code	The HTTP status code for the response
hit	The number of times files were requested
definition	The definition for the status code

- -

Code Samples

- -

-reportType = '' #Valid input includes '/daily', '/hourly', '/monthly' or ''
-api.get('/clients/{id}/reports/statuscodes.json'+reportType)

-reportType = '' #Valid input includes '/daily', '/hourly', '/monthly' or ''
-api.get('/clients/{id}/reports/statuscodes.json'+reportType)

-$reportType = ''; //Vaild input includes '/daily', '/hourly', '/monthly' or ''
-$api->get('/clients/{id}/reports/statuscodes.json/'.$reportType);

-var reportType = '' //Valid input includes '/daily', '/hourly', '/monthly' or ''
-api.get('/clients/{id}/reports/statuscodes.json/' + reportType, function(err, response) {
-  console.log('err', err, 'response', response)
-})

-{
-    "code": 200,
-    "data": {
-        "statuscodes": [
-            {
-                "definition": "Not Found",
-                "hit": "20",
-                "status_code": "404"
-            }
-        ],
-        "summary": {
-            "hit": "20"
-        },
-        "total": "1"
-    }
-}

- -

List Status Code Responses by Zone Id

- -

Gets HTTP status code response statistics for a specific -{zone_id}

- -

GET -https://rws.maxcdn.com/{companyalias}/clients/{id}/reports/{zone_id}/statuscodes.json/{report_type}

- -

Accepted Request Parameters

- - - - -

Parameter	Default Value	Validation	Description
date_from	now() - 1 month	Y-m-d (e.g. 2012-01-01)	Start date
date_to	now()	Y-m-d (e.g. 2012-01-01)	End date

- -

Response Parameters

- - - - - -

Parameter	Description
status_code	The HTTP status code for the response
hit	The number of times files were requested
definition	The definition for the status code

- -

Code Samples

- -

-reportType = '' #Valid input includes '/daily', '/hourly', '/monthly' or ''
-id = '96061'
-api.get('/clients/{id}/reports/'+id+'/statuscodes.json'+reportType)

-reportType = '' #Valid input includes '/daily', '/hourly', '/monthly' or ''
-id = '96061'
-api.get('/clients/{id}/reports/'+id+'/statuscodes.json'+reportType)

-$reportType = ''; //Vaild input includes '/daily', '/hourly', '/monthly' or ''
-$id = '96061';
-$api->get('/clients/{id}/reports/'.$id.'/statuscodes.json/'.$reportType);

-var reportType = '' //Valid input includes '/daily', '/hourly', '/monthly' or ''
-var id = '96061'
-api.get('/clients/{id}/reports/' + id + '/statuscodes.json/' + reportType, function(err, response) {
-  console.log('err', err, 'response', response)
-})

-{
-    "code": 200,
-    "data": {
-        "statuscodes": [],
-        "summary": {
-            "hit": null
-        },
-        "total": "0"
-    }
-}

- -

Reports by File Types API

- -

List File Types

- -

Gets file type statistics for your account

- -

GET -https://rws.maxcdn.com/{companyalias}/clients/{id}/reports/filetypes.json/{report_type}

- -

Accepted Request Parameters

- - - - -

Parameter	Default Value	Validation	Description
date_from	now() - 1 month	Y-m-d (e.g. 2012-01-01)	Start date
date_to	now()	Y-m-d (e.g. 2012-01-01)	End date

- -

Response Parameters

- - - - -

Parameter	Description
file_type	The file type requested
hit	The number of times files were requested

- -

Code Samples

- -

-reportType = '' #Valid input includes '/daily', '/hourly', '/monthly' or ''
-api.get('/clients/{id}/reports/filetypes.json'+reportType)

-reportType = '' #Valid input includes '/daily', '/hourly', '/monthly' or ''
-api.get('/clients/{id}/reports/filetypes.json'+reportType)

-$reportType = ''; //Vaild input includes '/daily', '/hourly', '/monthly' or ''
-$api->get('/clients/{id}/reports/filetypes.json'.$reportType);

-var reportType = '' //Valid input includes '/daily', '/hourly', '/monthly' or ''
-api.get('/clients/{id}/reports/filetypes.json', function(err, response) {
-  console.log('err', err, 'response', response)
-})

-{
-    "code": 200,
-    "data": {
-        "current_page_size": 1,
-        "filetypes": [
-            {
-                "file_type": "txt",
-                "hit": "20"
-            }
-        ],
-        "page": 1,
-        "page_size": "50",
-        "pages": 1,
-        "summary": {
-            "hit": "20"
-        },
-        "total": "1"
-    }
-}

- - -

List File Types by Zone Id

- -

Gets file type statistics for a specific {zone_id}

- -

GET -https://rws.maxcdn.com/{companyalias}/clients/{id}/reports/{zone_id}/filetypes.json/{report_type}

- -

Accepted Request Parameters

- - - - -

Parameter	Default Value	Validation	Description
date_from	now() - 1 month	Y-m-d (e.g. 2012-01-01)	Start date
date_to	now()	Y-m-d (e.g. 2012-01-01)	End date

- -

Response Parameters

- - - - -

Parameter	Description
file_type	The file type requested
hit	The number of times files were requested

- -

Code Samples

- -

-reportType = '' #Valid input includes '/daily', '/hourly', '/monthly' or ''
-id = '96061'
-api.get('/clients/{id}/reports/'+id+'/filetypes.json'+reportType)

-reportType = '' #Valid input includes '/daily', '/hourly', '/monthly' or ''
-id = '96061'
-api.get('/clients/{id}/reports/'+id+'/filetypes.json'+reportType)

-$reportType = ''; //Vaild input includes '/daily', '/hourly', '/monthly' or ''
-$id = '96061';
-$api->get('/clients/{id}/reports/'.$id.'/filetypes.json/'.$reportType);

-var reportType = '' //Valid input includes '/daily', '/hourly', '/monthly' or ''
-var id = '96061'
-api.get('/clients/{id}/reports/' + id + '/filetypes.json/' + reportType, function(err, response) {
-  console.log('err', err, 'response', response)
-})

-{
-    "code": 200,
-    "data": {
-        "current_page_size": 0,
-        "filetypes": [],
-        "page": 1,
-        "page_size": "50",
-        "pages": 0,
-        "summary": {
-            "hit": null
-        },
-        "total": "0"
-    }
-}

- - -

Reports by File Size Ranges API

- -

List File Sizes

- -

Gets request statistics for your account based on file size -ranges

- -

GET -https://rws.maxcdn.com/{companyalias}/clients/{id}/reports/filesizes.json/{report_type}

- -

Accepted Request Parameters

- - - - -

Parameter	Default Value	Validation	Description
date_from	now() - 1 month	Y-m-d (e.g. 2012-01-01)	Start date
date_to	now()	Y-m-d (e.g. 2012-01-01)	End date

- -

Response Parameters

- - - - - - - - - - -

Parameter	Description
le_10k_hits	The number of requests for files <= 10KB
le_50k_hits	The number of requests for files <= 50KB
le_100k_hits	The number of requests for files <= 100KB
le_500k_hits	The number of requests for files <= 500KB
le_1m_hits	The number of requests for files <= 1MB
le_10m_hits	The number of requests for files <= 10MB
le_100m_hits	The number of requests for files <= 100MB
gt_100m_hits	The number of requests for files > 100MB

- -

Code Samples

- -

-reportType = '' #Valid input includes '/daily', '/hourly', '/monthly' or ''
-zoneType = 'pull'
-id = '96061'
-api.get('/clients/{id}/reports/'+zoneType+'/'+id+'/filetypes.json'+reportType)

-reportType = '' #Valid input includes '/daily', '/hourly', '/monthly' or ''
-api.get('/clients/{id}/reports/filesizes.json'+reportType)

-$reportType = ''; //Vaild input includes '/daily', '/hourly', '/monthly' or ''
-$api->get('/clients/{id}/reports/filesizes.json/'.$reportType);

-var reportType = '' //Valid input includes '/daily', '/hourly', '/monthly' or ''
-api.get('/clients/{id}/reports/filesizes.json/' + reportType, function(err, response) {
-  console.log('err', err, 'response', response)
-})

-{
-    "code": 200,
-    "data": {
-        "filesizes": [
-            {
-                "gt_100m_hit": "0",
-                "le_100k_hit": "0",
-                "le_100m_hit": "0",
-                "le_10k_hit": "20",
-                "le_10m_hit": "0",
-                "le_1m_hit": "0",
-                "le_500k_hit": "0",
-                "le_50k_hit": "0"
-            }
-        ],
-        "summary": {
-            "hit": "20"
-        }
-    }
-}

- - -

List File Sizes by Zone Id

- -

Gets request statistics for the specified {zone_id} based on -file size ranges

- -

GET -https://rws.maxcdn.com/{companyalias}/clients/{id}/reports/{zone_id}/filesizes.json/{report_type}

- -

Accepted Request Parameters

- - - - -

Parameter	Default Value	Validation	Description
date_from	now() - 1 month	Y-m-d (e.g. 2012-01-01)	Start date
date_to	now()	Y-m-d (e.g. 2012-01-01)	End date

- -

Response Parameters

- - - - - - - - - - -

Parameter	Description
le_10k_hits	The number of requests for files <= 10KB
le_50k_hits	The number of requests for files <= 50KB
le_100k_hits	The number of requests for files <= 100KB
le_500k_hits	The number of requests for files <= 500KB
le_1m_hits	The number of requests for files <= 1MB
le_10m_hits	The number of requests for files <= 10MB
le_100m_hits	The number of requests for files <= 100MB
gt_100m_hits	The number of requests for files > 100MB

- -

Code Samples

- -

-reportType = '' #Valid input includes '/daily', '/hourly', '/monthly' or ''
-id = '96061'
-api.get('/clients/{id}/reports/'+id+'/filesizes.json'+reportType)

-reportType = '' #Valid input includes '/daily', '/hourly', '/monthly' or ''
-id = '96061'
-api.get('/clients/{id}/reports/'+id+'/filesizes.json'+reportType)

-$reportType = ''; //Vaild input includes '/daily', '/hourly', '/monthly' or ''
-$id = '96061';
-$api->get('/clients/{id}/reports/'.$id.'/filesizes.json/'.$reportType);

-var reportType = '' //Valid input includes '/daily', '/hourly', '/monthly' or ''
-var id = '96061'
-api.get('/clients/{id}/reports/' + id + '/filesizes.json/' + reportType, function(err, response) {
-  console.log('err', err, 'response', response)
-})

-{
-    "code": 200,
-    "data": {
-        "filesizes": [
-            {
-                "gt_100m_hit": null,
-                "le_100k_hit": null,
-                "le_100m_hit": null,
-                "le_10k_hit": null,
-                "le_10m_hit": null,
-                "le_1m_hit": null,
-                "le_500k_hit": null,
-                "le_50k_hit": null
-            }
-        ],
-        "summary": {
-            "hit": null
-        }
-    }
-}

- -

Reports by Location API

- -

List Nodes

- -

Gets a list of all active nodes (locations)

- -

GET -https://rws.maxcdn.com/{companyalias}/clients/{id}/reports/nodes.json

- - -

Response Parameters

- - - - - -

Parameter	Description
id	Node Id
name	Node 3 letter code
description	Full node name

- -

Code Samples

- -

-api.get('/clients/{id}/reports/nodes.json')

-api.get('/clients/{id}/reports/nodes.json')

-$api->get('/clients/{id}/reports/nodes.json');

-api.get('/clients/{id}/reports/nodes.json', function(err, response) {
-  console.log('err', err, 'response', response)
-})

-{
-    "code": 200,
-    "data": {
-        "nodes": [
-            {
-                "description": "Los Angeles",
-                "id": "1",
-                "name": "lax"
-            },
-            {
-                "description": "New York",
-                "id": "3",
-                "name": "jfk"
-            },
-            {
-                "description": "Seattle",
-                "id": "2",
-                "name": "sea"
-            },
-            {
-                "description": "Atlanta",
-                "id": "4",
-                "name": "atl"
-            },
-            {
-                "description": "Amsterdam",
-                "id": "5",
-                "name": "ams"
-            },
-            {
-                "description": "Dallas",
-                "id": "6",
-                "name": "dal"
-            },
-            {
-                "description": "Chicago",
-                "id": "8",
-                "name": "chi"
-            },
-            {
-                "description": "Virginia",
-                "id": "9",
-                "name": "vir"
-            },
-            {
-                "description": "Miami",
-                "id": "7",
-                "name": "mia"
-            },
-            {
-                "description": "London",
-                "id": "12",
-                "name": "lhr"
-            },
-            {
-                "description": "San Francisco",
-                "id": "13",
-                "name": "sfo"
-            },
-            {
-                "description": "Los Angeles 3",
-                "id": "30",
-                "name": "lax"
-            }
-        ]
-    }
-}

- - -

List Nodes by Zone

- -

Gets a list of all active nodes (locations) specified by the -{zone_id} parameter

- -

GET -https://rws.maxcdn.com/{companyalias}/clients/{id}/reports/{zone_id}/nodes.json

- -

Response Parameters

- - - - - -

Parameter	Description
id	Node Id
name	Node 3 letter code
description	Full node name

- -

Code Samples

- -

-id = '96061'
-api.get('/clients/{id}/reports/'+id+'/nodes.json')

-id = '96061'
-api.get('/clients/{id}/reports/'+id+'/nodes.json')

-$id = '96061';
-$api->get('/clients/{id}/reports/'.$id.'/nodes.json');

-var id = '96061'
-api.get('/clients/{id}/reports/' + id + '/nodes.json', function(err, response) {
-  console.log('err', err, 'response', response)
-})

-{
-    "code": 200,
-    "data": {
-        "nodes": [
-            {
-                "description": "Dallas",
-                "id": "6",
-                "name": "dal"
-            },
-            {
-                "description": "Los Angeles",
-                "id": "1",
-                "name": "lax"
-            },
-            {
-                "description": "Seattle",
-                "id": "2",
-                "name": "sea"
-            },
-            {
-                "description": "New York",
-                "id": "3",
-                "name": "jfk"
-            },
-            {
-                "description": "Atlanta",
-                "id": "4",
-                "name": "atl"
-            },
-            {
-                "description": "Amsterdam",
-                "id": "5",
-                "name": "ams"
-            },
-            {
-                "description": "Chicago",
-                "id": "8",
-                "name": "chi"
-            },
-            {
-                "description": "Virginia",
-                "id": "9",
-                "name": "vir"
-            },
-            {
-                "description": "London",
-                "id": "12",
-                "name": "lhr"
-            },
-            {
-                "description": "San Francisco",
-                "id": "13",
-                "name": "sfo"
-            }
-        ]
-    }
-}

- - -

List Zone Node Stats by Report Type

- -

Get usage statistics broken up by nodes and optionally -{report_type}. If no {report_type} is given the request will return -the total usage broken up by node.

- -

GET -https://rws.maxcdn.com/{companyalias}/clients/{id}/reports/nodes.json/stats/{report_type}

- -

Accepted Request Parameters

- - - - -

Parameter	Default Value	Validation	Description
date_from	now() - 1 month	Y-m-d (e.g. 2012-01-01)	Start date
date_to	now()	Y-m-d (e.g. 2012-01-01)	End date

- -

Response Parameters

- - - - - - - - - - -

Parameter	Description
pop_id	Node Id
pop_name	Node 3 letter code, only returned when {report_type} is not empty
pop_description	Full node name, only returned when {report_type} is not empty
size	The amount of bytes transferred
hit	The number of times files were requested
noncache_hit	The number of times a requested file was not in cache
cache_hit	The number of times a requested file was already cached
timestamp	A timestamp corresponding to {report_type}, only returned when {report_type} is not empty

- -

Code Samples

- -

-reportType = '' #Valid input includes '/daily', '/hourly', '/monthly' or ''
-api.get('/clients/{id}/reports/nodes.json/stats'+reportType)

-reportType = '' #Valid input includes '/daily', '/hourly', '/monthly' or ''
-api.get('/clients/{id}/reports/nodes.json/stats'+reportType)

-$reportType = ''; //Vaild input includes '/daily', '/hourly', '/monthly' or ''
-$api->get('/clients/{id}/reports/nodes.json/stats/'.$reportType);

-var reportType = '' //Vaild input includes '/daily', '/hourly', '/monthly' or ''
-api.get('/clients/{id}/reports/nodes.json/stats/' + reportType, function(err, response) {
-  console.log('err', err, 'response', response)
-})

-{
-    "code": 200,
-    "data": {
-        "stats": [
-            {
-                "cache_hit": "0",
-                "hit": "2",
-                "noncache_hit": "2",
-                "pop_description": "Los Angeles",
-                "pop_id": "1",
-                "pop_name": "lax",
-                "size": "0"
-            },
-            {
-                "cache_hit": "0",
-                "hit": "2",
-                "noncache_hit": "2",
-                "pop_description": "Atlanta",
-                "pop_id": "4",
-                "pop_name": "atl",
-                "size": "0"
-            },
-            {
-                "cache_hit": "0",
-                "hit": "2",
-                "noncache_hit": "2",
-                "pop_description": "Chicago",
-                "pop_id": "8",
-                "pop_name": "chi",
-                "size": "0"
-            },
-            {
-                "cache_hit": "0",
-                "hit": "2",
-                "noncache_hit": "2",
-                "pop_description": "San Francisco",
-                "pop_id": "13",
-                "pop_name": "sfo",
-                "size": "0"
-            },
-            {
-                "cache_hit": "0",
-                "hit": "2",
-                "noncache_hit": "2",
-                "pop_description": "Seattle",
-                "pop_id": "2",
-                "pop_name": "sea",
-                "size": "0"
-            },
-            {
-                "cache_hit": "0",
-                "hit": "2",
-                "noncache_hit": "2",
-                "pop_description": "Amsterdam",
-                "pop_id": "5",
-                "pop_name": "ams",
-                "size": "0"
-            },
-            {
-                "cache_hit": "0",
-                "hit": "2",
-                "noncache_hit": "2",
-                "pop_description": "Virginia",
-                "pop_id": "9",
-                "pop_name": "vir",
-                "size": "0"
-            },
-            {
-                "cache_hit": "0",
-                "hit": "2",
-                "noncache_hit": "2",
-                "pop_description": "New York",
-                "pop_id": "3",
-                "pop_name": "jfk",
-                "size": "0"
-            },
-            {
-                "cache_hit": "0",
-                "hit": "2",
-                "noncache_hit": "2",
-                "pop_description": "Dallas",
-                "pop_id": "6",
-                "pop_name": "dal",
-                "size": "0"
-            },
-            {
-                "cache_hit": "0",
-                "hit": "2",
-                "noncache_hit": "2",
-                "pop_description": "London",
-                "pop_id": "12",
-                "pop_name": "lhr",
-                "size": "0"
-            }
-        ],
-        "summary": {
-            "cache_hit": "0",
-            "hit": "20",
-            "noncache_hit": "20",
-            "size": "0"
-        },
-        "total": "1"
-    }
-}

- - -

List Node Stats by Zone and Report Type

- -

Get usage statistics for a particular {zone_id} broken up by -nodes and optionally {report_type}. If no {report_type} is given -the request will return the total usage broken up by node.

- -

GET -https://rws.maxcdn.com/{companyalias}/clients/{id}/reports/{zone_id}/nodes.json/stats/{report_type}

- -

Accepted Request Parameters

- - - - -

Parameter	Default Value	Validation	Description
date_from	now() - 1 month	Y-m-d (e.g. 2012-01-01)	Start date
date_to	now()	Y-m-d (e.g. 2012-01-01)	End date

- -

Response Parameters

- - - - - - - - - - -

Parameter	Description
pop_id	Node Id
pop_name	Node 3 letter code, only returned when {report_type} is not empty
pop_description	Full node name, only returned when {report_type} is not empty
size	The amount of bytes transferred
hit	The number of times files were requested
noncache_hit	The number of times a requested file was not in cache
cache_hit	The number of times a requested file was already cached
timestamp	A timestamp corresponding to {report_type}, only returned when {report_type} is not empty

- -

Code Samples

- -

-id = '96061'
-reportType = '' #Valid input includes '/daily', '/hourly', '/monthly' or ''
-api.get('/clients/{id}/reports/'+id+'/nodes.json/stats'+reportType)

-id = '96061'
-reportType = '' #Valid input includes '/daily', '/hourly', '/monthly' or ''
-api.get('/clients/{id}/reports/'+id+'/nodes.json/stats'+reportType)

-$id = '96061';
-$reportType = ''; //Vaild input includes '/daily', '/hourly', '/monthly' or ''
-$api->get('/clients/{id}/reports/'.$id.'/nodes.json/stats/'.$reportType);

-var id = '96061'
-var reportType = '' //Vaild input includes '/daily', '/hourly', '/monthly' or ''
-api.get('/clients/{id}/reports/' + id + '/nodes.json/stats/' + reportType, function(err, response) {
-  console.log('err', err, 'response', response)
-})

-{
-    "code": 200,
-    "data": {
-        "stats": [],
-        "summary": {
-            "cache_hit": null,
-            "hit": null,
-            "noncache_hit": null,
-            "size": null
-        },
-        "total": null
-    }
-}

- - -

Get Zone Node

- -

Gets the node information for the specified {node_id}

- -

GET -https://rws.maxcdn.com/{companyalias}/clients/{id}/reports/nodes.json/{node_id}

- -

Response Parameters

- - - - - -

Parameter	Description
id	Node Id
name	Node 3 letter code
description	Full node name

- -

Code Samples

- -

-id = '1'
-api.get('/clients/{id}/reports/nodes.json/'+id)

-id = '1'
-api.get('/clients/{id}/reports/nodes.json/'+id)

-$id = '1';
-$api->get('/clients/{id}/reports/nodes.json/'.$id);

-var id = '1'
-api.get('/clients/{id}/reports/nodes.json/' + id, function(err, response) {
-  console.log('err', err, 'response', response)
-})

-{
-    "code": 200,
-    "data": {
-        "node": {
-            "description": "Los Angeles",
-            "id": "1",
-            "name": "lax"
-        }
-    }
-}
-

- - -

Get Node by Zone

- -

Gets the node information for the specified {node_id} and -{zone_id}

- -

GET -https://rws.maxcdn.com/{companyalias}/clients/{id}/reports/{zone_id}/nodes.json/{node_id}

- -

Response Parameters

- - - - - -

Parameter	Description
id	Node Id
name	Node 3 letter code
description	Full node name

- -

Code Samples

- -

-zoneId = '96061'
-nodeId = '1'
-api.get('/clients/{id}/reports/'+zoneId+'/nodes.json/'+nodeId)

-zoneId = '96061'
-nodeId = '1'
-api.get('/clients/{id}/reports/'+zoneId+'/nodes.json/'+nodeId)

-$zoneId = '96061';
-$nodeId = '1';
-$api->get('/clients/{id}/reports/'.$zoneId.'/nodes.json/'.$nodeId);

-var zoneId = '96061'
-var nodeId = '1'
-api.get('/clients/{id}/reports/' + zoneId + '/nodes.json/' + nodeId, function(err, response) {
-  console.log('err', err, 'response', response)
-})

-{
-    "code": 200,
-    "data": {
-        "stats": [],
-        "summary": {
-            "cache_hit": null,
-            "hit": null,
-            "noncache_hit": null,
-            "size": null
-        },
-        "total": null
-    }
-}

- -

Get Zone Node Stats by Report Type

- -

Get usage statistics for a particular {node_id} optionally -broken up by {report_type}. If no {report_type} is given the -request will return the total usage for the node.

- -

GET -https://rws.maxcdn.com/{companyalias}/clients/{id}/reports/nodes.json/{node_id}/stats/{report_type}

- -

Accepted Request Parameters

- - - - -

Parameter	Default Value	Validation	Description
date_from	now() - 1 month	Y-m-d (e.g. 2012-01-01)	Start date
date_to	now()	Y-m-d (e.g. 2012-01-01)	End date

- -

Response Parameters

- - - - - - -

Parameter	Description
size	The amount of bytes transferred
hit	The number of times files were requested
noncache_hit	SThe number of times a requested file was not in cache
timestamp	The timestamp for the corresponding {report_type}

- -

Code Samples

- -

-id = '1'
-reportType = '' #Valid input includes '/daily', '/hourly', '/monthly' or ''
-api.get('/clients/{id}/reports/nodes.json/'+id+'/stats'+reportType)

-id = '1'
-reportType = '' #Valid input includes '/daily', '/hourly', '/monthly' or ''
-api.get('/clients/{id}/reports/nodes.json/'+id+'/stats'+reportType)

-$id = '1';
-$reportType = ''; //Vaild input includes '/daily', '/hourly', '/monthly' or ''
-$api->get('/clients/{id}/reports/nodes.json/'.$id.'/stats/'.$reportType);

-var id = '1'
-var reportType = '' //Valid input includes '/daily', '/hourly', '/monthly' or ''
-api.get('/clients/{id}/reports/nodes.json/' + id + '/stats/' + reportType, function(err, response) {
-  console.log('err', err, 'response', response)
-})

-{
-    "code": 200,
-    "data": {
-        "stats": [
-            {
-                "cache_hit": "0",
-                "hit": "2",
-                "noncache_hit": "2",
-                "size": "0"
-            }
-        ],
-        "total": "1"
-    }
-}

- - -

Get Node Stats by Zone and Report Type

- -

Get usage statistics for a particular {node_id} and {zone_id}, -optionally broken up by {report_type}. If no {report_type} is given -the request will return the total usage for the node.

- -

GET -https://rws.maxcdn.com/{companyalias}/clients/{id}/reports/{zone_id}/nodes.json/{node_id}/stats/{report_type}

- -

Accepted Request Parameters

- - - - -

Parameter	Default Value	Validation	Description
date_from	now() - 1 month	Y-m-d (e.g. 2012-01-01)	Start date
date_to	now()	Y-m-d (e.g. 2012-01-01)	End date

- -

Response Parameters

- - - - - - -

Parameter	Description
size	The amount of bytes transferred
hit	The number of times files were requested
noncache_hit	SThe number of times a requested file was not in cache
timestamp	The timestamp for the corresponding {report_type}

- - -

Code Samples

- -

-zoneId='96061'
-nodeId='1'
-reportType = '' #Valid input includes '/daily', '/hourly', '/monthly' or ''
-api.get('/clients/{id}/reports/'+zoneId+'/nodes.json/'+nodeId+'/stats'+reportType)

-zoneId='96061'
-nodeId='1'
-reportType = '' #Valid input includes '/daily', '/hourly', '/monthly' or ''
-api.get('/clients/{id}/reports/'+zoneId+'/nodes.json/'+nodeId+'/stats'+reportType)

-$zoneId='96061';
-$nodeId='1';
-$reportType = ''; //Vaild input includes '/daily', '/hourly', '/monthly' or ''
-$api->get('/clients/{id}/reports/'.$zoneId.'/nodes.json/'.$nodeId.'/stats/'.$reportType);

-var zoneId = '96061'
-var nodeId = '1'
-var reportType = '' //Valid input includes '/daily', '/hourly', '/monthly' or ''
-api.get('/clients/{id}/reports/' + zoneId + '/nodes.json/' + nodeId + '/stats/' + reportType, function(err, response) {
-  console.log('err', err, 'response', response)
-})

-{
-    "code": 200,
-    "data": {
-        "stats": [
-            {
-                "cache_hit": null,
-                "hit": null,
-                "noncache_hit": null,
-                "size": null
-            }
-        ],
-        "total": "0"
-    }
-}

- - -

Reports by Popular Files API

- -

List Popular Files

- -

Gets the most popularly requested files for your account, -grouped into daily statistics

- -

GET -https://rws.maxcdn.com/{companyalias}/clients/{id}/reports/{zone_id}/popularfiles.json

- -

Accepted Request Parameters

- - - - -

Parameter	Default Value	Validation	Description
date_from	now() - 1 month	Y-m-d (e.g. 2012-01-01)	Start date
date_to	now()	Y-m-d (e.g. 2012-01-01)	End date

- - -

Response Parameters

- - - - - - - - -

Parameter	Description
bucket_id	The Zone ID for the popular file
uri	The URI for the requested popular file
hit	The number of times the file was requested
size	The amount of bytes transferred for the given file
vhost	The CDN URL for the corresponding zone
timestamp	The amount of bytes transferred

- -

Code Samples

- -

-api.get('/clients/{id}/reports/popularfiles.json')

-api.get('/clients/{id}/reports/popularfiles.json')

-$api->get('/clients/{id}/reports/popularfiles.json');

-api.get('/clients/{id}/reports/popularfiles.json', function(err, response) {
-  console.log('err', err, 'response', response)
-})

-{
-    "code": 200,
-    "data": {
-        "current_page_size": 0,
-        "page": 1,
-        "page_size": "50",
-        "pages": 0,
-        "popularfiles": [],
-        "summary": {
-            "hit": null,
-            "size": null
-        },
-        "total": "0"
-    }
-}

- - -

List Popular Files By Zone Type

- -

Gets the most popularly requested files for your account, -filtered by {zone_type} and grouped into daily statistics - -

GET -https://rws.maxcdn.com/{companyalias}/clients/{id}/reports/{zone_type}/popularfiles.json

- -

Accepted Request Parameters

- - - - -

Parameter	Default Value	Validation	Description
date_from	now() - 1 month	Y-m-d (e.g. 2012-01-01)	Start date
date_to	now()	Y-m-d (e.g. 2012-01-01)	End date

- -

Response Parameters

- - - - - - - - -

Parameter	Description
bucket_id	The Zone ID for the popular file
uri	The URI for the requested popular file
hit	The number of times the file was requested
size	The amount of bytes transferred for the given file
vhost	The CDN URL for the corresponding zone
timestamp	The timestamp for the corresponding {report_type}

- - - -

Code Samples

- -

-type='pull'
-api.get('/clients/{id}/reports/'+type+'/popularfiles.json')

-type='pull'
-api.get('/clients/{id}/reports/'+type+'/popularfiles.json')

-$type='pull';
-$api->get('/clients/{id}/reports/'.$type.'/popularfiles.json');

-var type = 'pull'
-api.get('/clients/{id}/reports/' + type + '/popularfiles.json', function(err, response) {
-  console.log('err', err, 'response', response)
-})

-{
-    "code": 200,
-    "data": {
-        "current_page_size": 0,
-        "page": 1,
-        "page_size": "50",
-        "pages": 0,
-        "popularfiles": [],
-        "summary": {
-            "hit": null,
-            "size": null
-        },
-        "total": "0"
-    }
-}

- - -

Reports By Directory API

- -

List Stats By Directory

- -

Gets usage statistics by directory for your account. (This -report has to be enabled by Sales).

- -

GET -https://rws.maxcdn.com/{companyalias}/clients/{id}/reports/statsbydir.json/{report_type}

- -

Accepted Request Parameters

- - - - -

Parameter	Default Value	Validation	Description
date_from	now() - 1 month	Y-m-d (e.g. 2012-01-01)	Start date
date_to	now()	Y-m-d (e.g. 2012-01-01)	End date

- - -

Response Parameters

- - - - - - -

Parameter	Description
bucket_id	The Zone ID for the top level directory
dir	The name of the directory
hit	The number of requests made to files within this directory
size	The amount of bytes transferred from within this directory

- -

Code Samples

- -

-reportType = '' #Valid input includes '/daily', '/hourly', '/monthly' or ''
-api.get('/clients/{id}/reports/statsbydir.json'+reportType)

-reportType = '' #Valid input includes '/daily', '/hourly', '/monthly' or ''
-api.get('/clients/{id}/reports/statsbydir.json'+reportType)

-$reportType = ''; //Vaild input includes '/daily', '/hourly', '/monthly' or ''
-$api->get('/clients/{id}/reports/statsbydir.json/'.$reportType);

-var reportType = '' //Valid input includes '/daily', '/hourly', '/monthly' or ''
-api.get('/clients/{id}/reports/statsbydir.json/' + reportType, function(err, response) {
-  console.log('err', err, 'response', response)
-})

-{
-    "code": 200,
-    "data": {
-        "current_page_size": 0,
-        "page": 1,
-        "page_size": "50",
-        "pages": 0,
-        "statsbydir": [],
-        "summary": {
-            "hit": null,
-            "size": null
-        },
-        "total": "0"
-    }
-}

- - -

List Stats By Directory and Zone Id - -

Gets usage statistics by directory for the specified {zone_id}. -(This report has to be enabled by Sales).

- -

GET -https://rws.maxcdn.com/{companyalias}/clients/{id}/reports/{zone_id}/statsbydir.json/{report_type}

- -

Accepted Request Parameters

- - - - -

Parameter	Default Value	Validation	Description
date_from	now() - 1 month	Y-m-d (e.g. 2012-01-01)	Start date
date_to	now()	Y-m-d (e.g. 2012-01-01)	End date

- - -

Response Parameters

- - - - - - -

Parameter	Description
bucket_id	The Zone ID for the top level directory
dir	The name of the directory
hit	The number of requests made to files within this directory
size	The amount of bytes transferred from within this directory

- - -

Response Parameters

- -

-reportType = '' #Valid input includes '/daily', '/hourly', '/monthly' or ''
-id = '96061'
-api.get('/clients/{id}/reports/'+id+'/statsbydir.json'+reportType)

-reportType = '' #Valid input includes '/daily', '/hourly', '/monthly' or ''
-id = '96061'
-api.get('/clients/{id}/reports/'+id+'/statsbydir.json'+reportType)

-$reportType = ''; //Vaild input includes '/daily', '/hourly', '/monthly' or ''
-$id = '96061';
-$api->get('/clients/{id}/reports/'.$id.'/statsbydir.json/'.$reportType);

-var reportType = '' //Valid input includes '/daily', '/hourly', '/monthly' or ''
-var id = '96061'
-api.get('/clients/{id}/reports/' + id + '/' + '/statsbydir.json/' + reportType, function(err, response) {
-  console.log('err', err, 'response', response)
-})

-{
-    "code": 200,
-    "data": {
-        "current_page_size": 0,
-        "page": 1,
-        "page_size": "50",
-        "pages": 0,
-        "statsbydir": [],
-        "summary": {
-            "hit": null,
-            "size": null
-        },
-        "total": "0"
-    }
-}

- -

Raw Logs API

- -

Get Raw Logs

- -

Retrieve up to five days of raw log data

- -

GET -https://rws.maxcdn.com/{companyalias}/clients/{id}/v3/reporting/logs.json

- -

Accepted Request Parameters

- - - - - - - - - - - - - - - -

Parameter	Default Value	Validation	Description
start	now() - 1 hour	ISO-8601 formatted date/time	The start of the range for requests to pull.
end	now()	ISO-8601 formatted date/time	The end of the range for requests to pull
zones	-	CSV of ints	The specific zones whose requests you want to pull. Separate multiple zone ids by comma
uri	-	string	Use this filter to view requests made for a specific resource (or group of resources). You can do a literal match or regular expression in this field (i.e. '/images/header.png' or 'regex:/images/')
status	-	CSV of ints	The specific HTTP status code responses you want to pull. Separate multiple HTTP status codes by comma (i.e. 200,201,304)
ssl	both	enum(nossl, ssl, both)	Use this filter to distinguish between SSL and non-SSL traffic (choose nossl, ssl or both)
user_agent	-	string	Filter logs by specific user agents. You can do a literal match or regular expression in this field (i.e. 'Python MaxCDN API Client' or 'regex:Chrome')
referer	-	string	Filter logs by a specific referer. You can do a literal match or regular expression in this field (i.e. 'www.maxcdn.com' or 'regex:maxcdn.com')
pop	-	CSV of strings	Filter logs by specific POPs (Points Of Presence), use comma separation for multiple POPs. Possible values: ams, atl, aus, chi, dal, den, fra, hkg, jfk, lax, lhr, mia, sea, sfo, sin, sjc, slc, tko, vir
query_string	-	string	Filter logs by a specific query string. You can do a literal match or regular expression in this field (i.e. 'width=600' or 'regex:width')
limit	100	int	How many records should be retrieved per page. Maximum is 1000
start_key	-	string	String-based key for next page of records to return, for easy pagination or streaming. This key will be provided in the "next_page_key" from a response.
sort	recent	enum(recent, oldest)	Display records sorted by newest first or oldest first

- -

Response Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Parameter	Description
limit	The maximum number of records retrieved
page	The current page of records retrieved
noncache_hit	The number of times a requested file was not in cache
request_time	Time in milliseconds for request to complete
next_page_key	Number string that can be used to load the next page
records	Total records displayed
bytes	Total bytes of request
client_asn	Visitor's "access network" (ISP)
client_city	Visitor's city
client_continent	Visitor's continent
client_country	Visitor's country
client_dma	Visitor's "designated market area"
client_ip	Visitor's public IP
client_latitude	Visitor's geographical latitude (roughly)
client_longitude	Visitor's geographical longitude (roughly)
client_state	Visitor's state
company_id	Your company ID
cache_status	CDN status of the file (HIT, MISS)
hostname	Domain name that was visited
method	HTTP request method
origin_time	How long it takes MaxCDN to retrieve the file (if cache status was a MISS)
pop	Point Of Presence that was hit (LAX, LHR, TYO, etc.)
protocol	HTTP protocol used
query_string	Query string attached to a file (ex. ver=1.2)
referer	Referring site
scheme	HTTP or HTTPS
status	HTTP status code (200, 404, 302, etc.)
time	UTC timestamp of the request
uri	File requested
user_agent	Text identifying the visitor's browser
zone_id	ID of the Push/Pull/VOD zone hit

- - -

Response Parameters

- - - - - - -

Parameter	Description
size	The amount of bytes transferred
hit	The number of times files were requested
noncache_hit	The number of times a requested file was not in cache
timestamp	The timestamp for the corresponding {report_type}

- - -

Code Samples

- -

-api.get('/clients/{id}/v3/reporting/logs.json?start=2014-01-30&end=2014-01-31&status=200')

-params = {"start":"2014-01-30", "end":"2014-01-31", "status":"200"}
-api.get('/clients/{id}/v3/reporting/logs.json', data=params)

-$params = array("start"=>"2014-01-30", "end"=>"2014-01-31", "status"=>"200")
-$api->get('/clients/{id}/v3/reporting/logs.json', $params)

-api.get('/clients/{id}/v3/reporting/logs.json?start=2014-01-30&end=2014-01-31&status=200', function(err, response) {
-  console.log(response);
-});

-{
-  "limit":1000,
-  "page":1,
-  "total":3,
-  "next_page_key":"1234abcdef",
-  "records":[
-    {
-      "bytes":175953,
-      "asn":"AS4804 Microplex PTY LTD",
-      "city":"Brisbane",
-      "continent":"OC",
-      "country":"AU",
-      "dma":"0",
-      "ip":"127.0.0.1",
-      "latitude":0,
-      "longitude":1.2345,
-      "cache_status":"HIT",
-      "hostname":"cdn.example.com",
-      "method":"GET",
-      "origin_time":"0",
-      "pop":"lax",
-      "protocol":"HTTP/1.1",
-      "query_string":"",
-      "scheme":"https",
-      "status_code":200,
-      "request_time":"2014-01-30T17:00:12Z",
-      "uri":"/content.png",
-      "user_agent":"Opera/9.80 (Windows NT 5.1; Edition DriverPack) Presto/2.12.388 Version/12.16",
-      "zone":"example"
-    },
-    {
-      "bytes":175953,
-      "asn":"AS4804 Microplex PTY LTD",
-      "city":"Brisbane",
-      "continent":"OC",
-      "country":"AU",
-      "dma":"0",
-      "ip":"127.0.0.1",
-      "latitude":0.0,
-      "longitude":0.12345,
-      "cache_status":"HIT",
-      "hostname":"cdn.example.com",
-      "method":"GET",
-      "origin_time":"0",
-      "pop":"lax",
-      "protocol":"HTTP/1.1",
-      "query_string":"ver=1.2",
-      "scheme":"https",
-      "status_code":200,
-      "request_time":"2014-01-30T17:00:12Z",
-      "uri":"/sample/test.swf",
-      "user_agent":"Opera/9.80 (Windows NT 5.1; Edition DriverPack) Presto/2.12.388 Version/12.16",
-      "zone":"example"
-    }
-  ]
-}

- -

+})(document,"script","hs-analytics",300000); From 08a16e247066fcbd80883f3273906da135a03dc2 Mon Sep 17 00:00:00 2001 From: Ivan Dabic Date: Fri, 29 May 2015 23:51:13 +0200 Subject: [PATCH 3/3] Added Perl Intro --- README.md | 2 +- public/index.html | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index f3076de..be3862a 100644 --- a/README.md +++ b/README.md @@ -24,8 +24,8 @@ * Integrate with our RESTful API using a language wrapper: * [Node](https://github.com/maxcdn/node-maxcdn) * [Ruby](https://github.com/maxcdn/ruby-maxcdn) - * [Perl](https://github.com/maxcdn/perl-maxcdn) * [Python](https://github.com/maxcdn/python-maxcdn) + * [Perl](https://github.com/maxcdn/perl-maxcdn) * [PHP](https://github.com/MaxCDN/php-maxcdn) * [.NET](https://github.com/MaxCDN/dotnet-maxcdn) * [Go ^Beta](http://godoc.org/github.com/MaxCDN/go-maxcdn) diff --git a/public/index.html b/public/index.html index 2dc6d9c..0f032f5 100644 --- a/public/index.html +++ b/public/index.html @@ -25,8 +25,8 @@