Templates /

Get template

Get information about the given template.

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.

id
string required
ID of the template.
createdAt
date required
Timestamp of when the template was created.
updatedAt
date required
Timestamp of when the template was last updated.
content
{object}

name
string required
Name of the template.
min length
3
max length
20
pattern
^[a-zA-Z]((-|\s)?[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
project
required
spec
required

API

CLI

JS Client

GET /v1/templates/{templateId}

Example response

200 OK

Details about the template.

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"
    }
  }
}