API docs by Redocly

5centsCDN - Zones (1.0.0)

Download OpenAPI specification:Download

API for managing Zones in 5centsCDN

Contact Support: Email: help@5centscdn.com

List Zones

Zones

Return all zones

Authorizations:
apikeyAuth
header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": "success",
  • "zones": [
    ]
}

HTTP Push

Endpoints related to HTTP Push zones

Push Zone

Return HTTP push zone details

Authorizations:
apikeyAuth
path Parameters
zoneid
required
integer
Example: 1616

(Required) Zone ID

header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": "success",
  • "zone": {
    },
  • "warnings": null
}

Update Info

Update the information of HTTP Push Zone

Authorizations:
apikeyAuth
path Parameters
zoneid
required
integer
Example: 4486

(Required) Zone ID

header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
alias
string
  • A human-readable identifier or alias for the resource.
    • This helps easily identify the resource with a friendly name.
    • Can be used for referencing the resource in logs, settings, or configuration.
    • Example values: 'ratty-test', 'production-server'.
server
string
  • Represents the server identifier or number.
    • It helps to locate or reference the specific server in a network or setup.
    • Example values: '206', '103', '12'.
cnames
Array of strings
  • A list of Canonical Names (CNAMEs) associated with the server.
    • CNAMEs are DNS records that map a domain name to another domain name.
    • Used for aliasing one domain to another, often for server management or redundancy.
    • Example values: ['p.5centscdndemo.ca', 'example.com'].
profiles
Array of strings
  • A list of profile identifiers linked to the server.
    • Profiles may represent different configurations, user settings, or access profiles associated with the server.
    • Example values: ['2', '4', '5871'].
webhook
string

Responses

Request samples

Content type
application/json
{
  • "alias": "ratty-test",
  • "server": "206",
  • "cnames": [
    ],
  • "profiles": [
    ],
  • "webhook": "http://vicky.com/notify"
}

Response samples

Content type
application/json
{
  • "result": "success",
  • "message": "Zone Updated",
  • "zone": {
    }
}

Delete Info

Delete the information of HTTP Push Zone. To cast request method POST and parameters _METHOD = DELETE

Authorizations:
apikeyAuth
path Parameters
zoneid
required
integer
Example: 4486

(Required) Zone ID

header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": "success",
  • "message": "Zone Updated",
  • "zone": {
    }
}

Push Zones

Return HTTP push zone details

Authorizations:
apikeyAuth
query Parameters
page
integer
Example: page=1
header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": "success",
  • "zones": [
    ]
}

Create Push Zone

Create a new HTTP Push Zone

Authorizations:
apikeyAuth
header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
_METHOD
string
  • Specifies the HTTP request method to be used for the operation.
    • The value PUT indicates that this request is intended to update or create a resource. .
alias
string
  • A unique alias or identifier for the entity.
    • Helps to differentiate or name the resource for easy identification.
    • Examples include ratty-test and cdn-test-alias.
server
number
  • Represents the server ID or reference.
    • Used to indicate the target server for the operation.
    • Examples include 206 and 102.
cnames
string
  • A comma-separated list of canonical names (CNAMES).
    • Represents domain names associated with the entity.
    • Examples include test.5centscdndemo.ca,p.5centscdndemo.ca.
profiles
Array of numbers
  • A list of profile IDs associated with the entity.
    • Represents various configurations or settings linked to the entity.
    • Examples include [2, 4, 5871].
webhook
string
  • URL for the webhook to receive notifications or callbacks.
    • Used for automated notifications about events.
    • Examples include http://vicky.com/notify and https://example.com/webhook.
object
cache
string
  • Specifies the cache duration or configuration. - Determines how long the content will be cached. - Examples include 1M for one month or 7D for seven days.
object
enabled
string
  • Indicates if domain locking is enabled. - Values can be Y for enabled or N for disabled.
policy
string
  • Specifies the domain locking policy. - Examples include N for no policy or R for restricted.
list
string
  • Comma-separated list of domains under the lock policy. - Examples include test.com,test2.com.
noreferer
string
  • Indicates if requests without a referer are allowed. - Values can be Y for allowed or N for disallowed.
ips
string
  • Comma-separated list of IPs allowed or blocked by domain lock. - Examples include 1.1.1.1,2.2.2.2.
object
enabled
string
  • Indicates if geoblocking is enabled. - Values can be Y for enabled or N for disabled.
policy
string
  • Specifies the geoblocking policy. - Examples include N for no policy or R for restricted.
list
Array of strings
  • List of country codes for geoblocking. - Examples include AF for Afghanistan and AL for Albania.
ips
string
  • Comma-separated list of IPs allowed or blocked by geoblocking. - Examples include 1.1.1.1,2.2.2.2.
object
enabled
string
  • Indicates if IP access control is enabled. - Values can be Y for enabled or N for disabled.
policy
string
  • Specifies the IP access control policy. - Examples include Y for strict or N for relaxed.
list
string
  • Comma-separated list of IPs included in the access control. - Examples include 123.2.2.2,9.9.9.9.
ips
string
  • Additional comma-separated IPs for access control. - Examples include 1.1.1.1,2.2.2.2.
object
enabled
string
  • Indicates if user-agent-based filtering is enabled. - Values can be Y for enabled or N for disabled.
policy
string
  • Specifies the policy for user-agent filtering. - Examples include Y for strict filtering or N for relaxed filtering.
list
string
  • Comma-separated list of user agents to include in the filter. - Example: Mozilla/5.0 (Linux; Android 13; SM-S901B) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/112.0.0.0 Mobile Safari/537.36.
casesensitive
string
  • Indicates if the user-agent matching is case-sensitive. - Values can be Y for case-sensitive or N for case-insensitive.
ips
string
  • Comma-separated list of IPs associated with user-agent filtering. - Examples include 1.1.1.1,2.2.2.2.
object
enabled
string
  • Indicates if secure token authentication is enabled. - Values can be Y for enabled or N for disabled.
policy
string
  • Specifies the secure token policy. - Examples include F for flexible or S for strict.
list
string
  • List of secure tokens allowed for authentication. - Example: 68a291cfc067cdd9.
timeout
number
  • Timeout duration for secure tokens in seconds. - Examples include 300 seconds and 600 seconds.
session
number
  • Indicates if secure token is session-based. - Values can be 0 for no session or 1 for session-based.
keyip
string
  • Indicates if the token is tied to an IP address. - Values can be Y for tied or N for untied.
ips
string
  • Comma-separated list of IPs associated with the secure token. - Examples include 1.1.1.1,2.2.2.2.
object
enabled
string
  • Indicates if bandwidth limiting is enabled. - Values can be Y for enabled or N for disabled.
policy
number
  • Specifies the bandwidth limit policy. - Example values include 0 for unrestricted and 1 for restricted.
rate
number
  • Specifies the rate limit in Mbps. - Example values include 23 and 50.
rateafter
string
  • Specifies the rate limit after a certain threshold. - Examples include 024 for 24 MB.
object
http2
string
  • Indicates if HTTP/2 is enabled for SSL. - Values can be Y for enabled or N for disabled.
redirect
string
  • Indicates if HTTP to HTTPS redirection is enabled. - Values can be Y for enabled or N for disabled.
mode
string
  • Specifies the SSL mode. - Examples include S for strict mode and F for flexible mode.
certid
string
  • Certificate ID associated with SSL. - Example values include cert123 or ssl456.
name
string
  • The name associated with the SSL certificate. - Example values include example-cert or my-ssl.
crt
string
  • SSL certificate in PEM format. - Used to establish secure connections.
key
string
  • Private key associated with the SSL certificate. - Used for SSL authentication.
cabundle
string
  • Certificate Authority (CA) bundle for SSL. - Used to establish trust with the certificate chain.

Responses

Request samples

Content type
application/json
{
  • "_METHOD": "PUT",
  • "alias": "ratty-test",
  • "server": 206,
  • "cnames": "test.5centscdndemo.ca,p.5centscdndemo.ca",
  • "profiles": [
    ],
  • "webhook": "http://vicky.com/notify",
  • "cache": {
    },
  • "domainlock": {
    },
  • "geoblock": {
    },
  • "ipaccess": {
    },
  • "useragent": {
    },
  • "securetoken": {
    },
  • "bwlimit": {
    },
  • "ssl": {
    }
}

Response samples

Content type
application/json
{
  • "result": "success",
  • "message": "Zone Created",
  • "zone": {
    },
  • "warnings": [
    ]
}

Get Servers

HTTP Push Zone Servers

Authorizations:
apikeyAuth
header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": "success",
  • "servers": [
    ]
}

Update SSL

Update SSL of HTTP push zone

Authorizations:
apikeyAuth
path Parameters
zoneid
required
integer
Example: 4486

(Required) Zone ID

header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
http2
string
  • Indicates whether HTTP/2 protocol is enabled.
    • Y means HTTP/2 is enabled, while N means it is disabled.
    • This property is commonly used to improve website performance and speed.
    • Example values include Y or N.
redirect
string
  • Indicates whether HTTP traffic is automatically redirected to HTTPS.
    • Y means redirection is enabled, while N means it is not.
    • Example values include Y for enabled and N for disabled.
mode
string
  • Specifies the SSL mode used for the server configuration.
    • Typical values include S for strict mode or A for automated.
    • Example values are S and A.
certid
string
  • A unique identifier for the SSL certificate used.
    • This property is optional and can be empty if no certificate is assigned.
    • Example values include 123456789 or an empty string for no certificate.
name
string
  • The name associated with the SSL certificate.
    • Typically used to identify the certificate for a specific domain.
    • Example values include example.com or www.example.org.
crt
string
  • The SSL certificate content in PEM format.
    • This is a required field for custom SSL certificates.
    • Example values include certificate strings starting with -----BEGIN CERTIFICATE-----.
key
string
  • The private key associated with the SSL certificate in PEM format.
    • This is a required field for setting up custom SSL certificates.
    • Example values include key strings starting with -----BEGIN PRIVATE KEY-----.
cabundle
string
  • The Certificate Authority (CA) bundle content in PEM format.
    • This is used to validate the SSL certificate chain.
    • Example values include bundle strings starting with -----BEGIN CERTIFICATE-----.

Responses

Request samples

Content type
application/json
{
  • "http2": "Y",
  • "redirect": "Y",
  • "mode": "S",
  • "certid": "",
  • "name": "",
  • "crt": "",
  • "key": "",
  • "cabundle": ""
}

Response samples

Content type
application/json
{
  • "result": "success",
  • "message": "Zone Updated",
  • "zone": {
    },
  • "warnings": [
    ]
}

Update Secure Token

Update SecureToken of HTTP push zone

Authorizations:
apikeyAuth
path Parameters
zoneid
required
integer
Example: 4486

(Required) Zone ID

header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
enabled
string
  • Indicates whether the feature is enabled.
    • Y means the feature is enabled, while N means it is disabled.
    • Example values include Y for enabled or N for disabled.
policy
string
  • Specifies the policy type applied to the feature.
    • F might represent a specific predefined policy, while other values could represent alternative policies.
    • Example values include F or D.
list
string
  • Represents a unique identifier for the list associated with the feature.
    • Typically used to link the feature to specific configurations or data.
    • Example values include 68a291cfc067cdd9 or abc123xyz456.
timeout
integer
  • Specifies the timeout value in seconds.
    • Used to define how long a session or operation should wait before timing out.
    • Example values include 300 for 5 minutes or 600 for 10 minutes.
session
string
  • Indicates the session handling configuration.
    • 0 might represent no session management, while other values could indicate active configurations.
    • Example values include 0 or 1.
keyip
string
  • Determines whether IP-based keying is enabled.
    • Y means IP-based keying is active, while N means it is not.
    • Example values include Y or N.
ips
Array of strings
  • A list of IP addresses associated with the feature.
    • Useful for defining allowed or restricted IPs.
    • Example values include ["1.1.1.1", "2.2.2.2"] or ["192.168.1.1", "10.0.0.1"].

Responses

Request samples

Content type
application/json
{
  • "enabled": "Y",
  • "policy": "F",
  • "list": "68a291cfc067cdd9",
  • "timeout": 300,
  • "session": "0",
  • "keyip": "Y",
  • "ips": [
    ]
}

Response samples

Content type
application/json
{
  • "result": "success",
  • "message": "Zone Updated",
  • "zone": {
    },
  • "warnings": [
    ]
}

Update Geoblock

Update geblock of HTTP push zone

Authorizations:
apikeyAuth
path Parameters
zoneid
required
integer
Example: 4486

(Required) Zone ID

header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
enabled
string
  • Indicates whether the feature is enabled or disabled.
    • Y represents that the feature is enabled, while N represents that it is disabled.
    • Example values include Y for enabled or N for disabled.
policy
string
  • Specifies the policy associated with the feature.
    • Different values may represent various predefined policies or configurations.
    • Example values include N for no policy or A for a specific policy type.
list
Array of strings
  • A collection of codes or identifiers related to the feature.
    • These may represent region codes, categories, or other predefined entities.
    • Example values include ["AF", "AL"] for country codes or ["US", "CA"] for region codes.
ips
Array of strings
  • A list of IP addresses associated with the feature.
    • This could represent allowed, blocked, or monitored IPs, depending on the context.
    • Example values include ["1.1.1.1", "2.2.2.2"] for specific IPs or ["192.168.1.1", "10.0.0.1"] for private networks.

Responses

Request samples

Content type
application/json
{
  • "enabled": "Y",
  • "policy": "N",
  • "list": [
    ],
  • "ips": [
    ]
}

Response samples

Content type
application/json
{
  • "result": "success",
  • "message": "Zone Updated",
  • "zone": {
    }
}

Update Domain Lock

Update domain lock of HTTP push zone

Authorizations:
apikeyAuth
path Parameters
zoneid
required
integer
Example: 4486

(Required) Zone ID

header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
enabled
string
  • Indicates whether the domain lock feature is enabled or disabled.
    • Y means the feature is enabled, while N means it is disabled.
    • Example values include Y for enabled or N for disabled.
policy
string
  • Specifies the policy applied to the domain lock feature.
    • The value N typically means no policy is applied, while other values may represent specific configurations.
    • Example values include N for no policy or A for a specific policy type.
list
Array of strings
  • A list of domains that are affected by the domain lock feature.
    • These could represent allowed, blocked, or monitored domains, depending on the context.
    • Example values include ["test.com", "test2.com"] for specific domains or ["example.com", "mydomain.com"] for other use cases.
noreferer
string
  • Indicates whether requests without a referer are allowed or restricted.
    • Y means requests without a referer are allowed, while N means they are not.
    • Example values include Y for allowed or N for restricted.
ips
Array of strings
  • A list of IP addresses associated with the domain lock feature.
    • These could represent allowed, blocked, or monitored IPs, depending on the context.
    • Example values include ["1.1.1.1", "2.2.2.2"] for specific IPs or ["192.168.1.1", "10.0.0.1"] for private networks.

Responses

Request samples

Content type
application/json
{
  • "enabled": "Y",
  • "policy": "N",
  • "list": [
    ],
  • "noreferer": "Y",
  • "ips": [
    ]
}

Response samples

Content type
application/json
{
  • "result": "success",
  • "message": "Zone Updated",
  • "zone": {
    }
}

Update Edge Settings

Update Edge settings of HTTP push zone

Authorizations:
apikeyAuth
path Parameters
zoneid
required
integer
Example: 4486

(Required) Zone ID

header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
compression
any
compressionlevel
any
dispositionenabled
any
disposition
any
cors
any
webp
any
lfo
any
prefresh
any
pseudostreaming
any

Responses

Request samples

Content type
application/json
{
  • "compression": null,
  • "compressionlevel": null,
  • "dispositionenabled": null,
  • "disposition": null,
  • "cors": null,
  • "webp": null,
  • "lfo": null,
  • "prefresh": null,
  • "pseudostreaming": null
}

Response samples

Content type
application/json
{
  • "result": null,
  • "message": null,
  • "zone": null
}

Update Cache

Update cache of HTTP Push Zone

Authorizations:
apikeyAuth
path Parameters
zoneid
required
integer
Example: 4486

(Required) Zone ID

header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
cache
string
  • Specifies the duration for which the cache is valid.
    • The format uses a letter to indicate the unit of time: M for months, d for days, y for years, h for hours, and m for minutes.
    • Example values include 1M for one month or 7d for seven days.

Responses

Request samples

Content type
application/json
{
  • "cache": "1M"
}

Response samples

Content type
application/json
{
  • "result": "success",
  • "message": "Zone Updated",
  • "zone": {
    }
}

