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-fA-F0-9]{6}|[a-fA-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 settings to resources with specific tags
tags
[array]
The tags which determine the resources the settings should be applied to

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

tagMatchCondition
string
If all or any of the tags must be present on the target for it to match the condition.
one of
and, or

secrets
{object}

authKey
string
Tailscale auth key (required for enabling Tailscale)

hostAliases
{object}

enabled
boolean
Enable support for adding /etc/hosts overrides for a container
hostEntries
[array]
Entries to add to /etc/hosts

{object}

ipAddress
string required
pattern
^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$
hostnames
[array] required

string
pattern
^(([a-z0-9][a-z0-9\-]*)|[a-z0-9]\.)*([a-z]+|xn\-\-[a-z0-9]+)\.?$

restrictions
{object}

enabled
boolean
Whether or not to restrict the settings to resources with specific tags
tags
[array]
The tags which determine the resources the settings should be applied to

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

tagMatchCondition
string
If all or any of the tags must be present on the target for it to match the condition.
one of
and, or

Response body

{object}
Response object.

data
{object} required
Result data.

id
string required
Identifier for the project
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-fA-F0-9]{6}|[a-fA-F0-9]{3})$
region
string
The region the project will be hosted in.
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]+)*$
networking
{object}
Advanced project networking settings.

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

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

tailscale
{object}
Defines this project's Tailscale sidecar settings

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

enabled
boolean required
Whether or not to restrict the settings to resources with specific tags
tags
[array]
The tags which determine the resources the settings should be applied to

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

tagMatchCondition
string
If all or any of the tags must be present on the target for it to match the condition.
one of
and, or

secrets
{object}
Relevant Tailscale secrets

authKey
string
Tailscale auth key (required for enabling Tailscale)

options
{object}

acceptRoutes
boolean
Accept advertised routes from the Tailscale network

hostAliases
{object}
Defines the project host alias overrides to apply to /etc/hosts in resource containers

enabled
boolean
Enable support for adding /etc/hosts overrides for a container
hostEntries
[array]
Entries to add to /etc/hosts

{object}

ipAddress
string required
pattern
^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$
hostnames
[array] required

string
pattern
^(([a-z0-9][a-z0-9\-]*)|[a-z0-9]\.)*([a-z]+|xn\-\-[a-z0-9]+)\.?$

restrictions
{object}

enabled
boolean required
Whether or not to restrict the settings to resources with specific tags
tags
[array]
The tags which determine the resources the settings should be applied to

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

tagMatchCondition
string
If all or any of the tags must be present on the target for it to match the condition.
one of
and, or

createdAt
string
time of creation
updatedAt
string
time of update

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":{"tailscale":{"restrictions":{"tagMatchCondition":"or"}},"hostAliases":{"restrictions":{"tagMatchCondition":"or"}}}}' \
  https://api.northflank.com/v1/projects/{projectId}

Example response

200 OK

Details about the updated project.

JSON

{
  "data": {
    "id": "example-project",
    "name": "New Project",
    "description": "This is a new project.",
    "color": "#EF233C",
    "region": "europe-west",
    "clusterId": "gcp-cluster-1",
    "networking": {
      "tailscale": {
        "restrictions": {
          "tagMatchCondition": "or"
        }
      },
      "hostAliases": {
        "restrictions": {
          "tagMatchCondition": "or"
        }
      }
    },
    "createdAt": "2000-01-01T12:00:00.000Z",
    "updatedAt": "2000-01-01T12:00:00.000Z"
  }
}