Templates /
Run template
Required permission
Account > Templates > General > Run
Path parameters
templateId
string requiredID of the template
Response body
- {object}
Response object.
data
{object} requiredResult data.
id
string requiredID of the template run.
createdAt
date requiredTimestamp of when the run was initiated.
updatedAt
date requiredTimestamp of when the run was last updated.
template
{object} requiredDetails about the template being run.
id
string requiredID of the template
name
string requiredThe name of the template
status
string requiredStatus of the template run.
one ofwaiting, failure, retrying, success, unknowncontent
{object} requiredDetails about the template run.
name
string requiredName of the template.
min length3max length20pattern^[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 ofv1project
requiredspec
required
POST /v1/templates/{templateId}/runs
Example response
200 OK
JSON
{
"data": {
"id": "501c1e03-a021-4659-9048-85f8f6ee2bc7",
"createdAt": "2022-06-14 15:10:42.842Z",
"updatedAt": "2022-06-14 15:10:42.842Z",
"template": {
"id": "example-template",
"name": "Example Template"
},
"status": "success",
"content": {
"name": "Example Template",
"description": "This is a sample template.",
"apiVersion": "v1"
}
}
}