Restore Push Zone

Restore HTTP push zone

Authorizations:
apikeyAuth
path Parameters
zoneid
required
integer
Example: 4486

(Required) Zone ID

header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": "success",
  • "message": "Zone Updated",
  • "zone": {
    }
}

Push Zone Cache Purge

Purge cache of a HTTP push zone

Authorizations:
apikeyAuth
path Parameters
zoneid
required
integer
Example: 4486

(Required) Zone ID

header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
_METHOD
string
  • Indicates the HTTP method used for the request.
    • HTTP methods define the action to be performed on the resource.
    • Example values: 'GET', 'POST', 'PUT', 'DELETE'.
files
Array of strings
  • An array that holds a list of file paths.
    • Represents the files that are targeted for the operation, such as purging from cache or processing.
    • Example values: '/http/17.png', '/http/18.png'.

Responses

Request samples

Content type
application/json
{
  • "_METHOD": "DELETE",
  • "files": [
    ]
}

Response samples

Content type
application/json
{
  • "result": "success",
  • "message": "Cache Purged"
}

Import HTTP Push Zone

Import HTTP Push Zone

Authorizations:
apikeyAuth
path Parameters
zoneid
required
integer
Example: 4486

(Required) Zone ID

header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
id
string
  • A unique identifier for the resource.
    • This is used to reference or track a specific item or resource in the system.
    • Example values: '17375940497547540', 'abc123xyz'.
url
string
filename
string
  • The name of the file associated with the resource, including the file extension.
    • This represents the name of the resource as it is saved in the system.
    • Example values: 'image.jpg', 'sedan-car-concept-illustration_114360-16463.jpg'.
folder
string
  • The directory or folder where the file is stored.
    • This represents the file's location within the system's file structure.
    • Example values: '/', '/images', '/documents'.

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{}

Update bandwidth limit

Update bandwidth limit of HTTP push zone

Authorizations:
apikeyAuth
path Parameters
zoneid
required
integer
Example: 4486

(Required) Zone ID

header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
enabled
string
  • A flag indicating whether the feature or setting is enabled or disabled.
    • This can be a simple yes/no (or Y/N) value indicating whether a feature is active.
    • Example values: 'Y' (enabled), 'N' (disabled).
policy
string
  • A string representing a policy identifier or a code that determines which policy is applied.
    • This might be a number or code that corresponds to a specific set of rules or guidelines.
    • Example values: '0' (default policy), '1' (custom policy).
rate
string
  • The rate value, usually indicating a numerical or percentage rate for a certain action or process.
    • This could be used for pricing, speed, or other metrics that require a rate.
    • Example values: '23' (could represent a 23% rate), '5' (could represent a 5% rate).
rateafter
string
  • The rate value that applies after a certain condition or action has been performed.
    • This might indicate a new rate or value that comes into effect after a specific trigger.
    • Example values: '24' (could represent the new rate after a certain action), '10' (a new rate after a discount is applied).

Responses

Request samples

Content type
application/json
{
  • "enabled": "Y",
  • "policy": "0",
  • "rate": "23",
  • "rateafter": "24"
}

Response samples

Content type
application/json
{
  • "result": "success",
  • "message": "Zone Updated",
  • "zone": {
    }
}

Push Zone File Manager List

Zone File Manager List

Authorizations:
apikeyAuth
path Parameters
zoneid
required
integer
Example: 4486

(Required) Zone ID

query Parameters
dir
string
Example: dir=/http/

Enter directory name

query
string

search by filename

marker
string

Set the marker parameter to the name of the last item returned in the previous list.

end_marker
string

Limits the result set to names that are less than the end_marker parameter value.

header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "filemanager list": [
    ]
}

Push Zone File Manager info

Zone File Manager info

Authorizations:
apikeyAuth
path Parameters
zoneid
required
string
Example: <string>

(Required) Zone ID

query Parameters
file
string
Example: file=<string>

Enter file name

media
string
Example: media=<string>

show detailed media info if 1

header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "dirname": "/http",
  • "basename": "17.png",
  • "extension": "png",
  • "filename": "17",
  • "filesize": 141328,
  • "mime": "image/png",
  • "lastChange": 1737357408,
  • "lastAccess": 1737357755,
  • "etag": "f7f400dd8f4c22dafc93a65f8a4862a4",
  • "perms": "0664",
  • "media": {
    }
}

HTTP Pull

Pull Zone

Return HTTP pull zone details

Authorizations:
apikeyAuth
path Parameters
zoneid
required
integer
Example: 4486

(Required) Zone ID

header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": "success",
  • "zone": {
    }
}

Update Info

update the information of HTTP pull Zone

Authorizations:
apikeyAuth
path Parameters
zoneid
required
integer
Example: 4465

(Required) Zone ID

header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
origin
string
alias
string
  • The alias name for the zone.
    • This is a friendly name or identifier for the zone that is used in DNS or other services.
    • Example values: 'blazing-rails', 'example-zone'
cnames
string
  • A comma-separated list of CNAME records for the zone.
    • These are alternative domain names that map to the origin domain.
    • Example values: 'dave.5centscdndemo.ca,p.5centscdndemo.ca', 'www.example.com,blog.example.com'

Responses

Request samples

Content type
application/json
{
  • "origin": "http://www.google.com",
  • "alias": "blazing-rails",
  • "cnames": "dave.5centscdndemo.ca,p.5centscdndemo.ca"
}

Response samples

Content type
application/json
{
  • "result": "success",
  • "message": "Zone Updated",
  • "zone": {
    }
}

Delete Info

Delete the information of HTTP pull Zone. To cast request method POST and parameters _METHOD = DELETE

Authorizations:
apikeyAuth
path Parameters
zoneid
required
string
Example: <string>

(Required) Zone ID

header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": "success",
  • "message": "Zone deleted successfully"
}

Pull Zones

Zone HTTP Pull list

Authorizations:
apikeyAuth
query Parameters
page
string
Example: page=<integer>
header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": "success",
  • "zones": [
    ]
}

Create Pull Zone

Create a new HTTP Pull Zone

Authorizations:
apikeyAuth
header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
_METHOD
string
  • Specifies the HTTP request method to be used for the operation.
    • The value PUT indicates that this request is intended to update or create a resource.
    • Common values include GET (retrieves data), POST (creates data), PUT (updates or creates data), and DELETE (removes data).
alias
string
  • A unique identifier or nickname for the configuration. - Helps in referencing the settings easily. - Example values include 'blazing-rails', 'fast-cloud'.
origin
string
optimize
string
  • The optimization type for the request (e.g., 'http' or 'https'). - Used to specify protocol preferences. - Example values include 'http', 'https'.
cnames
Array of arrays
  • A list of CNAME (Canonical Name) records associated with the domain. - Typically used for DNS settings and domain mapping. - Example values include ['cdn.example.com', 'assets.example.com'].
object
cache
string
  • The cache duration, specified in time units (e.g., '1M' for 1 month). - Determines how long content is cached. - Example values include '1M', '7D'.
expiry
string
  • The cache expiry duration, similar to the 'cache' property. - Defines when cached content becomes stale. - Example values include '1M', '1W'.
querystring
string
  • Indicates whether the query string is included in caching decisions. - 'Y' enables query string caching; 'N' disables it. - Example values include 'Y', 'N'.
cachecontrol
string
  • Specifies whether HTTP cache control headers are respected. - 'Y' enables cache control; 'N' ignores it. - Example values include 'Y', 'N'.
usestale
string
  • Determines if stale cache content is served during revalidation. - 'Y' enables serving stale content; 'N' disables it. - Example values include 'Y', 'N'.
revalidate
string
  • Indicates if cache revalidation is enforced. - 'Y' enables revalidation; 'N' disables it. - Example values include 'Y', 'N'.
object
dnscheck
string
  • Indicates whether DNS checks are performed on the origin IP. - 'Y' enables DNS checks; 'N' disables it. - Example values include 'Y', 'N'.
ip
string
  • The IP address of the origin server. - Represents the source server's network address. - Example values include '8.8.8.8', '192.168.1.1'.
customhostheader
string
  • A custom host header sent in requests to the origin server. - Useful for identifying requests or testing. - Example values include 'testing', 'example-host'.
shields
Array of arrays
  • A list of shield locations for content delivery. - Shields are intermediate caching servers. - Example values include ['FR', 'CA', 'SG'].
object
canonical
string
  • Specifies if canonical tags are enabled for SEO purposes. - 'Y' enables canonical tags; 'N' disables them. - Example values include 'Y', 'N'.
robots
string
  • Indicates if robots.txt directives are applied. - 'Y' enables robots directives; 'N' disables them. - Example values include 'Y', 'N'.
object
enabled
string
  • Specifies if domain locking is enabled. - 'Y' enables domain locking; 'N' disables it. - Example values include 'Y', 'N'.
policy
string
  • The policy applied to domain locking. - 'N' represents no specific policy; 'Y' indicates active policy. - Example values include 'Y', 'N'.
list
Array of arrays
  • A list of domains that are locked or allowed. - Example values include ['test.com', 'example.org'].
noreferer
string
  • Indicates if referrer headers are removed. - 'Y' enables removal of referrer headers; 'N' disables it. - Example values include 'Y', 'N'.
ips
Array of arrays
  • A list of IP addresses associated with the domain lock policy. - Example values include ['1.1.1.1', '2.2.2.2'].

Responses

Request samples

Content type
application/json
{
  • "_METHOD": "PUT",
  • "alias": "blazing-rails",
  • "origin": "http://www.google.com",
  • "optimize": "http",
  • "cnames": [ ],
  • "cache": {
    },
  • "originip": {
    },
  • "shields": [
    ],
  • "seo": {
    },
  • "domainlock": {
    }
}

Response samples

Content type
application/json
{
  • "result": "success",
  • "message": "Zone Created",
  • "zone": {
    }
}

Purge

Purge cache of a HTTP pull zone

Authorizations:
apikeyAuth
path Parameters
zoneid
required
integer
Example: 4465

(Required) Zone ID

header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
_METHOD
string
  • Indicates the HTTP method to be used for the operation.
    • This value specifies the action being performed, such as retrieving, creating, updating, or deleting resources.
    • Example values include:
      • 'DELETE' for removing resources.
      • 'POST' for creating new resources.
files
Array of strings
  • Contains a list of file paths involved in the operation.
    • These paths specify the files to be processed, such as files to be deleted or modified.
    • Example values include paths to various file types, such as:
      • '/http/17.png' for an image file.
      • '/docs/manual.pdf' for a document file.

Responses

Request samples

Content type
application/json
{
  • "_METHOD": "DELETE",
  • "files": [
    ]
}

Response samples

Content type
application/json
{
  • "result": "success",
  • "message": "Cache Purged"
}

Update SSL

Update SSL of HTTP pull zone

Authorizations:
apikeyAuth
path Parameters
zoneid
required
integer
Example: 4465

(Required) Zone ID

header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
http2
string
  • Specifies whether HTTP/2 is enabled.
    • HTTP/2 provides improved performance for web connections.
    • Example values include:
      • 'Y' for enabling HTTP/2.
      • 'N' for disabling HTTP/2.
redirect
string
  • Indicates whether redirects are enabled.
    • This can be used for scenarios like redirecting HTTP traffic to HTTPS.
    • Example values include:
      • 'Y' for enabling redirection.
      • 'N' for disabling redirection.
mode
string
  • Defines the operational mode of the system or service.
    • This property typically specifies a configuration setting or behavior.
    • Example values include:
      • 'S' for secure mode.
      • 'A' for automatic mode.
certid
string
  • A unique identifier for the certificate.
    • This is used to reference or manage SSL/TLS certificates.
    • Example values include:
      • '12345-abcde' for a specific certificate ID.
      • An empty string ('') when no certificate ID is provided.
name
string
  • The name associated with the certificate or configuration.
    • This could represent a domain, service name, or label.
    • Example values include:
      • 'example.com' for a domain name.
      • An empty string ('') when no name is provided.
crt
string
  • The SSL/TLS certificate content in PEM format.
    • This property holds the actual certificate used for secure communications.
    • Example values include:
      • A PEM-encoded certificate string.
      • An empty string ('') when no certificate is provided.
key
string
  • The private key associated with the SSL/TLS certificate.
    • This is required for secure communication and must remain confidential.
    • Example values include:
      • A PEM-encoded private key string.
      • An empty string ('') when no private key is provided.
cabundle
string
  • The CA (Certificate Authority) bundle in PEM format.
    • This property contains intermediate certificates needed to validate the SSL/TLS certificate.
    • Example values include:
      • A PEM-encoded CA bundle string.
      • An empty string ('') when no CA bundle is provided.

Responses

Request samples

Content type
application/json
{
  • "http2": "Y",
  • "redirect": "Y",
  • "mode": "S",
  • "certid": "",
  • "name": "",
  • "crt": "",
  • "key": "",
  • "cabundle": ""
}

Response samples

Content type
application/json
{
  • "result": "success",
  • "message": "Zone Updated",
  • "zone": {
    }
}

Update Secure Token

Update SecureToken of HTTP pull zone

Authorizations:
apikeyAuth
path Parameters
zoneid
required
integer
Example: 4465

(Required) Zone ID

header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
enabled
string
  • Indicates whether the secure token feature is enabled.
    • This property determines if the security feature should be active.
    • Example values include:
      • 'Y' to enable the secure token.
      • 'N' to disable the secure token.
policy
string
  • Defines the policy type for the secure token.
    • This could represent different security levels or strategies.
    • Example values include:
      • 'F' for a fixed policy.
      • 'R' for a rotating policy.
list
string
  • Represents a list of specific items or configurations related to the secure token.
    • This is typically used for advanced settings or additional rules.
    • Example values include:
      • '192.168.1.1' for a single IP address.
      • An empty string ('') when no list is specified.
timeout
integer
  • Specifies the timeout duration for the secure token in seconds.
    • This determines how long a token remains valid before it expires.
    • Example values include:
      • 300 for a timeout of 5 minutes.
      • 600 for a timeout of 10 minutes.
session
integer
  • Indicates whether session-specific settings are applied.
    • A value of 0 typically disables session-specific settings, while non-zero values enable them.
    • Example values include:
      • 0 for session-independent configuration.
      • 1 for session-specific configuration.
keyip
string
  • Determines whether the token is bound to specific IP addresses.
    • This enhances security by restricting usage to specified IPs.
    • Example values include:
      • 'Y' to enable IP-based key binding.
      • 'N' to disable IP-based key binding.
ips
string
  • A comma-separated list of IP addresses associated with the secure token.
    • This is used when the token is bound to specific IPs for security.
    • Example values include:
      • '1.1.1.1,2.2.2.2' for multiple IP addresses.
      • An empty string ('') when no IPs are specified.

Responses

Request samples

Content type
application/json
{
  • "enabled": "Y",
  • "policy": "F",
  • "list": "",
  • "timeout": 300,
  • "session": 0,
  • "keyip": "Y",
  • "ips": "1.1.1.1,2.2.2.2"
}

Response samples

Content type
application/json
{
  • "result": "success",
  • "message": "Zone Updated",
  • "zone": {
    }
}

Update Seo

Update Seo of HTTP pull zone

Authorizations:
apikeyAuth
path Parameters
zoneid
required
integer
Example: 4465

(Required) Zone ID

header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
canonical
string
  • Indicates whether a canonical tag should be included in the webpage's SEO configuration.
    • Canonical tags help search engines identify the primary version of a page to avoid duplicate content issues.
    • Example values include:
      • 'Y' to enable canonical tags.
      • 'N' to disable canonical tags.
robots
string
  • Determines whether meta robots tags should be added to the webpage.
    • Meta robots tags guide search engines on how to index or follow links on the page.
    • Example values include:
      • 'Y' to include meta robots tags.
      • 'N' to exclude meta robots tags.
robotstxt
string
  • Specifies whether a default robots.txt file should be included in the website configuration.
    • The robots.txt file directs web crawlers on which parts of the site to crawl or avoid.
    • Example values include:
      • 'Y' to enable a default robots.txt file.
      • 'N' to disable a default robots.txt file.
robotstxtcustom
string
  • Contains the custom content for the robots.txt file.
    • This allows advanced configurations for web crawlers, defining rules such as user-agent behavior or disallowed directories.
    • Example values include:
      • 'User-agent: *\nDisallow: /' to block all crawlers from accessing the entire site.
      • 'User-agent: Googlebot\nDisallow: /private/' to block Googlebot from accessing a specific directory.

Responses

