Skip to main content
POST
/
api
/
projects
Create a project
curl --request POST \
  --url https://api.example.com/api/projects \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "key": "<string>",
  "copyContentRef": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "protected": false,
  "version": "v1"
}
'
import requests

url = "https://api.example.com/api/projects"

payload = {
"name": "<string>",
"key": "<string>",
"copyContentRef": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"protected": False,
"version": "v1"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
key: '<string>',
copyContentRef: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
protected: false,
version: 'v1'
})
};

fetch('https://api.example.com/api/projects', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/api/projects",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'key' => '<string>',
'copyContentRef' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'protected' => false,
'version' => 'v1'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://api.example.com/api/projects"

payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"key\": \"<string>\",\n \"copyContentRef\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"protected\": false,\n \"version\": \"v1\"\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.example.com/api/projects")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"key\": \"<string>\",\n \"copyContentRef\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"protected\": false,\n \"version\": \"v1\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/projects")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"key\": \"<string>\",\n \"copyContentRef\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"protected\": false,\n \"version\": \"v1\"\n}"

response = http.request(request)
puts response.read_body
{
  "project": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "organisationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "createdAt": "<string>",
    "updatedAt": "<string>",
    "key": "<string>",
    "protected": true,
    "deletedAt": "<string>",
    "decisionsApprovalGroups": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "description": "<string>",
        "roleId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      }
    ]
  }
}

Authorizations

Authorization
string
header
required

Personal access token is obtained through your profile

Body

application/json
name
string
required

Name of the project

key
string
required

Unique key identifier for the project (lowercase letters, numbers, and hyphens)

Pattern: ^[a-z0-9]{2,}(-[a-z0-9]+)*$
copyContentRef
string<uuid>

Project ID to copy content from

protected
boolean
default:false

Whether the project should be protected from deletion

version
enum<string> | null
default:v1

Project version to create (v1 or v2)

Available options:
v1,
v2,
null

Response

200 - application/json

The created project with details

The created project with details

project
object
required

The created project