API Documentation
- Introduction
- Authentication
- Errors
- ApiTokens
- Organizations
- Projects
- Domains
- ProxySettings
- Components
- ProjectComponents
- Statistics
- DataCollectionEvents
- Users
- Invitations
- DataCollection (Project)
Create a ProxySettings
Creates a new ProxySettings.
curl --request POST \
--url https://api.edgee.app/v1/projects/{id}/proxy-settings \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"description": "<string>",
"backends": [
{
"name": "<string>",
"address": "<string>",
"enable_ssl": true,
"check_certificate": "<string>",
"ca_certificate": "<string>",
"sni_hostname": "<string>",
"default": true,
"override_host": "<string>"
}
],
"routes": [
{
"path": "<string>",
"regex": true,
"backend_name": "<string>",
"rank": "<string>",
"continent": [
"<any>"
],
"region": [
"<any>"
],
"country": [
"<any>"
]
}
]
}'{
"object": "proxy_settings",
"revision": 123,
"description": "<string>",
"is_active": true,
"backends": [
{
"name": "<string>",
"address": "<string>",
"enable_ssl": true,
"check_certificate": "<string>",
"ca_certificate": "<string>",
"sni_hostname": "<string>",
"default": true,
"override_host": "<string>"
}
],
"routes": [
{
"path": "<string>",
"regex": true,
"backend_name": "<string>",
"rank": "<string>",
"continent": [
"<any>"
],
"region": [
"<any>"
],
"country": [
"<any>"
]
}
]
}Authorizations
Path Parameters
Body
Description of the proxy settings revision.
The backend list of the proxy.
A ProxySettings backend entity
A string that represents the name of the backend.
A string that represents the address of the backend.
A boolean that indicates that SSL should be enabled for this backend.
An optional string that, if present, represents the hostname that the server certificate should declare, and turn on validation during backend connections. You should enable this if you are using SSL/ TLS, and setting this will enable SSL for the connection as a side effect.
An optional string that, if present, represents the CA certificate for this backend. Set the CA certificate to use when checking the validity of the backend. Setting this will enable SSL for the connection as a side effect.
An optional string that, if present, represents the SNI hostname for this backend. Setting this will enable SSL for the connection as a side effect.
An optional boolean that, if present and set to true, indicates that this backend is the default backend.
An optional string that, if present, represents the host that should be overridden for this backend. This will force the value of the "Host" header to the given string when sending out the origin request. If this is not set and no header already exists, the "Host" header will default to this backend's address.
The routing rules of the proxy.
A ProxySettings route entity
A string that represents the path for which this rule applies. This can be a regular expression if regex is set to true.
A boolean that indicates whether the path is a regular expression.
The name of the backend to which requests that match this rule should be routed.
An integer that represents the rank of this rule. Rules with lower ranks are evaluated before rules with higher ranks.
An optional vector of strings that represent the continents associated with an IP address. If this is set, the rule only applies to requests from IP addresses in the specified continents.
An optional vector of strings that represent the general regions of the world in which the Fastly POP processing the current Compute instance resides. If this is set, the rule only applies to requests from the specified regions.
An optional vector of strings that represent the countries associated with an IP address. If this is set, the rule only applies to requests from IP addresses in the specified countries.
Response
A ProxySettings is a revision of the proxy settings of a project.
String representing the object's type. Objects of the same type share the same value
"proxy_settings"
The revision number of the proxy settings.
Description of the proxy settings revision.
Whether this revision is the active one.
The backend list of the proxy.
A ProxySettings backend entity
A string that represents the name of the backend.
A string that represents the address of the backend.
A boolean that indicates that SSL should be enabled for this backend.
An optional string that, if present, represents the hostname that the server certificate should declare, and turn on validation during backend connections. You should enable this if you are using SSL/ TLS, and setting this will enable SSL for the connection as a side effect.
An optional string that, if present, represents the CA certificate for this backend. Set the CA certificate to use when checking the validity of the backend. Setting this will enable SSL for the connection as a side effect.
An optional string that, if present, represents the SNI hostname for this backend. Setting this will enable SSL for the connection as a side effect.
An optional boolean that, if present and set to true, indicates that this backend is the default backend.
An optional string that, if present, represents the host that should be overridden for this backend. This will force the value of the "Host" header to the given string when sending out the origin request. If this is not set and no header already exists, the "Host" header will default to this backend's address.
The routing rules of the proxy.
A ProxySettings route entity
A string that represents the path for which this rule applies. This can be a regular expression if regex is set to true.
A boolean that indicates whether the path is a regular expression.
The name of the backend to which requests that match this rule should be routed.
An integer that represents the rank of this rule. Rules with lower ranks are evaluated before rules with higher ranks.
An optional vector of strings that represent the continents associated with an IP address. If this is set, the rule only applies to requests from IP addresses in the specified continents.
An optional vector of strings that represent the general regions of the world in which the Fastly POP processing the current Compute instance resides. If this is set, the rule only applies to requests from the specified regions.
An optional vector of strings that represent the countries associated with an IP address. If this is set, the rule only applies to requests from IP addresses in the specified countries.
Was this page helpful?
curl --request POST \
--url https://api.edgee.app/v1/projects/{id}/proxy-settings \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"description": "<string>",
"backends": [
{
"name": "<string>",
"address": "<string>",
"enable_ssl": true,
"check_certificate": "<string>",
"ca_certificate": "<string>",
"sni_hostname": "<string>",
"default": true,
"override_host": "<string>"
}
],
"routes": [
{
"path": "<string>",
"regex": true,
"backend_name": "<string>",
"rank": "<string>",
"continent": [
"<any>"
],
"region": [
"<any>"
],
"country": [
"<any>"
]
}
]
}'{
"object": "proxy_settings",
"revision": 123,
"description": "<string>",
"is_active": true,
"backends": [
{
"name": "<string>",
"address": "<string>",
"enable_ssl": true,
"check_certificate": "<string>",
"ca_certificate": "<string>",
"sni_hostname": "<string>",
"default": true,
"override_host": "<string>"
}
],
"routes": [
{
"path": "<string>",
"regex": true,
"backend_name": "<string>",
"rank": "<string>",
"continent": [
"<any>"
],
"region": [
"<any>"
],
"country": [
"<any>"
]
}
]
}