Hostodo Customer API

Manage your Hostodo VPS instances, SSH keys, reverse DNS, orders, and account programmatically. The Customer API is a REST JSON API that mirrors everything you can do from the Hostodo Console.

# 1. Authenticate (see Authentication below) to get a session cookie

# 2. Call an endpoint with the base URL:
curl -b cookies.txt https://api.hostodo.com/client/instances/

# 3. The API returns JSON
{ "count": 1, "results": [ { "hostname": "my-server", ... } ] }

Base URL

All Customer API endpoints live under /client/ and are served from the Hostodo API host:

The Customer API is a Django REST Framework JSON API. Send Content-Type: application/json for requests with a body.

Pagination

List endpoints are paginated with the limit/offset style and return a JSON object with count, next, previous, and results keys. Pagination is controlled by query parameters (default limit is 25):

Path parameters

Colon-prefixed segments in a path are parameters that must be replaced with a resource identifier:

Authentication

Authenticated endpoints use a JWT stored in a session cookie scoped to the Hostodo domain. Log in through the Hostodo Console (or the auth endpoints) to obtain the cookie, then send it with each request.

Most endpoints below require authentication. Public endpoints (signup, activation, forgot-password, plans, templates, ISOs, regions, and order pricing) can be called without a session.

Errors

Endpoints return standard HTTP status codes and DRF-style JSON errors:

Signup & Activation

Signup request body

Activate request body

Forgot-password request body

Customer Profile

Customer update request body

Password

Plans

Templates

ISOs

Regions

List & Details

Instance paths take the instance ID in place of :instance_id.

Power & Actions

Update-info request body

Instance-settings request body (PATCH)

Reinstall request body

Cancel request body

Network

Orders

Price-order request body

Deploy-instance request body

SSH Keys

Add / update SSH key request body

Reverse DNS

Create reverse DNS request body

All Endpoints

Complete list of Customer API endpoints. :pk, :customer_id, and :instance_id are path parameters identifying the resource.