Projects and folders

Projects group pipelines, permissions, and defaults. Folders add hierarchy inside a project. Global variables are workspace-scoped key/value pairs referenced from pipeline graphs. Base URL: https://api.planasonix.com
Auth: Authorization: Bearer plus your API key or JWT.

Projects

`GET /api/projects`

List projects you can access.

string

Filter by name.

Show Example request and response

curl -s https://api.planasonix.com/api/projects \
  -H "Authorization: Bearer plnx_live_xxxxxxxx"

{
  "data": [
    {
      "id": "prj_01",
      "name": "Analytics",
      "description": "Core warehouse loads",
      "createdAt": "2024-11-01T00:00:00Z",
      "updatedAt": "2025-03-27T07:00:00Z"
    }
  ]
}

`POST /api/projects`

Create a project.

string

required

Project name.

string

Optional description.

Show Example request and response

curl -X POST https://api.planasonix.com/api/projects \
  -H "Authorization: Bearer plnx_live_xxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{"name":"Marketing","description":"Campaign and ads data"}'

{
  "id": "prj_02",
  "name": "Marketing",
  "description": "Campaign and ads data",
  "createdAt": "2025-03-27T12:00:00Z"
}

`GET /api/projects/{id}`

Fetch project metadata and summary counts when available.

string

required

Project ID.

`PUT /api/projects/{id}`

Update project fields.

string

required

Project ID.

string

New name.

string

New description.

`DELETE /api/projects/{id}`

Delete a project. May fail if pipelines still exist unless cascade is supported by your workspace policy.

string

required

Project ID.

Folders

Folders use the same REST shape as projects, under /api/folders.

Method	Path	Description
`GET`	`/api/folders`	List folders (typically scoped by `projectId` query param)
`POST`	`/api/folders`	Create folder
`GET`	`/api/folders/{id}`	Get folder
`PUT`	`/api/folders/{id}`	Update folder (name, parent, and so on)
`DELETE`	`/api/folders/{id}`	Delete folder

`GET /api/folders`

string

required

Project whose folder tree to return.

Show Example response

{
  "data": [
    {
      "id": "fld_01",
      "projectId": "prj_01",
      "name": "Production",
      "parentId": null,
      "path": "/Production"
    },
    {
      "id": "fld_02",
      "projectId": "prj_01",
      "name": "Staging",
      "parentId": null,
      "path": "/Staging"
    }
  ]
}

`POST /api/folders`

string

required

Owning project.

string

required

Folder name.

string

Parent folder for nesting; omit for root-level folder.

Show Example request and response

{
  "projectId": "prj_01",
  "name": "Archived",
  "parentId": null
}

{
  "id": "fld_03",
  "projectId": "prj_01",
  "name": "Archived",
  "parentId": null,
  "path": "/Archived",
  "createdAt": "2025-03-27T12:15:00Z"
}

`GET /api/folders/{id}`

string

required

Folder ID.

`PUT /api/folders/{id}`

string

required

Folder ID.

string

Rename.

string

Move under another folder (or null for root).

`DELETE /api/folders/{id}`

string

required

Folder ID.

Deleting a folder may fail if it still contains pipelines or subfolders.

Global variables

`GET /api/variables/global`

List all global variables for the workspace.

Show Example response

{
  "data": [
    {
      "name": "ENV",
      "value": "prod",
      "updatedAt": "2025-03-01T09:00:00Z",
      "updatedBy": "usr_admin"
    },
    {
      "name": "DEFAULT_WAREHOUSE",
      "value": "ETL_LARGE",
      "updatedAt": "2025-02-10T11:30:00Z",
      "updatedBy": "usr_admin"
    }
  ]
}

`POST /api/variables/global`

Create or update a variable by name (upsert).

string

required

Variable name (letters, numbers, underscores; convention: SCREAMING_SNAKE_CASE).

string

required

String value as seen by pipelines at runtime.

string

Optional documentation for operators.

Show Example request and response

curl -X POST https://api.planasonix.com/api/variables/global \
  -H "Authorization: Bearer plnx_live_xxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{"name":"SLACK_WEBHOOK_URL","value":"https://hooks.slack.com/services/XXX/YYY/ZZZ"}'

{
  "name": "SLACK_WEBHOOK_URL",
  "value": "https://hooks.slack.com/services/XXX/YYY/ZZZ",
  "updatedAt": "2025-03-27T12:20:00Z"
}

`DELETE /api/variables/global/{name}`

Remove a global variable.

string

required

Variable name.

Show Example response

{
  "ok": true,
  "name": "SLACK_WEBHOOK_URL",
  "deletedAt": "2025-03-27T12:25:00Z"
}

Pipeline variables

Graph-local vs global variables.

Pipelines API

Create pipelines inside projects and folders.

Overview

Data platform

Orchestration

Integration

Governance

Iceberg Catalog

Platform

Projects and folders

Projects

`GET /api/projects`

`POST /api/projects`

`GET /api/projects/{id}`

`PUT /api/projects/{id}`

`DELETE /api/projects/{id}`

Folders

`GET /api/folders`

`POST /api/folders`

`GET /api/folders/{id}`

`PUT /api/folders/{id}`

`DELETE /api/folders/{id}`

Global variables

`GET /api/variables/global`

`POST /api/variables/global`

`DELETE /api/variables/global/{name}`

Pipeline variables

Pipelines API

​Projects

​GET /api/projects

​POST /api/projects

​GET /api/projects/{id}

​PUT /api/projects/{id}

​DELETE /api/projects/{id}

​Folders

​GET /api/folders

​POST /api/folders

​GET /api/folders/{id}

​PUT /api/folders/{id}

​DELETE /api/folders/{id}

​Global variables

​GET /api/variables/global

​POST /api/variables/global

​DELETE /api/variables/global/{name}

​Related

Pipeline variables

Pipelines API

Projects

`GET /api/projects`

`POST /api/projects`

`GET /api/projects/{id}`

`PUT /api/projects/{id}`

`DELETE /api/projects/{id}`

Folders

`GET /api/folders`

`POST /api/folders`

`GET /api/folders/{id}`

`PUT /api/folders/{id}`

`DELETE /api/folders/{id}`

Global variables

`GET /api/variables/global`

`POST /api/variables/global`

`DELETE /api/variables/global/{name}`

Related