servers.configureEdgeProxy

POST

/servers/{serverId}/edge-proxy/configuration

curl --request POST \
  --url https://example.com/api/servers/example/edge-proxy/configuration \
  --header 'Content-Type: application/json' \
  --data '{ "proxyKind": "none", "idempotencyKey": "example" }'

Configures the desired edge proxy kind for future server access routing. Public docs: /docs/servers/operations/proxy-and-terminal/#server-proxy-readiness

Parameters

Path Parameters

serverId

required

string

>= 1 characters

Request Body ^required

Media type application/json

object

proxyKind

required

string

Allowed values: none traefik caddy

idempotencyKey

string

>= 1 characters

Responses

200

OK

Media type application/json

object

id

required

string

edgeProxy

required

object

kind

required

string

Allowed values: none traefik caddy

status

required

string

Allowed values: pending starting ready failed disabled

Example

{
  "edgeProxy": {
    "kind": "none",
    "status": "pending"
  }
}