Request samples

Content type
application/json
{
  • "canonical": "Y",
  • "robots": "Y",
  • "robotstxt": "Y",
  • "robotstxtcustom": "User-agent: *\\nDisallow: /"
}

Response samples

Content type
application/json
{
  • "result": "success",
  • "message": "Zone Updated",
  • "zone": {
    }
}

Update originip

Update originip of HTTP pull zone

Authorizations:
apikeyAuth
path Parameters
zoneid
required
integer
Example: 4465

(Required) Zone ID

header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
dnscheck
string
  • Indicates whether DNS checks should be performed for the origin IP address.
    • DNS checks ensure that the IP address is correctly resolved and accessible.
    • Example values include:
      • 'Y' to enable DNS checks.
      • 'N' to disable DNS checks.
ip
string
  • Specifies the origin IP address used for communication.
    • This IP address represents the server or endpoint being checked or configured.
    • Example values include:
      • '8.8.8.8' for Google's public DNS.
      • '192.168.1.1' for a typical private network router.
customhostheader
string
  • Defines a custom host header value for HTTP requests sent to the origin IP.
    • This is useful when the origin server expects a specific host header.
    • Example values include:
      • 'example.com' for a domain name.
      • 'testing' for a test configuration.

Responses

Request samples

Content type
application/json
{
  • "dnscheck": "Y",
  • "ip": "8.8.8.8",
  • "customhostheader": "testing"
}

Response samples

Content type
application/json
{
  • "result": "success",
  • "message": "Zone Updated",
  • "zone": {
    }
}

Update Bandwidth limit

Update Bandwidth limit of HTTP pull zone

Authorizations:
apikeyAuth
path Parameters
zoneid
required
integer
Example: 4465

(Required) Zone ID

header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
enabled
string
  • Specifies whether bandwidth limiting is enabled.
    • When enabled, the system imposes restrictions on data transfer rates.
    • Example values include:
      • 'Y' to enable bandwidth limiting.
      • 'N' to disable bandwidth limiting.
policy
integer
  • Defines the policy type for bandwidth limitation.
    • Policies may determine how and when the rate limiting is applied.
    • Example values include:
      • 0 for a default or no specific policy.
      • 1 for a custom policy determined by the system.
rate
integer
  • Specifies the maximum data transfer rate (in kilobits per second) allowed when the bandwidth limit is active.
    • This setting helps control network usage and prevents overloading.
    • Example values include:
      • 0 for unlimited data transfer.
      • 1000 for a limit of 1000 kbps.
rateafter
integer
  • Defines the threshold (in kilobytes) after which the rate limiting applies.
    • This setting ensures a specific amount of data can be transferred at full speed before restrictions apply.
    • Example values include:
      • 0 for immediate rate limiting.
      • 5000 for allowing 5000 KB before applying limits.

Responses

Request samples

Content type
application/json
{
  • "enabled": "Y",
  • "policy": 0,
  • "rate": 0,
  • "rateafter": 0
}

Response samples

Content type
application/json
{
  • "result": "success",
  • "message": "Zone Updated",
  • "zone": {
    }
}

Update Edge Settings

Update Edge settings of HTTP record zone

Authorizations:
apikeyAuth
path Parameters
zoneid
required
string
Example: <string>

(Required) Zone ID

header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
compression
any
compressionlevel
any
dispositionenabled
any
disposition
any
stripcookie
any
xff
any
cors
any
webp
any
lfo
any
prefresh
any
wp
any
pseudostreaming
any

Responses

Request samples

Content type
application/json
{
  • "compression": null,
  • "compressionlevel": null,
  • "dispositionenabled": null,
  • "disposition": null,
  • "stripcookie": null,
  • "xff": null,
  • "cors": null,
  • "webp": null,
  • "lfo": null,
  • "prefresh": null,
  • "wp": null,
  • "pseudostreaming": null
}

Response samples

Content type
application/json
{
  • "result": null,
  • "message": null,
  • "zone": null
}

Update shield Settings

Update shield settings of HTTP record zone

Authorizations:
apikeyAuth
path Parameters
zoneid
required
integer
Example: 4465

(Required) Zone ID

header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
shields
Array of strings
  • An array representing the regions or countries where shields are applied.
    • This could refer to security or access controls for specific regions.
    • Example values could represent countries or territories with specific protections in place.
    • Example: ['FR', 'CA', 'SG']

Responses

Request samples

Content type
application/json
{
  • "shields": [
    ]
}

Response samples

Content type
application/json
{
  • "result": "success",
  • "message": "Zone Updated",
  • "zone": {
    }
}

Update Domain Lock

Update Domain lock of HTTP pull zone

Authorizations:
apikeyAuth
path Parameters
zoneid
required
integer
Example: 4465

(Required) Zone ID

header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
enabled
string
  • A flag indicating whether the domain lock is enabled or disabled.
    • The value can be either 'Y' (Yes) or 'N' (No).
    • Example values: 'Y' (enabled), 'N' (disabled)
policy
string
  • A flag indicating the current policy for the domain lock.
    • The value can be either 'Y' (Yes) or 'N' (No), representing whether the policy is active or not.
    • Example values: 'Y' (policy active), 'N' (policy inactive)
list
string
  • A comma-separated list of domains that are subject to the lock.
    • This list represents specific domains that will be affected by the domain lock settings.
    • Example values: 'www.test.com,www.google.com', 'example.com,anotherdomain.com'
ips
string
  • A comma-separated list of IP addresses that are allowed or blocked for domain access.
    • This can be used to specify which IP addresses can access the domains.
    • Example values: '1.1.1.1,2.2.2.2', '192.168.1.1,10.0.0.1'
noreferer
string
  • A flag indicating whether referer headers are blocked for the domain lock.
    • The value can be either 'Y' (Yes) or 'N' (No), controlling whether referer headers are used.
    • Example values: 'Y' (referer blocked), 'N' (referer allowed)

Responses

Request samples

Content type
application/json
{
  • "enabled": "Y",
  • "policy": "N",
  • "list": "www.test.com,www.google.com",
  • "ips": "1.1.1.1,2.2.2.2",
  • "noreferer": "Y"
}

Response samples

Content type
application/json
{
  • "result": "success",
  • "message": "Zone Updated",
  • "zone": {
    }
}

Update Geoblock

Update Geoblock of HTTP pull zone

Authorizations:
apikeyAuth
path Parameters
zoneid
required
integer
Example: 4465

(Required) Zone ID

header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
enabled
string
  • A flag indicating whether geoblock is enabled or disabled.
    • The value can be either 'Y' (Yes) or 'N' (No), which determines whether geoblocking is active.
    • Example values: 'Y' (enabled), 'N' (disabled)
policy
string
  • A flag indicating the current policy for the geoblock.
    • The value can be either 'Y' (Yes) or 'N' (No), representing whether the policy is active or not.
    • Example values: 'Y' (policy active), 'N' (policy inactive)
list
Array of strings
  • An array representing the regions or countries that are affected by the geoblock.
    • Each entry in the array corresponds to a specific region or country that will be blocked.
    • Example values: ['AF', 'AS', 'US'], where 'AF' is Africa, 'AS' is Asia, and 'US' is the United States.
ips
string
  • A comma-separated list of IP addresses that are blocked or allowed by the geoblock.
    • These IP addresses represent specific addresses that will be either blocked or allowed based on the geoblock settings.
    • Example values: '1.1.1.1,2.2.2.2', where '1.1.1.1' and '2.2.2.2' are the IP addresses.

Responses

Request samples

Content type
application/json
{
  • "enabled": "Y",
  • "policy": "N",
  • "list": [
    ],
  • "ips": "1.1.1.1,2.2.2.2"
}

Response samples

Content type
application/json
{
  • "result": "success",
  • "message": "Zone Updated",
  • "zone": {
    }
}

Restore Pull Zone

Restore HTTP pull zone

Authorizations:
apikeyAuth
path Parameters
zoneid
required
integer
Example: 4465

(Required) Zone ID

header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": "success",
  • "message": "Zone Updated",
  • "zone": {
    }
}

Update Cache

Update Cache HTTP Push Zone

Authorizations:
apikeyAuth
path Parameters
zoneid
required
integer
Example: 4465

(Required) Zone ID

header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
cache
string
  • A string representing the cache duration.
    • This defines how long the cache will be valid before it expires and needs to be refreshed.
    • Example values: '1M' (1 minute), '30s' (30 seconds), '1H' (1 hour)
expiry
string
  • A string representing the expiry duration of the cache.
    • This indicates how long the cached data will remain before it is considered expired and a new request is made to refresh it.
    • Example values: '1M' (1 minute), '1D' (1 day), '30s' (30 seconds)
querystring
string
  • A flag indicating whether the cache should consider the query string in the URL when caching the data.
    • The value can be 'Y' (Yes) or 'N' (No), determining if variations in the URL based on query parameters should be treated as separate cache entries.
    • Example values: 'Y' (consider querystring), 'N' (ignore querystring)
cachecontrol
string
  • A flag indicating whether cache control headers are enabled for this cache.
    • The value can be 'Y' (Yes) or 'N' (No), indicating whether the cache will use cache control headers to manage caching behavior.
    • Example values: 'Y' (cache control enabled), 'N' (cache control disabled)
usestale
string
  • A flag indicating whether stale cache data can be used when the fresh data is unavailable.
    • The value can be 'Y' (Yes) or 'N' (No), allowing the system to use outdated data temporarily until fresh data can be retrieved.
    • Example values: 'Y' (allow stale data), 'N' (do not use stale data)
revalidate
string
  • A flag indicating whether the cache should revalidate the data before serving it.
    • The value can be 'Y' (Yes) or 'N' (No), determining whether the cache will check if the data has changed before returning it.
    • Example values: 'Y' (revalidate), 'N' (do not revalidate)

Responses

Request samples

Content type
application/json
{
  • "cache": "1M",
  • "expiry": "1M",
  • "querystring": "Y",
  • "cachecontrol": "Y",
  • "usestale": "Y",
  • "revalidate": "Y"
}

Response samples

Content type
application/json
{
  • "result": "success",
  • "message": "Zone Updated",
  • "zone": {
    }
}

HTTP Global Security Settings

update zone http domain setting

update zone http domain setting

Authorizations:
apikeyAuth
header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
enabled
string
  • Indicates whether the feature is enabled or not. - Accepts values like 'Y' for yes and 'N' for no. - Useful for toggling functionality in a system.
policy
string
  • Represents the status of a specific policy. - Accepts values such as 'Y' for active and 'N' for inactive. - Determines if a policy is currently applied.
list
string
  • Contains a comma-separated list of domain names. - Represents allowed or blocked domains in a policy. - Examples: 'test.com, google.com' or 'example.com, sample.org'.
ips
string
  • Holds a comma-separated list of IP addresses. - Used for specifying allowed or blocked IP ranges. - Examples: '1.1.1.1, 2.2.2.2' or '192.168.0.1, 10.0.0.1'.
mode
string
  • Specifies the operational mode of the system. - Possible values include 'save' (to store data) or 'load' (to retrieve data). - Determines how the system behaves in specific contexts.

Responses

Request samples

Content type
application/json
{
  • "enabled": "Y",
  • "policy": "N",
  • "list": "test.com,google.com",
  • "ips": "1.1.1.1,2.2.2.2",
  • "mode": "save"
}

Response samples

Content type
application/json
{
  • "result": "success",
  • "message": "Zone Settings Updated"
}

update zone http geoblock setting

update zone http domain setting

Authorizations:
apikeyAuth
header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
enabled
string
  • Indicates whether the geoblocking feature is enabled. - 'Y' represents enabled, while 'N' represents disabled. - Useful for toggling geoblocking functionality in a system.
policy
string
  • Specifies the policy status for geoblocking. - 'Y' indicates the policy is active, and 'N' indicates it is inactive. - Determines if the defined policy is enforced.
list
Array of strings
  • Contains a list of country codes subject to geoblocking. - Country codes follow the ISO 3166-1 alpha-2 standard. - Examples: 'GB' for the United Kingdom, 'US' for the United States.
ips
string
  • Holds a comma-separated list of IP addresses. - Used to specify exceptions or targets for geoblocking. - Examples: '1.1.1.1, 2.2.2.2' or '192.168.0.1, 10.0.0.1'.
mode
string
  • Specifies the operational mode of the geoblocking feature. - Possible values include 'save' to store settings or 'load' to retrieve settings. - Determines how the system interacts with geoblocking configurations.

Responses

Request samples

Content type
application/json
{
  • "enabled": "Y",
  • "policy": "N",
  • "list": [
    ],
  • "ips": "1.1.1.1,2.2.2.2",
  • "mode": "save"
}

Response samples

Content type
application/json
{
  • "result": "success",
  • "message": "Zone Settings Updated"
}

update zone http securetoken setting

update zone http securetoken setting

Authorizations:
apikeyAuth
header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
enabled
string
  • Indicates whether the feature is enabled or disabled. - 'Y' means enabled, while 'N' means disabled. - Controls the activation state of the system.
policy
string
  • Defines the policy applied within the system. - 'F' might represent a specific policy type, such as 'Fail'. - Useful for categorizing or enforcing system behaviors.
list
string
  • Represents a unique identifier or token related to the list. - Can be a hashed or encoded value. - Example: '68a291cfc067cdd9' is a sample unique identifier.
timeout
number
  • Specifies the timeout duration in seconds. - Determines how long the system waits before taking action. - Example values include 300 seconds for 5 minutes, or 600 seconds for 10 minutes.
session
number
  • Indicates the session count or state. - Can represent active sessions or usage limits. - Example values include 0 for no active sessions, or 10 for ten active sessions.
keyip
string
  • Determines if the key IP feature is enabled. - 'Y' means enabled, 'N' means disabled. - Useful for securing actions to specific IP addresses.
ips
string
  • Contains a comma-separated list of IP addresses. - Used for whitelisting, blacklisting, or other configurations. - Examples include '1.1.1.1, 2.2.2.2' for specific IPs, or '192.168.1.1, 10.0.0.1' for private networks.
mode
string
  • Indicates the operation mode of the system. - Possible values include 'save' to store configurations, or 'load' to retrieve them. - Determines the action taken on the system settings.

Responses

Request samples

Content type
application/json
{
  • "enabled": "Y",
  • "policy": "F",
  • "list": "68a291cfc067cdd9",
  • "timeout": 300,
  • "session": 0,
  • "keyip": "Y",
  • "ips": "1.1.1.1,2.2.2.2",
  • "mode": "save"
}

Response samples

Content type
application/json
{
  • "result": "success",
  • "message": "Zone Settings Updated"
}

update zone http bwlimit setting

update zone http bwlimit setting

Authorizations:
apikeyAuth
header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
enabled
string
  • Specifies whether the bandwidth limit setting is enabled or disabled.
    • Possible values:
      • 'Y': The setting is active and enforced.
      • 'N': The setting is inactive and not applied.
    • Example use cases include toggling the limit during high-traffic periods or maintenance windows.
policy
integer
  • Defines the policy identifier for the bandwidth limitation.
    • This is typically a numeric code representing specific bandwidth rules or strategies.
    • Possible values include:
      • 0: No specific policy applied (default).
      • 1: Custom-defined policy with stricter limitations.
    • Example usage includes associating different policies for specific scenarios or user groups.
rate
integer
  • Specifies the maximum allowable bandwidth rate in kilobytes per second (KBps).
    • Used to limit the data transfer rate to prevent overloading resources.
    • Example values:
      • 0: No limit is applied (default).
      • 500: Limits bandwidth to 500 KBps for all traffic.
rateafter
integer
  • Defines the data threshold (in kilobytes) after which the bandwidth rate limit is applied.
    • Used to allow initial unrestricted data transfer before enforcing the limit.
    • Example values:
      • 0: Enforces the limit from the start of data transfer.
      • 1000: Applies the limit only after 1000 KB of data transfer.
mode
string
  • Determines the action or operational mode for the configuration.
    • Possible values include:
      • 'save': Save the configuration changes.
      • 'test': Test the configuration without applying it.
    • Example usage includes applying configurations immediately or testing for correctness before implementation.

Responses

Request samples

Content type
application/json
{
  • "enabled": "Y",
  • "policy": 0,
  • "rate": 0,
  • "rateafter": 0,
  • "mode": "save"
}

Response samples

Content type
application/json
{
  • "result": "success",
  • "message": "Zone Settings Updated"
}

VoD Push

VoD Push Zone

Return VoD push zone details

Authorizations:
apikeyAuth
path Parameters
zoneid
required
integer
Example: 4487

