REST API
Everything you do in the Proxy Charm dashboard to read your setup — list workspaces, pull proxy credentials, check your plan, fetch invoices — you can also do from your own code. Add and remove workspaces too.
Base URL
Every endpoint is relative to this base. The version is in the path, so a future v2 will not change how v1 behaves.
Base URL
https://api.proxycharm.com/api/v1/publicWhat the API covers
Five resources, eight endpoints. The surface is small on purpose — it covers reading your account and changing workspace count, which is what most integrations need.
| Organization | The container for everything. One organization per API key. |
|---|---|
| Workspaces | Billed units that own proxies. List, read, create, and remove them. |
| Proxies | Assigned IPs with the gateway credentials your client connects with. |
| Subscription | Your live plan, its slots, and pending changes. |
| Invoices | Paginated billing history with links to hosted invoices and PDFs. |
What the API does not do
Some operations move money or grant access, so they stay in the dashboard where a human confirms them:
- Starting a plan, changing a plan, or cancelling. Use Billing in the dashboard.
- Adding or removing payment methods.
- Inviting people or changing their roles.
- Creating or revoking API keys — those live on the Developer page.
- Replacing an unhealthy IP. Ask support and we will swap it.