Projects /
Create project
Required permission
Project > Projects > Manage > Create
Request body
- {object}
Create a project in a Northflank region
name
string requiredThe name of the project.
min length3max length39pattern^[a-zA-Z]((-|\s)?[a-zA-Z0-9]+((-|\s)[a-zA-Z0-9]+)*)?$description
stringThe description of the project.
max length200pattern^[a-zA-Z0-9.,?\s\\/'"()[\];`%^&*\-_:!]+$color
stringThe color of the project in the Northflank App.
pattern^#([a-f0-9]{6}|[a-f0-9]{3})$/region
stringThe region the project will be hosted in.
- {object}
Create a project in a BYOC cluster
name
string requiredThe name of the project.
min length3max length39pattern^[a-zA-Z]((-|\s)?[a-zA-Z0-9]+((-|\s)[a-zA-Z0-9]+)*)?$description
stringThe description of the project.
max length200pattern^[a-zA-Z0-9.,?\s\\/'"()[\];`%^&*\-_:!]+$color
stringThe color of the project in the Northflank App.
pattern^#([a-f0-9]{6}|[a-f0-9]{3})$/clusterId
stringThe BYOC cluster this project will be hosted in.
min length3max length20pattern^[a-z]-?[a-z0-9]+(-[a-z0-9]+)*$
Response body
- {object}
Response object.
data
(multiple options: oneOf) required- {object}
Create a project in a Northflank region
name
string requiredThe name of the project.
min length3max length39pattern^[a-zA-Z]((-|\s)?[a-zA-Z0-9]+((-|\s)[a-zA-Z0-9]+)*)?$description
stringThe description of the project.
max length200pattern^[a-zA-Z0-9.,?\s\\/'"()[\];`%^&*\-_:!]+$color
stringThe color of the project in the Northflank App.
pattern^#([a-f0-9]{6}|[a-f0-9]{3})$/region
stringThe region the project will be hosted in.
- {object}
Create a project in a BYOC cluster
name
string requiredThe name of the project.
min length3max length39pattern^[a-zA-Z]((-|\s)?[a-zA-Z0-9]+((-|\s)[a-zA-Z0-9]+)*)?$description
stringThe description of the project.
max length200pattern^[a-zA-Z0-9.,?\s\\/'"()[\];`%^&*\-_:!]+$color
stringThe color of the project in the Northflank App.
pattern^#([a-f0-9]{6}|[a-f0-9]{3})$/clusterId
stringThe BYOC cluster this project will be hosted in.
min length3max length20pattern^[a-z]-?[a-z0-9]+(-[a-z0-9]+)*$
OR
POST /v1/projects
Example request
curl --header "Content-Type: application/json" \
--header "Authorization: Bearer NORTHFLANK_API_TOKEN" \
--request POST \
--data '{"name":"New Project","description":"This is a new project.","color":"#EF233C","region":"europe-west"}' \
https://api.northflank.com/v1/projects
curl --header "Content-Type: application/json" \
--header "Authorization: Bearer NORTHFLANK_API_TOKEN" \
--request POST \
--data '{"name":"New Project","description":"This is a new project.","color":"#EF233C","clusterId":"gcp-cluster-1"}' \
https://api.northflank.com/v1/projects
Example response
200 OK
JSON
{
"data": {
"name": "New Project",
"description": "This is a new project.",
"color": "#EF233C",
"region": "europe-west"
}
}
OR
JSON
{
"data": {
"name": "New Project",
"description": "This is a new project.",
"color": "#EF233C",
"clusterId": "gcp-cluster-1"
}
}