Skip to content

API Reference / Proxy renewals

List proxy renewal episodes

Returns the proxy renewal episodes in your workspace, optionally filtered by provider or status. Results are paginated. Pass an empty cursor for the first page and follow the returned cursor for subsequent pages.

POST/proxies.v1.Proxies/ListRenewals

Request body

application/jsonRequired

Request for one page of the endpoint renewals in the caller's workspace, optionally narrowed by status.

cursor?string

Opaque pagination cursor from a previous ListRenewalsResponse. Empty for the first page.

descending?boolean

Order descending instead of ascending.

filter?RenewalFilter

Optional filters applied before pagination.

Show attributes
providerId?string

Optional provider id to limit results to that provider's renewal episodes. Unset includes renewal episodes across all providers.

Format"byte" base64

limit?integer

Maximum number of renewal episodes to return. Server caps this at a service-defined upper bound.

Format"int32"

sortField?string

Field to order the page by. Unspecified orders by creation time.

Value in"RENEWAL_SORT_FIELD_CREATED_AT""RENEWAL_SORT_FIELD_UPDATED_AT"

statuses?array<string>

Optional status set, the grouping dimension CountRenewals breaks down by. Empty includes every status.

Value in"RENEWAL_STATUS_RENEWING""RENEWAL_STATUS_DONE""RENEWAL_STATUS_HALTED"

Response body

application/json

Success

nextCursor?string

Cursor to pass as cursor to fetch the next page. Empty when this is the last page.

renewals?array<ProxiesRenewal>

The renewals on this page, in the requested order.

Show attributes
attempts?integer

Number of renewal attempts in the current episode. Capped, and reset when a new episode starts.

Format"int32"

createdAt?string

When the renewal started.

Format"date-time"

endpointIds?array<string>

The provider's identifiers of the endpoints this renewal extends.

id?string

Opaque 16-byte identifier of the renewal, base64-encoded in JSON.

Format"byte" base64

lastError?string

The last failure, recorded when the renewal halts so a member can see what went wrong. Absent otherwise.

orderReference?string

A summary of the confirmed renewal, giving the number of endpoints and the furthest new expiry. Absent until the renewal is confirmed.

providerId?string

Opaque 16-byte identifier of the provider whose endpoints are renewed, base64-encoded in JSON.

Format"byte" base64

spendCents?string

Money committed to the provider in the current episode, in US cents. Reset when a new episode starts.

Format"int64"

status?string

Where the renewal stands: renewing, done, or halted and needing attention. A provider has at most one renewal in progress.

Value in"RENEWAL_STATUS_RENEWING""RENEWAL_STATUS_DONE""RENEWAL_STATUS_HALTED"

updatedAt?string

When the renewal last changed.

Format"date-time"

workspaceId?string

Opaque 16-byte identifier of the workspace, base64-encoded in JSON.

Format"byte" base64

curl -X POST "https://api.goldmine.to/proxies.v1.Proxies/ListRenewals" \
  -H "Authorization: Bearer $CSTRADER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "limit": 50,
    "filter": {
      "providerId": "AY+MIZmZfu6P/05OTk5OTg=="
    }
  }'
{
  "renewals": [
    {
      "id": "AY+MJmZmfu6P/05OTk5OTg==",
      "workspaceId": "AY+MHnorfD2eTxorPE1ebw==",
      "providerId": "AY+MIZmZfu6P/05OTk5OTg==",
      "status": "RENEWAL_STATUS_HALTED",
      "endpointIds": [
        "10.0.0.1:8080"
      ],
      "attempts": 3,
      "spendCents": "0",
      "lastError": "insufficient balance",
      "createdAt": "2026-06-28T09:00:00Z",
      "updatedAt": "2026-06-28T09:05:00Z"
    }
  ],
  "nextCursor": "eyJvZmZzZXQiOjUwfQ=="
}