Home / Resources / API Reference
Chapters
Intro
Release - Create
Release - Deploy
Release - Promote
Deployment - Get status
Deployment - Cancel
Package store - Upload package
Create environment
Update environment
Delete environment
Update tag
Delete tag
Create lifecycle
Update lifecycle
Delete lifecycle
Add lifecycle phase
Update lifecycle phase
Delete lifecycle phase
Upsert phase environment
Delete phase environment
Create feed
Update feed
Delete feed
Create cloud account
Update cloud account
Delete cloud account
Create workspace variable
Update workspace variable
Delete workspace variable
Create workspace variable value
Update workspace variable value
Delete workspace variable value
Create step template
Update step template
Delete step template
Create script module
Update script module
Delete script module
Create project
Update project settings
Delete project
Get project script modules
Replace project script modules
Assign script module to project
Unassign script module from project
Get project channels
Create project channel
Update project channel
Delete project channel
Get imported workspace variables for project
Replace imported workspace variables for project
Import workspace variable to project
Unimport workspace variable from project
Create project variable (non-workspace)
Update project variable (non-workspace)
Create project variable value
Update project variable value
Get project steps
Create project step
Update project step
Delete project step
Update project steps order

Project

Base route: /api/project

Create project

This API endpoint creates a new project within a specific workspace. Projects serve as the primary container for deployment processes, releases, and variables.

Request

Parameters
workspaceId
string
required
The unique identifier of the workspace.
name
string
required
The name of the project.
description
string
optional
A brief summary of the project purpose.
Request body

POST /api/project {   "workspaceId": "string",   "name": "string",   "description": "string" }

Response

Parameters
projectId
string
The unique ID assigned to the new project.
Response body

{   "projectId": "string" }