Authorizations
API key for authentication. Make sure to include the word apikey
, followed by a single space and then your token.
Example: apikey 1234$abcdef
Path Parameters
Origin group ID.
Response
Successful.
Origin group ID.
Example:
1
Origin group name.
Example:
"YourOriginGroup"
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
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 responsehttp_403
- a origin returned a response with the code 403http_404
- a origin returned a response with the code 404http_429
- a origin returned a response with the code 429http_500
- a origin returned a response with the code 500http_502
- a origin returned a response with the code 502http_503
- a origin returned a response with the code 503http_504
- a origin returned a response with the code 504
Example:
[
"error",
"timeout",
"invalid_header",
"http_500",
"http_502",
"http_503",
"http_504"
]
Origin authentication type.
Possible values:
- none - Used for public origins.
- awsSignatureV4 - Used for S3 storage.
Example:
"none"
List of origin sources in the origin group.
Example:
[
{
"backup": false,
"enabled": true,
"source": "yourwebsite.com"
},
{
"backup": true,
"enabled": true,
"source": "1.2.3.4:5500"
}
]
Parameter is deprecated.
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