Skip to content

API Reference / Proxy renewals

Count proxy renewal episodes

Returns the number of proxy renewal episodes in your workspace, optionally filtered by provider or status, so a list page can render a count without loading and counting every row.

POST/proxies.v1.Proxies/CountRenewals

Request body

application/jsonRequired

Request for the number of endpoint renewals in each status in the caller's workspace.

filter?RenewalFilter

The same filter as ListRenewals.

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

Response body

application/json

Success

counts?array<RenewalStatusCount>

Count of renewal episodes in each status, scoped to the workspace and the filter. A status with no episodes may be omitted.

Show attributes
count?integer

Number of renewals in this status.

Format"int32"

status?string

The renewal status this count is for.

Value in"RENEWAL_STATUS_RENEWING""RENEWAL_STATUS_DONE""RENEWAL_STATUS_HALTED"

curl -X POST "https://api.goldmine.to/proxies.v1.Proxies/CountRenewals" \
  -H "Authorization: Bearer $CSTRADER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
{
  "counts": [
    {
      "status": "RENEWAL_STATUS_HALTED",
      "count": 1
    },
    {
      "status": "RENEWAL_STATUS_DONE",
      "count": 1
    }
  ]
}