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.
/ proxies. v1. Proxies/ UpdateProxyRequest body
application/jsonRequired
Request to enable or disable a legacy proxy. Re-enabling a proxy disabled for its failure rate resets its counts.
enabled?booleanNew enabled state. Absent keeps the current state.
proxyId?stringOpaque 16-byte identifier of the legacy proxy to change, base64-encoded in JSON.
Format"byte" base64
Response body
application/json
Success
proxy?ProxyThe legacy proxy with the update applied, without its password.
Show attributes
createdAt?stringWhen the proxy was created.
Format"date-time"
deletedAt?stringWhen the proxy was deleted. Absent while it is live.
Format"date-time"
enabled?booleanTrue when the proxy can be used. Set false by UpdateProxy or automatically when its failure rate is too high.
failureCount?stringNumber of failed requests reported through the proxy over its lifetime. Drives automatic disabling.
Format"int64"
id?stringOpaque 16-byte identifier of the proxy, assigned on creation. Base64-encoded in JSON.
Format"byte" base64
ip?stringProxy host address, an IPv4 or IPv6 address. Unique with port within the workspace.
password?stringPassword for proxy authentication. Write only: accepted when the proxy is created, stored encrypted and never returned.
port?integerProxy TCP port, from 1 to 65535.
Format"int32"
scheme?stringProtocol used to connect to the proxy: "http", "https" or "socks5".
successCount?stringNumber of successful requests reported through the proxy over its lifetime.
Format"int64"
updatedAt?stringWhen the proxy was last changed.
Format"date-time"
user?stringUsername for proxy authentication. Absent for a proxy without authentication.
version?stringEdit counter, incremented by every change a user makes to the proxy.
Format"int64"
workspaceId?stringOpaque 16-byte identifier of the workspace that owns the proxy, base64-encoded in JSON.
Format"byte" base64
application/json
The request was malformed, such as a missing required field or an unparseable cursor. The request cannot be carried out in the current system state.
codestringThe Connect error code, such as "not_found".
details?array<object>Optional machine-readable error details.
messagestringA human-readable description of the error.
application/json
The request lacks a valid API key in the Authorization header.
codestringThe Connect error code, such as "not_found".
details?array<object>Optional machine-readable error details.
messagestringA human-readable description of the error.
application/json
The API key is not allowed to perform this action on this workspace.
codestringThe Connect error code, such as "not_found".
details?array<object>Optional machine-readable error details.
messagestringA human-readable description of the error.
application/json
The requested resource does not exist in this workspace.
codestringThe Connect error code, such as "not_found".
details?array<object>Optional machine-readable error details.
messagestringA human-readable description of the error.
application/json
The operation was aborted, typically because of a concurrency conflict.
codestringThe Connect error code, such as "not_found".
details?array<object>Optional machine-readable error details.
messagestringA human-readable description of the error.
application/json
The request was rate limited. Slow down and retry later.
codestringThe Connect error code, such as "not_found".
details?array<object>Optional machine-readable error details.
messagestringA human-readable description of the error.
application/json
An internal server error occurred.
codestringThe Connect error code, such as "not_found".
details?array<object>Optional machine-readable error details.
messagestringA human-readable description of the error.
application/json
The service is temporarily unavailable. Retry with backoff.
codestringThe Connect error code, such as "not_found".
details?array<object>Optional machine-readable error details.
messagestringA human-readable description of the error.
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
}'const res = await fetch("https://api.goldmine.to/proxies.v1.Proxies/UpdateProxy", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CSTRADER_API_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"proxyId": "bGVnYWN5cHJveHkwMDEAAA==",
"enabled": true
}),
});
const data = await res.json();body := strings.NewReader(`{
"proxyId": "bGVnYWN5cHJveHkwMDEAAA==",
"enabled": true
}`)
req, err := http.NewRequestWithContext(ctx, http.MethodPost, "https://api.goldmine.to/proxies.v1.Proxies/UpdateProxy", body)
if err != nil {
return err
}
req.Header.Set("Authorization", "Bearer "+os.Getenv("CSTRADER_API_KEY"))
req.Header.Set("Content-Type", "application/json")
res, err := http.DefaultClient.Do(req)import os, requests
res = requests.post(
"https://api.goldmine.to/proxies.v1.Proxies/UpdateProxy",
headers={"Authorization": f"Bearer {os.environ['CSTRADER_API_KEY']}"},
json={
"proxyId": "bGVnYWN5cHJveHkwMDEAAA==",
"enabled": true
},
)
data = res.json(){
"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"
}
}{
"code": "failed_precondition",
"message": "The request cannot be carried out in the current system state."
}{
"code": "unauthenticated",
"message": "The request lacks a valid API key in the Authorization header."
}{
"code": "permission_denied",
"message": "The API key is not allowed to perform this action on this workspace."
}{
"code": "not_found",
"message": "The requested resource does not exist in this workspace."
}{
"code": "aborted",
"message": "The operation was aborted, typically because of a concurrency conflict."
}{
"code": "resource_exhausted",
"message": "The request was rate limited. Slow down and retry later."
}{
"code": "internal",
"message": "An internal server error occurred."
}{
"code": "unavailable",
"message": "The service is temporarily unavailable. Retry with backoff."
}