Projects

Projects

get

Projects you are a member of.

Authorizations

Query parameters

lastintegerOptional

Last projects.

namestringOptional

Name matching projects.

Responses

200

OK

application/json

get

HTTPcURLJavaScriptPython

GET /v1/projects HTTP/1.1
Host: cloud-api.calyptia.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

OK

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "my-project",
    "membersCount": 1,
    "agentsCount": 1,
    "aggregatorsCount": 1,
    "createdAt": "2025-05-09T06:41:08.286Z",
    "membership": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "userID": "123e4567-e89b-12d3-a456-426614174000",
      "projectID": "123e4567-e89b-12d3-a456-426614174000",
      "roles": [
        "creator"
      ],
      "permissions": [
        "create:*"
      ],
      "createdAt": "2025-05-09T06:41:08.286Z",
      "user": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "email": "[e-mail]",
        "name": "user",
        "avatarURL": "https://example.com",
        "createdAt": "2025-05-09T06:41:08.286Z",
        "updatedAt": "2025-05-09T06:41:08.286Z"
      }
    }
  }
]

Create project

post

Creates a new project. A project is the base unit of work at Calyptia Cloud. You can register agents here, create core instances in which you can deploy an entire set of pipelines, and monitor them. You can even invite other people to the project and have a team.

Authorizations

Body

Create project request body.

namestringRequiredExample: new-project

Responses

201

Created

application/json

post

HTTPcURLJavaScriptPython

POST /v1/projects HTTP/1.1
Host: cloud-api.calyptia.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 22

{
  "name": "new-project"
}

201

Created

{
  "id": "text",
  "token": "redacted",
  "createdAt": "2025-05-09T06:41:08.286Z",
  "membership": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "userID": "123e4567-e89b-12d3-a456-426614174000",
    "projectID": "123e4567-e89b-12d3-a456-426614174000",
    "roles": [
      "creator"
    ],
    "permissions": [
      "create:*"
    ],
    "createdAt": "2025-05-09T06:41:08.286Z",
    "user": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "email": "[e-mail]",
      "name": "user",
      "avatarURL": "https://example.com",
      "createdAt": "2025-05-09T06:41:08.286Z",
      "updatedAt": "2025-05-09T06:41:08.286Z"
    }
  }
}

Project

get

Project by ID.

Authorizations

userproject

Path parameters

projectIDstring · uuidRequired

Responses

200

OK

application/json

get

HTTPcURLJavaScriptPython

GET /v1/projects/{projectID} HTTP/1.1
Host: cloud-api.calyptia.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

OK

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "my-project",
  "membersCount": 1,
  "agentsCount": 1,
  "aggregatorsCount": 1,
  "createdAt": "2025-05-09T06:41:08.286Z",
  "membership": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "userID": "123e4567-e89b-12d3-a456-426614174000",
    "projectID": "123e4567-e89b-12d3-a456-426614174000",
    "roles": [
      "creator"
    ],
    "permissions": [
      "create:*"
    ],
    "createdAt": "2025-05-09T06:41:08.286Z",
    "user": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "email": "[e-mail]",
      "name": "user",
      "avatarURL": "https://example.com",
      "createdAt": "2025-05-09T06:41:08.286Z",
      "updatedAt": "2025-05-09T06:41:08.286Z"
    }
  }
}

Delete project

delete

Delete project by its ID. Only the creator of the project can delete it.

Authorizations

Path parameters

projectIDstring · uuidRequired

Responses

200

OK

application/json

delete

HTTPcURLJavaScriptPython

DELETE /v1/projects/{projectID} HTTP/1.1
Host: cloud-api.calyptia.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

OK

{
  "deleted": true,
  "deletedAt": "2025-05-09T06:41:08.286Z"
}

Update project

patch

Update project by its ID.

Authorizations

userproject

Path parameters

projectIDstring · uuidRequired

Body

Update project request body.

namestring | nullableOptionalDefault: nullExample: new-project

Responses

204

No Content

patch

HTTPcURLJavaScriptPython

PATCH /v1/projects/{projectID} HTTP/1.1
Host: cloud-api.calyptia.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 22

{
  "name": "new-project"
}

204

No Content

No content