(Required) Zone ID

header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": "success",
  • "zone": {
    }
}

Update Info

Update information of a VoD Push zone

Authorizations:
apikeyAuth
path Parameters
zoneid
required
integer
Example: 4487

(Required) Zone ID

header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
alias
string
  • A unique alias or nickname for the zone.
    • This is often used to identify or reference the zone in a user-friendly way.
    • Example values: 'fly-higher', 'zone-123'.
server
string
  • The identifier or name of the server associated with this zone.
    • Represents the server where the zone is hosted or managed.
    • Example values: '206', '103'.
cnames
string
  • Canonical Name (CNAME) records associated with the zone.
    • These are DNS entries that point to another domain or subdomain.
    • Example values: '', 'example.com'.
profiles
Array of strings
  • A list of profile IDs associated with the zone.
    • Profiles define specific configurations or settings applied to the zone.
    • Example values: ['2', '4', '5871'], ['1', '10', '42'].
webhook
string

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "result": "success",
  • "message": "Zone Updated",
  • "zone": {
    }
}

Delete Info

Delete information of a VoD Push zone. To cast request method POST and parameters _METHOD = DELETE

Authorizations:
apikeyAuth
path Parameters
zoneid
required
integer
Example: 4487

(Required) Zone ID

header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": "success",
  • "message": "Zone Updated",
  • "zone": {
    }
}

Create VoD Push Zone

Create a new VOD push Zone

Authorizations:
apikeyAuth
header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
alias
string
  • A custom alias or identifier for the resource.
    • It represents a human-readable name or label associated with the resource.
    • Example values: 'fly-higher', 'my-cdn'.
server
integer
  • The identifier for the server associated with the resource.
    • Represents the server code used to identify the specific server for the resource.
    • Example values: 206, 102, 405.
cnames
Array of strings
  • A list of CNAME records (Canonical Names) used for the resource.
    • Represents the custom domain names associated with the resource.
    • Example values: ['testing1.5centscdndemo.ca', 'p.5centscdndemo.ca'].
profiles
Array of integers
  • A list of profile IDs associated with the resource.
    • Represents different predefined configurations or setups for the resource.
    • Example values: [2, 4, 5871].
webhook
string
  • The URL endpoint for sending notifications related to the resource.
    • Represents a service that will receive real-time notifications about resource events.
    • Example values: 'http://vicky.com/notify'.
object
cache
string
  • A cache duration value representing the caching time.
    • Represents how long the resource data should be cached before refreshing.
    • Example values: '1M' (one minute), '5M' (five minutes).
object
enabled
string
  • Indicates whether domain locking is enabled.
    • Represents whether domain restrictions are applied to prevent unauthorized usage.
    • Example values: 'Y', 'N'.
policy
string
  • Defines the policy applied for domain locking.
    • Determines if there are any specific rules or restrictions for domains.
    • Example values: 'Y', 'N'.
list
Array of strings
  • A list of allowed or restricted domains for the resource.
    • Represents domain names that are permitted or blocked for the resource.
    • Example values: ['www.domain-two.com', 'test.com'].
noreferer
string
  • Indicates whether referrer restrictions are applied.
    • Represents whether the referer header is checked to limit access.
    • Example values: 'Y', 'N'.
ips
Array of strings
  • A list of IP addresses associated with the domain lock policy.
    • Represents the specific IP addresses allowed or denied access based on domain lock settings.
    • Example values: ['117.251.60.184', '117.251.60.185'].
object
enabled
string
  • Indicates whether geoblocking is enabled for the resource.
    • Represents whether access restrictions based on geographical location are applied.
    • Example values: 'Y', 'N'.
policy
string
  • Defines the policy applied for geoblocking.
    • Determines if there are any specific rules or restrictions for geographic locations.
    • Example values: 'Y', 'N'.
list
Array of strings
  • A list of countries or regions blocked for access.
    • Represents country codes or regions where access is restricted.
    • Example values: ['GB', 'US'].
ips
Array of strings
  • A list of IP addresses that are blocked based on geoblocking policy.
    • Represents specific IP addresses that will be denied access.
    • Example values: ['1.1.1.1', '2.2.2.2'].
object
enabled
string
  • Indicates whether IP access control is enabled for the resource.
    • Represents whether access is restricted based on IP address.
    • Example values: 'Y', 'N'.
policy
string
  • Defines the policy applied for IP access control.
    • Determines whether specific IP addresses are allowed or denied access.
    • Example values: 'Y', 'N'.
list
Array of strings
  • A list of allowed or denied IP addresses for access control.
    • Represents the IP addresses that are either permitted or restricted based on the policy.
    • Example values: ['123.2.2.2', '8.8.8.8'].
ips
Array of strings
  • A list of IP addresses permitted for access based on IP access control.
    • Represents specific IP addresses that are allowed under the access policy.
    • Example values: ['1.1.1.1', '2.2.2.2'].
object
enabled
string
  • Indicates whether user-agent based restrictions are enabled.
    • Represents whether the user-agent header is checked for access control.
    • Example values: 'Y', 'N'.
policy
string
  • Defines the policy applied for user-agent restrictions.
    • Determines if access is allowed or denied based on the user-agent.
    • Example values: 'Y', 'N'.
list
Array of strings
  • A list of allowed or denied user-agent strings for access control.
    • Represents specific user-agents (like browsers or bots) that are permitted or blocked.
    • Example values: ['mozilla'].
casesensitive
string
  • Indicates whether the user-agent matching is case-sensitive.
    • Represents if the check for the user-agent string should distinguish between upper and lower case.
    • Example values: 'Y', 'N'.
ips
Array of strings
  • A list of IP addresses associated with user-agent restrictions.
    • Represents IPs that are restricted or allowed based on the user-agent.
    • Example values: ['1.1.1.1', '2.2.2.2'].

Responses

Request samples

Content type
application/json
{
  • "alias": "fly-higher",
  • "server": 206,
  • "cnames": [
    ],
  • "profiles": [
    ],
  • "webhook": "http://vicky.com/notify",
  • "cache": {
    },
  • "domainlock": {
    },
  • "geoblock": {
    },
  • "ipaccess": {
    },
  • "useragent": {
    }
}

Response samples

Content type
application/json
{
  • "result": "success",
  • "message": "Zone Created",
  • "zone": {
    },
  • "warnings": [
    ]
}

Update SSL

Update SSL of VoD push zone

Authorizations:
apikeyAuth
path Parameters
zoneid
required
integer
Example: 4487

(Required) Zone ID

header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
http2
string
  • Indicates whether HTTP/2 is enabled.
    • HTTP/2 is a major revision of the HTTP network protocol designed to improve web performance.
    • If enabled, it allows faster communication between clients and servers.
    • Example values: 'Y' (enabled), 'N' (disabled).
redirect
string
  • Indicates whether HTTP redirection is enabled.
    • Redirection automatically sends users from one URL to another.
    • This can be useful for redirecting users to a secure version of a site or from outdated links.
    • Example values: 'Y' (enabled), 'N' (disabled).
mode
string
  • Represents the mode of operation for the resource.
    • This could determine how the system behaves under certain conditions or how it processes requests.
    • Example values: 'S' (safe mode), 'P' (production mode), 'D' (development mode).
certid
string
  • Represents the certificate ID used for SSL/TLS encryption.
    • SSL/TLS certificates are used to secure communications between clients and servers, ensuring data privacy.
    • An empty string means no certificate is assigned or available.
    • Example values: '123456', '' (empty string).
name
string
  • Represents the name of the resource.
    • This could be the title or label associated with the resource for identification purposes.
    • Example values: 'example.com', 'secure-site'.
crt
string
  • Represents the certificate file (CRT) used for SSL/TLS encryption.
    • This file is used to establish a secure connection between the client and server.
    • If empty, it means no certificate is provided.
    • Example values: 'cert.pem', '' (empty string).
key
string
  • Represents the private key associated with the certificate for SSL/TLS encryption.
    • This key is used to encrypt and decrypt data between the client and server.
    • If empty, it means no private key is provided.
    • Example values: 'privatekey.pem', '' (empty string).
cabundle
string
  • Represents the certificate authority bundle (CABundle) used for SSL/TLS encryption.
    • This bundle contains intermediate certificates from trusted authorities that validate the SSL certificate.
    • If empty, it means no CA bundle is provided.
    • Example values: 'ca_bundle.pem', '' (empty string).

Responses

Request samples

Content type
application/json
{
  • "http2": "Y",
  • "redirect": "Y",
  • "mode": "S",
  • "certid": "",
  • "name": "",
  • "crt": "",
  • "key": "",
  • "cabundle": ""
}

Response samples

Content type
application/json
{
  • "result": "success",
  • "message": "Zone Updated",
  • "zone": {
    },
  • "warnings": [
    ]
}

Restore Zone

Restore VoD push zone

Authorizations:
apikeyAuth
path Parameters
zoneid
required
integer
Example: 4487

(Required) Zone ID

header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": "success",
  • "message": "Zone Updated",
  • "zone": {
    }
}

Purge

Purge cache of a VoD Push zone

Authorizations:
apikeyAuth
path Parameters
zoneid
required
integer
Example: 4487

(Required) Zone ID

header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
_METHOD
string
  • Specifies the HTTP method used for the request.
    • It determines the type of operation to be performed on the resource.
    • Common methods include 'GET', 'POST', 'DELETE', 'PUT'.
    • Example values: 'DELETE' (deletes a resource), 'POST' (creates a resource).
files
Array of strings
  • A list of file paths that are to be affected by the operation.
    • This property indicates which files should be purged, deleted, or manipulated based on the request.
    • The array items specify the paths to the files on the server.
    • Example values: ['/http/18.png', '/http/19.png'].

Responses

Request samples

Content type
application/json
{
  • "_METHOD": "DELETE",
  • "files": [
    ]
}

Response samples

Content type
application/json
{
  • "result": "success",
  • "message": "Cache Purged"
}

Update Geoblock

Update Geoblock of VoD push zone

Authorizations:
apikeyAuth
path Parameters
zoneid
required
integer
Example: 4487

(Required) Zone ID

header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
enabled
string
  • A flag indicating whether the geoblock feature is enabled or not.
    • If set to 'Y', the geoblock is active. If set to 'N', the geoblock is disabled.
    • Example values: 'Y' (enabled), 'N' (disabled).
policy
string
  • Represents the policy of the geoblock.
    • This property controls whether the geoblock policy is active or not.
    • Example values: 'Y' (active), 'N' (inactive).
list
Array of strings
  • A list of country codes to block.
    • This array contains country codes in ISO 3166-1 alpha-2 format that are to be blocked by the geoblock.
    • Example values: ['GB', 'US'] (blocks Great Britain and the United States), ['FR', 'DE'] (blocks France and Germany).
ips
string
  • A comma-separated list of IP addresses to block.
    • This property contains a list of specific IP addresses that are blocked by the geoblock feature.
    • Example values: '1.1.1.1,2.2.2.2' (blocks the IP addresses 1.1.1.1 and 2.2.2.2), '192.168.0.1,10.0.0.1' (blocks two private IP addresses).

Responses

Request samples

Content type
application/json
{
  • "enabled": "Y",
  • "policy": "N",
  • "list": [
    ],
  • "ips": "1.1.1.1,2.2.2.2"
}

Response samples

Content type
application/json
{
  • "result": "success",
  • "message": "Zone Updated",
  • "zone": {
    }
}

Update External Auth Control

Update External auth control for of VoD push zone

Authorizations:
apikeyAuth
path Parameters
zoneid
required
integer
Example: 4487

(Required) Zone ID

header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
policy
any
authurl
any
ips
any

Responses

Request samples

Content type
application/json
{
  • "policy": null,
  • "authurl": null,
  • "ips": null
}

Response samples

Content type
application/json
{
  • "result": null,
  • "zone": null
}

Update Edge Settings

Update Edge settings of VoD push zone

Authorizations:
apikeyAuth
path Parameters
zoneid
required
string
Example: <string>

(Required) Zone ID

header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
pseudostreaming
any

Responses

Request samples

Content type
application/json
{
  • "pseudostreaming": null
}

Response samples

Content type
application/json
{
  • "result": null,
  • "message": null,
  • "zone": null
}

Update Domain Lock

Update Domain lock of VoD push zone

Authorizations:
apikeyAuth
path Parameters
zoneid
required
integer
Example: 4487

(Required) Zone ID

header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
enabled
string
  • A flag indicating whether the feature is enabled or disabled.
    • If set to 'Y', the feature is active. If set to 'N', the feature is inactive.
    • Example values: 'Y' (enabled), 'N' (disabled).
policy
string
  • Represents whether a specific policy is enforced.
    • If set to 'Y', the policy is enforced. If set to 'N', the policy is not enforced.
    • Example values: 'Y' (policy enforced), 'N' (policy not enforced).
list
string
  • A comma-separated list of domains to be included in the feature.
ips
string
  • A comma-separated list of IP addresses affected by the feature.
    • This property specifies the IP addresses involved in the policy or feature.
    • Example values: '117.251.60.184,117.251.60.185,117.251.60.186' (includes three specific IP addresses), '192.168.1.1,192.168.1.2' (includes two private IP addresses).
noreferer
string
  • Indicates whether requests without a referrer are allowed.
    • If set to 'Y', requests without a referrer are permitted. If set to 'N', such requests are denied.
    • Example values: 'Y' (allows requests without referrer), 'N' (denies requests without referrer).

Responses

Request samples

Content type
application/json
{
  • "enabled": "Y",
  • "policy": "Y",
  • "list": "www.test.com,www.google.com",
  • "ips": "117.251.60.184,117.251.60.185,117.251.60.186",
  • "noreferer": "Y"
}

Response samples

Content type
application/json
{
  • "result": "success",
  • "message": "Zone Updated",
  • "zone": {
    }
}

Update Securetoken

Update Securetoken of VoD push zone

Authorizations:
apikeyAuth
path Parameters
zoneid
required
integer
Example: 4487

(Required) Zone ID

header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
enabled
string
  • A flag indicating whether the secure token feature is enabled.
    • If set to 'Y', the feature is active. If set to 'N', the feature is inactive.
    • Example values: 'Y' (enabled), 'N' (disabled).
policy
string
  • Specifies the policy to be applied for the secure token feature.
    • Common values include 'F' for a fixed policy or 'D' for a dynamic policy.
    • Example values: 'F' (fixed policy), 'D' (dynamic policy).
list
string
  • A unique identifier or token string associated with the secure token feature.
    • This token is used to identify sessions or requests.
    • Example values: 'c4d6dde6cf072bf9' (a sample token), 'abcd1234efgh5678' (another unique token).
timeout
number
  • The timeout duration (in seconds) for the secure token feature.
    • Defines how long a session or token remains valid before expiring.
    • Example values: 3600 (1 hour), 7200 (2 hours).
session
number
  • Indicates the number of active sessions allowed for the secure token feature.
    • This property ensures control over session limits per user or token.
    • Example values: 1 (single session), 2 (two concurrent sessions).
keyip
string
  • Determines whether the secure token is tied to a specific IP address.
    • If set to 'Y', the token is restricted to a single IP address. If set to 'N', it can be used from multiple IPs.
    • Example values: 'Y' (IP-bound token), 'N' (non-IP-bound token).
ips
string
  • A comma-separated list of IP addresses that are associated with the secure token feature.
    • Defines which IPs are allowed or recognized by the system for the token.
    • Example values: '1.1.1.1,2.2.2.2' (specific allowed IPs), '192.168.0.1,192.168.0.2' (internal network IPs).

Responses

Request samples

Content type
application/json
{
  • "enabled": "Y",
  • "policy": "F",
  • "list": "c4d6dde6cf072bf9",
  • "timeout": 3600,
  • "session": 1,
  • "keyip": "Y",
  • "ips": "1.1.1.1,2.2.2.2"
}

Response samples

Content type
application/json
{
  • "result": "success",
  • "message": "Zone Updated",
  • "zone": {
    }
}

Import VoD Push Zone

Import VOD Push Zone

Authorizations:
apikeyAuth
path Parameters
zoneid
required
integer
Example: 4485

(Required) Zone ID

header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
id
string
  • A unique identifier for the resource or operation.
    • Typically used to track or reference specific files or jobs.
    • Example values: '17373801834604600', '12345678901234567'.
url
string
filename
string
  • The name of the file, including its extension, as it appears in the system or directory.
    • This is often used for saving or referencing the file locally.
    • Example values: 'fast-car-concept-illustration_114360-2495.jpg', 'example-file.png'.
