v32

latestOpenAPI 3.1.0raw.githubusercontent.com2026-05-151,1412,2144.5 MB

Projects

Update project

This endpoint allows partial updates of a project (such as its name or description). Only the fields explicitly provided in the request body will be updated.

patch/cloud/v1/projects/{project_id}

Path parameters

project_idinteger required

Project ID

Example:4

Project ID

Request body

descriptionstring

Description of the project.

namestring

Name of the entity, following a specific format.

Example request

{
  "description": "Project description",
  "name": "my-project"
}

Response

client_idinteger required

ID associated with the client.

created_atstring date-time required

Datetime of creation, which is automatically generated.

deleted_atstring date-time nullable required

Datetime of deletion, which is automatically generated if the project is deleted.

descriptionstring nullable required

Description of the project.

idinteger required

Project ID, which is automatically generated upon creation.

is_defaultboolean required

Indicates if the project is the default one. Each client always has one default project.

namestring required

Unique project name for a client.

statestring required

The state of the project.

task_idstring nullable required

The UUID of the active task that currently holds a lock on the resource. This lock prevents concurrent modifications to ensure consistency. If null, the resource is not locked.

Example response

{
  "client_id": 1,
  "created_at": "2019-12-31T23:59:59Z",
  "description": "Project description",
  "id": 1,
  "is_default": true,
  "name": "default",
  "state": "ACTIVE",
  "task_id": "7244e161-664c-4afd-a34e-7003eac4d949"
}