Templates /

List template runs

Get a list of template runs

Required permission

Account > Templates > General > Read

Path parameters

templateId
string required
ID of the template

Query parameters

per_page
integer
The number of results to display per request. Maximum of 100 results per page.
page
integer
The page number to access.
cursor
string
The cursor returned from the previous page of results, used to request the next page.

Response body

{object}
Response object.

data
{object} required
Result data.

templateRuns
[array] required
An array of template run objects.

{object}

name
string required
Name of the template.
min length
3
max length
100
pattern
^[a-zA-Z0-9]+((-|\s)[a-zA-Z0-9]+)*$
description
string
Description of the template.
max length
200
pattern
^[a-zA-Z0-9.,?\s\\/'"()[\];`%^&*\-_:!]+$
apiVersion
string required
The version of the Northflank API to run the template against.
one of
v1.2
options
{object}
Options regarding how the template is run.

autorun
boolean
If true, the template will run automatically whenever a change is made to it.
concurrencyPolicy
string
Defines the concurrency behaviour of the template with respect to parallel runs.
one of
allow, queue, forbid

id
string required
Identifier for the template run
templateId
string required
Identifier for the template
status
string required
Status of the template run
one of
pending, running, success, failure, aborted, aborting, queued, unknown, skipped
startedAt
string
Timestamp the run started at.
concluded
boolean required
Whether the run has concluded (aborted, success, failed)
concludedAt
string
Timestamp the run concluded at.
createdAt
string required
Timestamp the run was created at.
updatedAt
string required
Timestamp the run was last updated at.

pagination
{object} required
Data about the endpoint pagination.

hasNextPage
boolean required
Is there another page of results available?
cursor
string
The cursor to access the next page of results.
count
number required
The number of results returned by this request.

API

CLI

JS Client

GET /v1/templates/{templateId}/runs

Example response

200 OK

A list of template runs.

JSON

{
  "data": {
    "templateRuns": [
      {
        "name": "Example Template",
        "description": "This is a sample template.",
        "apiVersion": "v1.2",
        "options": {
          "autorun": false,
          "concurrencyPolicy": "allow"
        },
        "id": "3dd592f6-ce63-45ee-acf8-13dc5ec5235c",
        "templateId": "example-template",
        "status": "success",
        "startedAt": "2021-01-01 12:01:00.000Z",
        "concluded": true,
        "concludedAt": "2021-01-01 12:10:00.000Z",
        "createdAt": "2021-01-01 12:00:00.000Z",
        "updatedAt": "2021-01-01 12:00:00.000Z"
      }
    ]
  },
  "pagination": {
    "hasNextPage": false,
    "count": 1
  }
}