Sessions
Update a proxy session
Updates a proxy session, such as disabling it to trim a pool or changing a static endpoint's host, port, or username. Only the fields you supply are changed.
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/UpdateSession" \ -H "Content-Type: application/json" \ -d '{ "workspaceId": "AY+MHnorfD2eTxorPE1ebw==", "sessionId": "AY+MIjMzfu6P/05OTk5OTg==", "host": "203.0.113.99", "port": 8080, "username": "user-rotated" }'{
"session": {
"id": "AY+MIjMzfu6P/05OTk5OTg==",
"workspaceId": "AY+MHnorfD2eTxorPE1ebw==",
"poolId": "AY+MISIifMyN3T09PT09PQ==",
"providerId": "AY+MIBEReqqLuywsLCwsLA==",
"token": "sess-abc123",
"scheme": "http",
"host": "203.0.113.99",
"port": 8080,
"username": "user-rotated",
"enabled": true,
"version": "3",
"createdAt": "2026-06-20T12:00:00Z",
"updatedAt": "2026-06-29T11: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."
}ListSessions
Returns the identifiers of proxy sessions in your workspace, optionally limited to a single pool. Results are paginated; pass an empty cursor for the first page and follow the returned cursor for subsequent pages.
RotateWorkspaceKey
Generates a fresh encryption key for the workspace so new sensitive data is protected under the latest key. Returns the previous and new key versions.