folder
string
  • The folder or directory where the file is stored or categorized.
    • Represents either a root directory ('/') or a specific subfolder.
    • Example values: '/', '/images', '/uploads'.

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{}

VoD Push Zones

Return VoD Push zones

Authorizations:
apikeyAuth
query Parameters
page
integer
Example: page=1
header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": "success",
  • "message": "Zone Updated",
  • "zones": [
    ]
}

Zone filemanager List

Zone filemanager List

Authorizations:
apikeyAuth
path Parameters
zoneid
required
integer
Example: 4487

(Required) Zone ID

query Parameters
dir
string
Example: dir=/

Enter directory name

query
string

search by filename

marker
string

Set the marker parameter to the name of the last item returned in the previous list.

end_marker
string

Limits the result set to names that are less than the end_marker parameter value.

header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "zoneFileManagerList": [
    ]
}

Zone filemanager info

Zone filemanager info

Authorizations:
apikeyAuth
path Parameters
zoneid
required
integer
Example: 4487

(Required) Zone ID

query Parameters
file
string
Example: file=/http/18png

Enter file name

media
integer
Example: media=1

show detailed media info if 1

header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "dirname": "/http",
  • "basename": "18.png",
  • "filesize": 105565,
  • "lastChange": 1737379062,
  • "lastAccess": 1737379062,
  • "etag": "642372ebb127f2eac6fd8db3631730e0",
  • "perms": "0664",
  • "media": {
    }
}

Get Servers

Vod Push Zone Servers

Authorizations:
apikeyAuth
header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": "success",
  • "servers": [
    ]
}

VoD Pull

VoD Pull Zones

Return VoD Pull zones

Authorizations:
apikeyAuth
query Parameters
page
integer
Example: page=1
header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": null,
  • "zones": null
}

VoD Pull Zone

Return VoD pull zone details

Authorizations:
apikeyAuth
path Parameters
zoneid
required
integer
Example: 4469

(Required) Zone ID

header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{}

Update Info

Update information of a VoD Pull zone

Authorizations:
apikeyAuth
path Parameters
zoneid
required
integer
Example: 4469

(Required) Zone ID

header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
alias
string
  • A human-readable identifier or name for the resource.
    • Represents an alias or a nickname used to refer to the resource in a more recognizable way.
    • Example values: jambing-dune, my-site-alias.
origin
string
  • The source URL or origin where the resource is hosted or derived from.
    • Represents the web address (URL) from which the resource is accessed or loaded.
    • Example values: https://www.google.com, https://example.com.
cname
string
  • A comma-separated list of CNAME records pointing to different subdomains.
    • Represents the canonical names (CNAME) used for domain aliasing or redirection to other subdomains.
    • Example values: tes.5centscdndemo.ca,p.5centscdndemo.ca, www.example.com,blog.example.com.

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{}

Delete Info

Delete information of a VoD Pull zone. To cast request method POST and parameters _METHOD = DELETE

Authorizations:
apikeyAuth
path Parameters
zoneid
required
integer
Example: 4469

(Required) Zone ID

header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": "success",
  • "message": "Zone deleted successfully"
}

Create Pull Zone

Create a new VOD pull Zone

Authorizations:
apikeyAuth
header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
alias
string
  • Represents an alias or a unique identifier for the resource.
    • It could be used as a shorthand or custom name for a domain or service.
    • Example values: jambing-dune, test-alias.
origin
string
  • Represents the origin URL from which resources are fetched.
    • This could be a source website or domain URL.
    • Example values: https://www.google.com, https://example.com.
cnames
Array of strings
  • Contains a list of canonical names (CNAMEs) for the domain.
    • CNAMEs are used to map one domain name to another, typically for subdomains or external services.
    • Example values: testing.5centscdndemo.ca, p.5centscdndemo.ca.
object
cache
string
  • Represents the caching duration for resources.
    • The value specifies how long the resource should be cached before re-fetching it.
    • Example values: 30m, 1h, 12h.
shields
Array of strings
  • A list of country codes representing the countries for which resources are shielded or restricted.
    • These could be regions that have access control or protection.
    • Example values: FR, CA, SG.
object
enabled
string
  • Indicates whether domain lock is enabled.
    • Domain lock prevents unauthorized changes to domain settings.
    • Example values: Y, N.
policy
string
  • Represents the policy applied for domain lock.
    • This could indicate a specific lock policy for domain management.
    • Example values: Y, N.
list
Array of strings
  • A list of domains that are locked under the domain lock policy.
    • These are the domains that are subject to the lock.
    • Example values: www.domain-two.com, test.com.
ips
Array of strings
  • A list of IP addresses associated with domain lock functionality.
    • These IPs are likely allowed or restricted under the lock policy.
    • Example values: 117.251.60.184, 117.251.60.185.
object
enabled
string
  • Indicates whether geoblocking is enabled.
    • Geoblocking restricts access based on geographical location.
    • Example values: Y, N.
policy
string
  • Represents the policy applied for geoblocking.
    • This could define how geoblocking is enforced.
    • Example values: Y, N.
list
Array of strings
  • A list of country codes representing regions blocked by geoblocking.
    • These are the countries or regions that are denied access.
    • Example values: GB, US.
ips
Array of strings
  • A list of IP addresses associated with geoblocking.
    • These IPs may be blocked or restricted.
    • Example values: 1.1.1.1, 2.2.2.2.
object
enabled
string
  • Indicates whether IP access is enabled.
    • IP access control limits access based on specific IPs.
    • Example values: Y, N.
policy
string
  • Represents the policy applied for IP access control.
    • This could define whether only certain IPs are allowed access.
    • Example values: Y, N.
list
Array of strings
  • A list of IP addresses allowed or restricted by IP access control.
    • These are the specific IPs that can either access or be blocked.
    • Example values: 123.2.2.2, 8.8.8.8.
ips
Array of strings
  • A list of IP addresses associated with IP access control.
    • These IPs are either allowed or denied based on the policy.
    • Example values: 1.1.1.1, 2.2.2.2.
object
enabled
string
  • Indicates whether user-agent filtering is enabled.
    • User-agent filtering restricts or allows access based on the client’s user-agent.
    • Example values: Y, N.
policy
string
  • Represents the policy applied for user-agent filtering.
    • This could define whether specific user-agents are allowed or denied.
    • Example values: Y, N.
list
Array of strings
  • A list of user-agent strings that are allowed or denied by the policy.
    • These are the identifiers of the clients that are being filtered based on their user-agent.
    • Example values: mozilla, chrome.
casesensitive
string
  • Indicates whether the user-agent filter is case-sensitive.
    • This setting controls if the user-agent values are treated with case sensitivity.
    • Example values: Y, N.
ips
Array of strings
  • A list of IP addresses associated with user-agent filtering.
    • These IPs may have specific user-agent filtering applied.
    • Example values: 1.1.1.1, 2.2.2.2.

Responses

Request samples

Content type
application/json
{
  • "alias": "jambing-dune",
  • "origin": "https://www.google.com",
  • "cnames": [
    ],
  • "cache": {
    },
  • "shields": [
    ],
  • "domainlock": {
    },
  • "geoblock": {
    },
  • "ipaccess": {
    },
  • "useragent": {
    }
}

Response samples

Content type
application/json
{}

Update SSL

Update SSL of VoD pull zone

Authorizations:
apikeyAuth
path Parameters
zoneid
required
integer
Example: 4469

(Required) Zone ID

header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
http2
string
  • Indicates whether HTTP/2 protocol is enabled.
    • HTTP/2 is a modern protocol that improves the speed and performance of web pages.
    • Possible values: Y (enabled), N (disabled).
redirect
string
  • Indicates whether HTTP redirection is enabled.
    • Redirection refers to the process of forwarding a web request to a different URL.
    • Possible values: Y (enabled), N (disabled).
mode
string
  • Represents the mode or state of the configuration.
    • This could refer to operational modes such as 'secure' or 'non-secure' modes.
    • Example values: S (secure), U (unsafe).
certid
string
  • Represents the identifier for the SSL/TLS certificate.
    • This is a unique ID for the certificate associated with the website.
    • Example values: 123456, a1b2c3.
name
string
  • Represents the name of the certificate or service.
    • This could be the name of the domain, service, or entity for which the certificate is issued.
    • Example values: example.com, mywebsite.org.
crt
string
  • Represents the SSL/TLS certificate.
    • This is the actual certificate in PEM format, containing public key data.
    • Example values: MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8A..., MIIE8zCCAssgAwIBAgIQPTHuREddzcksm9cVDF....
key
string
  • Represents the private key associated with the SSL/TLS certificate.
    • This key should be kept private and secure, as it is used to decrypt secure data.
    • Example values: MIIBVwIBADANBgkqhkiG9w0BAQEFAASCAT4wggE..., MIIEpAIBAAKCAQEAyST....
cabundle
string
  • Represents the certificate authority (CA) bundle.
    • The CA bundle includes intermediate certificates that establish the authenticity of the certificate.
    • Example values: MIIF8zCCBG+gAwIBAgIQDkn2hdmR2pOU7CGhoC7F1E8gP7khIwbN+0E..., MIIFdzCCBF+gAwIBAgIQTmnW2p2eS5uR....

Responses

Request samples

Content type
application/json
{
  • "http2": "Y",
  • "redirect": "Y",
  • "mode": "S",
  • "certid": "",
  • "name": "",
  • "crt": "",
  • "key": "",
  • "cabundle": ""
}

Response samples

Content type
application/json
{}

Restore

Restore VoD pull zone

Authorizations:
apikeyAuth
path Parameters
zoneid
required
integer
Example: 4469

(Required) Zone ID

header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{}

Purge

Purge cache of a VoD pull zone

Authorizations:
apikeyAuth
path Parameters
zoneid
required
integer
Example: 4469

(Required) Zone ID

header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
_METHOD
string
  • Specifies the HTTP method used for the request.
    • Common HTTP methods include GET, POST, PUT, DELETE.
    • In this case, DELETE indicates a request to remove resources.
files
Array of strings
  • A list of file paths that are to be affected by the action.
    • Each item in the array represents a file that is being deleted or modified.
    • Example values include file paths to images, documents, or any other resources.
    • The files specified are typically relative paths within the system.

Responses

Request samples

Content type
application/json
{
  • "_METHOD": "DELETE",
  • "files": [
    ]
}

Response samples

Content type
application/json
{
  • "result": "success",
  • "message": "Cache Purged"
}

Update Geoblock

Update Geoblock of VoD pull zone

Authorizations:
apikeyAuth
path Parameters
zoneid
required
integer
Example: 4469

(Required) Zone ID

header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
enabled
string
  • Specifies whether the geoblock feature is enabled.
    • A value of Y means the geoblock is enabled, while N means it is disabled.
    • Example values: Y, N.
policy
string
  • Indicates the policy for geoblocking.
    • A value of Y means the policy is active, while N means it is inactive.
    • Example values: Y, N.
list
Array of strings
  • A list of country codes that are subject to geoblocking.
    • Countries in this list will be blocked from accessing the resource.
    • Example values: GB for Great Britain, US for United States.
ips
string
  • A comma-separated list of IP addresses that are affected by the geoblock policy.
    • These IP addresses are either blocked or allowed based on the policy.
    • Example values: 1.1.1.1,2.2.2.2.

Responses

Request samples

Content type
application/json
{
  • "enabled": "Y",
  • "policy": "N",
  • "list": [
    ],
  • "ips": "1.1.1.1,2.2.2.2"
}

Response samples

Content type
application/json
{}

Update shield Settings

Update shield settings of VOD record zone

Authorizations:
apikeyAuth
path Parameters
zoneid
required
integer
Example: 4469

(Required) Zone ID

header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
shields
Array of strings
  • A list of country codes representing countries that have specific shields or protections applied.
    • Each entry in the list corresponds to a country code that is associated with a shielded region.
    • Example values: FR for France, CA for Canada, SG for Singapore.

Responses

Request samples

Content type
application/json
{
  • "shields": [
    ]
}

Response samples

Content type
application/json
{}

Update External Auth Control

Update External auth control for of VoD push zone

Authorizations:
apikeyAuth
path Parameters
zoneid
required
integer
Example: 4469

(Required) Zone ID

header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
policy
any
authurl
any
ips
any

Responses

Request samples

Content type
application/json
{
  • "policy": null,
  • "authurl": null,
  • "ips": null
}

Response samples

Content type
application/json
{
  • "result": null,
  • "zone": null
}

Update Edge Settings

Update Edge settings of VoD push zone

Authorizations:
apikeyAuth
path Parameters
zoneid
required
string
Example: <string>

(Required) Zone ID

header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
pseudostreaming
any

Responses

Request samples

Content type
application/json
{
  • "pseudostreaming": null
}

Response samples

Content type
application/json
{
  • "result": null,
  • "message": null,
  • "zone": null
}

Update Domain Lock

Update Domain lock of VoD push zone

Authorizations:
apikeyAuth
path Parameters
zoneid
required
integer
Example: 4469

(Required) Zone ID

header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
enabled
string
  • A flag that indicates whether the feature is enabled or not.
    • Represents a simple 'Yes' or 'No' status for enabling a feature.
    • Possible values: Y (enabled), N (disabled).
policy
string
  • A flag indicating whether a policy is active.
    • Represents whether a specific policy is applied or not.
    • Possible values: Y (active), N (inactive).
list
string
  • A comma-separated list of URLs that are included in the policy.
    • Represents domains or websites that are affected by the policy.
    • Example values: wwww.google.com,www.test.com.
ips
string
  • A comma-separated list of IP addresses that are included in the policy.
    • Represents the IP addresses that are allowed or affected by the policy.
    • Example values: 117.251.60.184,117.251.60.185,117.251.60.186.
noreferer
string
  • A flag indicating whether referer headers should be excluded.
    • Represents whether the referer information should be included or not in requests.
    • Possible values: Y (exclude referer), N (include referer).

Responses

Request samples

Content type
application/json
{
  • "enabled": "Y",
  • "policy": "Y",
  • "list": "wwww.google.com,www.test.com",
  • "ips": "117.251.60.184,117.251.60.185,117.251.60.186",
  • "noreferer": "Y"
}

Response samples

Content type
application/json
{}

Update Securetoken

Update securetoken of VoD push zone

Authorizations:
apikeyAuth
path Parameters
zoneid
required
integer
Example: 4469

(Required) Zone ID

header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
enabled
string
  • A flag indicating whether the feature is enabled or disabled.
    • Represents whether a security feature is active or inactive.
    • Possible values: Y (enabled), N (disabled).
policy
string
  • A flag indicating the policy type.
    • Represents whether the security policy is in use or not.
    • Possible values: Y (active), N (inactive), F (failed or inactive).
list
string
  • A list or ID of secure tokens that are permitted or are part of the policy.
    • Represents a comma-separated list or a single ID used in enforcing the policy.
    • Example value: 9190dbf16ebbaf49.
timeout
integer
  • The time in seconds before a session or token times out.
    • Represents the duration of the session or token validity.
    • Example values: 3600 (1 hour), 1800 (30 minutes).
session
integer
  • The session ID or count.
    • Represents the number of active sessions allowed or the specific session ID for the user.
    • Example values: 1, 5.
keyip
string
  • A flag indicating whether the key is tied to a specific IP address.
    • Represents whether the security key should only be valid for specific IP addresses.
    • Possible values: Y (tied to IP), N (not tied to IP).
ips
string
  • A comma-separated list of IP addresses that are allowed or restricted by the policy.
    • Represents the IP addresses that are either authorized or blocked.
    • Example values: 1.1.1.1,2.2.2.2.

Responses

Request samples

Content type
application/json
{
  • "enabled": "Y",
  • "policy": "F",
  • "list": "9190dbf16ebbaf49",
  • "timeout": 3600,
  • "session": 1,
  • "keyip": "Y",
  • "ips": "1.1.1.1,2.2.2.2"
}

Response samples

Content type
application/json
{}

VoD Global Security Settings

update zone vod domain setting

update zone vod domain setting

Authorizations:
apikeyAuth
header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
enabled
string
  • Indicates whether the VOD domain setting is enabled.
    • 'Y' means enabled, while 'N' means disabled.
    • Example values: 'Y', 'N'.
policy
string
  • Specifies if a particular policy is active for the VOD domain setting.
    • 'Y' means the policy is enabled, while 'N' means it is disabled.
    • Example values: 'Y', 'N'.
