Goldmine
Sessions

Create a proxy session

POST
/proxies.v1.Proxies/CreateSession

Adds a single proxy session to a pool from one of its providers. For static endpoints you provide the scheme, host, port, and credentials; rotation sessions carry only a sticky-session token. The endpoint password is write only and 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/CreateSession" \  -H "Content-Type: application/json" \  -d '{    "workspaceId": "AY+MHnorfD2eTxorPE1ebw==",    "poolId": "AY+MISIifMyN3T09PT09PQ==",    "providerId": "AY+MIBEReqqLuywsLCwsLA==",    "token": "sess-abc123",    "scheme": "http",    "host": "203.0.113.10",    "port": 8080,    "username": "user-018f",    "password": "s3cr3t-pass"  }'
{
  "session": {
    "id": "AY+MIjMzfu6P/05OTk5OTg==",
    "workspaceId": "AY+MHnorfD2eTxorPE1ebw==",
    "poolId": "AY+MISIifMyN3T09PT09PQ==",
    "providerId": "AY+MIBEReqqLuywsLCwsLA==",
    "token": "sess-abc123",
    "scheme": "http",
    "host": "203.0.113.10",
    "port": 8080,
    "username": "user-018f",
    "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": "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."
}

BulkCreateSessions

Adds many proxy sessions to a pool from one provider in a single transaction, typically when seeding a pool. The operation is idempotent on the pool and session token, so re-running it does not create duplicates.

DeleteSession

Removes a proxy session from its pool. The session is soft deleted and excluded from future proxy resolution.