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 agent API

The agent API from Calyptia — 3 operation(s) for agent.

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

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

This API exposes 6 operations across 3 paths, and defines 4 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}.

6 operations 3 paths 4 schemas 2 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 agent 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 6

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

agent 6
POST
/v1/agents
Register agent
registerAgent body → 201
GET
/v1/projects/{projectID}/agents
Agents
agents 8 params → 200
DELETE
/v1/projects/{projectID}/agents
Delete Agents
deleteAgents 2 params → 204
GET
/v1/agents/{agentID}
Agent
agent 1 param → 200
PATCH
/v1/agents/{agentID}
Update agent
updateAgent 1 param body → 204
DELETE
/v1/agents/{agentID}
Delete agent
deleteAgent 1 param → 204

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are Agent (21 properties), RegisterAgent (10 properties), UpdateAgent (8 properties), RegisteredAgent (5 properties). Each schema is shown below with its type and property counts.

Agent
object
Agent model.
21 properties 19 required
UpdateAgent
object
Update agent request body.
8 properties
RegisterAgent
object
Register agent request body.
10 properties 7 required
RegisteredAgent
object
Registered agent response body.
5 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

calyptia-agent-api-openapi.yml Raw ↑

Other APIs Calyptia publishes across the network.

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
Calyptia core_instance_check API