POST
/
v1
/
projects
/
{id}
/
proxy-settings
/
{revision}
curl --request POST \
  --url https://api.edgee.app/v1/projects/{id}/proxy-settings/{revision} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "description": "<string>",
  "is_active": true
}'
{
  "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

​
Authorization
string
header
required

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

Path Parameters

​
id
string
required
​
revision
string
required

Body

application/json
​
description
string

Description of the proxy settings revision.

​
is_active
boolean

Whether this revision is the active one.

Response

200
application/json
The updated ProxySettings

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

Example:

"proxy_settings"

​
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.

A ProxySettings backend entity

​
routes
object[]

The routing rules of the proxy.

A ProxySettings route entity