API Reference

Hostinvo REST API

Integrate, extend, and automate Hostinvo with the REST API.

Base URL: https://api.hostinvo.dev/api/v1

Auth: Authorization: Bearer <API key>

Authentication: Create an API key under Settings > API Keys in your workspace and send it as Authorization: Bearer <key>. A key acts with the permissions of the person who created it (Read Only, Read & Write or Full Access) and can be limited to IP addresses. Browsers use the Sanctum session with a CSRF token instead.

MethodEndpointDescription

GET/api/v1/admin/clientsList clients (search, status, page)

POST/api/v1/admin/clientsCreate a client

GET/api/v1/admin/clients/{client}/activityA client's activity log

GET/api/v1/admin/ordersList orders

GET/api/v1/admin/productsList products and plans

GET/api/v1/admin/invoicesList invoices (status, client, period)

POST/api/v1/admin/invoicesCreate an invoice

POST/api/v1/admin/invoices/{invoice}/paymentsRecord a payment against an invoice

GET/api/v1/admin/invoices/{invoice}/pdfThe invoice as PDF

GET/api/v1/admin/servicesList services

POST/api/v1/admin/services/{service}/operations/{operation}Queue suspend, unsuspend, terminate or password reset

GET/api/v1/admin/serversList provisioning servers

POST/api/v1/admin/servers/{server}/testTest a server connection

GET/api/v1/admin/domainsList domains

GET/api/v1/admin/ticketsList support tickets

POST/api/v1/licensing/validateValidate a licence key and its domain binding

GET/healthHealth check (database, cache, queue)

Looking for integration guides?

View Guides