Create origin group

curl --request POST \
  --url https://api.gcore.com/cdn/origin_groups \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "YourOriginGroup",
  "sources": [
    {
      "source": "yourwebsite.com",
      "backup": false,
      "enabled": true,
      "host_header_override": null
    }
  ],
  "use_next": true,
  "proxy_next_upstream": [
    "error",
    "timeout",
    "invalid_header",
    "http_500",
    "http_502",
    "http_503",
    "http_504"
  ],
  "auth_type": "none"
}
'

import requests

url = "https://api.gcore.com/cdn/origin_groups"

payload = {
    "name": "YourOriginGroup",
    "sources": [
        {
            "source": "yourwebsite.com",
            "backup": False,
            "enabled": True,
            "host_header_override": None
        }
    ],
    "use_next": True,
    "proxy_next_upstream": ["error", "timeout", "invalid_header", "http_500", "http_502", "http_503", "http_504"],
    "auth_type": "none"
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'YourOriginGroup',
    sources: [
      {
        source: 'yourwebsite.com',
        backup: false,
        enabled: true,
        host_header_override: null
      }
    ],
    use_next: true,
    proxy_next_upstream: [
      'error',
      'timeout',
      'invalid_header',
      'http_500',
      'http_502',
      'http_503',
      'http_504'
    ],
    auth_type: 'none'
  })
};

fetch('https://api.gcore.com/cdn/origin_groups', 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/origin_groups",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'YourOriginGroup',
    'sources' => [
        [
                'source' => 'yourwebsite.com',
                'backup' => false,
                'enabled' => true,
                'host_header_override' => null
        ]
    ],
    'use_next' => true,
    'proxy_next_upstream' => [
        'error',
        'timeout',
        'invalid_header',
        'http_500',
        'http_502',
        'http_503',
        'http_504'
    ],
    'auth_type' => 'none'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.gcore.com/cdn/origin_groups"

	payload := strings.NewReader("{\n  \"name\": \"YourOriginGroup\",\n  \"sources\": [\n    {\n      \"source\": \"yourwebsite.com\",\n      \"backup\": false,\n      \"enabled\": true,\n      \"host_header_override\": null\n    }\n  ],\n  \"use_next\": true,\n  \"proxy_next_upstream\": [\n    \"error\",\n    \"timeout\",\n    \"invalid_header\",\n    \"http_500\",\n    \"http_502\",\n    \"http_503\",\n    \"http_504\"\n  ],\n  \"auth_type\": \"none\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.gcore.com/cdn/origin_groups")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"YourOriginGroup\",\n  \"sources\": [\n    {\n      \"source\": \"yourwebsite.com\",\n      \"backup\": false,\n      \"enabled\": true,\n      \"host_header_override\": null\n    }\n  ],\n  \"use_next\": true,\n  \"proxy_next_upstream\": [\n    \"error\",\n    \"timeout\",\n    \"invalid_header\",\n    \"http_500\",\n    \"http_502\",\n    \"http_503\",\n    \"http_504\"\n  ],\n  \"auth_type\": \"none\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.gcore.com/cdn/origin_groups")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"YourOriginGroup\",\n  \"sources\": [\n    {\n      \"source\": \"yourwebsite.com\",\n      \"backup\": false,\n      \"enabled\": true,\n      \"host_header_override\": null\n    }\n  ],\n  \"use_next\": true,\n  \"proxy_next_upstream\": [\n    \"error\",\n    \"timeout\",\n    \"invalid_header\",\n    \"http_500\",\n    \"http_502\",\n    \"http_503\",\n    \"http_504\"\n  ],\n  \"auth_type\": \"none\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": 1,
  "name": "YourOriginGroup",
  "sources": [
    {
      "source": "yourwebsite.com",
      "backup": false,
      "enabled": true,
      "host_header_override": null
    },
    {
      "source": "1.2.3.4:5500",
      "backup": true,
      "enabled": true,
      "host_header_override": null
    },
    {
      "origin_type": "s3",
      "config": {
        "s3_type": "amazon",
        "s3_bucket_name": "my-bucket",
        "s3_region": "eu-west-1",
        "s3_access_key_id": "SECRET_VALUE",
        "s3_secret_access_key": "SECRET_VALUE",
        "s3_auth_type": "awsSignatureV4"
      },
      "backup": true,
      "enabled": true,
      "host_header_override": null
    }
  ],
  "use_next": true,
  "proxy_next_upstream": [
    "error",
    "timeout",
    "invalid_header",
    "http_500",
    "http_502",
    "http_503",
    "http_504"
  ],
  "auth_type": "none",
  "path": "",
  "has_related_resources": true
}

{
  "errors": {
    "name": [
      "Origin Group name should be unique."
    ]
  }
}

