Skip to main content
PUT
/
api
/
v1
/
projects
/
{id}
Update a project
curl --request PUT \
  --url https://app.dimred.com/api/v1/projects/{id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "project_name": "<string>",
  "project_description": "<string>",
  "project_metadata": {}
}'
{
  "id": "<string>",
  "organization_id": "<string>",
  "project_name": "<string>",
  "project_description": "<string>",
  "project_metadata": {},
  "created_at": "2023-11-07T05:31:56Z"
}

Authorizations

x-api-key
string
header
required

API key for authentication. Obtain from your DimRed dashboard. The organization context is automatically derived from the API key.

Path Parameters

id
string
required

Project identifier

Body

application/json
project_name
string

Name of the project

project_description
string | null

Description of the project

project_metadata
object

Additional metadata

Response

Project updated successfully

id
string

Unique identifier for the project

organization_id
string

Organization identifier

project_name
string

Name of the project

project_description
string | null

Description of the project

project_metadata
object | null

Additional metadata

created_at
string<date-time>

ISO 8601 timestamp of creation