Python
import os
from gcore import Gcore
client = Gcore(
api_key=os.environ.get("GCORE_API_KEY"), # This is the default and can be omitted
)
cdn_resource_rule = client.cdn.cdn_resources.rules.get(
rule_id=0,
resource_id=0,
)
print(cdn_resource_rule.id)package main
import (
"context"
"fmt"
"github.com/G-Core/gcore-go"
"github.com/G-Core/gcore-go/cdn"
"github.com/G-Core/gcore-go/option"
)
func main() {
client := gcore.NewClient(
option.WithAPIKey("My API Key"),
)
cdnResourceRule, err := client.CDN.CDNResources.Rules.Get(
context.TODO(),
0,
cdn.CDNResourceRuleGetParams{
ResourceID: 0,
},
)
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", cdnResourceRule.ID)
}
curl --request GET \
--url https://api.gcore.com/cdn/resources/{resource_id}/rules/{rule_id} \
--header 'Authorization: <api-key>'const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
fetch('https://api.gcore.com/cdn/resources/{resource_id}/rules/{rule_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.gcore.com/cdn/resources/{resource_id}/rules/{rule_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}HttpResponse<String> response = Unirest.get("https://api.gcore.com/cdn/resources/{resource_id}/rules/{rule_id}")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gcore.com/cdn/resources/{resource_id}/rules/{rule_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"id": 5,
"name": "My first rule",
"active": true,
"deleted": false,
"originGroup": null,
"rule": "/folder/images/*.png",
"ruleType": 0,
"weight": 1,
"originProtocol": "HTTPS",
"overrideOriginProtocol": "HTTPS",
"preset_applied": false,
"primary_rule": null,
"options": {
"allowedHttpMethods": {
"enabled": true,
"value": [
"GET",
"POST"
]
},
"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": [
"example.com",
"example.org"
],
"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": 301,
"body": "http://example.com/redirect_address",
"time_interval": {
"start_time": "09:00",
"end_time": "20:00",
"time_zone": "CET"
}
},
"forward_host_header": {
"enabled": false,
"value": false
},
"gzipOn": {
"enabled": true,
"value": true
},
"hostHeader": {
"enabled": true,
"value": "example.com"
},
"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.0.2.20/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": "4s"
},
"proxy_read_timeout": {
"enabled": true,
"value": "10s"
},
"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"
],
"forward_only_keys": [
"auth_token",
"session_id"
],
"forward_except_keys": [
"debug_info"
]
},
"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.org"
]
},
"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": {
"X-Example": "Value_1",
"X-Example-Multiple": [
"Value_2",
"Value_3"
]
}
},
"staticRequestHeaders": {
"enabled": true,
"value": {
"Header-One": "Value 1",
"Header-Two": "Value 2"
}
},
"user_agent_acl": {
"enabled": true,
"policy_type": "allow",
"excepted_values": [
"UserAgent Value",
"~*.*bot.*",
""
]
},
"waap": {
"enabled": true,
"value": true
},
"websockets": {
"enabled": true,
"value": true
}
}
}Rules
Get rule details
GET
/
cdn
/
resources
/
{resource_id}
/
rules
/
{rule_id}
Python
import os
from gcore import Gcore
client = Gcore(
api_key=os.environ.get("GCORE_API_KEY"), # This is the default and can be omitted
)
cdn_resource_rule = client.cdn.cdn_resources.rules.get(
rule_id=0,
resource_id=0,
)
print(cdn_resource_rule.id)package main
import (
"context"
"fmt"
"github.com/G-Core/gcore-go"
"github.com/G-Core/gcore-go/cdn"
"github.com/G-Core/gcore-go/option"
)
func main() {
client := gcore.NewClient(
option.WithAPIKey("My API Key"),
)
cdnResourceRule, err := client.CDN.CDNResources.Rules.Get(
context.TODO(),
0,
cdn.CDNResourceRuleGetParams{
ResourceID: 0,
},
)
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", cdnResourceRule.ID)
}
curl --request GET \
--url https://api.gcore.com/cdn/resources/{resource_id}/rules/{rule_id} \
--header 'Authorization: <api-key>'const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
fetch('https://api.gcore.com/cdn/resources/{resource_id}/rules/{rule_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.gcore.com/cdn/resources/{resource_id}/rules/{rule_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}HttpResponse<String> response = Unirest.get("https://api.gcore.com/cdn/resources/{resource_id}/rules/{rule_id}")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gcore.com/cdn/resources/{resource_id}/rules/{rule_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"id": 5,
"name": "My first rule",
"active": true,
"deleted": false,
"originGroup": null,
"rule": "/folder/images/*.png",
"ruleType": 0,
"weight": 1,
"originProtocol": "HTTPS",
"overrideOriginProtocol": "HTTPS",
"preset_applied": false,
"primary_rule": null,
"options": {
"allowedHttpMethods": {
"enabled": true,
"value": [
"GET",
"POST"
]
},
"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": [
"example.com",
"example.org"
],
"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": 301,
"body": "http://example.com/redirect_address",
"time_interval": {
"start_time": "09:00",
"end_time": "20:00",
"time_zone": "CET"
}
},
"forward_host_header": {
"enabled": false,
"value": false
},
"gzipOn": {
"enabled": true,
"value": true
},
"hostHeader": {
"enabled": true,
"value": "example.com"
},
"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.0.2.20/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": "4s"
},
"proxy_read_timeout": {
"enabled": true,
"value": "10s"
},
"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"
],
"forward_only_keys": [
"auth_token",
"session_id"
],
"forward_except_keys": [
"debug_info"
]
},
"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.org"
]
},
"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": {
"X-Example": "Value_1",
"X-Example-Multiple": [
"Value_2",
"Value_3"
]
}
},
"staticRequestHeaders": {
"enabled": true,
"value": {
"Header-One": "Value 1",
"Header-Two": "Value 2"
}
},
"user_agent_acl": {
"enabled": true,
"policy_type": "allow",
"excepted_values": [
"UserAgent Value",
"~*.*bot.*",
""
]
},
"waap": {
"enabled": true,
"value": true
},
"websockets": {
"enabled": true,
"value": true
}
}
}Authorizations
Response
Successful.
Rule type.
Possible values:
- Type 0 - Regular expression. Must start with '^/' or '/'.
- Type 1 - Regular expression. Note that for this rule type we automatically add / to each rule pattern before your regular expression. This type is legacy, please use Type 0.
Required range:
0 <= x <= 1Example:
0
Protocol used by CDN servers to request content from an origin source.
Possible values:
- HTTPS - CDN servers connect to origin via HTTPS protocol.
- HTTP - CDN servers connect to origin via HTTP protocol.
- MATCH - Connection protocol is chosen automatically; in this case, content on origin source should be available for the CDN both through HTTP and HTTPS protocols.
Available options:
HTTPS, HTTP, MATCH Example:
"HTTPS"
Sets a protocol other than the one specified in the CDN resource settings to connect to the origin.
Possible values:
- HTTPS - CDN servers connect to origin via HTTPS protocol.
- HTTP - CDN servers connect to origin via HTTP protocol.
- MATCH - Connection protocol is chosen automatically; in this case, content on origin source should be available for the CDN both through HTTP and HTTPS protocols.
- null -
originProtocolsetting is inherited from the CDN resource settings.
If an enabled origin among the origins this rule pulls from is bound to a Gcore Object Storage (s3_type is gcore), HTTPS is used regardless of this setting.
Available options:
HTTPS, HTTP, MATCH Was this page helpful?