Goldmine
Providers

Refresh a proxy provider's state

POST
/proxies.v1.Proxies/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.

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/RefreshProviderState" \  -H "Content-Type: application/json" \  -d '{    "workspaceId": "AY+MHnorfD2eTxorPE1ebw==",    "providerId": "AY+MIBEReqqLuywsLCwsLA=="  }'
{
  "provider": {
    "id": "AY+MIBEReqqLuywsLCwsLA==",
    "workspaceId": "AY+MHnorfD2eTxorPE1ebw==",
    "type": "PROVIDER_TYPE_WEBSHARE_RESIDENTIAL",
    "targetPoolId": "AY+MISIifMyN3T09PT09PQ==",
    "capabilities": {
      "enumerable": true,
      "stateApi": true
    },
    "state": {
      "bandwidthLimitBytes": "1099511627776",
      "bandwidthUsedBytes": "23622320128",
      "plan": "residential-1tb",
      "geoCount": 195
    },
    "stateRefreshedAt": "2026-06-29T11:30:00Z",
    "enabled": true,
    "version": "5",
    "createdAt": "2026-06-20T12:00:00Z",
    "updatedAt": "2026-06-29T11:30: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": "resource_exhausted",
  "message": "The request was rate limited. Slow down and retry later."
}
{
  "code": "internal",
  "message": "An internal server error occurred."
}

ListProviders

Returns the identifiers of the proxy providers connected to your workspace. Results are paginated; pass an empty cursor for the first page and follow the returned cursor for subsequent pages.

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.