Add CDN Resource

Posthttps://api.cdn77.com/v3/cdn

Request body≥1 required

cacheobject
Your files will remain cached for the specified duration, after which your origin will be checked for an updated version of your files. Expiry/cache-control headers override this setting.
- max_ageinteger
  In minutes.
  Available values: 10, 30, 60, 240, 720, 1440, 2160, 2880, 4320, 5760, 7200, 8640, 10800, 11520, 12960, 14400, 15840, 17280
- max_age_404integer
  In seconds. Use null to set the default value.
  Available values: 1, 5, 10, 30, 60, 300, 3600
- requests_with_cookies_enabledboolean
  When disabled, requests with cookies will ignore changing cookie headers allowing all requests to hit the cache. When enabled, requests with cookies will be handled separately, so when the cookie changes it will not hit the previously cached request with different cookie options.
cnamesarray of strings
All CNAMEs should be mapped via DNS to CDN URL. Otherwise it's not possible to generate SSL certificate. Maximum number of CNAMEs is "10". To add more, contact our support.
geo_protectionobject
Geo protection enables you to control which countries can access your content directly.
- countriesarray of strings
  We are using ISO 3166-1 alpha-2 code. For full list check Wikipedia.
- typestring
  With "type": "blocklist" all values set are not allowed. With "type": "passlist" only values set are allowed.
  Available values: blocklist, disabled, passlist
headersobject
- cors_enabledboolean
  The "Access-Control-Allow-Origin:" response header will always act in accordance with the "Origin:" request header sent by the client. For example, a request including the HTTP header "Origin: https://www.cdn77.com" will translate to the response header "Access-Control-Allow-Origin: https://www.cdn77.com". Files remain cached while the request/response header changes.
- cors_timing_enabledboolean
  When enabled "Timing-Allow-Origin" CORS header is set.
- cors_wildcard_enabledboolean
  When enabled the wildcard value (*) is set in CORS headers.
- host_header_forwarding_enabledboolean
  When fetching the content from the origin server, our edge servers will pass the host header that was included in the request between the user and our edge server.
- content_dispositionobject
  When the "type" is set to "parameter" the Content-Disposition is defined by the "cd" parameter in the URL, often set to "attachment". The filename is specified using the "fn" parameter in the URL.
  typestring
  Available values: none, parameter
hotlink_protectionobject
Hotlink protection enables you to control which hostnames/domains can link to and access your content directly.
- domainsarray of strings
- typestring
  With "type": "blocklist" all values set are not allowed. With "type": "passlist" only values set are allowed.
  Available values: blocklist, disabled, passlist
- empty_referer_deniedbooleanrequired
  Enabling this parameter prevents your content from being directly accessed by sources that send empty referrers.
https_redirectobject
If enabled, all requests via HTTP are redirected to HTTPS. Verify HTTPS availability of CNAMEs before activating, if applicable.
- codeinteger
  301 for permanent redirect and 302 for temporary redirect. If you are not sure, select the default 301 code.
  Available values: 301, 302
- enabledbooleanrequired
ip_protectionobject
IP protection enables you to control which networks can access your content directly.
- ipsarray of strings
- typestring
  With "type": "blocklist" all values set are not allowed. With "type": "passlist" only values set are allowed.
  Available values: blocklist, disabled, passlist
labelstringrequired
The label helps you to identify your CDN Resource.
notestring
Optional note for the CDN Resource.
mp4_pseudo_streamingobject
Turn this option on if using a flash-based video player with MP4 files. Pseudo-streaming is used mainly in flash players. HTML5 players use range-requests. When enabled the "query_string" option must be set to ignore all parameters.
- enabledboolean
origin_idstringrequired
ID of attached Origin (content source for CDN Resource). More information in our Origin API documentation.
origin_headersobject
- customobjectrequired
  Custom HTTP headers included in requests sent to the origin server.
  additionalProp1string
  additionalProp2string
  additionalProp3string
