Sign in
Beta
Directories

Create Directory

Changed on

Create a new directory within the specified project.

If data_source_id is provided, validates that the data source exists and belongs to the same project.

post/api/v1/beta/directories

Request

  • The document declares no server URL.
  • Auth: HTTP bearer

Query parameters

project_idstring uuid nullable
organization_idstring uuid nullable

Cookies

sessionstring nullable

Request body

namestring required

Human-readable name for the directory.

descriptionstring nullable

Optional description shown to users.

data_source_idstring nullable

Optional data source id the directory syncs from.

Response

Successful Response

idstring required

Unique identifier for the directory.

created_atstring date-time nullable

Creation datetime

updated_atstring date-time nullable

Update datetime

project_idstring required

Project the directory belongs to.

namestring required

Human-readable name for the directory.

descriptionstring nullable

Optional description shown to users.

data_source_idstring nullable

Optional data source id the directory syncs from. Null if just manual uploads.

deleted_atstring date-time nullable

Optional timestamp of when the directory was deleted. Null if not deleted.

Changes