List workflows

Lists all workflows for a project

Required permission

Project > Workflows > General > Read

Path parameters

projectId
string required
ID of the project

Query parameters

per_page
integer
The number of results to display per request. Maximum of 100 results per page.
min
1
max
100
page
integer
The page number to access.
min
1
cursor
string
The cursor returned from the previous page of results, used to request the next page.
min length
24
max length
24

Response body

{object}
Response object.

data
{object} required
Result data.

workflows
[array] required
An array of workflows in this project.

{object}
A workflow.

apiVersion
string required
The version of the Northflank API to run the template against.
one of
v1.2
arguments
{object}
A set of arguments that can be referenced in a template using '${args.argumentName}'.

gitops
{object}

vcsService
string required
The VCS provider to use.
one of
bitbucket, gitlab, github, self-hosted, azure, origin
selfHostedVcsId
string
If projectType is self-hosted, the ID of the self-hosted vcs to use.
pattern
^([A-Za-z0-9-]+)|([0-9a-f]{24})$
accountLogin
string
By default, if you have multiple version control accounts of the same provider linked, Northflank will pick a linked account that has access to the repository. If `accountLogin` is provided, Northflank will instead use your linked account with that login name.
vcsLinkId
string
Legacy key. Please used accountLogin instead.
repoUrl
string required
URL of the Git repo to sync the file with.
pattern
^(https:\/\/)?((www(\.[a-zA-Z0-9-]{2,})+\.)?[a-zA-Z0-9-]{2,})(\.([a-zA-Z0-9-]{2,}))+(\/((?:[a-zA-Z0-9\-._]|%[a-fA-F0-9]{2}){2,}))+?$
branch
string required
The name of the branch to use.
filePath
string required
The file path in the repository. If using an existing file, it should be in JSON format.
pattern
^\/((?!\.\.?\/)[a-zA-Z0-9-._]+\/)*(?!\.\.?$)[a-zA-Z0-9-._]+$

$schema
string
name
string required
min length
3
max length
100
pattern
^[a-zA-Z0-9]+((-|\s)[a-zA-Z0-9]+)*$
description
string
max length
200
pattern
^[a-zA-Z0-9.,?\s\\/'"()[\];`%^&*\-_:!]+$

spec
(multiple options: oneOf)
A node representing an action to be performed as part of the template.

richInputs
[array]
An array of rich UI override inputs for the workflow.

(multiple options: oneOf)
A node representing a rich UI override for the Release Flow template.

{object}

BranchCommitSelector input

kind
string required
The kind of input.
one of
BranchCommitSelector
spec
{object} required
The specification for the BranchCommitSelector input.

{object}

BuildSelector input

kind
string required
The kind of input.
one of
BuildSelector
spec
{object} required
The specification for the BuildSelector input.

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, latest, replace

teardownSpec
{object} | null
Optional spec to run when the workflow is deleted.

spec
required
The root node of the teardown workflow.
failurePolicy
string
Controls what happens if the teardown spec fails or times out. `ignore` (default) — proceed with resource deletion regardless. `block` — halt deletion and set the environment to `teardown_failed`
one of
ignore, block

argumentOverrides
{object}
A set of arguments that can be referenced in a template using '${args.argumentName}'.

crossProjectAccess
{object}
Controls which projects can run this workflow.

enabled
boolean required
Allow this workflow to be run from other projects.
projects
[array] required
A list of project IDs used as an allow list or deny list.

string
pattern
^[A-Za-z0-9-]+$

isAllowList
boolean required
If true, only the listed projects can run this workflow. If false, all projects except the listed ones can run this workflow.

stageId
(multiple options: oneOf)
ID of the stage

string | null

ID of the stage

min length

max length

100

pattern

^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*$

string

A string containing one or more references that resolve to iD of the stage

pattern

.*\${.*}.*

triggers
[array]

(multiple options: anyOf)

{object}

kind
string required
one of
vcs-push
spec
{object} required
ref
string
A reference that can be used to access the output of this trigger in the template.
id
string
paused
boolean

{object}

kind
string required
one of
vcs-pr
spec
{object} required
ref
string
A reference that can be used to access the output of this trigger in the template.
id
string
paused
boolean

{object}

kind
string required
one of
webhook
spec
{object} required
ref
string required
A reference that can be used to access the output of this trigger in the template.
id
string
paused
boolean

{object}

kind
string required
one of
vcs-release
spec
{object} required
ref
string
A reference that can be used to access the output of this trigger in the template.
id
string
paused
boolean

{object}

kind
string required
one of
vcs-pr-label
spec
{object} required
ref
string
A reference that can be used to access the output of this trigger in the template.
id
string
paused
boolean

{object}

kind
string required
one of
vcs-check-suite
spec
{object} required
ref
string
A reference that can be used to access the output of this trigger in the template.
id
string
paused
boolean

{object}

kind
string required
one of
cron
spec
{object} required
ref
string
A reference that can be used to access the output of this trigger in the template.
id
string
paused
boolean

id
string required
Identifier for the workflow
createdAt
string required
Timestamp the template was created at.
updatedAt
string required
Timestamp the template was last updated at.

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.

GET /v1/projects/{projectId}/workflows

GET /v1/teams/{teamId}/projects/{projectId}/workflows

Example response

200 OK

A list of workflows that belong to the project.

JSON

{
  "data": {
    "workflows": [
      {
        "apiVersion": "v1.2",
        "gitops": {
          "vcsService": "github",
          "accountLogin": "github-user",
          "repoUrl": "https://github.com/northflank-examples/remix-postgres-redis-demo",
          "branch": "main",
          "filePath": "/Dockerfile"
        },
        "options": {
          "autorun": false,
          "concurrencyPolicy": "allow"
        },
        "crossProjectAccess": {
          "projects": [
            "example-project"
          ]
        },
        "triggers": [
          {
            "spec": {
              "vcs": {
                "vcsService": "github",
                "accountLogin": "github-user",
                "repoUrl": "https://github.com/northflank-examples/remix-postgres-redis-demo"
              },
              "commitMessageFlags": {
                "flags": [
                  "[skip ci]"
                ]
              },
              "filePaths": {
                "paths": [
                  "README.md"
                ]
              }
            }
          }
        ],
        "id": "example-workflow",
        "createdAt": "2021-01-01 12:00:00.000Z",
        "updatedAt": "2021-01-01 12:00:00.000Z"
      }
    ]
  },
  "pagination": {
    "hasNextPage": false,
    "count": 1
  }
}