HTTP Site API


Overview

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 is designed to be simple and easy to get started with.

URL Structure

The HTTP Site API URL structure is:

1https://calibreapp.com/api/<resource>/<site>?secret=<secret>
ParameterRequiredDescription
resourceYesThe type of resource, either "snapshots" or "deploys".
siteYesSite slug, found in site settings (see below)
secretYesSite secret, found in site settings (see below)

Site Settings

Each Site within Calibre has a site-slug and a site-secret. These can be found on the Site settings page:

Example site settings page

Related Articles