api

Projects API

Organize deployments into projects.

Projects#

Projects let you group related deployments together. For example, you might have a "My SaaS" project containing a web service, an API, a background worker, and a PostgreSQL database.

GET/projects

List all projects in your workspace.

🔒 Auth: Bearer token required

Response

[
  {
    "id": "p1a2b3...",
    "name": "My SaaS",
    "created_at": "2026-02-20T08:00:00Z"
  }
]

Example: list projects

bash

curl https://api.runix.dev/projects \
  -H "Authorization: Bearer $TOKEN"

POST/projects

Create a new project.

🔒 Auth: Bearer token required

Parameters

namestringrequiredProject name

Response

{
  "id": "p1a2b3...",
  "name": "My SaaS",
  "created_at": "2026-02-25T10:00:00Z"
}

Example: create a project

bash

curl -X POST https://api.runix.dev/projects \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ "name": "My SaaS" }'

GET/projects/{id}

Get details for a single project.

🔒 Auth: Bearer token required

Parameters

iduuidrequiredProject ID

Response

{
  "id": "p1a2b3...",
  "name": "My SaaS",
  "created_at": "2026-02-20T08:00:00Z"
}

PUT/projects/{id}

Update a project's name.

🔒 Auth: Bearer token required

Parameters

iduuidrequiredProject ID

namestringrequiredNew project name

DELETE/projects/{id}

Delete a project. Deployments inside the project are NOT deleted — they become unassigned.

🔒 Auth: Bearer token required

Parameters

iduuidrequiredProject ID

Deleting a project does not delete its deployments. They will still be accessible from the main deployments list.

GET/projects/{id}/deployments

List all deployments that belong to a specific project.

🔒 Auth: Bearer token required

Parameters

iduuidrequiredProject ID

Response

[
  {
    "id": "a1b2c3d4-...",
    "service_name": "my-api",
    "status": "running"
  }
]

PATCH/deployments/{id}/project

Assign a deployment to a project, or remove it from its current project by passing null.

🔒 Auth: Bearer token required

Parameters

iduuidrequiredDeployment ID

project_iduuid | nullrequiredProject ID to assign, or null to unassign

Example: assign deployment to project

bash

curl -X PATCH https://api.runix.dev/deployments/a1b2c3d4-.../project \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ "project_id": "p1a2b3..." }'

Domains

Webhooks