Projects /

Update project

Updates a project.

Required permission

Project > Projects > Manage > Update

Path parameters

projectId
string required
ID of the project

Request body

{object}

description
string
The description of the project.
max length
200
pattern
^[a-zA-Z0-9.,?\s\\/'"()[\];`%^&*\-_:!]+$
color
string
The color of the project in the Northflank App.
pattern
^#([a-f0-9]{6}|[a-f0-9]{3})$/
networking
{object}

allowedIngressProjects
[array]
Projects from which ingress request should be permitted.

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

tailscale
{object}

enabled
boolean
Whether or not to inject a tailscale sidecar for this project's resources
restrictions
{object}

enabled
boolean
Whether or not to restrict the tailscale sidecar to run only on resources with specific tags
tags
[array]
The tags which determine whether tailscale sidecar should be added

string
min length
3
max length
39
pattern
^[a-zA-Z](-?[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*)?$

secrets
{object}

authKey
string
tailscale auth key which is required for enabling tailscale

Response body

{object}
Response object.

data
(multiple options: oneOf) required

{object}

Create a project in a Northflank region

name
string required
The name of the project.
min length
3
max length
39
pattern
^[a-zA-Z]((-|\s)?[a-zA-Z0-9]+((-|\s)[a-zA-Z0-9]+)*)?$
description
string
The description of the project.
max length
200
pattern
^[a-zA-Z0-9.,?\s\\/'"()[\];`%^&*\-_:!]+$
color
string
The color of the project in the Northflank App.
pattern
^#([a-f0-9]{6}|[a-f0-9]{3})$/
region
string
The region the project will be hosted in.

{object}

Create a project in a BYOC cluster

name
string required
The name of the project.
min length
3
max length
39
pattern
^[a-zA-Z]((-|\s)?[a-zA-Z0-9]+((-|\s)[a-zA-Z0-9]+)*)?$
description
string
The description of the project.
max length
200
pattern
^[a-zA-Z0-9.,?\s\\/'"()[\];`%^&*\-_:!]+$
color
string
The color of the project in the Northflank App.
pattern
^#([a-f0-9]{6}|[a-f0-9]{3})$/
clusterId
string
The BYOC cluster this project will be hosted in.
min length
3
max length
20
pattern
^[a-z]-?[a-z0-9]+(-[a-z0-9]+)*$

API

CLI

JS Client

PATCH /v1/projects/{projectId}

Example request

Request body

curl

curl --header "Content-Type: application/json" \
  --header "Authorization: Bearer NORTHFLANK_API_TOKEN" \
  --request PATCH \
  --data '{"description":"This is a new project.","color":"#EF233C","networking":{"allowedIngressProjects":[null],"tailscale":{"restrictions":{"tags":[null]}}}}' \
  https://api.northflank.com/v1/projects/{projectId}

Example response

200 OK

Details about the updated project.

JSON

{
  "data": {
    "name": "New Project",
    "description": "This is a new project.",
    "color": "#EF233C",
    "region": "europe-west"
  }
}

JSON

{
  "data": {
    "name": "New Project",
    "description": "This is a new project.",
    "color": "#EF233C",
    "clusterId": "gcp-cluster-1"
  }
}