The Calibre HTTP Site API allows you to create and manage Snapshots and deploys. This is useful as part of a post-deploy or post-merge hook.
The Site API is exclusively JSON over HTTP. There are no additional runtime dependencies. It's designed to be simple and easy to get started with.
URL Structure#
The HTTP Site API URL structure is:
https://calibreapp.com/api/<resource>/<site>?secret=<secret>| Parameter | Required | Description |
|---|---|---|
| resource | Yes | The type of resource, either "snapshots" or "deploys". |
| site | Yes | Site slug, found in Site Settings (see below). |
| secret | Yes | Site secret, found in Site Settings (see below). |
Site Settings#
Each Site within Calibre has a site-slug and a site-secret. You can find them in the Site Settings → General tab:
