Providers
Get a proxy provider
Returns a single connected proxy provider, including its capabilities and the most recent snapshot of its upstream plan and bandwidth state. Stored credentials are never returned.
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/GetProvider" \ -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": "21474836480",
"plan": "residential-1tb",
"geoCount": 195
},
"stateRefreshedAt": "2026-06-29T09:00:00Z",
"enabled": true,
"version": "3",
"createdAt": "2026-06-20T12:00:00Z",
"updatedAt": "2026-06-29T09: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."
}DeleteProvider
Removes a connected proxy provider from your workspace. The provider is soft deleted and stops contributing proxies to its pools.
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.