Skip to main content
PATCH
/
cloud
/
v1
/
projects
/
{project_id}
Update the project
curl --request PATCH \
  --url https://api.gcore.com/cloud/v1/projects/{project_id} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "description": "<string>",
  "name": "<string>"
}
'
{
  "client_id": 123,
  "created_at": "2023-11-07T05:31:56Z",
  "deleted_at": "2023-11-07T05:31:56Z",
  "description": "Project description",
  "id": 123,
  "is_default": true,
  "name": "<string>",
  "state": "<string>",
  "task_id": "7244e161-664c-4afd-a34e-7003eac4d949"
}

Authorizations

​
Authorization
string
header
required

API key for authentication. Make sure to include the word apikey, followed by a single space and then your token. Example: apikey 1234$abcdef

Path Parameters

​
project_id
integer<int64>
required

Project ID

Body

application/json
​
description
string

Description of the project.

​
name
string

Name of the entity, following a specific format.

Response

200 - application/json

OK

​
client_id
integer
required

ID associated with the client.

​
created_at
string<date-time>
required

Datetime of creation, which is automatically generated.

​
deleted_at
string<date-time> | null
required

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

​
description
string | null
required

Description of the project.

Maximum string length: 255
Example:

"Project description"

​
id
integer
required

Project ID, which is automatically generated upon creation.

​
is_default
boolean
required

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

​
name
string
required

Unique project name for a client.

​
state
string
required

The state of the project.

​
task_id
string | null
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:

"7244e161-664c-4afd-a34e-7003eac4d949"