Projects

Projects

Projects you are a member of.

GEThttps://cloud-api.calyptia.com/v1/projects

Authorization

user

Query parameters

Response

200

OK

Body

application/json

id*string (uuid)

name*string

Example: "my-project"

membersCount*integer

agentsCount*integer

aggregatorsCount*integer

createdAt*string (date-time)

membershipMembership (object)

Membership of a user in a project.

Request

JavaScriptCurlPython

const response = await fetch('https://cloud-api.calyptia.com/v1/projects', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

200

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "my-project",
    "createdAt": "2024-11-21T10:08:15.277Z",
    "membership": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "userID": "123e4567-e89b-12d3-a456-426614174000",
      "projectID": "123e4567-e89b-12d3-a456-426614174000",
      "roles": [
        "creator"
      ],
      "permissions": [
        "create:*"
      ],
      "createdAt": "2024-11-21T10:08:15.277Z",
      "user": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "email": "[e-mail]",
        "name": "user",
        "avatarURL": "https://example.com",
        "createdAt": "2024-11-21T10:08:15.277Z",
        "updatedAt": "2024-11-21T10:08:15.277Z"
      }
    }
  }
]

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.

POSThttps://cloud-api.calyptia.com/v1/projects

Authorization

user

Body

application/json

name*string

Example: "new-project"

Response

201

Created

Body

application/json

id*string

token*string

Example: "redacted"

createdAt*string (date-time)

membership*Membership (object)

Membership of a user in a project.

Request

JavaScriptCurlPython

const response = await fetch('https://cloud-api.calyptia.com/v1/projects', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "new-project"
    }),
});
const data = await response.json();

Response

201

{
  "id": "text",
  "token": "redacted",
  "createdAt": "2024-11-21T10:08:15.277Z",
  "membership": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "userID": "123e4567-e89b-12d3-a456-426614174000",
    "projectID": "123e4567-e89b-12d3-a456-426614174000",
    "roles": [
      "creator"
    ],
    "permissions": [
      "create:*"
    ],
    "createdAt": "2024-11-21T10:08:15.277Z",
    "user": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "email": "[e-mail]",
      "name": "user",
      "avatarURL": "https://example.com",
      "createdAt": "2024-11-21T10:08:15.277Z",
      "updatedAt": "2024-11-21T10:08:15.277Z"
    }
  }
}

Project

Project by ID.

GEThttps://cloud-api.calyptia.com/v1/projects/{projectID}

Authorization

userproject

Path parameters

projectID*string (uuid)

Response

200

OK

Body

application/json

id*string (uuid)

name*string

Example: "my-project"

membersCount*integer

agentsCount*integer

aggregatorsCount*integer

createdAt*string (date-time)

membershipMembership (object)

Membership of a user in a project.

Request

JavaScriptCurlPython

const response = await fetch('https://cloud-api.calyptia.com/v1/projects/{projectID}', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

200

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "my-project",
  "createdAt": "2024-11-21T10:08:15.277Z",
  "membership": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "userID": "123e4567-e89b-12d3-a456-426614174000",
    "projectID": "123e4567-e89b-12d3-a456-426614174000",
    "roles": [
      "creator"
    ],
    "permissions": [
      "create:*"
    ],
    "createdAt": "2024-11-21T10:08:15.277Z",
    "user": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "email": "[e-mail]",
      "name": "user",
      "avatarURL": "https://example.com",
      "createdAt": "2024-11-21T10:08:15.277Z",
      "updatedAt": "2024-11-21T10:08:15.277Z"
    }
  }
}

Delete project

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

DELETEhttps://cloud-api.calyptia.com/v1/projects/{projectID}

Authorization

user

Path parameters

projectID*string (uuid)

Response

200

OK

Body

application/json

deleted*boolean

deletedAt*nullable string (date-time)

Request

JavaScriptCurlPython

const response = await fetch('https://cloud-api.calyptia.com/v1/projects/{projectID}', {
    method: 'DELETE',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

200

{
  "deleted": false,
  "deletedAt": "2024-11-21T10:08:15.277Z"
}

Update project

Update project by its ID.

PATCHhttps://cloud-api.calyptia.com/v1/projects/{projectID}

Authorization

userproject

Path parameters

projectID*string (uuid)

Body

application/json

namenullable string

Example: "new-project"

Response

204

No Content

Request

JavaScriptCurlPython

const response = await fetch('https://cloud-api.calyptia.com/v1/projects/{projectID}', {
    method: 'PATCH',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();