Skip to main content
POST
/
api
/
v1
/
projects
Create a new project
curl --request POST \
  --url https://app.dimred.com/api/v1/projects \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "project_name": "My Project",
  "project_description": "Testing the API"
}
'
{
  "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.

Body

application/json
project_name
string
required

Name of the project

project_description
string | null

Optional description of the project

Response

Project created 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

Additional metadata

created_at
string<date-time>

ISO 8601 timestamp of creation