Skip to content

Changelog

Versioning

The version is in the path: /api/v1. Changes within v1 are additive, so code written against v1 keeps working:

  • new endpoints;
  • new optional fields in requests, and new fields in responses;
  • new values in enumerations, such as a new action type, order status or error code.

Write clients that ignore fields they don't know, and treat an unknown value by what they can tell from the rest: an unknown error code by its HTTP status, for example.

A breaking change, such as removing or renaming a field or changing what one means, comes as a new version at /api/v2/, announced here.

1.0.0

The first version of the HostHatch Cloud API, at https://console.hosthatch.com/api/v1.

  • API keys sent as Bearer tokens, with names, expiry, read-only keys and revocation on a password change, and GET /me/.
  • Projects with slugs that never change, the member, admin and owner roles, members and invitations.
  • Servers: list, detail, rename, reverse DNS and cancellation.
  • Actions for power, reboot, reinstall, root password reset, IPv6 and private networking, with one exclusive action per server and Idempotency-Key on every start.
  • Orders for new servers, upgrades and extra bandwidth, from the catalogue of images, locations and plans, paid from account credit or in the console.
  • Snapshots and ISOs: take, restore and delete snapshots, upload a custom ISO, and mount ISOs on servers.
  • Firewalls: groups, rules, and attaching groups to servers.
  • SSH keys, with fingerprints and duplicate detection.
  • Problem details errors with stable codes, rate limits per key, and paginated lists.