Workspaces API

Version: 1.0

Preview

Create a folder

POST

/workspace/orgs/{org_id}/workspaces/{workspace_id}/folders

Preview API

This API functionality is currently in preview. Preview APIs may be unstable within the preview period: they may change without notice. You must set the header API-Preview: opt-in to opt into using this functionality.

Creates a new folder in the workspace. The folder needs to have a name and exclusively define either a parent_folder_id or a parent_folder_path.

Request

Path parameters

workspace_iduuid

Required

org_iduuid

Required

Body parameters

Required

namestring

Required

(1, 100) chars

The name of the folder

parent_folder_iduuid | null

The ID of the parent folder

parent_folder_pathpath | null

The path of the parent folder

Example body

{
  "name": "string",
  "parent_folder_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "parent_folder_path": "string"
}

Responses

201

Folder created successfully.

Response schema

created_atdate-time

created_byUserModel

emailstring | null

iduuid

namestring | null

deletedboolean

folder_iduuid

namestring

parent_folder_iduuid | null

pathpath

updated_atdate-time

updated_byUserModel

emailstring | null

iduuid

namestring | null

workspace_iduuid

Example response

{
  "created_at": "2024-07-29T15:51:28.071Z",
  "created_by": {
    "email": "string",
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "string"
  },
  "deleted": true,
  "folder_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "name": "string",
  "parent_folder_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "path": "string",
  "updated_at": "2024-07-29T15:51:28.071Z",
  "updated_by": {
    "email": "string",
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "string"
  },
  "workspace_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}

400

Bad request syntax or unsupported method

Response schema

detailstring | null

invalid-paramsobject[] | null

statusinteger

titlestring

typestring

Example response

{
  "detail": "string",
  "invalid-params": [
    {
      "name": "string",
      "reason": "string"
    }
  ],
  "status": 0,
  "title": "string",
  "type": "string"
}

401

No permission -- see authorization schemes

Response schema

detailstring | null

invalid-paramsobject[] | null

statusinteger

titlestring

typestring

Example response

{
  "detail": "string",
  "invalid-params": [
    {
      "name": "string",
      "reason": "string"
    }
  ],
  "status": 0,
  "title": "string",
  "type": "string"
}

403

Request forbidden -- authorization will not help

Response schema

detailstring | null

invalid-paramsobject[] | null

statusinteger

titlestring

typestring

Example response

{
  "detail": "string",
  "invalid-params": [
    {
      "name": "string",
      "reason": "string"
    }
  ],
  "status": 0,
  "title": "string",
  "type": "string"
}

404

Resource not found or user lacks access

Response schema

detailstring | null

invalid-paramsobject[] | null

statusinteger

titlestring

typestring

Example response

{
  "detail": "string",
  "invalid-params": [
    {
      "name": "string",
      "reason": "string"
    }
  ],
  "status": 0,
  "title": "string",
  "type": "string"
}

405

Specified method is invalid for this resource

Response schema

detailstring | null

invalid-paramsobject[] | null

statusinteger

titlestring

typestring

Example response

{
  "detail": "string",
  "invalid-params": [
    {
      "name": "string",
      "reason": "string"
    }
  ],
  "status": 0,
  "title": "string",
  "type": "string"
}

409

Request conflict

Response schema

detailstring | null

invalid-paramsobject[] | null

statusinteger

titlestring

typestring

Example response

{
  "detail": "string",
  "invalid-params": [
    {
      "name": "string",
      "reason": "string"
    }
  ],
  "status": 0,
  "title": "string",
  "type": "string"
}

410

Resource is gone

Response schema

detailstring | null

invalid-paramsobject[] | null

statusinteger

titlestring

typestring

Example response

{
  "detail": "string",
  "invalid-params": [
    {
      "name": "string",
      "reason": "string"
    }
  ],
  "status": 0,
  "title": "string",
  "type": "string"
}

422

Unprocessable Content

Response schema

detailstring | null

invalid-paramsobject[] | null

statusinteger

titlestring

typestring

Example response

{
  "detail": "string",
  "invalid-params": [
    {
      "name": "string",
      "reason": "string"
    }
  ],
  "status": 0,
  "title": "string",
  "type": "string"
}