# HostHatch Docs

> Guides for HostHatch servers and the HostHatch API.

The HostHatch API manages HostHatch projects, servers and their resources.
Base URL: https://console.hosthatch.com/api/v1. Authenticate with `Authorization: Bearer <key>`.
Requests and responses are JSON; errors are RFC 9457 problem details with a stable `code`.
OpenAPI document: https://docs.hosthatch.com/api/openapi.json


## API guides

- [HostHatch API](https://docs.hosthatch.com/api/index.md): Base URL, conventions, versioning and every endpoint
- [Quickstart](https://docs.hosthatch.com/api/quickstart/index.md): From an API key to a running server
- [Authentication](https://docs.hosthatch.com/api/authentication/index.md): API keys, read-only keys and the current user
- [Projects and roles](https://docs.hosthatch.com/api/projects-and-roles/index.md): Projects, roles, and reading your projects
- [Servers](https://docs.hosthatch.com/api/servers/index.md): Servers, hostnames, reverse DNS and cancellation
- [Actions](https://docs.hosthatch.com/api/actions/index.md): Asynchronous actions, polling, exclusivity and idempotency
- [Orders and payment](https://docs.hosthatch.com/api/orders-and-payment/index.md): The catalogue, orders, credit and invoices
- [Snapshots](https://docs.hosthatch.com/api/snapshots/index.md): Snapshots and restoring them
- [Firewalls](https://docs.hosthatch.com/api/firewalls/index.md): Firewall groups, rules and attaching them to servers
- [ISOs](https://docs.hosthatch.com/api/isos/index.md): ISO images and mounting them
- [SSH keys](https://docs.hosthatch.com/api/ssh-keys/index.md): SSH keys

## API reference

- [Errors](https://docs.hosthatch.com/api/errors/index.md): Every error code, with its HTTP status and what to do
- [Rate limits](https://docs.hosthatch.com/api/rate-limits/index.md): Per-key limits and how to back off
- [Reference](https://docs.hosthatch.com/api/reference/index.md): The generated reference, from the OpenAPI document
- [Changelog](https://docs.hosthatch.com/api/changelog/index.md): Versioning policy and changes

## Legacy API

- [Legacy API](https://docs.hosthatch.com/legacy-api/index.md): The Peregrine API at cloud.hosthatch.com, kept for existing customers

## Servers and networking

- [Features](https://docs.hosthatch.com/features/index.md): Locations and what each offers
- [Networking](https://docs.hosthatch.com/networking/index.md): Network configuration examples