Templates /
List template runs
Required permission
Account > Templates > General > Read
Path parameters
templateId
string requiredID of the template
Query parameters
per_page
integerThe number of results to display per request. Maximum of 100 results per page.
page
integerThe page number to access.
cursor
stringThe cursor returned from the previous page of results, used to request the next page.
Response body
- {object}
Response object.
data
{object} requiredResult data.
templateRuns
[array] requiredAn array of template run objects.
- {object}
name
string requiredName of the template.
min length3max length39pattern^[a-zA-Z]((-|\s)?[a-zA-Z0-9]+((-|\s)[a-zA-Z0-9]+)*)?$description
stringDescription of the template.
max length200pattern^[a-zA-Z0-9.,?\s\\/'"()[\];`%^&*\-_:!]+$apiVersion
string requiredThe version of the Northflank API to run the template against.
one ofv1id
string requiredIdentifier for the template run
templateId
string requiredIdentifier for the template
status
string requiredStatus of the template run
one ofpending, running, success, failure, aborted, abortingstartedAt
stringTimestamp the run started at.
concluded
boolean requiredWhether the run has concluded (aborted, success, failed)
concludedAt
stringTimestamp the run concluded at.
createdAt
string requiredTimestamp the run was created at.
updatedAt
string requiredTimestamp the run was last updated at.
pagination
{object} requiredData about the endpoint pagination.
hasNextPage
boolean requiredIs there another page of results available?
cursor
stringThe cursor to access the next page of results.
count
number requiredThe number of results returned by this request.
GET /v1/templates/{templateId}/runs
Example response
200 OK
JSON
{
"data": {
"templateRuns": [
{
"name": "Example Template",
"description": "This is a sample template.",
"apiVersion": "v1",
"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
}
}