Skip to content
TrueProxies Docs

Overview

TrueProxies Customer API 1.0.0

Section titled “TrueProxies Customer API 1.0.0”

Manage existing proxy services using scoped Bearer keys. Default budget: 300 requests per minute per account, shared across keys and control replicas. On HTTP 429, wait for Retry-After. Protected responses use Cache-Control: no-store and X-Request-ID. Timestamps are ISO-8601; monetary amounts are cents. Use the dashboard for API key management. Creating and paying invoices requires billing:write or reseller:purchase.

Information

  • OpenAPI version: 3.1.0

Operations

Section titled “Operations”
GET
/v1/analytics
GET
/v1/catalog
GET
/v1/catalog/priced
GET
/v1/invoices
POST
/v1/invoices
GET
/v1/invoices/{id}
POST
/v1/invoices/{id}/cancel
POST
/v1/invoices/{id}/pay
GET
/v1/invoices/{id}/pdf
GET
/v1/me
GET
/v1/reseller/customers
POST
/v1/reseller/customers
GET
/v1/reseller/customers/{id}
DELETE
/v1/reseller/customers/{id}
PATCH
/v1/reseller/customers/{id}
POST
/v1/reseller/customers/{id}/resume
POST
/v1/reseller/customers/{id}/suspend
GET
/v1/services
GET
/v1/services/{id}
GET
/v1/services/{id}/analytics
POST
/v1/services/{id}/check
POST
/v1/services/{id}/endpoints
GET
/v1/services/{id}/live-metrics
POST
/v1/services/{id}/rotate-password
GET
/v1/services/{id}/secret
GET
/v1/services/{id}/usage
GET
/v1/services/{id}/whitelist
POST
/v1/services/{id}/whitelist
DELETE
/v1/services/{id}/whitelist/{entryId}
GET
/v1/wallet
GET
/v1/wallet/ledger
POST
/v1/wallet/topups

Authentication

Section titled “Authentication”

customerAPIKey

Section titled “customerAPIKey”

Send Authorization: Bearer tp_api_… . Create a named, scoped key in the customer dashboard. Keys expire after 30, 90 or 365 days and can be revoked immediately.

Security scheme type: http

Bearer format: API key