Skip to content

API Reference / Proxies

Update a proxy

Patches a legacy proxy's enabled flag - the only field this RPC changes, and the only field the BulkReportHealth/ReportHealth auto-disable threshold ever flips to false on its own. Use it to re-enable a proxy the threshold disabled. Concurrency is guarded server-side on the row's own version, so no client-supplied version is needed.

POST/proxies.v1.Proxies/UpdateProxy

Request body

application/jsonRequired

Request to enable or disable a legacy proxy. Re-enabling a proxy disabled for its failure rate resets its counts.

enabled?boolean

New enabled state. Absent keeps the current state.

proxyId?string

Opaque 16-byte identifier of the legacy proxy to change, base64-encoded in JSON.

Format"byte" base64

Response body

application/json

Success

proxy?Proxy

The legacy proxy with the update applied, without its password.

Show attributes
createdAt?string

When the proxy was created.

Format"date-time"

deletedAt?string

When the proxy was deleted. Absent while it is live.

Format"date-time"

enabled?boolean

True when the proxy can be used. Set false by UpdateProxy or automatically when its failure rate is too high.

failureCount?string

Number of failed requests reported through the proxy over its lifetime. Drives automatic disabling.

Format"int64"

id?string

Opaque 16-byte identifier of the proxy, assigned on creation. Base64-encoded in JSON.

Format"byte" base64

ip?string

Proxy host address, an IPv4 or IPv6 address. Unique with port within the workspace.

password?string

Password for proxy authentication. Write only: accepted when the proxy is created, stored encrypted and never returned.

port?integer

Proxy TCP port, from 1 to 65535.

Format"int32"

scheme?string

Protocol used to connect to the proxy: "http", "https" or "socks5".

successCount?string

Number of successful requests reported through the proxy over its lifetime.

Format"int64"

updatedAt?string

When the proxy was last changed.

Format"date-time"

user?string

Username for proxy authentication. Absent for a proxy without authentication.

version?string

Edit counter, incremented by every change a user makes to the proxy.

Format"int64"

workspaceId?string

Opaque 16-byte identifier of the workspace that owns the proxy, base64-encoded in JSON.

Format"byte" base64

curl -X POST "https://api.goldmine.to/proxies.v1.Proxies/UpdateProxy" \
  -H "Authorization: Bearer $CSTRADER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "proxyId": "bGVnYWN5cHJveHkwMDEAAA==",
    "enabled": true
  }'
{
  "proxy": {
    "scheme": "http",
    "ip": "203.0.113.10",
    "port": 8080,
    "user": "legacyproxyuser",
    "id": "bGVnYWN5cHJveHkwMDEAAA==",
    "workspaceId": "AY+MHnorfD2eTxorPE1ebw==",
    "enabled": true,
    "version": "2",
    "createdAt": "2026-06-20T12:00:00Z",
    "updatedAt": "2026-06-29T11:00:00Z"
  }
}