API Reference / Proxy providers
Update a proxy provider
Updates a connected proxy provider. You can enable or disable it, rotate its credentials, switch automatic renewal on or off, and set or remove its purchase budget. Only the fields you supply are changed.
/ proxies. v1. Proxies/ UpdateProviderRequest body
application/jsonRequired
Request to enable or disable a provider connection or replace its credentials. Fields left out are unchanged. Its pool cannot be changed.
clearPurchaseBudget?booleanTrue removes the purchase budget, which switches buying off. Cannot be combined with purchase_budget_cents.
credentials?stringReplacement API credential as UTF-8 bytes, base64-encoded in JSON. Absent keeps the current credential. Empty is rejected. Returned only by RevealProviderCredentials.
Format"byte" base64
enabled?booleanNew enabled state. Absent keeps the current state.
providerId?stringOpaque 16-byte identifier of the provider connection to change, base64-encoded in JSON.
Format"byte" base64
purchaseBudgetCents?stringSets the most the service may spend buying new proxies from this provider in any rolling 30 days, in US cents, which switches buying on. Absent keeps the current budget. Must not be negative, and is rejected for a provider type that cannot buy.
Format"int64"
renewalEnabled?booleanSwitches automatic renewal on or off for this provider. Absent keeps the current setting. Rejected as invalid for a provider type that cannot renew.
Response body
application/json
Success
provider?ProxiesProviderThe provider connection with the update applied.
Show attributes
capabilities?ProxiesProviderCapabilitiesWhat this provider type can do, recorded when it was connected.
Show attributes
acquirable?booleanTrue when a new endpoint can be bought, which costs money, as with Proxyline.
enumerable?booleanTrue when the provider lists real endpoints, as Webshare static and Proxyline do. False when sessions are rotation slots, as with Webshare residential.
releasable?booleanTrue when an endpoint can be given back to the provider.
renewable?booleanTrue when an endpoint can be extended before it expires, as with Proxyline.
replaceable?booleanTrue when a dead endpoint can be swapped for another within the plan at no charge, as with Webshare static.
stateApi?booleanTrue when the provider reports bandwidth and plan details that RefreshProviderState can read.
staticExitIp?booleanTrue when each session always exits from the same IP address, so its sessions are never rotated.
supportsSocks5?booleanTrue when the provider serves SOCKS5 as well as HTTP. Its sessions then use the socks5 scheme.
condition?stringWhy the service switched the provider off, when it did. Unset while the provider is serving or a member switched it off themselves.
Value in"PROVIDER_"PROVIDER_"PROVIDER_"PROVIDER_"PROVIDER_
conditionDetail?stringThe provider's own response to the rejected request, for support staff. Empty for a capacity condition.
conditionObservedAt?stringWhen the service last checked the account and still found the condition. Absent without a condition.
Format"date-time"
conditionSince?stringWhen the condition was first observed. Absent without a condition.
Format"date-time"
createdAt?stringWhen the provider was connected.
Format"date-time"
deletedAt?stringWhen the connection was deleted. Absent while it is live.
Format"date-time"
enabled?booleanTrue when the provider's sessions can be handed to accounts. False takes its whole pool out of use.
id?stringOpaque 16-byte identifier of the provider connection, assigned when it is connected. Base64-encoded in JSON.
Format"byte" base64
purchaseBudgetCents?stringThe most the service may spend buying new proxies from this provider in any rolling 30 days, in US cents. Absent means buying is switched off. Renewals are not counted against it.
Format"int64"
renewalEnabled?booleanTrue when the service renews this provider's proxies that have an account on them before they expire, limited by the provider balance. False for every newly connected provider, and then nothing is renewed.
state?ProxiesProviderStateThe provider account's latest plan and usage details. Empty until the first successful refresh.
Show attributes
balanceCents?stringProxyline and Suborbital account balance, in US cents. Zero for other providers.
Format"int64"
bandwidthLimitBytes?stringBandwidth allowed in the current billing period, in bytes. Zero when the plan is not metered.
Format"int64"
bandwidthUsedBytes?stringBandwidth used so far in the current billing period, in bytes.
Format"int64"
failedPaymentTimes?integerWebshare: number of failed automatic renewal payments on the subscription.
Format"int32"
geoCount?integerNumber of distinct locations available on the plan.
Format"int32"
lowBalance?booleanTrue when the account balance is below low_balance_threshold_cents. The account should be topped up before renewals, purchases or traffic stop. False for providers not billed from a balance.
lowBalanceThresholdCents?stringThe balance below which low_balance is true, in US cents: the larger of a fixed floor and what the endpoints expiring in the next 30 days cost to renew. Zero for providers not billed from a balance.
Format"int64"
nextRenewalAt?stringProxyline and Suborbital static: when the earliest of the account's active endpoints expires. The renewal duty renews endpoints shortly before this time. Unset for other providers and when the account has no active endpoints.
Format"date-time"
nextRenewalCostCents?stringProxyline: the cost of renewing next_renewal_endpoint_count endpoints at the quoted unit cost, in US cents. Unset when no quote has been read yet or no renewal is due.
Format"int64"
nextRenewalEndpointCount?integerProxyline and Suborbital static: how many endpoints expire within the renewal window starting at next_renewal_at, so renew together. Zero for other providers.
Format"int32"
paused?booleanWebshare: true when the subscription is paused. False for other providers.
plan?stringThe provider's identifier for the account's plan.
renewalHeldEndpointCount?integerProxyline: how many endpoints with an account on them expire within the renewal window but are not being renewed because renewal is switched off for this provider. They lapse unless renewal is switched on. Zero while renewal is on and for other providers.
Format"int32"
replacementQuota?integerWebshare static: free endpoint replacements left in the current window. Zero when none are left or the provider has none.
Format"int32"
throttled?booleanWebshare: true when the subscription is throttled. False for other providers.
unitCostCents?stringProxyline and Suborbital static: the cost of renewing one endpoint for 30 days, in US cents (Proxyline quoted live, Suborbital the published price of the dearest kind held). Zero for other providers and before the first read.
Format"int64"
stateRefreshedAt?stringWhen state was last read from the provider. Absent until the first successful refresh.
Format"date-time"
targetPoolId?stringOpaque 16-byte identifier of the pool the provider's sessions belong to, base64-encoded in JSON. Created when the provider is connected and never changes.
Format"byte" base64
type?stringWhich provider this is. A workspace can connect each type once.
Value in"PROVIDER_"PROVIDER_"PROVIDER_"PROVIDER_"PROVIDER_
updatedAt?stringWhen the connection was last changed.
Format"date-time"
userFixable?booleanTrue when the member can clear the condition themselves, for example by updating the API key or topping the account up. False without a condition, and for a suspended account, which only the provider's support can lift.
version?stringEdit counter, incremented by every change a user makes to the connection.
Format"int64"
workspaceId?stringOpaque 16-byte identifier of the workspace that owns the connection, 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/UpdateProvider" \
-H "Authorization: Bearer $CSTRADER_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"providerId": "AY+MIBEReqqLuywsLCwsLA==",
"credentials": "d2Vic2hhcmUtdG9rZW4tcm90YXRlZC0yMDI2"
}'const res = await fetch("https://api.goldmine.to/proxies.v1.Proxies/UpdateProvider", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CSTRADER_API_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"providerId": "AY+MIBEReqqLuywsLCwsLA==",
"credentials": "d2Vic2hhcmUtdG9rZW4tcm90YXRlZC0yMDI2"
}),
});
const data = await res.json();body := strings.NewReader(`{
"providerId": "AY+MIBEReqqLuywsLCwsLA==",
"credentials": "d2Vic2hhcmUtdG9rZW4tcm90YXRlZC0yMDI2"
}`)
req, err := http.NewRequestWithContext(ctx, http.MethodPost, "https://api.goldmine.to/proxies.v1.Proxies/UpdateProvider", 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/UpdateProvider",
headers={"Authorization": f"Bearer {os.environ['CSTRADER_API_KEY']}"},
json={
"providerId": "AY+MIBEReqqLuywsLCwsLA==",
"credentials": "d2Vic2hhcmUtdG9rZW4tcm90YXRlZC0yMDI2"
},
)
data = res.json(){
"provider": {
"id": "AY+MIBEReqqLuywsLCwsLA==",
"workspaceId": "AY+MHnorfD2eTxorPE1ebw==",
"type": "PROVIDER_TYPE_WEBSHARE_RESIDENTIAL",
"targetPoolId": "AY+MISIifMyN3T09PT09PQ==",
"capabilities": {
"stateApi": true,
"supportsSocks5": true
},
"state": {
"bandwidthLimitBytes": "1099511627776",
"bandwidthUsedBytes": "21474836480",
"plan": "residential-1tb",
"geoCount": 195
},
"stateRefreshedAt": "2026-06-29T09:00:00Z",
"enabled": true,
"version": "4",
"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."
}