list
string
  • A comma-separated list of domains associated with the VOD zone.
    • Defines the domains that are allowed or restricted based on the policy.
    • Example values: 'www.domain-two.com,test.com', 'example.com,another-site.net'.
ips
string
  • A comma-separated list of IP addresses related to the VOD domain setting.
    • These IPs might represent whitelisted or blacklisted addresses depending on the policy.
    • Example values: '117.251.60.184,117.251.60.185,117.251.60.186', '192.168.1.1,192.168.1.2'.
mode
string
  • Defines the operation mode for updating the VOD domain settings.
    • Possible values: 'save' (to store new settings), 'update' (to modify existing settings), 'delete' (to remove settings).
    • Example values: 'save', 'update', 'delete'.

Responses

Request samples

Content type
application/json
{
  • "enabled": "Y",
  • "policy": "Y",
  • "list": "www.domain-two.com,test.com",
  • "ips": "117.251.60.184,117.251.60.185,117.251.60.186",
  • "mode": "save"
}

Response samples

Content type
application/json
{
  • "result": "success",
  • "message": "Zone Settings Updated"
}

update zone vod geoblock setting

update zone vod domain setting

Authorizations:
apikeyAuth
header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
enabled
string
  • Indicates whether the zone geoblock is enabled or not.
    • A value of Y means enabled, while N means disabled.
    • Example values: Y, N.
policy
string
  • Defines the policy related to geoblocking.
    • A value of Y means the policy allows access, while N means the policy blocks access.
    • Example values: Y, N.
list
Array of strings
  • A list of countries that are geoblocked from accessing the zone.
    • This array can contain country codes (ISO 3166-1 alpha-2 codes) for the blocked countries.
    • Example values: GB, US.
ips
string
  • A comma-separated list of IP addresses that are either allowed or blocked based on the geoblocking policy.
    • These IPs are used to filter or block specific access from certain addresses.
    • Example values: 1.1.1.1,2.2.2.2.
mode
string
  • Indicates the operation mode for geoblocking.
    • save typically means that the current settings are being saved.
    • Example values: save, update.

Responses

Request samples

Content type
application/json
{
  • "enabled": "Y",
  • "policy": "N",
  • "list": [
    ],
  • "ips": "1.1.1.1,2.2.2.2",
  • "mode": "save"
}

Response samples

Content type
application/json
{
  • "result": "success",
  • "message": "Zone Settings Updated"
}

update zone vod securetoken setting

update zone vod securetoken setting

Authorizations:
apikeyAuth
header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
enabled
string
  • Indicates whether the feature is enabled or not.
    • The value 'Y' means enabled and 'N' means disabled.
    • Example values include 'Y' (enabled) or 'N' (disabled).
policy
string
  • Defines the policy setting for the zone.
    • A value of 'F' typically means 'False' or 'No', indicating a policy is not applied.
    • Other possible values might include 'T' for 'True' (enabled) depending on the system's logic.
list
string
  • Represents an identifier or list related to the zone.
    • It could represent an ID or unique key related to the configuration.
    • Example values could include '2054a14b626723ed', representing a specific zone identifier.
timeout
integer
  • Specifies the timeout duration in seconds.
    • This defines how long the session or connection will last before it times out.
    • Common values might be 3600 (1 hour), or other values depending on your requirements.
session
integer
  • Represents the session identifier.
    • This could represent a particular session or a flag for active sessions.
    • Possible values include 1 (active session) or other integers representing specific session statuses.
keyip
string
  • Specifies if the IP address is a key or is used as a key in the system.
    • The value 'Y' means the key is used, while 'N' means it is not.
    • Example values include 'Y' (key used) or 'N' (key not used).
ips
string
  • A list of IP addresses that are allowed or blocked.
    • This property can be used for IP filtering or access control.
    • Possible example values are '8.8.8.8,9.9.9.9', representing a list of allowed IP addresses.
mode
string
  • Defines the mode of operation for the zone.
    • The value 'save' means saving changes to the configuration.
    • Other possible values could include 'edit' (edit mode), 'delete' (delete mode), depending on the system functionality.

Responses

Request samples

Content type
application/json
{
  • "enabled": "Y",
  • "policy": "F",
  • "list": "2054a14b626723ed",
  • "timeout": 3600,
  • "session": 1,
  • "keyip": "Y",
  • "ips": "8.8.8.8,9.9.9.9",
  • "mode": "save"
}

Response samples

Content type
application/json
{
  • "result": "success",
  • "message": "Zone Settings Updated"
}

HTTP Push Standard Reports

HTTP Push Reports for Standard Network

Reports by zone push Summary

Get reports of zone push Summary

Authorizations:
apikeyAuth
path Parameters
zoneid
required
integer
Example: 4533

(Required) Zone ID

header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
range
string
  • Represents the time range for the report.
    • Typically formatted as a datetime string in YYYY-MM-DD HH:MM:SS format.
    • Used to specify the start of the reporting period.
    • Example values: "2024-11-15 00:00:00", "2024-08-01 12:30:45".
type
string
  • Specifies the type of report.
    • Only accepts two possible values: "hourly" or "daily".
    • Determines the granularity of the report.
    • Example values: "hourly", "daily".

Responses

Request samples

Content type
application/json
{
  • "range": "2024-11-15 00:00:00",
  • "type": "daily"
}

Response samples

Content type
application/json
{
  • "result": "success",
  • "stats": {
    }
}

Reports by zone push Cache Statistics

Get reports of zone push Summary

Authorizations:
apikeyAuth
path Parameters
zoneid
required
integer
Example: 4522

(Required) Zone ID

header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
frequency
string
  • Defines how often the cache statistics are updated or retrieved. - Represents the frequency of data collection in days, hours, or minutes. - Example values: "1" (daily), "7" (weekly), "30" (monthly).
filter_type
string
  • Determines the filtering method applied to cache statistics. - Could indicate different filtering options such as 0 (all data), 1 (by region), 2 (by time range). - Example values: "0" (no filter), "1" (filter by zone), "2" (filter by server type).
start_date
string
  • Specifies the starting date for retrieving cache statistics. - Defines the beginning of the data range in YYYY-MM-DD format. - Example values: "2025-01-01", "2024-12-15".
end_date
string
  • Specifies the ending date for retrieving cache statistics. - Defines the last date of the data range in YYYY-MM-DD format. - Example values: "2025-02-01", "2024-12-31".

Responses

Request samples

Content type
application/json
{
  • "frequency": "2",
  • "filter_type": "0",
  • "start_date": "2025-01-26",
  • "end_date": "2025-02-02"
}

Response samples

Content type
application/json
{
  • "result": "success",
  • "stats": {
    }
}

Reports by zone push Top Files

Get reports of zone top files

Authorizations:
apikeyAuth
path Parameters
zoneid
required
integer
Example: 4522

(Required) Zone ID

header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
start_date
string
  • Represents the start date for the report.
    • This date marks the beginning of the time period covered by the report.
    • Example values could be the start of a business period or a specific event's start date.
end_date
string
  • Represents the end date for the report.
    • This date marks the conclusion of the time period covered by the report.
    • Example values could be the end of a business period or when a specific event ends.
type
string
  • Specifies the type of the report.
    • This could represent the format or content style of the report. For example, it could be 'static' for a fixed report or 'dynamic' for a report that updates over time.

Responses

Request samples

Content type
application/json
{
  • "start_date": "2025-01-26",
  • "end_date": "2025-02-02",
  • "type": "dynamic"
}

Response samples

Content type
application/json
{
  • "result": "success",
  • "stats": {
    }
}

Reports by zone push Top Referrers

Get reports of zone top referrers

Authorizations:
apikeyAuth
path Parameters
zoneid
required
integer
Example: 4522

(Required) Zone ID

header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
start_date
string
  • Represents the starting date of the report period.
    • This date is in the format 'YYYY-MM-DD'.
    • Examples include '2025-01-27' or '2024-12-01'.
end_date
string
  • Represents the ending date of the report period.
    • This date is in the format 'YYYY-MM-DD'.
    • Examples include '2025-02-03' or '2024-12-31'.

Responses

Request samples

Content type
application/json
{
  • "start_date": "2025-01-27",
  • "end_date": "2025-02-03"
}

Response samples

Content type
application/json
{
  • "result": "success",
  • "stats": {
    }
}

Reports by zone push Status Codes

Get reports of zone push Status Codes

Authorizations:
apikeyAuth
path Parameters
zoneid
required
integer
Example: 4522

(Required) Zone ID

header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
frequency
string
  • Represents the frequency at which the report is generated or updated.
    • '0' indicates the report is generated every minute.
    • '1' indicates the report is generated every hour.
    • '2' indicates the report is generated daily.
start_date
string
  • Represents the starting date of the report period.
    • This date is in the format 'YYYY-MM-DD'.
    • Examples include '2025-01-27' or '2024-12-01'.
end_date
string
  • Represents the ending date of the report period.
    • This date is in the format 'YYYY-MM-DD'.
    • Examples include '2025-02-03' or '2024-12-31'.

Responses

Request samples

Content type
application/json
{
  • "frequency": "2",
  • "start_date": "2025-01-27",
  • "end_date": "2025-02-03"
}

Response samples

Content type
application/json
{
  • "result": "success",
  • "stats": {
    }
}

Reports by zone push countries

Get reports of zone push countries

Authorizations:
apikeyAuth
path Parameters
zoneid
required
integer
Example: 4522

(Required) Zone ID

header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
frequency
string
  • Represents the frequency at which the report is generated or updated.
    • '0' indicates the report is generated every minute.
    • '1' indicates the report is generated every hour.
    • '2' indicates the report is generated daily.
start_date
string
  • Represents the starting date of the report period.
    • This date is in the format 'YYYY-MM-DD'.
    • Examples include '2025-01-27' or '2024-12-01'.
end_date
string
  • Represents the ending date of the report period.
    • This date is in the format 'YYYY-MM-DD'.
    • Examples include '2025-02-03' or '2024-12-31'.

Responses

Request samples

Content type
application/json
{
  • "frequency": "2",
  • "start_date": "2025-01-27",
  • "end_date": "2025-02-03"
}

Response samples

Content type
application/json
{
  • "result": "success",
  • "stats": {
    }
}

Reports by zone push browsers

Get reports of zone push browsers

Authorizations:
apikeyAuth
path Parameters
zoneid
required
integer
Example: 4522

(Required) Zone ID

header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
frequency
string
  • Represents the frequency at which the report is generated or updated.
    • '0' indicates the report is generated every minute.
    • '1' indicates the report is generated every hour.
    • '2' indicates the report is generated daily.
start_date
string
  • Represents the starting date of the report period.
    • This date is in the format 'YYYY-MM-DD'.
    • Examples include '2025-01-27' or '2024-12-01'.
end_date
string
  • Represents the ending date of the report period.
    • This date is in the format 'YYYY-MM-DD'.
    • Examples include '2025-02-03' or '2024-12-31'.

Responses

Request samples

Content type
application/json
{
  • "frequency": "2",
  • "start_date": "2025-01-27",
  • "end_date": "2025-02-03"
}

Response samples

Content type
application/json
{
  • "result": "success",
  • "stats": {
    }
}

Reports by zone push os

Get reports of zone push os

Authorizations:
apikeyAuth
path Parameters
zoneid
required
integer
Example: 4522

(Required) Zone ID

header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
frequency
string
  • Represents the frequency at which the report is generated or updated.
    • '0' indicates the report is generated every minute.
    • '1' indicates the report is generated every hour.
    • '2' indicates the report is generated daily.
start_date
string
  • Represents the starting date of the report period.
    • This date is in the format 'YYYY-MM-DD'.
    • Examples include '2025-01-27' or '2024-12-01'.
end_date
string
  • Represents the ending date of the report period.
    • This date is in the format 'YYYY-MM-DD'.
    • Examples include '2025-02-03' or '2024-12-31'.

Responses

Request samples

Content type
application/json
{
  • "frequency": "2",
  • "start_date": "2025-01-27",
  • "end_date": "2025-02-03"
}

Response samples

Content type
application/json
{
  • "result": "success",
  • "stats": {
    }
}

Reports by zone push visitors

Get reports of zone push visitors

Authorizations:
apikeyAuth
path Parameters
zoneid
required
integer
Example: 4522

(Required) Zone ID

header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
frequency
string
  • Represents the frequency at which the report is generated or updated.
    • '0' indicates the report is generated every minute.
    • '1' indicates the report is generated every hour.
    • '2' indicates the report is generated daily.
start_date
string
  • Represents the starting date of the report period.
    • This date is in the format 'YYYY-MM-DD'.
    • Examples include '2025-01-27' or '2024-12-01'.
end_date
string
  • Represents the ending date of the report period.
    • This date is in the format 'YYYY-MM-DD'.
    • Examples include '2025-02-03' or '2024-12-31'.

Responses

Request samples

Content type
application/json
{
  • "frequency": "2",
  • "start_date": "2025-01-27",
  • "end_date": "2025-02-03"
}

Response samples

Content type
application/json
{
  • "result": "success",
  • "stats": {
    }
}

HTTP Pull Standard Reports

HTTP Pull Reports for Standard Network

Reports by zone pull Summary

Get reports of zone pull Summary

Authorizations:
apikeyAuth
path Parameters
zoneid
required
integer
Example: 4484

(Required) Zone ID

header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
range
string
  • Represents the date and time range for the report.
    • Used to specify the starting point of the data collection.
    • Example values:
      • '2024-12-15 00:00:00' (midnight of December 15, 2024)
      • '2023-06-01 12:30:45' (June 1, 2023, at 12:30:45 PM)
type
string
  • Defines the interval type for the report data.
    • Common values include:
      • 'hourly' (data segmented by each hour)
      • 'daily' (data segmented by each day)
      • 'weekly' (data segmented by each week)

Responses

Request samples

Content type
application/json
{
  • "range": "2024-12-15 00:00:00",
  • "type": "hourly"
}

Response samples

Content type
application/json
{
  • "result": "success",
  • "stats": {
    }
}

Reports by zone pull cache

Get reports of zone pull cache

Authorizations:
apikeyAuth
path Parameters
zoneid
required
integer
Example: 4522

(Required) Zone ID

header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
frequency
string
  • Represents how often the report is generated.
    • Indicates the frequency of data collection or reporting.
    • Example values include '1' for daily, '2' for weekly, or '3' for monthly.
filter_type
string
  • Specifies the type of filter applied to the report.
    • Determines the scope or category of data included in the report.
    • Example values include '0' for no filter, '1' for specific categories, or '2' for custom filters.
start_date
string
  • Indicates the starting date for the report data range.
    • Defines the beginning of the period for which data is collected.
    • Example values include '2025-01-26' or '2024-12-01'.
end_date
string
  • Indicates the ending date for the report data range.
    • Defines the end of the period for which data is collected.
    • Example values include '2025-02-02' or '2024-12-31'.

Responses

Request samples

Content type
application/json
{
  • "frequency": "2",
  • "filter_type": "0",
  • "start_date": "2025-01-26",
  • "end_date": "2025-02-02"
}

Response samples

Content type
application/json
{
  • "result": "success",
  • "stats": {
    }
}

Reports by zone pull topfiles

Get reports of zone pull topfiles

Authorizations:
apikeyAuth
path Parameters
zoneid
required
integer
Example: 4484

(Required) Zone ID

header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
start_date
string
  • Represents the starting date for the report data range.
    • Defines the beginning of the period for which data is collected.
    • Example values include '2025-01-26' or '2024-12-01'.
end_date
string
  • Represents the ending date for the report data range.
    • Defines the end of the period for which data is collected.
    • Example values include '2025-02-02' or '2024-12-31'.
type
string
  • Specifies the type of report being generated.
    • Indicates whether the report is static or dynamic.
    • Example values include 'dynamic' for real-time data or 'static' for pre-generated data.

Responses

Request samples

Content type
application/json
{
  • "start_date": "2025-01-26",
  • "end_date": "2025-02-02",
  • "type": "dynamic"
}

Response samples

Content type
application/json
{
  • "result": "success",
  • "stats": {
    }
}

Reports by zone pull topreferrers

Get reports of zone pull topreferrers

Authorizations:
apikeyAuth
path Parameters
zoneid
required
integer
Example: 4484

(Required) Zone ID

header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
start_date
string
  • The beginning date for the report query period. - Represents the starting point from which data will be collected. - The date should be in YYYY-MM-DD format. - Example values: '2025-01-27', '2024-12-01'.
end_date
string
  • The ending date for the report query period. - Represents the final date up to which data will be collected. - The date should be in YYYY-MM-DD format. - Example values: '2025-02-03', '2024-12-31'.

