Create a ProxySettings - Edgee documentation

Authorizations

Authorization

string

headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token. More info here

Path Parameters

string

required

Body

application/json

description

string

required

Description of the proxy settings revision.

backends

object[]

required

The backend list of the proxy.

backends.name

string

A string that represents the name of the backend.

backends.address

string

A string that represents the address of the backend.

backends.enable_ssl

boolean

A boolean that indicates that SSL should be enabled for this backend.

backends.check_certificate

string

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.

backends.ca_certificate

string

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.

backends.sni_hostname

string

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.

backends.default

boolean

An optional boolean that, if present and set to true, indicates that this backend is the default backend.

backends.override_host

string

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.

routes

object[]

The routing rules of the proxy.

routes.path

string

A string that represents the path for which this rule applies. This can be a regular expression if regex is set to true.

routes.regex

boolean

A boolean that indicates whether the path is a regular expression.

routes.backend_name

string

The name of the backend to which requests that match this rule should be routed.

routes.rank

string

An integer that represents the rank of this rule. Rules with lower ranks are evaluated before rules with higher ranks.

routes.continent

any[]

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.

routes.region

any[]

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.

routes.country

any[]

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.

routes.rewritepath_regex

string

An optional string that, if present, represents a regular expression that is used to rewrite the path of requests that match this rule.

routes.rewritepath_replace

string

An optional string that, if present, is used as the replacement string when the rewritepath_regex is applied to the path of a request.

Response

200 - application/json

A ProxySettings is a revision of the proxy settings of a project.

object

string

String representing the object's type. Objects of the same type share the same value

revision

number

The revision number of the proxy settings.

description

string

Description of the proxy settings revision.

is_active

boolean

Whether this revision is the active one.

backends

object[]

The backend list of the proxy.

backends.name

string

A string that represents the name of the backend.

backends.address

string

A string that represents the address of the backend.

backends.enable_ssl

boolean

A boolean that indicates that SSL should be enabled for this backend.

backends.check_certificate

string

backends.ca_certificate

string

backends.sni_hostname

string

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.

backends.default

boolean

An optional boolean that, if present and set to true, indicates that this backend is the default backend.

backends.override_host

string

routes

object[]

The routing rules of the proxy.

routes.path

string

A string that represents the path for which this rule applies. This can be a regular expression if regex is set to true.

routes.regex

boolean

A boolean that indicates whether the path is a regular expression.

routes.backend_name

string

The name of the backend to which requests that match this rule should be routed.

routes.rank

string

An integer that represents the rank of this rule. Rules with lower ranks are evaluated before rules with higher ranks.

routes.continent

any[]

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.

routes.region

any[]

routes.country

any[]

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.

routes.rewritepath_regex

string

An optional string that, if present, represents a regular expression that is used to rewrite the path of requests that match this rule.

routes.rewritepath_replace

string

An optional string that, if present, is used as the replacement string when the rewritepath_regex is applied to the path of a request.

API Documentation

Authorizations

Path Parameters

Body

Response