response_headersobject
Custom HTTP headers included in response sent to the client.
- headersarray of objects
  Custom HTTP headers included in response sent to client. Pass an empty array to remove all custom response headers.
query_stringobject
Enabling this feature will ignore the query string, allowing URLs with query strings to cache properly. This is particularly useful if you tag your URLs with tracking/marketing parameters, for example.
- parametersarray of strings
  List of parameters used when "ignore_type" is set to "list".
- ignore_typestring
  Available values: all, list, none
rate_limitobject
When enabled, this feature limits the data transfer rate by setting "limit_rate" based on the "rs" URL parameter and "limit_rate_after" by the value from the "ri" URL parameter.
- enabledbooleanrequired
secure_tokenobject
This feature allows you to serve your content using signed URLs. You can enable your users to download secured content from the CDN Resource with a valid hash. Note: When you check this option, make sure to generate secured links to access your content. Maximum length is 64 characters.
- tokenstring
  Token length is between 8 and 64 characters.
- typestring
  
  parameter - Token will be in the query string - e.g.:/video.mp4?secure=MY_SECURE_TOKEN.
  
  path - Token will be in the path - e.g.:/MY_SECURE_TOKEN/video.mp4.
  
  none - Use to disable secure token.
  
  highwinds
  
  Available values: highwinds, none, parameter, path
sslobject
- typestring
  Available values: instantSsl, none, SNI
- ssl_idstring, format UUIDv4
  ID of the SSL certificate.

Example of the request body

{
  "cache": {
    "max_age": 1440,
    "max_age_404": 1,
    "requests_with_cookies_enabled": false
  },
  "cnames": [
    "cname.your-domain.com"
  ],
  "geo_protection": {
    "countries": [
      "UK"
    ],
    "type": "passlist"
  },
  "headers": {
    "cors_enabled": true,
    "cors_timing_enabled": false,
    "cors_wildcard_enabled": false,
    "host_header_forwarding_enabled": false,
    "content_disposition": {
      "type": "parameter"
    }
  },
  "hotlink_protection": {
    "domains": [
      "some-domain.com"
    ],
    "type": "passlist",
    "empty_referer_denied": true
  },
  "https_redirect": {
    "code": 301,
    "enabled": false
  },
  "ip_protection": {
    "ips": [
      "8.8.8.8"
    ],
    "type": "passlist"
  },
  "label": "My cdn",
  "note": "Note for my CDN",
  "mp4_pseudo_streaming": {
    "enabled": false
  },
  "origin_id": "e56564d1-8d3e-4457-93a6-082b054bc736",
  "origin_headers": {
    "custom": {
      "additionalProp1": "default-src 'self' *.example.com; img-src *",
      "additionalProp2": "default-src 'self' *.example.com; img-src *",
      "additionalProp3": "default-src 'self' *.example.com; img-src *"
    }
  },
  "response_headers": {
    "headers": [
      {
        "name": "X-Custom-Header",
        "value": "custom-value"
      }
    ]
  },
  "query_string": {
    "parameters": [
      "utm"
    ],
    "ignore_type": "all"
  },
  "rate_limit": {
    "enabled": false
  },
  "secure_token": {
    "token": "2Xod4tW8Ln4BDg23",
    "type": "parameter"
  },
  "ssl": {
    "type": "SNI",
    "ssl_id": "9880280c-0507-46d1-88f3-71cfee83fa57"
  }
}

Responses

Detail of the created CDN Resource.

Response parameters

idinteger
ID of the CDN Resource. This is also used as the CDN Resource URL.
cnamesarray of objects
All CNAMEs should be mapped via DNS to CDN URL. Otherwise it's not possible to generate SSL certificate. Maximum number of CNAMEs is "10". To add more, contact our support.
creation_timestring, format date-time
Timestamp when CDN Resource was created.
labelstring
The label helps you to identify your CDN Resource.
notestring
Optional note for the CDN Resource.
origin_idstring
ID of attached Origin (content source for CDN Resource). More information in our Origin API documentation.
origin_referenceobject
- idstring
  Origin ID.
