Projects /
Create project
Creates a new project.
Required permission
Project > Projects > Manage > Create
Request body
- {object}
name
string requiredThe name of the project.
min length3max length20pattern^[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\\/'"()[\];`%^&*\-_:!]+$region
string requiredThe region the project will be hosted in.
color
stringThe color of the project in the Northflank App.
pattern^#([a-f0-9]{6}|[a-f0-9]{3})$/
Response body
- {object}
Response object.
data
{object} requiredResult data.
success
boolean requiredBoolean flag that the operation was successful.
id
string requiredID for the created project.
API
CLI
JS Client
POST /v1/projects
Example request
Request body
curl
curl --header "Content-Type: application/json" \
--header "Authorization: Bearer NORTHFLANK_API_TOKEN" \
--request POST \
--data '{"name":"New Project","description":"This is a new project.","region":"europe-west","color":"#EF233C"}' \
http://api.northflank.com/v1/projects
Example response
200 OK
Details about the created project.
JSON
{
"data": {
"success": true,
"id": "default-project"
}
}