Templates /
Get template
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.
id
string requiredID of the template.
createdAt
date requiredTimestamp of when the template was created.
updatedAt
date requiredTimestamp of when the template was last updated.
content
{object}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
GET /v1/templates/{templateId}
Example response
200 OK
JSON
{
"data": {
"id": "example-template",
"createdAt": "2022-06-14 15:10:42.842Z",
"updatedAt": "2022-06-14 15:10:42.842Z",
"content": {
"name": "Example Template",
"description": "This is a sample template.",
"apiVersion": "v1"
}
}
}