Skip to content

Templates ​

One-click templates and deploying them into a project.

Base URL: https://api.fjordrun.com. Generated from the OpenAPI document (API version 0.1.0).

List templates ​

GET /api/v1/templates

Public (no auth): the dashboard and the website's template gallery. The list only changes with a release, so browsers and CDNs may cache it for a few minutes.

Authentication: none.

Response

200: JSON.

Example

bash
curl "https://api.fjordrun.com/api/v1/templates"

Deploy a template ​

POST /api/v1/projects/{pid}/templates/{code}/deploy

Authentication: a team API token or personal access token.

Parameters

NameInTypeRequiredDescription
pidpathstring (UUID)yes
codepathstringyes

Request body

FieldTypeRequiredDescription
environment_idstring (UUID)yes

Response

201: a list of Service objects.

Example

bash
curl -X POST "https://api.fjordrun.com/api/v1/projects/$PROJECT_ID/templates/$TEMPLATE_CODE/deploy" \
  -H "Authorization: Bearer $FJORDRUN_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"environment_id":"00000000-0000-0000-0000-000000000000"}'

Request objects ​

TemplateDeployIn ​

FieldTypeRequiredDescription
environment_idstring (UUID)yes

Fjordrun is hosted in the EU (Hetzner, Nuremberg, Germany). Private beta.