Projects

Support Portal Calyptia Core Contact Us

Projects you are a member of.

get

/v1/projects

Authorizations

Query parameters

lastinteger

Last projects.

namestring

Name matching projects.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://cloud-api.calyptia.com/v1/projects' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "my-project",
    "membersCount": 1,
    "agentsCount": 1,
    "aggregatorsCount": 1,
    "createdAt": "2025-03-12T04:25:34.133Z",
    "membership": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "userID": "123e4567-e89b-12d3-a456-426614174000",
      "projectID": "123e4567-e89b-12d3-a456-426614174000",
      "roles": null,
      "permissions": [
        "create:*"
      ],
      "createdAt": "2025-03-12T04:25:34.133Z",
      "user": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "email": "hello@example.com",
        "name": "user",
        "avatarURL": null,
        "createdAt": "2025-03-12T04:25:34.133Z",
        "updatedAt": "2025-03-12T04:25:34.133Z"
      }
    }
  }
]

Create project

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.

post

/v1/projects

Authorizations

Body

namestringrequired

Example: new-project

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://cloud-api.calyptia.com/v1/projects' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "new-project"
  }'

201

{
  "id": "text",
  "token": "redacted",
  "createdAt": "2025-03-12T04:25:34.133Z",
  "membership": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "userID": "123e4567-e89b-12d3-a456-426614174000",
    "projectID": "123e4567-e89b-12d3-a456-426614174000",
    "roles": null,
    "permissions": [
      "create:*"
    ],
    "createdAt": "2025-03-12T04:25:34.133Z",
    "user": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "email": "hello@example.com",
      "name": "user",
      "avatarURL": null,
      "createdAt": "2025-03-12T04:25:34.133Z",
      "updatedAt": "2025-03-12T04:25:34.133Z"
    }
  }
}

Created

Project

Project by ID.

get

/v1/projects/{projectID}

Authorizations

Path parameters

projectIDstring · uuidrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://cloud-api.calyptia.com/v1/projects/{projectID}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "my-project",
  "membersCount": 1,
  "agentsCount": 1,
  "aggregatorsCount": 1,
  "createdAt": "2025-03-12T04:25:34.133Z",
  "membership": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "userID": "123e4567-e89b-12d3-a456-426614174000",
    "projectID": "123e4567-e89b-12d3-a456-426614174000",
    "roles": null,
    "permissions": [
      "create:*"
    ],
    "createdAt": "2025-03-12T04:25:34.133Z",
    "user": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "email": "hello@example.com",
      "name": "user",
      "avatarURL": null,
      "createdAt": "2025-03-12T04:25:34.133Z",
      "updatedAt": "2025-03-12T04:25:34.133Z"
    }
  }
}

Delete project

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

delete

/v1/projects/{projectID}

Authorizations

Path parameters

projectIDstring · uuidrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'https://cloud-api.calyptia.com/v1/projects/{projectID}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

{
  "deleted": true,
  "deletedAt": null
}

Update project

Update project by its ID.

patch

/v1/projects/{projectID}

Authorizations

Path parameters

projectIDstring · uuidrequired

Body

namestring | nullable

Example: new-project

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request PATCH \
  --url 'https://cloud-api.calyptia.com/v1/projects/{projectID}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "new-project"
  }'

204

No body

No Content