v1

latestOpenAPI 3.0.02026-07-13103151174.7 KB

Projects

Create project in the current organization

Creates a new project within the authed organization. The project key must be unique within the organization. If this is called in an Organization that has permissions controlled via an external IdP (https://docs.devcycle.com/platform/security-and-guardrails/permissions#full-role-based-access-control-project-level-roles--enterprise-only) - then no users will have permission to access this project.

post/v1/projects

Request body

namestring required

Project name

keystring required

A unique key to identify the Project

descriptionstring

A description of the Project

colorstring

Project display color, used to highlight different projects on the dashboard. Must use Hex color code.

Example request

{
  "name": "Delivery App",
  "key": "delivery-app",
  "description": "A web app to manage outbound deliveries",
  "color": "#4073FF"
}

Response

The project has been successfully created

_idstring required

A unique Project ID

_organizationstring required

ID of the Organization owning the Project

_createdBystring required

ID of the User who created the project

namestring required

Project name

keystring required

A unique key to identify the Project

descriptionstring

A description of the Project

colorstring

Project display color, used to highlight different projects on the dashboard. Must use Hex color code.

createdAtstring date-time required

The date the Project was created

updatedAtstring date-time required

The date the Project was last updated

hasJiraIntegrationboolean required

Boolean tracking whether this project has a jira integration set up

hasReceivedCodeUsagesboolean required

Describe if a project has ever received code usages for any variable

hasUserConfigFetchboolean required

Boolean indicating whether a user config has been fetched for this project

jiraBaseUrlstring required

Jira project base url, if the integration is defined

readonlyboolean required

Controls whether the feature is editable for a given user

Example response

{
  "_id": "61450f3daec96f5cf4a49946",
  "name": "Delivery App",
  "key": "delivery-app",
  "description": "A web app to manage outbound deliveries",
  "color": "#4073FF"
}