GET
/
cdn
/
resources
Get CDN resources list
curl --request GET \
  --url https://api.gcore.com/cdn/resources \
  --header 'Authorization: <api-key>'
[
  {
    "id": 220,
    "cname": "cdn.site.com",
    "active": true,
    "enabled": true,
    "status": "active",
    "deleted": "<string>",
    "client": 170,
    "name": "Resource for images",
    "description": "My resource",
    "created": "2017-06-10 10:30:04.954354+00:00",
    "updated": "2017-06-14 05:05:42.065221+00:00",
    "originGroup": 132,
    "originGroup_name": "Resource origin group",
    "originProtocol": "HTTPS",
    "secondaryHostnames": [
      "first.example.com",
      "second.example.com"
    ],
    "shielded": false,
    "shield_dc": null,
    "shield_enabled": false,
    "shield_routing_map": null,
    "sslEnabled": false,
    "sslData": 192,
    "proxy_ssl_enabled": false,
    "proxy_ssl_ca": null,
    "proxy_ssl_data": null,
    "preset_applied": false,
    "vp_enabled": false,
    "full_custom_enabled": false,
    "can_purge_by_urls": false,
    "suspend_date": null,
    "suspended": false,
    "primary_resource": null,
    "is_primary": null,
    "waap_domain_id": "<string>",
    "rules": [],
    "options": {
      "allowedHttpMethods": {
        "enabled": true,
        "value": [
          "GET",
          "POST"
        ]
      },
      "bot_protection": {
        "enabled": true,
        "bot_challenge": {
          "enabled": true
        }
      },
      "brotli_compression": {
        "enabled": true,
        "value": [
          "text/html",
          "text/plain"
        ]
      },
      "browser_cache_settings": {
        "enabled": true,
        "value": "3600s"
      },
      "cache_http_headers": {
        "enabled": false,
        "value": [
          "vary",
          "content-length",
          "last-modified",
          "connection",
          "accept-ranges",
          "content-type",
          "content-encoding",
          "etag",
          "cache-control",
          "expires",
          "keep-alive",
          "server"
        ]
      },
      "cors": {
        "enabled": true,
        "value": [
          "domain.com",
          "domain2.com"
        ],
        "always": true
      },
      "country_acl": {
        "enabled": true,
        "policy_type": "allow",
        "excepted_values": [
          "GB",
          "DE"
        ]
      },
      "disable_cache": {
        "enabled": true,
        "value": false
      },
      "disable_proxy_force_ranges": {
        "enabled": true,
        "value": true
      },
      "edge_cache_settings": {
        "enabled": true,
        "value": "43200s",
        "custom_values": {
          "100": "43200s"
        }
      },
      "fastedge": {
        "enabled": true,
        "on_request_headers": {
          "enabled": true,
          "app_id": "1001",
          "interrupt_on_error": true
        }
      },
      "fetch_compressed": {
        "enabled": true,
        "value": false
      },
      "follow_origin_redirect": {
        "enabled": true,
        "codes": [
          302,
          308
        ]
      },
      "force_return": {
        "enabled": true,
        "code": 349,
        "body": "<string>",
        "time_interval": {
          "start_time": "<string>",
          "end_time": "<string>",
          "time_zone": "Europe/Luxembourg"
        }
      },
      "forward_host_header": {
        "enabled": false,
        "value": false
      },
      "gzipOn": {
        "enabled": true,
        "value": true
      },
      "hostHeader": {
        "enabled": true,
        "value": "host.com"
      },
      "http3_enabled": {
        "enabled": true,
        "value": true
      },
      "ignore_cookie": {
        "enabled": true,
        "value": true
      },
      "ignoreQueryString": {
        "enabled": true,
        "value": false
      },
      "image_stack": {
        "enabled": true,
        "avif_enabled": true,
        "webp_enabled": false,
        "quality": 80,
        "png_lossless": true
      },
      "ip_address_acl": {
        "enabled": true,
        "policy_type": "deny",
        "excepted_values": [
          "192.168.1.100/32"
        ]
      },
      "limit_bandwidth": {
        "enabled": true,
        "limit_type": "static",
        "speed": 100,
        "buffer": 200
      },
      "proxy_cache_key": {
        "enabled": true,
        "value": "$scheme$uri"
      },
      "proxy_cache_methods_set": {
        "enabled": true,
        "value": false
      },
      "proxy_connect_timeout": {
        "enabled": true,
        "value": "<string>"
      },
      "proxy_read_timeout": {
        "enabled": true,
        "value": "<string>"
      },
      "query_params_blacklist": {
        "enabled": true,
        "value": [
          "some",
          "blacklisted",
          "query"
        ]
      },
      "query_params_whitelist": {
        "enabled": true,
        "value": [
          "some",
          "whitelisted",
          "query"
        ]
      },
      "query_string_forwarding": {
        "enabled": true,
        "forward_from_file_types": [
          "m3u8",
          "mpd"
        ],
        "forward_to_file_types": [
          "ts",
          "mp4"
        ]
      },
      "redirect_http_to_https": {
        "enabled": true,
        "value": true
      },
      "redirect_https_to_http": {
        "enabled": false,
        "value": true
      },
      "referrer_acl": {
        "enabled": true,
        "policy_type": "deny",
        "excepted_values": [
          "example.com",
          "*.example.net"
        ]
      },
      "request_limiter": {
        "enabled": true,
        "rate_unit": "r/s",
        "rate": 5,
        "burst": 5,
        "delay": 0
      },
      "response_headers_hiding_policy": {
        "enabled": true,
        "mode": "hide",
        "excepted": [
          "my-header"
        ]
      },
      "rewrite": {
        "enabled": true,
        "body": "/(.*) /additional_path/$1",
        "flag": "break"
      },
      "secure_key": {
        "enabled": true,
        "key": "secretkey",
        "type": 2
      },
      "slice": {
        "enabled": true,
        "value": true
      },
      "sni": {
        "enabled": true,
        "sni_type": "custom",
        "custom_hostname": "custom.example.com"
      },
      "stale": {
        "enabled": true,
        "value": [
          "http_404",
          "http_500"
        ]
      },
      "static_response_headers": {
        "enabled": true,
        "value": [
          {
            "name": "X-Example",
            "value": [
              "Value_1"
            ],
            "always": true
          },
          {
            "name": "X-Example-Multiple",
            "value": [
              "Value_1",
              "Value_2",
              "Value_3"
            ],
            "always": false
          }
        ]
      },
      "staticHeaders": {
        "enabled": true,
        "value": {}
      },
      "staticRequestHeaders": {
        "enabled": true,
        "value": {
          "Header-One": "Value 1",
          "Header-Two": "Value 2"
        }
      },
      "tls_versions": {
        "enabled": true,
        "value": [
          "SSLv3",
          "TLSv1.3"
        ]
      },
      "use_default_le_chain": {
        "enabled": true,
        "value": true
      },
      "use_dns01_le_challenge": {
        "enabled": true,
        "value": true
      },
      "use_rsa_le_cert": {
        "enabled": true,
        "value": true
      },
      "user_agent_acl": {
        "enabled": true,
        "policy_type": "allow",
        "excepted_values": [
          "UserAgent Value",
          ""
        ]
      },
      "waap": {
        "enabled": true,
        "value": true
      },
      "websockets": {
        "enabled": true,
        "value": true
      }
    }
  }
]

