v1
ApplicationAPI & CLI
Double column
API
CLI
JS Client

Pipelines /

List preview template runs

Get a list of preview template runs

Required permission

Account > Templates > General > Read

Path parameters

    • projectId

      string required
      ID of the project

    • pipelineId

      string required
      ID of the pipeline

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.

      • previewTemplateRuns

        [array] required
        An array of template run objects.
        • {object}

          • 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.

            • concurrencyPolicy

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

            • nameFormat

              string
              The format of the automatically generated preview name. This is a parsed ref string.

            • prefixName

              boolean
              If true, the preview name will default to the front of the resource name.

            • schedule

              {object}
              Options regarding which hours preview environments should be active. Only available for BYOC projects.

              • mon

                {object}

                • startTime

                  integer
                  min
                  0
                  max
                  2400

                • endTime

                  integer
                  min
                  0
                  max
                  2400

              • tue

                {object}

                • startTime

                  integer
                  min
                  0
                  max
                  2400

                • endTime

                  integer
                  min
                  0
                  max
                  2400

              • wed

                {object}

                • startTime

                  integer
                  min
                  0
                  max
                  2400

                • endTime

                  integer
                  min
                  0
                  max
                  2400

              • thu

                {object}

                • startTime

                  integer
                  min
                  0
                  max
                  2400

                • endTime

                  integer
                  min
                  0
                  max
                  2400

              • fri

                {object}

                • startTime

                  integer
                  min
                  0
                  max
                  2400

                • endTime

                  integer
                  min
                  0
                  max
                  2400

              • sat

                {object}

                • startTime

                  integer
                  min
                  0
                  max
                  2400

                • endTime

                  integer
                  min
                  0
                  max
                  2400

              • sun

                {object}

                • startTime

                  integer
                  min
                  0
                  max
                  2400

                • endTime

                  integer
                  min
                  0
                  max
                  2400

            • expiry

              {object}
              Settings regarding the automatic deletion of previews.

              • previewLifetime

                integer
                If set, preview environments will be automatically deleted after this many minutes since their last update.
                min
                1

              • resetOnUpdate

                boolean
                If `true`, the expiry time for an existing preview will be reset when it is ran again.

          • id

            string required
            Identifier for the template run

          • templateId

            string required
            Identifier for the template

          • status

            string required
            Status of the template run
            one of
            pending, running, success, failure

          • 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/projects/{projectId}/pipelines/{pipelineId}/preview-envs/runs

Example response

200 OK

A list of preview template runs.

JSON

{
  "data": {
    "previewTemplateRuns": [
      {
        "apiVersion": "v1.2",
        "options": {
          "concurrencyPolicy": "allow"
        },
        "id": "3dd592f6-ce63-45ee-acf8-13dc5ec5235c",
        "templateId": "example-template",
        "status": "pending"
      }
    ]
  },
  "pagination": {
    "hasNextPage": false,
    "count": 1
  }
}

© 2024 Northflank Ltd. All rights reserved.

northflank.comTermsPrivacyfeedback@northflank.com