Goldmine
Providers

Update a proxy provider

POST
/proxies.v1.Proxies/UpdateProvider

Updates a connected proxy provider. You can enable or disable it, rotate its credentials, or change the pool that discovered endpoints feed into. Only the fields you supply are changed.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://loading/proxies.v1.Proxies/UpdateProvider" \  -H "Content-Type: application/json" \  -d '{    "workspaceId": "AY+MHnorfD2eTxorPE1ebw==",    "providerId": "AY+MIBEReqqLuywsLCwsLA==",    "credentials": "d2Vic2hhcmUtdG9rZW4tcm90YXRlZC0yMDI2"  }'
{
  "provider": {
    "id": "AY+MIBEReqqLuywsLCwsLA==",
    "workspaceId": "AY+MHnorfD2eTxorPE1ebw==",
    "type": "PROVIDER_TYPE_WEBSHARE_RESIDENTIAL",
    "targetPoolId": "AY+MISIifMyN3T09PT09PQ==",
    "capabilities": {
      "enumerable": true,
      "stateApi": 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": "invalid_argument",
  "message": "The request was malformed, such as a missing required field or an unparseable cursor."
}
{
  "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": "resource_exhausted",
  "message": "The request was rate limited. Slow down and retry later."
}
{
  "code": "internal",
  "message": "An internal server error occurred."
}

RefreshProviderState

Pulls the latest plan and bandwidth usage from the provider's upstream account and returns the refreshed provider. Only providers that expose an account state interface can be refreshed.

CreatePool

Creates a named proxy pool that groups proxy sessions for a use case. You can set how many rotation slots it materializes, whether unhealthy sessions are rotated automatically, and optional capacity and health-probe settings.