Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Calyptia project API

The project API from Calyptia — 2 operation(s) for project.

Calyptia project API is one of 41 APIs that Calyptia publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include project. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 5 operations across 2 paths, and defines 8 schemas. It is described by OpenAPI 3.0.4, at version 1.0.

Requests are made against 4 base URLs: https://cloud-api.calyptia.com, https://cloud-api-dev.calyptia.com, https://cloud-api-staging.calyptia.com, http://localhost:{port}.

5 operations 2 paths 8 schemas 1 DELETE2 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.4
API Version
1.0
Base URL
https://cloud-api.calyptia.com
Authentication
HTTP Bearer, API Key, OAuth 2.0
Contact
Terms of Service
Resource Areas
1

Authentication & Security 3

Calyptia project API declares 3 security schemes for authenticating requests. It accepts HTTP bearer tokens (user). An API key is passed in the header as X-Project-Token (project). It supports OAuth 2.0 (auth0) using the clientCredentials and authorizationCode flows.

Paths & Operations 5

Across 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.

project 5
POST
/v1/projects
Create project
createProject body → 201
GET
/v1/projects
Projects
projects 2 params → 200
GET
/v1/projects/{projectID}
Project
project 1 param → 200
PATCH
/v1/projects/{projectID}
Update project
updateProject 1 param body → 204
DELETE
/v1/projects/{projectID}
Delete project
deleteProject 1 param → 200

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are Project (9 properties), Membership (7 properties), User (6 properties), UpdateProject (5 properties). Each schema is shown below with its type and property counts.

User
object
User model.
6 properties 6 required
UpdateProject
object
Update project request body.
5 properties
Membership
object
Membership of a user in a project.
7 properties 6 required
CreatedProject
object
Created project response body.
4 properties 4 required
Permission
string
Deleted
object
2 properties 2 required
Project
object
Project model.
9 properties 6 required
CreateProject
object
Create project request body.
2 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

calyptia-project-api-openapi.yml Raw ↑

Other APIs Calyptia publishes across the network.

Calyptia agent API
Calyptia agent_config API
Calyptia agent_error API
Calyptia aggregator API
Calyptia audit_log API
Calyptia aws_marketplace API
Calyptia cluster_object API
Calyptia cluster_object_regex API
Calyptia config_section API
Calyptia config_validator API
Calyptia config_validator_v2 API
Calyptia core_instance API