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.
/ proxies. v1. Proxies/ ListRenewalsRequest body
application/jsonRequired
Request for one page of the endpoint renewals in the caller's workspace, optionally narrowed by status.
cursor?stringOpaque pagination cursor from a previous ListRenewalsResponse. Empty for the first page.
descending?booleanOrder descending instead of ascending.
filter?RenewalFilterOptional filters applied before pagination.
Show attributes
providerId?stringOptional provider id to limit results to that provider's renewal episodes. Unset includes renewal episodes across all providers.
Format"byte" base64
limit?integerMaximum number of renewal episodes to return. Server caps this at a service-defined upper bound.
Format"int32"
sortField?stringField to order the page by. Unspecified orders by creation time.
Value in"RENEWAL_"RENEWAL_
statuses?array<string>Optional status set, the grouping dimension CountRenewals breaks down by. Empty includes every status.
Value in"RENEWAL_"RENEWAL_"RENEWAL_
Response body
application/json
Success
nextCursor?stringCursor 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?integerNumber of renewal attempts in the current episode. Capped, and reset when a new episode starts.
Format"int32"
createdAt?stringWhen the renewal started.
Format"date-time"
endpointIds?array<string>The provider's identifiers of the endpoints this renewal extends.
id?stringOpaque 16-byte identifier of the renewal, base64-encoded in JSON.
Format"byte" base64
lastError?stringThe last failure, recorded when the renewal halts so a member can see what went wrong. Absent otherwise.
orderReference?stringA summary of the confirmed renewal, giving the number of endpoints and the furthest new expiry. Absent until the renewal is confirmed.
providerId?stringOpaque 16-byte identifier of the provider whose endpoints are renewed, base64-encoded in JSON.
Format"byte" base64
spendCents?stringMoney committed to the provider in the current episode, in US cents. Reset when a new episode starts.
Format"int64"
status?stringWhere the renewal stands: renewing, done, or halted and needing attention. A provider has at most one renewal in progress.
Value in"RENEWAL_"RENEWAL_"RENEWAL_
updatedAt?stringWhen the renewal last changed.
Format"date-time"
workspaceId?stringOpaque 16-byte identifier of the workspace, base64-encoded in JSON.
Format"byte" base64
application/json
The request was malformed, such as a missing required field or an unparseable cursor. The request cannot be carried out in the current system state.
codestringThe Connect error code, such as "not_found".
details?array<object>Optional machine-readable error details.
messagestringA human-readable description of the error.
application/json
The request lacks a valid API key in the Authorization header.
codestringThe Connect error code, such as "not_found".
details?array<object>Optional machine-readable error details.
messagestringA human-readable description of the error.
application/json
The API key is not allowed to perform this action on this workspace.
codestringThe Connect error code, such as "not_found".
details?array<object>Optional machine-readable error details.
messagestringA human-readable description of the error.
application/json
The request was rate limited. Slow down and retry later.
codestringThe Connect error code, such as "not_found".
details?array<object>Optional machine-readable error details.
messagestringA human-readable description of the error.
application/json
An internal server error occurred.
codestringThe Connect error code, such as "not_found".
details?array<object>Optional machine-readable error details.
messagestringA human-readable description of the error.
application/json
The service is temporarily unavailable. Retry with backoff.
codestringThe Connect error code, such as "not_found".
details?array<object>Optional machine-readable error details.
messagestringA human-readable description of the error.
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=="
}
}'const res = await fetch("https://api.goldmine.to/proxies.v1.Proxies/ListRenewals", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CSTRADER_API_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"limit": 50,
"filter": {
"providerId": "AY+MIZmZfu6P/05OTk5OTg=="
}
}),
});
const data = await res.json();body := strings.NewReader(`{
"limit": 50,
"filter": {
"providerId": "AY+MIZmZfu6P/05OTk5OTg=="
}
}`)
req, err := http.NewRequestWithContext(ctx, http.MethodPost, "https://api.goldmine.to/proxies.v1.Proxies/ListRenewals", body)
if err != nil {
return err
}
req.Header.Set("Authorization", "Bearer "+os.Getenv("CSTRADER_API_KEY"))
req.Header.Set("Content-Type", "application/json")
res, err := http.DefaultClient.Do(req)import os, requests
res = requests.post(
"https://api.goldmine.to/proxies.v1.Proxies/ListRenewals",
headers={"Authorization": f"Bearer {os.environ['CSTRADER_API_KEY']}"},
json={
"limit": 50,
"filter": {
"providerId": "AY+MIZmZfu6P/05OTk5OTg=="
}
},
)
data = res.json(){
"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=="
}{
"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": "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."
}