v1
Double column
API
CLI
JS Client

Projects /

Create project

Creates a new project.

Required permission

Project > Projects > Manage > Create

Request body

  • {object}
    • name

      string required

      The name of the project.

      min length
      3
      max length
      20
      pattern
      ^[a-zA-Z](-?[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\\/'"()[\];`%^&*\-_:!]+$
    • region

      string required

      The region the project will be hosted in.

    • color

      string

      The color of the project in the Northflank App.

      pattern
      ^#([a-f0-9]{6}|[a-f0-9]{3})$/

Response body

  • {object}

    Response object.

    • data

      {object} required

      Result data.

      • success

        boolean required

        Boolean flag that the operation was successful.

      • id

        string required

        ID 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"}' \
  https://api.northflank.com/v1/projects

Example response

200 OK

Details about the created project.

JSON

{
  "data": {
    "success": true,
    "id": "default-project"
  }
}

© 2022 Northflank Ltd. All rights reserved.