Connect a proxy provider
Connects a credential-bearing proxy backend such as a Webshare or Proxyline account to your workspace. Credentials are sent in plaintext and encrypted before storage, and only one connection of each provider type is allowed per workspace.
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
application/json
curl -X POST "https://loading/proxies.v1.Proxies/ConnectProvider" \ -H "Content-Type: application/json" \ -d '{ "workspaceId": "AY+MHnorfD2eTxorPE1ebw==", "type": "PROVIDER_TYPE_WEBSHARE_RESIDENTIAL", "targetPoolId": "AY+MISIifMyN3T09PT09PQ==", "credentials": "d2Vic2hhcmUtdG9rZW4tQWJDZEVmMTIzNDU2" }'{
"provider": {
"id": "AY+MIBEReqqLuywsLCwsLA==",
"workspaceId": "AY+MHnorfD2eTxorPE1ebw==",
"type": "PROVIDER_TYPE_WEBSHARE_RESIDENTIAL",
"targetPoolId": "AY+MISIifMyN3T09PT09PQ==",
"capabilities": {
"enumerable": true,
"stateApi": true
},
"enabled": true,
"version": "1",
"createdAt": "2026-06-29T10:15:00Z",
"updatedAt": "2026-06-29T10:15: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": "already_exists",
"message": "The resource already exists."
}{
"code": "resource_exhausted",
"message": "The request was rate limited. Slow down and retry later."
}{
"code": "internal",
"message": "An internal server error occurred."
}UpdateAssignment
Updates a proxy assignment, such as rebinding the account to a different session or changing whether it is pinned. Only the fields you supply are changed.
DeleteProvider
Removes a connected proxy provider from your workspace. The provider is soft deleted and stops contributing proxies to its pools.