API

Control your account from your own code: keys, scopes, and the routes covering services, invoices, orders, tickets and the account.

• What the FreshPerf API isDrive your account from your own tools, with a key you control.
• Getting started in five minutesCreate a key, make a first call, act on a server.
• Authentication and API keysPresenting a key, what it holds, its life cycle and its log.
• Permissions (scopes)The 28 permissions, the routes each one opens, and how they combine.
• Securing your keysService restriction, address allowlist, expiry, spending cap, and what to do after a leak.
• Requests and responsesEnvelope, pagination, errors, identifiers, amounts, dates, headers.
• Rate limits and idempotencyThe six counters, and how to retry a payment without making it twice.
• Managing servicesRead, monitor, power, back up, reinstall and renew a service.
• Invoices, balance and paymentsRead invoices and credit notes, follow the prepaid balance, pay an invoice.
• Ordering through the APIRead the catalogue, place an order, pay it, collect the services it created.
• Tickets, SSH keys and accountOpen and follow a ticket, manage SSH keys, read the account, its notifications and its delegated access.
• Error referenceEvery marker, its status, the routes that emit it and what to do.
• Tools, OpenAPI and code samplesImport the API into your tools, generate a client, and small samples in bash, Python and Node.
• Status page APIRead the platform's state, its incidents and its maintenance windows, with no key.