Authorizations

Authorization
string
header
required

API key for authentication. Make sure to include the word apikey, followed by a single space and then your token. Example: apikey 1234$abcdef

Query Parameters

deleted
boolean

Defines whether a CDN resource has been deleted. Possible values:

  • true - CDN resource has been deleted.
  • false - CDN resource has not been deleted.
enabled
boolean

Enables or disables a CDN resource change by a user. Possible values:

  • true - CDN resource is enabled.
  • false - CDN resource is disabled.
originGroup
integer

Origin group ID.

sslEnabled
boolean

Defines whether the HTTPS protocol is enabled for content delivery. Possible values:

  • true - HTTPS protocol is enabled for CDN resource.
  • false - HTTPS protocol is disabled for CDN resource.
sslData
integer

SSL certificate ID.

sslData_in
integer

SSL certificates IDs. Example:

  • ?sslData_in=1643,1644,1652
min_created
string

Earliest date of CDN resource creation for which CDN resources should be returned (ISO 8601/RFC 3339 format, UTC.)

max_created
string

Most recent date of CDN resource creation for which CDN resources should be returned (ISO 8601/RFC 3339 format, UTC.)

cname
string

Delivery domain (CNAME) of the CDN resource.

secondaryHostnames
string

Additional delivery domains (CNAMEs) of the CDN resource.

vp_enabled
boolean

Defines whether the CDN resource is integrated with the Streaming platform. Possible values:

  • true - CDN resource is used for Streaming platform.
  • false - CDN resource is not used for Streaming platform.
rules
string

Rule name or pattern.

shielded
boolean

Defines whether origin shielding is enabled for the CDN resource. Possible values:

  • true - Origin shielding is enabled for the CDN resource.
  • false - Origin shielding is disabled for the CDN resource.
shield_dc
string

Name of the origin shielding data center location.

suspend
boolean

Defines whether the CDN resource was automatically suspended by the system. Possible values:

  • true - CDN resource is selected for automatic suspension in the next 7 days.
  • false - CDN resource is not selected for automatic suspension.
status
enum<string>

CDN resource status.

Available options:
active,
processed,
suspended,
deleted

Response

200 - application/json

Successful.

The response is of type object[].