Skip to content

API Reference / Proxy pools

Update a proxy pool

Updates a proxy pool's name, description, auto-rotation behaviour, capacity caps, or health-probe settings. Only the fields you supply are changed. Set a clear_* flag to intentionally return a capacity cap or prober override to its unset default instead of setting a value.

POST/proxies.v1.Proxies/UpdatePool

Request body

application/jsonRequired

Request to change a proxy pool's name, description, rotation, capacity limits or health check settings. Fields left out are unchanged, and a clear flag resets a setting to unset. Setting a value and its clear flag together is rejected with invalid_argument.

autoRotateUnhealthy?boolean

New automatic rotation setting. Absent keeps the current setting.

carriers?PoolCarriers

New networks a bought address must come from, best first. Absent keeps the current list. An empty list buys on any network. Accepted only for the platform's own pools.

Show attributes
carriers?array<string>

Networks as ASNs such as AS8881, best first. Empty buys on any network.

clearMaxAssignmentsPerSession?boolean

True removes the limit on accounts per session. Cannot be combined with max_assignments_per_session.

clearMaxSessions?boolean

True removes the limit on enabled sessions. Cannot be combined with max_sessions.

clearProbeInterval?boolean

True returns the health check interval to the service default. Cannot be combined with probe_interval.

clearProbeLatencyCeiling?boolean

True returns the latency limit to the service default. Cannot be combined with probe_latency_ceiling.

clearUnhealthyAfterFailures?boolean

True returns the failure threshold to the service default. Cannot be combined with unhealthy_after_failures.

description?string

New description. Absent keeps the current description.

maxAssignmentsPerSession?integer

New maximum number of accounts per session. Absent keeps the current limit. Clear_max_assignments_per_session removes it.

Format"int32"

maxSessions?integer

New maximum number of enabled sessions. Absent keeps the current limit. Clear_max_sessions removes it.

Format"int32"

name?string

New pool name, unique within the workspace. Absent keeps the current name.

poolId?string

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

Format"byte" base64

probeInterval?string

New health check interval. Absent keeps the current value. Clear_probe_interval returns to the service default.

probeLatencyCeiling?string

New round trip time above which a check fails. Absent keeps the current value. Clear_probe_latency_ceiling returns to the service default.

purchaseLocation?string

New location bought addresses are ordered from. Absent keeps the current one. Empty returns to the provider's default. Accepted only for the platform's own pools.

unhealthyAfterFailures?integer

New number of consecutive failed checks before a session is unhealthy. Absent keeps the current value. Clear_unhealthy_after_failures returns to the service default.

Format"int32"

Response body

application/json

Success

pool?ProxiesPool

The pool with the update applied.

Show attributes
assignmentCount?integer

Number of accounts assigned to the pool, counted when the pool is read. Zero in create and update responses.

Format"int32"

autoRotateUnhealthy?boolean

True moves unpinned accounts off a session that becomes unhealthy onto a healthy one. Has no effect on sessions of a provider with static exit IPs.

carriers?array<string>

Networks a bought address must come from, as ASNs such as AS8881, best first. Empty buys on any network.

createdAt?string

When the pool was created.

Format"date-time"

deletedAt?string

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

Format"date-time"

description?string

Free-text description of the pool. May be empty.

disabledSessionCount?integer

Number of live sessions that are disabled.

Format"int32"

freeSessionCount?integer

Number of enabled sessions whose latest health check passed and that no account is assigned to: the IPs a new account could have to itself. Zero in create and update responses.

Format"int32"

healthySessionCount?integer

Number of enabled sessions whose latest health check passed.

Format"int32"

id?string

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

Format"byte" base64

maxAssignmentsPerSession?integer

Maximum number of accounts sharing one session. Absent means no limit.

Format"int32"

maxSessions?integer

Maximum number of enabled sessions in the pool. Absent means no limit.

Format"int32"

name?string

Pool name, unique within the workspace. A provider's pool is named after the provider type. An imported pool takes the name given at import.

oldestProbedAt?string

When the least recently checked enabled session was last checked. Absent while no enabled session has been checked.

Format"date-time"

probeInterval?string

How often each session in the pool is health checked. Absent uses the service default.

probeLatencyCeiling?string

Health check round trip time above which a check counts as failed. Absent uses the service default.

proxyCount?integer

Number of live sessions in the pool, enabled or not, counted when the pool is read. Zero in create and update responses.

Format"int32"

purchaseLocation?string

Where a bought address is ordered from, in the provider's own naming such as Germany - Frankfurt. Empty uses the provider's default.

sessionCount?integer

No longer used and always 0. proxy_count gives the number of sessions in the pool.

Format"int32"

unhealthyAfterFailures?integer

Number of consecutive failed health checks after which a session is marked unhealthy. Absent uses the service default.

Format"int32"

unhealthySessionCount?integer

Number of enabled sessions whose latest health check failed.

Format"int32"

unprobedSessionCount?integer

Number of enabled sessions that have never been health checked.

Format"int32"

updatedAt?string

When the pool was last changed.

Format"date-time"

version?string

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

Format"int64"

workspaceId?string

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

Format"byte" base64

curl -X POST "https://api.goldmine.to/proxies.v1.Proxies/UpdatePool" \
  -H "Authorization: Bearer $CSTRADER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "poolId": "AY+MISIifMyN3T09PT09PQ==",
    "autoRotateUnhealthy": true
  }'
{
  "pool": {
    "id": "AY+MISIifMyN3T09PT09PQ==",
    "workspaceId": "AY+MHnorfD2eTxorPE1ebw==",
    "name": "csfloat-scrapers",
    "description": "Residential pool for csfloat scraping",
    "autoRotateUnhealthy": true,
    "version": "4",
    "createdAt": "2026-06-20T12:00:00Z",
    "updatedAt": "2026-06-29T11:00:00Z",
    "maxAssignmentsPerSession": 1,
    "probeInterval": "300s",
    "unhealthyAfterFailures": 3,
    "probeLatencyCeiling": "5s"
  }
}