Goldmine
Providers

Connect a proxy provider

POST
/proxies.v1.Proxies/ConnectProvider

Connects a credential-bearing proxy provider 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 '{    "type": "PROVIDER_TYPE_WEBSHARE_RESIDENTIAL",    "credentials": "d2Vic2hhcmUtdG9rZW4tQWJDZEVmMTIzNDU2"  }'
{
  "provider": {
    "id": "AY+MIBEReqqLuywsLCwsLA==",
    "workspaceId": "AY+MHnorfD2eTxorPE1ebw==",
    "type": "PROVIDER_TYPE_WEBSHARE_RESIDENTIAL",
    "targetPoolId": "AY+MISIifMyN3T09PT09PQ==",
    "capabilities": {
      "stateApi": true,
      "supportsSocks5": true
    },
    "enabled": true,
    "version": "1",
    "createdAt": "2026-06-29T10:15:00Z",
    "updatedAt": "2026-06-29T10:15: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": "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."
}
{
  "code": "unavailable",
  "message": "The service is temporarily unavailable. Retry with backoff."
}