G-g-core
CDN resources

Get CDN resources list

Changed on

Get information about all CDN resources in your account.

get/cdn/resources

Request

  • Base URL
    https://api.gcore.com
  • URL
    https://api.gcore.com/cdn/resources
  • Auth
    HTTP apikey

Query parameters

deletedboolean

Defines whether a CDN resource has been deleted.

Possible values:

  • true - CDN resource has been deleted.
  • false - CDN resource has not been deleted.
enabledboolean

Enables or disables a CDN resource change by a user.

Possible values:

  • true - CDN resource is enabled.
  • false - CDN resource is disabled.
originGroupinteger

Origin group ID.

originGroup__instring

Origin group IDs. Values should be separated by a comma.

Example:

  • ?originGroup__in=1,2,3
sslEnabledboolean

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.
sslDatainteger

SSL certificate ID.

sslData_ininteger

SSL certificates IDs.

Example:

  • ?sslData_in=1643,1644,1652
min_createdstring

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

max_createdstring

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

cnamestring

Delivery domain (CNAME) of the CDN resource.

secondaryHostnamesstring

Additional delivery domains (CNAMEs) of the CDN resource.

vp_enabledboolean

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.
rulesstring

Rule name or pattern.

shieldedboolean

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_dcstring

Name of the origin shielding data center location.

suspendboolean

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'active' | 'processed' | 'suspended' | 'deleted'

CDN resource status.

activeboolean

Defines whether a CDN resource is activated.

Possible values:

  • true - CDN resource is activated.
  • false - CDN resource is deactivated.
namestring

Name of the CDN resource. Matches partially and is case-insensitive.

originProtocol'HTTP' | 'HTTPS' | 'MATCH'

Protocol used by CDN servers to request content from an origin source.

suspendedboolean

Defines whether a CDN resource is currently suspended. This reflects the resource's suspended state, unlike the suspend parameter, which selects resources that have a scheduled automatic suspension date.

Possible values:

  • true - CDN resource is currently suspended.
  • false - CDN resource is not suspended.
is_primaryboolean

Filters CDN resources by their primary/alternate relationship. Standalone resources — those not linked to another resource, which is the default — match neither value and are returned by neither true nor false.

Possible values:

  • true - CDN resource is a primary resource for one or more alternate resources.
  • false - CDN resource is an alternate resource linked to a primary resource.
waap_domain_id__isnullboolean

Filters CDN resources by whether they are linked to a WAAP domain. A CDN resource stays linked when WAAP is turned off on it.

Possible values:

  • true - CDN resource is not linked to a WAAP domain.
  • false - CDN resource is linked to a WAAP domain.
min_updatedstring

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

max_updatedstring

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

limitinteger

Maximum number of items to return in the response. Cannot exceed 1000.

offsetinteger

Number of items to skip from the beginning of the list.

Response

Successful.

OR

Example response

[
  {
    "id": 220,
    "cname": "cdn.example.com",
    "active": true,
    "enabled": true,
    "status": "active",
    "deleted": false,
    "client": 170,
    "name": "My resource",
    "description": "Resource for images",
    "created": "2017-06-10T10:30:04.954354Z",
    "updated": "2017-06-10T10:35:04.954354Z",
    "originGroup": 80,
    "originGroup_name": "Resource origin group",
    "originProtocol": "HTTP",
    "secondaryHostnames": [
      "cdn1.example.com",
      "cdn2.example.com"
    ],
    "shielded": false,
    "shield_dc": null,
    "shield_enabled": false,
    "shield_routing_map": null,
    "sslEnabled": true,
    "sslData": 100,
    "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": true,
    "suspend_date": null,
    "suspended": false,
    "primary_resource": null,
    "is_primary": null,
    "waap_domain_id": null,
    "rules": [],
    "options": {}
  },
  {
    "id": 222,
    "deleted": true,
    "client": 170,
    "status": "deleted",
    "updated": "2021-06-07T12:23:44.978506Z",
    "cname": "www.example.com"
  }
]

Changes

  • d034c0d6d6ffRevision changes
    • info

      added the new optional query request parameter waap_domain_id__isnull

  • 290afc8ffdbbRevision changes
    • info

      added the optional property /// to the response with the status

    • info

      added the optional property ///// to the response with the status