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

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

Calyptia agent_error 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_error. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

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

4 operations 3 paths 5 schemas 2 GET2 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_error 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 4

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

agent_error 4
POST
/v1/agents/{agentID}/errors
Create agent error
createAgentError 1 param body → 201
GET
/v1/agents/{agentID}/errors
Agent errors
agentErrors 4 params → 200
GET
/v1/fleets/{fleetID}/agent_errors
Fleet agent errors
fleetAgentErrors 4 params → 200
POST
/v1/agent_errors/{agentErrorID}/dismiss
Dismiss agent error
dismissAgentError 1 param body → 200

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are AgentError (6 properties), CreatedAgentError (2 properties), DismissAgentError (1 property), DismissedAgentError (1 property). Each schema is shown below with its type and property counts.

AgentError
object
An Agent Error represent an error that occurred on an agent. It can be an invalid configuration, or a malfunctioning plugin. These come directly from agents. A…
6 properties 6 required
CreateAgentError
object
Request body required to create a new Agent Error.
1 property 1 required
CreatedAgentError
object
Response body after creating a new Agent Error.
2 properties 2 required
DismissedAgentError
object
Response body after dismissing an Agent Error.
1 property 1 required
DismissAgentError
object
Request body required to dismiss an existing agent error.
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

calyptia-agent-error-api-openapi.yml Raw ↑

Other APIs Calyptia publishes across the network.

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