Responses

Request samples

Content type
application/json
{
  • "start_date": "2025-01-27",
  • "end_date": "2025-02-03"
}

Response samples

Content type
application/json
{}

Reports by zone pull statuscodes

Get reports of zone pull statuscodes

Authorizations:
apikeyAuth
path Parameters
zoneid
required
string
Example: <string>

(Required) Zone ID

header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
frequency
any
start_date
any
end_date
any

Responses

Request samples

Content type
application/json
{
  • "frequency": null,
  • "start_date": null,
  • "end_date": null
}

Response samples

Content type
application/json
{
  • "result": null,
  • "stats": null
}

Reports by zone pull country

Get reports of zone pull country

Authorizations:
apikeyAuth
path Parameters
zoneid
required
string
Example: <string>

(Required) Zone ID

header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
frequency
any
start_date
any
end_date
any

Responses

Request samples

Content type
application/json
{
  • "frequency": null,
  • "start_date": null,
  • "end_date": null
}

Response samples

Content type
application/json
{
  • "result": null,
  • "stats": null
}

Reports by zone pull browsers

Get reports of zone browsers

Authorizations:
apikeyAuth
path Parameters
zoneid
required
string
Example: <string>

(Required) Zone ID

header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
frequency
any
start_date
any
end_date
any

Responses

Request samples

Content type
application/json
{
  • "frequency": null,
  • "start_date": null,
  • "end_date": null
}

Response samples

Content type
application/json
{
  • "result": null,
  • "stats": null
}

Reports by zone pull os

Get reports of zone os

Authorizations:
apikeyAuth
path Parameters
zoneid
required
string
Example: <string>

(Required) Zone ID

header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
frequency
any
start_date
any
end_date
any

Responses

Request samples

Content type
application/json
{
  • "frequency": null,
  • "start_date": null,
  • "end_date": null
}

Response samples

Content type
application/json
{
  • "result": null,
  • "stats": null
}

Reports by zone pull visitors

Get reports of zone visitors

Authorizations:
apikeyAuth
path Parameters
zoneid
required
string
Example: <string>

(Required) Zone ID

header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
frequency
any
start_date
any
end_date
any

Responses

Request samples

Content type
application/json
{
  • "frequency": null,
  • "start_date": null,
  • "end_date": null
}

Response samples

Content type
application/json
{
  • "result": null,
  • "stats": null
}

HTTP Push Enterprise Reports

HTTP Push Reports for Enterprise Network

Reports by zone push traffic

Get reports of zone push traffic

Authorizations:
apikeyAuth
path Parameters
zoneid
required
string
Example: <string>

(Required) Zone ID

header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
r
any
t
any
m
any

Responses

Request samples

Content type
application/json
{
  • "r": null,
  • "t": null,
  • "m": null
}

Response samples

Content type
application/json
{
  • "result": null,
  • "bytesByTime": null,
  • "bytesByCPC": null,
  • "hitsByTime": null,
  • "mhitsByTime": null
}

Reports by zone push duv

Get reports of zone push duv

Authorizations:
apikeyAuth
path Parameters
zoneid
required
string
Example: <string>

(Required) Zone ID

query Parameters
r
string
Example: r=<string>

Enter date range

header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": null
}

Reports by zone push topvisitors

Get reports of zone push topvisitors

Authorizations:
apikeyAuth
path Parameters
zoneid
required
string
Example: <string>

(Required) Zone ID

query Parameters
r
string
Example: r=<string>

Enter date range

header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": null,
  • "bytesByIP": null,
  • "hitsByIP": null
}

Reports by zone push bybo

Get reports of zone push bybo

Authorizations:
apikeyAuth
path Parameters
zoneid
required
string
Example: <string>

(Required) Zone ID

query Parameters
r
string
Example: r=<string>

Enter date range

header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": null,
  • "hitsByBrowser": null,
  • "hitsByOS": null
}

Reports by zone push bygeo

Get reports of zone push bygeo

Authorizations:
apikeyAuth
path Parameters
zoneid
required
string
Example: <string>

(Required) Zone ID

query Parameters
r
string
Example: r=<string>

Enter date range

header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": null,
  • "trafficByCountry": null
}

Reports by zone push uv

Get reports of zone push uv

Authorizations:
apikeyAuth
path Parameters
zoneid
required
string
Example: <string>

(Required) Zone ID

query Parameters
t
string
Example: t=<string>

(Required) Enter daily or hourly

header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": null,
  • "uvByTime": null
}

Reports by zone push urlresponse

Get reports of zone push urlresponse

Authorizations:
apikeyAuth
path Parameters
zoneid
required
string
Example: <string>

(Required) Zone ID

query Parameters
m
string
Example: m=<string>

(Required) Enter reported by

header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": null,
  • "urlrByTime": null,
  • "urlrByUrl": null
}

Reports by zone push urltraffic

Get reports of zone push urltraffic

Authorizations:
apikeyAuth
path Parameters
zoneid
required
string
Example: <string>

(Required) Zone ID

query Parameters
m
string
Example: m=<string>

(Required) Enter reported by

header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": null,
  • "urlBytesByUrl": null,
  • "urlHitsByUrl": null
}

HTTP Pull Enterprise Reports

HTTP Pull Reports for Enterprise Network

Reports by zone pull traffic

Get reports of zone pull traffic

Authorizations:
apikeyAuth
path Parameters
zoneid
required
string
Example: <string>

(Required) Zone ID

header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
r
any
t
any
m
any

Responses

Request samples

Content type
application/json
{
  • "r": null,
  • "t": null,
  • "m": null
}

Response samples

Content type
application/json
{
  • "result": null,
  • "bytesByTime": null,
  • "bytesByCPC": null,
  • "hitsByTime": null,
  • "mhitsByTime": null
}

Reports by zone pull duv

Get reports of zone pull duv

Authorizations:
apikeyAuth
path Parameters
zoneid
required
string
Example: <string>

(Required) Zone ID

query Parameters
r
string
Example: r=<string>

Enter date range

header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": null,
  • "duvByTime": null,
  • "duvByCountry": null,
  • "duvByState": null,
  • "duvByProvince": null,
  • "duvByOS": null
}

Reports by zone pull topvisitors

Get reports of zone pull topvisitors

Authorizations:
apikeyAuth
path Parameters
zoneid
required
string
Example: <string>

(Required) Zone ID

query Parameters
r
string
Example: r=<string>

Enter date range

header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": null,
  • "bytesByIP": null,
  • "hitsByIP": null
}

Reports by zone pull bybo

Get reports of zone pull bybo

Authorizations:
apikeyAuth
path Parameters
zoneid
required
string
Example: <string>

(Required) Zone ID

query Parameters
r
string
Example: r=<string>

Enter date range

header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": null,
  • "hitsByBrowser": null,
  • "hitsByOS": null
}

Reports by zone pull bygeo

Get reports of zone pull bygeo

Authorizations:
apikeyAuth
path Parameters
zoneid
required
string
Example: <string>

(Required) Zone ID

query Parameters
r
string
Example: r=<string>

Enter date range

header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": null,
  • "trafficByCountry": null
}

Reports by zone pull uv

Get reports of zone pull uv

Authorizations:
apikeyAuth
path Parameters
zoneid
required
string
Example: <string>

(Required) Zone ID

query Parameters
t
string
Example: t=<string>

(Required) Enter daily or hourly

header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": null,
  • "uvByTime": null
}

Reports by zone pull urlresponse

Get reports of zone pull urlresponse

Authorizations:
apikeyAuth
path Parameters
zoneid
required
string
Example: <string>

(Required) Zone ID

query Parameters
m
string
Example: m=<string>

(Required) Enter reported by

header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": null,
  • "urlrByTime": null,
  • "urlrByUrl": null
}

Reports by zone pull urltraffic

Get reports of zone pull urltraffic

Authorizations:
apikeyAuth
path Parameters
zoneid
required
string
Example: <string>

(Required) Zone ID

query Parameters
m
string
Example: m=<string>

(Required) Enter reported by

header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": null,
  • "urlBytesByUrl": null,
  • "urlHitsByUrl": null
}

HTTP Push Volume/Premium Reports

HTTP Push Volume/Premium Reports for Volume/Premium Network

Statistics

Authorizations:
apikeyAuth
path Parameters
zoneid
required
string
Example: <string>

(Required) Zone ID

query Parameters
r
string
Example: r=<string>

Month/Granularity, Granularity can be daily/hourly

header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": null,
  • "stats": null
}

Cache

Authorizations:
apikeyAuth
path Parameters
zoneid
required
string
Example: <string>

(Required) Zone ID

query Parameters
r
string
Example: r=<string>

granularity/0/from/to Granularity: 0 (Minute), 1 (Hour), 2 (Day)

header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": null,
  • "stats": null,
  • "edgegroups": null
}

Top Files

Authorizations:
apikeyAuth
path Parameters
zoneid
required
string
Example: <string>

(Required) Zone ID

query Parameters
r
string
Example: r=<string>

from/to/type, type -> dynamic

header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": null,
  • "stats": null
}

Status Codes

Authorizations:
apikeyAuth
path Parameters
zoneid
required
string
Example: <string>

(Required) Zone ID

query Parameters
r
string
Example: r=<string>

granularity/from/to Granularity: 0 (Minute), 1 (Hour), 2 (Day)

header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": null,
  • "stats": null
}

By Country

Authorizations:
apikeyAuth
path Parameters
zoneid
required
string
Example: <string>

(Required) Zone ID

query Parameters
r
string
Example: r=<string>

granularity/from/to Granularity: 0 (Minute), 1 (Hour), 2 (Day)

header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": null,
  • "stats": null
}

By Browsers

Authorizations:
apikeyAuth
path Parameters
zoneid
required
string
Example: <string>

(Required) Zone ID

query Parameters
r
string
Example: r=<string>

granularity/from/to Granularity: 0 (Minute), 1 (Hour), 2 (Day)

header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": null,
  • "stats": null
}

By OS

Authorizations:
apikeyAuth
path Parameters
zoneid
required
string
Example: <string>

(Required) Zone ID

query Parameters
r
string
Example: r=<string>

granularity/from/to Granularity: 0 (Minute), 1 (Hour), 2 (Day)

header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": null,
  • "stats": null
}

By Device

Authorizations:
apikeyAuth
path Parameters
zoneid
required
string
Example: <string>

(Required) Zone ID

query Parameters
r
string
Example: r=<string>

granularity/from/to Granularity: 0 (Minute), 1 (Hour), 2 (Day)

header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": null,
  • "stats": null
}

CDN Logs

Authorizations:
apikeyAuth
path Parameters
zoneid
required
string
Example: <string>

(Required) Zone ID

query Parameters
from
string
Example: from=<string>
to
string
Example: to=<string>
limit
string
Example: limit=<integer>

max: 1000

offset
string
Example: offset=<integer>
header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{ }

HTTP Pull Volume/Premium Reports

HTTP Pull Volume/Premium Reports for Volume/Premium Network

Statistics

Authorizations:
apikeyAuth
path Parameters
zoneid
required
string
Example: <string>

(Required) Zone ID

query Parameters
r
string
Example: r=<string>

Month/Granularity, Granularity can be daily/hourly

header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": null,
  • "stats": null
}

Cache

Authorizations:
apikeyAuth
path Parameters
zoneid
required
string
Example: <string>

(Required) Zone ID

query Parameters
r
string
Example: r=<string>

granularity/0/from/to Granularity: 0 (Minute), 1 (Hour), 2 (Day)

header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": null,
  • "stats": null,
  • "edgegroups": null
}

Top Files

Authorizations:
apikeyAuth
path Parameters
zoneid
required
string
Example: <string>

(Required) Zone ID

query Parameters
r
string
Example: r=<string>

from/to/type, type -> dynamic

header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": null,
  • "stats": null
}

Status Codes

Authorizations:
apikeyAuth
path Parameters
zoneid
required
string
Example: <string>

(Required) Zone ID

query Parameters
r
string
Example: r=<string>

granularity/from/to Granularity: 0 (Minute), 1 (Hour), 2 (Day)

header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": null,
  • "stats": null
}

By Country

Authorizations:
apikeyAuth
path Parameters
zoneid
required
string
Example: <string>

(Required) Zone ID

query Parameters
r
string
Example: r=<string>

granularity/from/to Granularity: 0 (Minute), 1 (Hour), 2 (Day)

header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": null,
  • "stats": null
}

By Browsers

Authorizations:
apikeyAuth
path Parameters
zoneid
required
string
Example: <string>

(Required) Zone ID

query Parameters
r
string
Example: r=<string>

granularity/from/to Granularity: 0 (Minute), 1 (Hour), 2 (Day)

header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": null,
  • "stats": null
}

By OS

Authorizations:
apikeyAuth
path Parameters
zoneid
required
string
Example: <string>

(Required) Zone ID

query Parameters
r
string
Example: r=<string>

granularity/from/to Granularity: 0 (Minute), 1 (Hour), 2 (Day)

header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": null,
  • "stats": null
}

By Device

Authorizations:
apikeyAuth
path Parameters
zoneid
required
string
Example: <string>

(Required) Zone ID

query Parameters
r
string
Example: r=<string>

granularity/from/to Granularity: 0 (Minute), 1 (Hour), 2 (Day)

header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": null,
  • "stats": null
}

CDN Logs

Authorizations:
apikeyAuth
path Parameters
zoneid
required
string
Example: <string>

(Required) Zone ID

query Parameters
from
string
Example: from=<string>
to
string
Example: to=<string>
limit
string
Example: limit=<integer>

max: 1000

offset
string
Example: offset=<integer>
header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{ }

VoD Push Standard Reports

VoD Push Reports for Standard Network

Reports by zone vod push summary

Get reports of zone vod push summary

Authorizations:
apikeyAuth
path Parameters
zoneid
required
string
Example: <string>

(Required) Zone ID

header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
range
any
type
any

Responses

Request samples

Content type
application/json
{
  • "range": null,
  • "type": null
}

Response samples

Content type
application/json
{
  • "result": null,
  • "stats": null
}

Reports by zone vod push cache

Get reports of zone vod push cache

Authorizations:
apikeyAuth
path Parameters
zoneid
required
string
Example: <string>

(Required) Zone ID

header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
frequency
any
filter_type
any
start_date
any
end_date
any

Responses

Request samples

Content type
application/json
{
  • "frequency": null,
  • "filter_type": null,
  • "start_date": null,
  • "end_date": null
}

Response samples

Content type
application/json
{
  • "result": null,
  • "stats": null
}

Reports by zone vod push topfiles

Get reports of zone vod push topfiles

Authorizations:
apikeyAuth
path Parameters
zoneid
required
string
Example: <string>

(Required) Zone ID

header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
start_date
any
end_date
any
type
any

Responses

Request samples

Content type
application/json
{
  • "start_date": null,
  • "end_date": null,
  • "type": null
}

Response samples

Content type
application/json
{
  • "result": null,
  • "stats": null
}

Reports by zone vod push topreferrers

Get reports of zone vod push topreferrers

Authorizations:
apikeyAuth
path Parameters
zoneid
required
string
Example: <string>

(Required) Zone ID

header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
start_date
any
end_date
any

Responses

Request samples

Content type
application/json
{
  • "start_date": null,
  • "end_date": null
}

Response samples

Content type
application/json
{
  • "result": null,
  • "stats": null
}

Reports by zone vod push statuscodes

Get reports of zone vod push statuscodes

Authorizations:
apikeyAuth
path Parameters
zoneid
required
string
Example: <string>

(Required) Zone ID

header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
frequency
any
start_date
any
end_date
any

Responses

Request samples

Content type
application/json
{
  • "frequency": null,
  • "start_date": null,
  • "end_date": null
}

Response samples

Content type
application/json
{
  • "result": null,
  • "stats": null
}

Reports by zone vod push countries

Get reports of zone vod push countries

Authorizations:
apikeyAuth
path Parameters
zoneid
required
string
Example: <string>

(Required) Zone ID

header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
frequency
any
start_date
any
end_date
any

Responses

Request samples

Content type
application/json
{
  • "frequency": null,
  • "start_date": null,
  • "end_date": null
}

Response samples

Content type
application/json
{
  • "result": null,
  • "stats": null
}

Reports by zone vod push browsers

Get reports of zone vod push browsers

Authorizations:
apikeyAuth
path Parameters
zoneid
required
string
Example: <string>

(Required) Zone ID

header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
frequency
any
start_date
any
end_date
any

Responses

Request samples

