Add instance proxy

Adds a proxy to the instance.

Authorization

AuthorizationBearer <token>

Preferred API authentication. Use a JWT with the api audience.

In: header

Path Parameters

id*string

The unique identifier (UUID) of the instance.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

proxy.type?

The proxy protocol type. Determines how the connection is established.

proxy.address?string

The proxy server address in "host:port" format (e.g., "proxy.example.com:8080"). The address must be resolvable and the port must be valid (1-65535).

proxy.username?string

Optional username for proxy authentication. Required if the proxy server requires authentication. If password is set, username must also be set.

proxy.password?string

Optional password for proxy authentication. Used with username for SOCKS5 or HTTP proxy authentication. Not supported for SOCKS4 proxies (will cause an error if set).

Response Body

`application/json`

curl -X POST "http://127.0.0.1:38765/v1/instances/:id/proxies" \  -H "Content-Type: application/json" \  -d '{}'

{}

{
  "code": 0,
  "grpc-code": "string",
  "message": "string",
  "stack-trace": "string",
  "details": [
    {}
  ]
}

{
  "code": 0,
  "grpc-code": "string",
  "message": "string",
  "stack-trace": "string",
  "details": [
    {}
  ]
}

{
  "code": 0,
  "grpc-code": "string",
  "message": "string",
  "stack-trace": "string",
  "details": [
    {}
  ]
}

Add instance proxy

Authorization

Path Parameters

Request Body

Response Body

200application/json

401application/json

403application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`