Skip to content

API Reference / Proxy renewals

Get a proxy renewal episode

Returns a single provider renewal episode by id, showing its status, the endpoint batch it renews, and spend so far.

POST/proxies.v1.Proxies/GetRenewal

Request body

application/jsonRequired

Request for one endpoint renewal in the caller's workspace by identifier.

renewalId?string

Renewal episode identifier.

Format"byte" base64

Response body

application/json

Success

renewal?ProxiesRenewal

The renewal with its status, attempts and spend.

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/GetRenewal" \
  -H "Authorization: Bearer $CSTRADER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "renewalId": "AY+MJmZmfu6P/05OTk5OTg=="
  }'
{
  "renewal": {
    "id": "AY+MJmZmfu6P/05OTk5OTg==",
    "workspaceId": "AY+MHnorfD2eTxorPE1ebw==",
    "providerId": "AY+MIZmZfu6P/05OTk5OTg==",
    "status": "RENEWAL_STATUS_RENEWING",
    "endpointIds": [
      "10.0.0.1:8080",
      "10.0.0.2:8080"
    ],
    "attempts": 1,
    "spendCents": "2500",
    "createdAt": "2026-06-29T09:00:00Z",
    "updatedAt": "2026-06-29T09:00:00Z"
  }
}