- labelstring
- fallbacksarray of objects
  idstring
  Origin ID.
  labelstring
urlstring
URL of the CDN Resource. Automatically generated when the CDN Resource is created. The number is the same as the CDN Resource ID.
cacheobject
Your files will remain cached for the specified duration, after which your origin will be checked for an updated version of your files. Expiry/cache-control headers override this setting.
- max_ageinteger
  In minutes.
  Available values: 10, 30, 60, 240, 720, 1440, 2160, 2880, 4320, 5760, 7200, 8640, 10800, 11520, 12960, 14400, 15840, 17280
- max_age_404integer
  In seconds. Use null to set the default value.
  Available values: 1, 5, 10, 30, 60, 300, 3600
- requests_with_cookies_enabledboolean
  When disabled, requests with cookies will ignore changing cookie headers allowing all requests to hit the cache. When enabled, requests with cookies will be handled separately, so when the cookie changes it will not hit the previously cached request with different cookie options.
secure_tokenobject
This feature allows you to serve your content using signed URLs. You can enable your users to download secured content from the CDN Resource with a valid hash. Note: When you check this option, make sure to generate secured links to access your content. Maximum length is 64 characters.
- tokenstring
  Token length is between 8 and 64 characters.
- typestring
  
  parameter - Token will be in the query string - e.g.:/video.mp4?secure=MY_SECURE_TOKEN.
  
  path - Token will be in the path - e.g.:/MY_SECURE_TOKEN/video.mp4.
  
  none - Use to disable secure token.
  
  highwinds
  
  Available values: highwinds, none, parameter, path
query_stringobject
Enabling this feature will ignore the query string, allowing URLs with query strings to cache properly. This is particularly useful if you tag your URLs with tracking/marketing parameters, for example.
- parametersarray of strings
  List of parameters used when "ignore_type" is set to "list".
- ignore_typestring
  Available values: all, list, none
headersobject
- cors_enabledboolean
  The "Access-Control-Allow-Origin:" response header will always act in accordance with the "Origin:" request header sent by the client. For example, a request including the HTTP header "Origin: https://www.cdn77.com" will translate to the response header "Access-Control-Allow-Origin: https://www.cdn77.com". Files remain cached while the request/response header changes.
- cors_timing_enabledboolean
  When enabled "Timing-Allow-Origin" CORS header is set.
- cors_wildcard_enabledboolean
  When enabled the wildcard value (*) is set in CORS headers.
- host_header_forwarding_enabledboolean
  When fetching the content from the origin server, our edge servers will pass the host header that was included in the request between the user and our edge server.
- content_dispositionobject
  When the "type" is set to "parameter" the Content-Disposition is defined by the "cd" parameter in the URL, often set to "attachment". The filename is specified using the "fn" parameter in the URL.
  typestring
  Available values: none, parameter
https_redirectobject
If enabled, all requests via HTTP are redirected to HTTPS. Verify HTTPS availability of CNAMEs before activating, if applicable.
- codeinteger
  301 for permanent redirect and 302 for temporary redirect. If you are not sure, select the default 301 code.
  Available values: 301, 302
- enabledbooleanrequired
mp4_pseudo_streamingobject
Turn this option on if using a flash-based video player with MP4 files. Pseudo-streaming is used mainly in flash players. HTML5 players use range-requests. When enabled the "query_string" option must be set to ignore all parameters.
- enabledboolean
sslobject
- typestring
  Available values: instantSsl, none, SNI
- ssl_idstring, format UUIDv4
  ID of the SSL certificate.
streamobject
Detail parameters of stream CDN Resource.
- origin_urlstringrequired
- passwordstring
- query_keystringrequired
- protocolstringrequired
- portintegerrequired
- pathstring
hotlink_protectionobject
Hotlink protection enables you to control which hostnames/domains can link to and access your content directly.
- domainsarray of strings
- typestring
  With "type": "blocklist" all values set are not allowed. With "type": "passlist" only values set are allowed.
  Available values: blocklist, disabled, passlist
