Create a folder

POST/projects/{project_id}/folders

Base URL https://arcus.testsigma.com/api/v1

Creates a new folder within a project to organize test assets hierarchically.

Authenticate with your API key as a Bearer token in the Authorization header. How to authenticate →

Path parameters

project_id Unique identifier of the project in which the folder is created.

Request body

`name`	Name of the folder to be created.
`order`	Order in which the folder should be displayed.

Response attributes

`message`	Status message for the request; may be empty.
`data.folder.id`	Unique identifier of the created folder.
`data.folder.name`	Name of the created folder.
`data.folder.project_id`	Identifier of the project to which the folder belongs.
`data.folder.children`	Array of child folders, if any.
`data.folder.parent_folder_id`	Identifier of the parent folder, if applicable.
`data.folder.order`	Order index of the folder.

Request

curl -X POST \
  'https://arcus.testsigma.com/api/v1/projects/{project_id}/folders' \
  -H 'Authorization: Bearer <API_KEY>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "Regression Suite",
    "order": 20
  }'

const response = await fetch('https://arcus.testsigma.com/api/v1/projects/{project_id}/folders', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer <API_KEY>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
      "name": "Regression Suite",
      "order": 20
  })
});
const data = await response.json();

import requests

response = requests.post(
  'https://arcus.testsigma.com/api/v1/projects/{project_id}/folders',
  headers={
    'Authorization': 'Bearer <API_KEY>',
    'Content-Type': 'application/json'
  },
  json={
      "name": "Regression Suite",
      "order": 20
  }
)
data = response.json()

Response201 Created

{
  "message": "",
  "data": {
    "folder": {
      "id": "a1f3c2d8-7b4e-4f91-9c2a-6e8d5b3a1c47",
      "name": "Regression Suite",
      "project_id": "c47ade67-0543-4582-a4a5-b7de447c94f5",
      "children": [],
      "parent_folder_id": "",
      "order": 1
    }
  }
}

Was this page helpful?