{
  "message": "You do not have permission to perform this action."
}

POST

cdn

origin_groups

Create origin group

curl --request POST \
  --url https://api.gcore.com/cdn/origin_groups \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "YourOriginGroup",
  "sources": [
    {
      "source": "yourwebsite.com",
      "backup": false,
      "enabled": true,
      "host_header_override": null
    }
  ],
  "use_next": true,
  "proxy_next_upstream": [
    "error",
    "timeout",
    "invalid_header",
    "http_500",
    "http_502",
    "http_503",
    "http_504"
  ],
  "auth_type": "none"
}
'

import requests

url = "https://api.gcore.com/cdn/origin_groups"

payload = {
    "name": "YourOriginGroup",
    "sources": [
        {
            "source": "yourwebsite.com",
            "backup": False,
            "enabled": True,
            "host_header_override": None
        }
    ],
    "use_next": True,
    "proxy_next_upstream": ["error", "timeout", "invalid_header", "http_500", "http_502", "http_503", "http_504"],
    "auth_type": "none"
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'YourOriginGroup',
    sources: [
      {
        source: 'yourwebsite.com',
        backup: false,
        enabled: true,
        host_header_override: null
      }
    ],
    use_next: true,
    proxy_next_upstream: [
      'error',
      'timeout',
      'invalid_header',
      'http_500',
      'http_502',
      'http_503',
      'http_504'
    ],
    auth_type: 'none'
  })
};

fetch('https://api.gcore.com/cdn/origin_groups', 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/origin_groups",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'YourOriginGroup',
    'sources' => [
        [
                'source' => 'yourwebsite.com',
                'backup' => false,
                'enabled' => true,
                'host_header_override' => null
        ]
    ],
    'use_next' => true,
    'proxy_next_upstream' => [
        'error',
        'timeout',
        'invalid_header',
        'http_500',
        'http_502',
        'http_503',
        'http_504'
    ],
    'auth_type' => 'none'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.gcore.com/cdn/origin_groups"

	payload := strings.NewReader("{\n  \"name\": \"YourOriginGroup\",\n  \"sources\": [\n    {\n      \"source\": \"yourwebsite.com\",\n      \"backup\": false,\n      \"enabled\": true,\n      \"host_header_override\": null\n    }\n  ],\n  \"use_next\": true,\n  \"proxy_next_upstream\": [\n    \"error\",\n    \"timeout\",\n    \"invalid_header\",\n    \"http_500\",\n    \"http_502\",\n    \"http_503\",\n    \"http_504\"\n  ],\n  \"auth_type\": \"none\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.gcore.com/cdn/origin_groups")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"YourOriginGroup\",\n  \"sources\": [\n    {\n      \"source\": \"yourwebsite.com\",\n      \"backup\": false,\n      \"enabled\": true,\n      \"host_header_override\": null\n    }\n  ],\n  \"use_next\": true,\n  \"proxy_next_upstream\": [\n    \"error\",\n    \"timeout\",\n    \"invalid_header\",\n    \"http_500\",\n    \"http_502\",\n    \"http_503\",\n    \"http_504\"\n  ],\n  \"auth_type\": \"none\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.gcore.com/cdn/origin_groups")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"YourOriginGroup\",\n  \"sources\": [\n    {\n      \"source\": \"yourwebsite.com\",\n      \"backup\": false,\n      \"enabled\": true,\n      \"host_header_override\": null\n    }\n  ],\n  \"use_next\": true,\n  \"proxy_next_upstream\": [\n    \"error\",\n    \"timeout\",\n    \"invalid_header\",\n    \"http_500\",\n    \"http_502\",\n    \"http_503\",\n    \"http_504\"\n  ],\n  \"auth_type\": \"none\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": 1,
  "name": "YourOriginGroup",
  "sources": [
    {
      "source": "yourwebsite.com",
      "backup": false,
      "enabled": true,
      "host_header_override": null
    },
    {
      "source": "1.2.3.4:5500",
      "backup": true,
      "enabled": true,
      "host_header_override": null
    },
    {
      "origin_type": "s3",
      "config": {
        "s3_type": "amazon",
        "s3_bucket_name": "my-bucket",
        "s3_region": "eu-west-1",
        "s3_access_key_id": "SECRET_VALUE",
        "s3_secret_access_key": "SECRET_VALUE",
        "s3_auth_type": "awsSignatureV4"
      },
      "backup": true,
      "enabled": true,
      "host_header_override": null
    }
  ],
  "use_next": true,
  "proxy_next_upstream": [
    "error",
    "timeout",
    "invalid_header",
    "http_500",
    "http_502",
    "http_503",
    "http_504"
  ],
  "auth_type": "none",
  "path": "",
  "has_related_resources": true
}

