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.
/ proxies. v1. Proxies/ GetRenewalRequest body
application/jsonRequired
Request for one endpoint renewal in the caller's workspace by identifier.
renewalId?stringRenewal episode identifier.
Format"byte" base64
Response body
application/json
Success
renewal?ProxiesRenewalThe renewal with its status, attempts and spend.
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 requested resource does not exist in 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/GetRenewal" \
-H "Authorization: Bearer $CSTRADER_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"renewalId": "AY+MJmZmfu6P/05OTk5OTg=="
}'const res = await fetch("https://api.goldmine.to/proxies.v1.Proxies/GetRenewal", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CSTRADER_API_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"renewalId": "AY+MJmZmfu6P/05OTk5OTg=="
}),
});
const data = await res.json();body := strings.NewReader(`{
"renewalId": "AY+MJmZmfu6P/05OTk5OTg=="
}`)
req, err := http.NewRequestWithContext(ctx, http.MethodPost, "https://api.goldmine.to/proxies.v1.Proxies/GetRenewal", 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/GetRenewal",
headers={"Authorization": f"Bearer {os.environ['CSTRADER_API_KEY']}"},
json={
"renewalId": "AY+MJmZmfu6P/05OTk5OTg=="
},
)
data = res.json(){
"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"
}
}{
"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."
}{
"code": "unavailable",
"message": "The service is temporarily unavailable. Retry with backoff."
}