Project / Harnesses /

List harnesses

Gets a list of harnesses belonging to the project

Required permission

Project > Harnesses > 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.
page
integer
The page number to access.
cursor
string
The cursor returned from the previous page of results, used to request the next page.
projectUrl
string
If provided, only returns harnesses whose source repository URL matches this value.
projectType
string
If provided, only returns harnesses whose source VCS provider matches this value.
one of
bitbucket, gitlab, github, self-hosted, azure
projectBranch
string
If provided, only returns harnesses whose source branch matches this value.

Response body

{object}
Response object.

data
{object} required
Result data.

harnesses
[array] required
An array of harnesses.

{object}
Information about a harness.

id
string required
Identifier for the harness.
name
string required
Harness name.
appId
string required
Full identifier for the harness.
tags
[array]

string

description
string
A short description of the harness.
harness
{object}
Details about the harness's specifications.

type
string required
The harness environment type.
one of
claude, codex

source
{object}
The git source linked to the harness.

projectUrl
string
URL of the git repository pre-pulled into the harness environment.
projectType
string
The VCS provider of the harness source.
projectBranch
string
The branch of the harness source.

status
{object}
The current status of the harness.

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}/harnesses

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

Example response

200 OK

A list of harnesses belonging to the project.

JSON

{
  "data": {
    "harnesses": [
      {
        "id": "example-harness",
        "name": "Example Harness",
        "appId": "/example-user/default-project/example-harness",
        "description": "This is the harness description",
        "harness": {
          "type": "claude"
        },
        "source": {
          "projectUrl": "https://github.com/northflank-examples/next-js-example",
          "projectType": "github",
          "projectBranch": "main"
        }
      }
    ]
  },
  "pagination": {
    "hasNextPage": false,
    "count": 1
  }
}