- empty_referer_deniedbooleanrequired
  Enabling this parameter prevents your content from being directly accessed by sources that send empty referrers.
ip_protectionobject
IP protection enables you to control which networks can access your content directly.
- ipsarray of strings
- typestring
  With "type": "blocklist" all values set are not allowed. With "type": "passlist" only values set are allowed.
  Available values: blocklist, disabled, passlist
geo_protectionobject
Geo protection enables you to control which countries can access your content directly.
- countriesarray of strings
  We are using ISO 3166-1 alpha-2 code. For full list check Wikipedia.
- typestring
  With "type": "blocklist" all values set are not allowed. With "type": "passlist" only values set are allowed.
  Available values: blocklist, disabled, passlist
rate_limitobject
When enabled, this feature limits the data transfer rate by setting "limit_rate" based on the "rs" URL parameter and "limit_rate_after" by the value from the "ri" URL parameter.
- enabledbooleanrequired
origin_headersobject
- customobjectrequired
  Custom HTTP headers included in requests sent to the origin server.
  additionalProp1string
  additionalProp2string
  additionalProp3string
response_headersobject
Custom HTTP headers included in response sent to the client.
- headersarray of objects
  Custom HTTP headers included in response sent to client. Pass an empty array to remove all custom response headers.

Example of the response

{
  "id": 1234567890,
  "cnames": [
    {
      "id": "9880280c-0507-46d1-88f3-71cfee83fa57",
      "cname": "cname.your-domain.com"
    }
  ],
  "creation_time": "2027-07-07T00:00:00.000Z",
  "label": "My cdn",
  "note": "Note for my CDN",
  "origin_id": "e56564d1-8d3e-4457-93a6-082b054bc736",
  "origin_reference": {
    "id": "e56564d1-8d3e-4457-93a6-082b054bc736",
    "label": "My origin",
    "fallbacks": [
      {
        "id": "e56564d1-8d3e-4457-93a6-082b054bc736",
        "label": "My fallback origin"
      }
    ]
  },
  "url": "1234567890.rsc.cdn77.org",
  "cache": {
    "max_age": 1440,
    "max_age_404": 1,
    "requests_with_cookies_enabled": false
  },
  "secure_token": {
    "token": "2Xod4tW8Ln4BDg23",
    "type": "parameter"
  },
  "query_string": {
    "parameters": [
      "utm"
    ],
    "ignore_type": "all"
  },
  "headers": {
    "cors_enabled": true,
    "cors_timing_enabled": false,
    "cors_wildcard_enabled": false,
    "host_header_forwarding_enabled": false,
    "content_disposition": {
      "type": "parameter"
    }
  },
  "https_redirect": {
    "code": 301,
    "enabled": false
  },
  "mp4_pseudo_streaming": {
    "enabled": false
  },
  "ssl": {
    "type": "SNI",
    "ssl_id": "9880280c-0507-46d1-88f3-71cfee83fa57"
  },
  "stream": {
    "origin_url": "prg-1.s.cdn77.com",
    "password": "P4ssw0rd123456",
    "query_key": "123456789",
    "protocol": "rtmp",
    "port": 1936,
    "path": "static"
  },
  "hotlink_protection": {
    "domains": [
      "some-domain.com"
    ],
    "type": "passlist",
    "empty_referer_denied": true
  },
  "ip_protection": {
    "ips": [
      "8.8.8.8"
    ],
    "type": "passlist"
  },
  "geo_protection": {
    "countries": [
      "UK"
    ],
    "type": "passlist"
  },
  "rate_limit": {
    "enabled": false
  },
  "origin_headers": {
    "custom": {
      "additionalProp1": "default-src 'self' *.example.com; img-src *",
      "additionalProp2": "default-src 'self' *.example.com; img-src *",
      "additionalProp3": "default-src 'self' *.example.com; img-src *"
    }
  },
  "response_headers": {
    "headers": [
      {
        "name": "X-Custom-Header",
        "value": "custom-value"
      }
    ]
  }
}

List of CDN Resources Detail of CDN Resource