What the FreshPerf API is
The FreshPerf API does from your scripts and servers what you do in the dashboard: services, billing, orders, support.
| The API | Detail |
|---|---|
| Base URL | https://api.freshperf.fr/v1 |
| Format | JSON in, JSON out |
| Authentication | Authorization: Bearer fpk_..., a key created under Account > API keys |
| Reach | your own account only |
| Full reference | freshperf.fr/api-reference |
A key carries the permissions you tick, narrows to a list of services and a list of IP addresses, can expire, and revokes with effect on the next call. The dashboard keeps 30 days of log per key.
What you can do
| Area | Operations | Article |
|---|---|---|
| Services | list, detail, live status, resource history, start / stop / restart, console, backups, reinstall, rename, resume and advance the renewal, add-ons | Managing services |
| Provider actions | firewall and reverse DNS, through POST /services/{code}/actions/{action} | Managing services |
| Billing | invoices and credit notes with their PDFs, prepaid balance and its ledger, stored payment methods, paying an invoice | Invoices, balance and payments |
| Orders | catalogue, placing an order, paying it, following it | Ordering through the API |
| Support and account | tickets, SSH keys, notifications, delegated access, profile | Tickets, SSH keys and account |
The firewall and reverse DNS have no dedicated route. They go through the provider action gateway, with arguments specific to each kind of infrastructure.
What stays in the dashboard
- Stopping a renewal.
PATCH /services/{code}withautoRenew: falseanswers400 RENEWAL_CANCELLATION_NOT_AVAILABLE_VIA_API. Resuming it (autoRenew: true) does go through. - Managing API keys. No
/v1route creates, lists or revokes one. - Adding or removing a payment method. The API reads the list and charges it; it does not fill it.
- The interactive console, file uploads, sub-users, referral withdrawals.
Where to find what
| Resource | Contents |
|---|---|
| This section | keys, permissions, conventions, and every route with its fields and errors |
| /api-reference | the reference generated from the code, with a try-it console. English |
https://api.freshperf.fr/v1/openapi.json | the same content for machines. The only route of the API that takes no key |
| status.freshperf.fr | the platform's state. Its own API, no key needed: see Status page API |
Reading order
- Getting started in five minutes: create a key, make a first call.
- Authentication, Permissions, Securing your keys: what a key can do and how to bound it.
- Requests and responses, Rate limits and idempotency: the conventions every route follows.
- Managing services, Invoices, balance and payments, Ordering through the API, Tickets, SSH keys and account: the contract of each route.
- Error reference and Tools, OpenAPI and code samples when you need them.