Content type
application/json
{
  • "frequency": null,
  • "start_date": null,
  • "end_date": null
}

Response samples

Content type
application/json
{
  • "result": null,
  • "stats": null
}

Reports by zone vod push os

Get reports of zone vod push os

Authorizations:
apikeyAuth
path Parameters
zoneid
required
string
Example: <string>

(Required) Zone ID

header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
frequency
any
start_date
any
end_date
any

Responses

Request samples

Content type
application/json
{
  • "frequency": null,
  • "start_date": null,
  • "end_date": null
}

Response samples

Content type
application/json
{
  • "result": null,
  • "stats": null
}

Reports by zone vod push visitors

Get reports of zone vod push visitors

Authorizations:
apikeyAuth
path Parameters
zoneid
required
string
Example: <string>

(Required) Zone ID

header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
frequency
any
start_date
any
end_date
any

Responses

Request samples

Content type
application/json
{
  • "frequency": null,
  • "start_date": null,
  • "end_date": null
}

Response samples

Content type
application/json
{
  • "result": null,
  • "stats": null
}

VoD Pull Standard Reports

VoD Pull Reports for Standard Network

Reports by zone vod pull summary

Get reports of zone vod pull summary

Authorizations:
apikeyAuth
path Parameters
zoneid
required
string
Example: <string>

(Required) Zone ID

header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
range
any
type
any

Responses

Request samples

Content type
application/json
{
  • "range": null,
  • "type": null
}

Response samples

Content type
application/json
{
  • "result": null,
  • "stats": null
}

Reports by zone vod pull cache

Get reports of zone vod pull cache

Authorizations:
apikeyAuth
path Parameters
zoneid
required
string
Example: <string>

(Required) Zone ID

header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
frequency
any
filter_type
any
start_date
any
end_date
any

Responses

Request samples

Content type
application/json
{
  • "frequency": null,
  • "filter_type": null,
  • "start_date": null,
  • "end_date": null
}

Response samples

Content type
application/json
{
  • "result": null,
  • "stats": null
}

Reports by zone vod pull topfiles

Get reports of zone vod pull topfiles

Authorizations:
apikeyAuth
path Parameters
zoneid
required
string
Example: <string>

(Required) Zone ID

header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
start_date
any
end_date
any
type
any

Responses

Request samples

Content type
application/json
{
  • "start_date": null,
  • "end_date": null,
  • "type": null
}

Response samples

Content type
application/json
{
  • "result": null,
  • "stats": null
}

Reports by zone vod pull topreferrers

Get reports of zone vod pull topreferrers

Authorizations:
apikeyAuth
path Parameters
zoneid
required
string
Example: <string>

(Required) Zone ID

header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
start_date
any
end_date
any

Responses

Request samples

Content type
application/json
{
  • "start_date": null,
  • "end_date": null
}

Response samples

Content type
application/json
{
  • "result": null,
  • "stats": null
}

Reports by zone vod push statuscodes

Get reports of zone vod push statuscodes

Authorizations:
apikeyAuth
path Parameters
zoneid
required
string
Example: <string>

(Required) Zone ID

header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
frequency
any
start_date
any
end_date
any

Responses

Request samples

Content type
application/json
{
  • "frequency": null,
  • "start_date": null,
  • "end_date": null
}

Response samples

Content type
application/json
{
  • "result": null,
  • "stats": null
}

Reports by zone vod pull countries

Get reports of zone vod pull countries

Authorizations:
apikeyAuth
path Parameters
zoneid
required
string
Example: <string>

(Required) Zone ID

header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
frequency
any
start_date
any
end_date
any

Responses

Request samples

Content type
application/json
{
  • "frequency": null,
  • "start_date": null,
  • "end_date": null
}

Response samples

Content type
application/json
{
  • "result": null,
  • "stats": null
}

Reports by zone vod pull browsers

Get reports of zone vod pull browsers

Authorizations:
apikeyAuth
path Parameters
zoneid
required
string
Example: <string>

(Required) Zone ID

header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
frequency
any
start_date
any
end_date
any

Responses

Request samples

Content type
application/json
{
  • "frequency": null,
  • "start_date": null,
  • "end_date": null
}

Response samples

Content type
application/json
{
  • "result": null,
  • "stats": null
}

Reports by zone vod pull os

Get reports of zone vod pull os

Authorizations:
apikeyAuth
path Parameters
zoneid
required
string
Example: <string>

(Required) Zone ID

header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
frequency
any
start_date
any
end_date
any

Responses

Request samples

Content type
application/json
{
  • "frequency": null,
  • "start_date": null,
  • "end_date": null
}

Response samples

Content type
application/json
{
  • "result": null,
  • "stats": null
}

Reports by zone vod pull visitors

Get reports of zone vod pull visitors

Authorizations:
apikeyAuth
path Parameters
zoneid
required
string
Example: <string>

(Required) Zone ID

header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
frequency
any
start_date
any
end_date
any

Responses

Request samples

Content type
application/json
{
  • "frequency": null,
  • "start_date": null,
  • "end_date": null
}

Response samples

Content type
application/json
{
  • "result": null,
  • "stats": null
}

VoD Push Enterprise Reports

VoD Push Reports for Enterprise Network

Reports by zone vod push traffic

Get reports of zone vod push traffic

Authorizations:
apikeyAuth
path Parameters
zoneid
required
string
Example: <string>

(Required) Zone ID

header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
r
any
t
any
m
any

Responses

Request samples

Content type
application/json
{
  • "r": null,
  • "t": null,
  • "m": null
}

Response samples

Content type
application/json
{
  • "result": null,
  • "bytesByTime": null,
  • "bytesByCPC": null,
  • "hitsByTime": null,
  • "mhitsByTime": null
}

Reports by zone vod push duv

Get reports of zone vod push duv

Authorizations:
apikeyAuth
path Parameters
zoneid
required
string
Example: <string>

(Required) Zone ID

query Parameters
r
string
Example: r=<string>

Enter date range

header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": null,
  • "duvByTime": null,
  • "duvByCountry": null,
  • "duvByState": null,
  • "duvByProvince": null,
  • "duvByOS": null
}

Reports by zone vod push topvisitors

Get reports of zone vod push topvisitors

Authorizations:
apikeyAuth
path Parameters
zoneid
required
string
Example: <string>

(Required) Zone ID

query Parameters
r
string
Example: r=<string>

Enter date range

header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": null,
  • "bytesByIP": null,
  • "hitsByIP": null
}

Reports by zone vod push bybo

Get reports of zone vod push bybo

Authorizations:
apikeyAuth
path Parameters
zoneid
required
string
Example: <string>

(Required) Zone ID

query Parameters
r
string
Example: r=<string>

Enter date range

header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": null,
  • "hitsByBrowser": null,
  • "hitsByOS": null
}

Reports by zone vod push bygeo

Get reports of zone vod push bygeo

Authorizations:
apikeyAuth
path Parameters
zoneid
required
string
Example: <string>

(Required) Zone ID

query Parameters
r
string
Example: r=<string>

Enter date range

header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": null,
  • "trafficByCountry": null
}

Reports by zone vod push uv

Get reports of zone vod push uv

Authorizations:
apikeyAuth
path Parameters
zoneid
required
string
Example: <string>

(Required) Zone ID

query Parameters
t
string
Example: t=<string>

(Required) Enter daily or hourly

header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": null,
  • "uvByTime": null
}

Reports by zone vod push urlresponse

Get reports of zone vod push urlresponse

Authorizations:
apikeyAuth
path Parameters
zoneid
required
string
Example: <string>

(Required) Zone ID

query Parameters
m
string
Example: m=<string>

(Required) Enter reported by

header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": null,
  • "urlrByTime": null,
  • "urlrByUrl": null
}

Reports by zone vod push urltraffic

Get reports of zone vod push urltraffic

Authorizations:
apikeyAuth
path Parameters
zoneid
required
string
Example: <string>

(Required) Zone ID

query Parameters
m
string
Example: m=<string>

(Required) Enter reported by

header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": null,
  • "urlBytesByUrl": null,
  • "urlHitsByUrl": null
}

VoD Pull Enterprise Reports

VoD Pull Reports for Enterprise Network

Reports by zone vod pull traffic

Get reports of zone vod pull traffic

Authorizations:
apikeyAuth
path Parameters
zoneid
required
string
Example: <string>

(Required) Zone ID

header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
r
any
t
any
m
any

Responses

Request samples

Content type
application/json
{
  • "r": null,
  • "t": null,
  • "m": null
}

Response samples

Content type
application/json
{
  • "result": null,
  • "bytesByTime": null,
  • "bytesByCPC": null,
  • "hitsByTime": null,
  • "mhitsByTime": null
}

Reports by zone vod pull duv

Get reports of zone vod pull duv

Authorizations:
apikeyAuth
path Parameters
zoneid
required
string
Example: <string>

(Required) Zone ID

query Parameters
r
string
Example: r=<string>

Enter date range

header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": null,
  • "duvByTime": null,
  • "duvByCountry": null,
  • "duvByState": null,
  • "duvByProvince": null,
  • "duvByOS": null
}

Reports by zone vod pull topvisitors

Get reports of zone vod pull topvisitors

Authorizations:
apikeyAuth
path Parameters
zoneid
required
string
Example: <string>

(Required) Zone ID

query Parameters
r
string
Example: r=<string>

Enter date range

header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": null,
  • "bytesByIP": null,
  • "hitsByIP": null
}

Reports by zone vod pull bybo

Get reports of zone vod pull bybo

Authorizations:
apikeyAuth
path Parameters
zoneid
required
string
Example: <string>

(Required) Zone ID

query Parameters
r
string
Example: r=<string>

Enter date range

header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": null,
  • "hitsByBrowser": null,
  • "hitsByOS": null
}

Reports by zone vod pull bygeo

Get reports of zone vod pull bygeo

Authorizations:
apikeyAuth
path Parameters
zoneid
required
string
Example: <string>

(Required) Zone ID

query Parameters
r
string
Example: r=<string>

Enter date range

header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": null,
  • "trafficByCountry": null
}

Reports by zone vod pull uv

Get reports of zone vod pull uv

Authorizations:
apikeyAuth
path Parameters
zoneid
required
string
Example: <string>

(Required) Zone ID

query Parameters
t
string
Example: t=<string>

(Required) Enter daily or hourly

header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": null,
  • "uvByTime": null
}

Reports by zone vod pull urlresponse

Get reports of zone vod pull urlresponse

Authorizations:
apikeyAuth
path Parameters
zoneid
required
string
Example: <string>

(Required) Zone ID

query Parameters
m
string
Example: m=<string>

(Required) Enter reported by

header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": null,
  • "urlrByTime": null,
  • "urlrByUrl": null
}

Reports by zone vod pull urltraffic

Get reports of zone vod pull urltraffic

Authorizations:
apikeyAuth
path Parameters
zoneid
required
string
Example: <string>

(Required) Zone ID

query Parameters
m
string
Example: m=<string>

(Required) Enter reported by

header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": null,
  • "urlBytesByUrl": null,
  • "urlHitsByUrl": null
}

VoD Push Volume/Premium Reports

VoD Push Reports for Volume/Premium Network

Statistics

Authorizations:
apikeyAuth
path Parameters
zoneid
required
string
Example: <string>

(Required) Zone ID

query Parameters
r
string
Example: r=<string>

Month/Granularity, Granularity can be daily/hourly

header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": null,
  • "stats": null
}

Cache

Authorizations:
apikeyAuth
path Parameters
zoneid
required
string
Example: <string>

(Required) Zone ID

query Parameters
r
string
Example: r=<string>

granularity/0/from/to Granularity: 0 (Minute), 1 (Hour), 2 (Day)

header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": null,
  • "stats": null,
  • "edgegroups": null
}

Top Files

Authorizations:
apikeyAuth
path Parameters
zoneid
required
string
Example: <string>

(Required) Zone ID

query Parameters
r
string
Example: r=<string>

from/to/type, type -> dynamic

header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": null,
  • "stats": null
}

Status Codes

Authorizations:
apikeyAuth
path Parameters
zoneid
required
string
Example: <string>

(Required) Zone ID

query Parameters
r
string
Example: r=<string>

granularity/from/to Granularity: 0 (Minute), 1 (Hour), 2 (Day)

header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": null,
  • "stats": null
}

By Country

Authorizations:
apikeyAuth
path Parameters
zoneid
required
string
Example: <string>

(Required) Zone ID

query Parameters
r
string
Example: r=<string>

granularity/from/to Granularity: 0 (Minute), 1 (Hour), 2 (Day)

header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": null,
  • "stats": null
}

By Browsers

Authorizations:
apikeyAuth
path Parameters
zoneid
required
string
Example: <string>

(Required) Zone ID

query Parameters
r
string
Example: r=<string>

granularity/from/to Granularity: 0 (Minute), 1 (Hour), 2 (Day)

header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": null,
  • "stats": null
}

By OS

Authorizations:
apikeyAuth
path Parameters
zoneid
required
string
Example: <string>

(Required) Zone ID

query Parameters
r
string
Example: r=<string>

granularity/from/to Granularity: 0 (Minute), 1 (Hour), 2 (Day)

header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": null,
  • "stats": null
}

By Device

Authorizations:
apikeyAuth
path Parameters
zoneid
required
string
Example: <string>

(Required) Zone ID

query Parameters
r
string
Example: r=<string>

granularity/from/to Granularity: 0 (Minute), 1 (Hour), 2 (Day)

header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": null,
  • "stats": null
}

CDN Logs

Authorizations:
apikeyAuth
path Parameters
zoneid
required
string
Example: <string>

(Required) Zone ID

query Parameters
from
string
Example: from=<string>
to
string
Example: to=<string>
limit
string
Example: limit=<integer>

max: 1000

offset
string
Example: offset=<integer>
header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{ }

VoD Pull Volume/Premium Reports

VoD Pull Reports for Volume/Premium Network

Statistics

Authorizations:
apikeyAuth
path Parameters
zoneid
required
string
Example: <string>

(Required) Zone ID

query Parameters
r
string
Example: r=<string>

Month/Granularity, Granularity can be daily/hourly

header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": null,
  • "stats": null
}

Cache

Authorizations:
apikeyAuth
path Parameters
zoneid
required
string
Example: <string>

(Required) Zone ID

query Parameters
r
string
Example: r=<string>

granularity/0/from/to Granularity: 0 (Minute), 1 (Hour), 2 (Day)

header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": null,
  • "stats": null,
  • "edgegroups": null
}

Top Files

Authorizations:
apikeyAuth
path Parameters
zoneid
required
string
Example: <string>

(Required) Zone ID

query Parameters
r
string
Example: r=<string>

from/to/type, type -> dynamic

header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": null,
  • "stats": null
}

Status Codes

Authorizations:
apikeyAuth
path Parameters
zoneid
required
string
Example: <string>

(Required) Zone ID

query Parameters
r
string
Example: r=<string>

granularity/from/to Granularity: 0 (Minute), 1 (Hour), 2 (Day)

header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": null,
  • "stats": null
}

By Country

Authorizations:
apikeyAuth
path Parameters
zoneid
required
string
Example: <string>

(Required) Zone ID

query Parameters
r
string
Example: r=<string>

granularity/from/to Granularity: 0 (Minute), 1 (Hour), 2 (Day)

header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": null,
  • "stats": null
}

By Browsers

Authorizations:
apikeyAuth
path Parameters
zoneid
required
string
Example: <string>

(Required) Zone ID

query Parameters
r
string
Example: r=<string>

granularity/from/to Granularity: 0 (Minute), 1 (Hour), 2 (Day)

header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": null,
  • "stats": null
}

By OS

Authorizations:
apikeyAuth
path Parameters
zoneid
required
string
Example: <string>

(Required) Zone ID

query Parameters
r
string
Example: r=<string>

granularity/from/to Granularity: 0 (Minute), 1 (Hour), 2 (Day)

header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": null,
  • "stats": null
}

By Device

Authorizations:
apikeyAuth
path Parameters
zoneid
required
string
Example: <string>

(Required) Zone ID

query Parameters
r
string
Example: r=<string>

granularity/from/to Granularity: 0 (Minute), 1 (Hour), 2 (Day)

header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": null,
  • "stats": null
}

CDN Logs

Authorizations:
apikeyAuth
path Parameters
zoneid
required
string
Example: <string>

(Required) Zone ID

query Parameters
from
string
Example: from=<string>
to
string
Example: to=<string>
limit
string
Example: limit=<integer>

max: 1000

offset
string
Example: offset=<integer>
header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{ }