v1
ApplicationAPI & CLI
Double column
API
CLI
JS Client

Templates /

List templates

Get a list of templates

Required permission

Account > Templates > General > Read

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.

      • templates

        [array] required
        An array of template 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

          • concurrencyPolicy

            string
            Defines the concurrency behaviour of the template with respect to parallel runs.
            one of
            allow, queue, forbid

          • createdAt

            string
            time of creation

          • updatedAt

            string
            time of update

    • 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

Example response

200 OK

A list of templates.

JSON

{
  "data": {
    "templates": [
      {
        "name": "Example Template",
        "description": "This is a sample template.",
        "apiVersion": "v1.2",
        "options": {
          "autorun": false,
          "concurrencyPolicy": "allow"
        },
        "id": "example-template",
        "concurrencyPolicy": "allow"
      }
    ]
  },
  "pagination": {
    "hasNextPage": false,
    "count": 1
  }
}

© 2024 Northflank Ltd. All rights reserved.

northflank.comTermsPrivacyfeedback@northflank.com