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"
}
'
{
  "project": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "organisationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "version": "v1",
    "createdAt": "<string>",
    "updatedAt": "<string>",
    "key": "<string>",
    "protected": true,
    "deletedAt": "<string>",
    "decisionsApprovalMode": "require_one_per_team",
    "decisionsApprovalGroups": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "description": "<string>",
        "roleId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      }
    ]
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.gorules.io/llms.txt

Use this file to discover all available pages before exploring further.

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