{
  "errors": {
    "name": [
      "Origin Group name should be unique."
    ]
  }
}

{
  "message": "You do not have permission to perform this action."
}

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

Body

application/json

None Auth
AWS Signature V4

Create an origin group with host origins, or mixed host and S3 origins.

name

string

required

Origin group name.

Example:

"YourOriginGroup"

sources

(Host Source · object | S3 Source · object | FastEdge Source · object)[]

required

Host Source
S3 Source
FastEdge Source

Show child attributes

use_next

boolean

Defines whether to use the next origin from the origin group if origin responds with the cases specified in proxy_next_upstream. If you enable it, you must specify cases in proxy_next_upstream.

Possible values:

true - Option is enabled.
false - Option is disabled.

Example:

true

proxy_next_upstream

string[]

Defines cases when the request should be passed on to the next origin.

Possible values:

error - an error occurred while establishing a connection with the origin, passing a request to it, or reading the response header
timeout - a timeout has occurred while establishing a connection with the origin, passing a request to it, or reading the response header
invalid_header - a origin returned an empty or invalid response
http_403 - a origin returned a response with the code 403
http_404 - a origin returned a response with the code 404
http_429 - a origin returned a response with the code 429
http_500 - a origin returned a response with the code 500
http_502 - a origin returned a response with the code 502
http_503 - a origin returned a response with the code 503
http_504 - a origin returned a response with the code 504

Example:

[
  "error",
  "timeout",
  "invalid_header",
  "http_500",
  "http_502",
  "http_503",
  "http_504"
]

auth_type

string

default:none

deprecated

Deprecated. No longer necessary. Defaults to none.

Origin authentication type.

Possible values:

none - Used for public origins.
awsSignatureV4 - Used for S3 storage.

Example:

"none"

Response

Successful.

None Auth
AWS Signature V4

Origin group with host origins, or mixed host and S3 origins using inline origin_type and config in sources.

integer

required

Origin group ID.

Example:

1

name

string

required

Origin group name.

Example:

"YourOriginGroup"

sources

(Host Source · object | S3 Source · object | FastEdge Source · object)[]

required

List of origin sources in the origin group. Each entry can be a host origin or an S3 origin.

Host origins have a source field with the hostname or IP. S3 origins have origin_type: s3 and a config object with S3 credentials. Both types can be mixed in the same origin group.

A host origin source.

Host Source
S3 Source
FastEdge Source

Show child attributes

Example:

[
  {
    "source": "yourwebsite.com",
    "backup": false,
    "enabled": true,
    "host_header_override": null
  },
  {
    "source": "1.2.3.4:5500",
    "backup": true,
    "enabled": true,
    "host_header_override": null
  },
  {
    "origin_type": "s3",
    "config": {
      "s3_type": "amazon",
      "s3_bucket_name": "my-bucket",
      "s3_region": "eu-west-1",
      "s3_access_key_id": "SECRET_VALUE",
      "s3_secret_access_key": "SECRET_VALUE",
      "s3_auth_type": "awsSignatureV4"
    },
    "backup": true,
    "enabled": true,
    "host_header_override": null
  }
]

use_next

boolean

Defines whether to use the next origin from the origin group if origin responds with the cases specified in proxy_next_upstream. If you enable it, you must specify cases in proxy_next_upstream.

Possible values:

true - Option is enabled.
false - Option is disabled.

Example:

true

proxy_next_upstream

string[]

Defines cases when the request should be passed on to the next origin.

Possible values:

error - an error occurred while establishing a connection with the origin, passing a request to it, or reading the response header
timeout - a timeout has occurred while establishing a connection with the origin, passing a request to it, or reading the response header
invalid_header - a origin returned an empty or invalid response
http_403 - a origin returned a response with the code 403
http_404 - a origin returned a response with the code 404
http_429 - a origin returned a response with the code 429
http_500 - a origin returned a response with the code 500
http_502 - a origin returned a response with the code 502
http_503 - a origin returned a response with the code 503
http_504 - a origin returned a response with the code 504

Example:

[
  "error",
  "timeout",
  "invalid_header",
  "http_500",
  "http_502",
  "http_503",
  "http_504"
]

auth_type

string

default:none

deprecated

Deprecated. No longer necessary. Defaults to none.

Origin authentication type.

Possible values:

none - Used for public origins.
awsSignatureV4 - Used for S3 storage.

Example:

"none"

path

string

deprecated

Deprecated. No longer necessary. Omit this field and the default origin path behavior will be used.

Origin path prefix.

Example:

""

Defines whether the origin group has related CDN resources.

Possible values:

true - Origin group has related CDN resources.
false - Origin group does not have related CDN resources.

Example:

true

Get origin groups list Get origin group details

⌘I