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

The fleet API from Calyptia — 7 operation(s) for fleet.

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

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

This API exposes 13 operations across 7 paths, and defines 12 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}.

13 operations 7 paths 12 schemas 2 DELETE7 GET2 PATCH2 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 fleet 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 13

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

fleet 13
POST
/v1/projects/{projectID}/fleets
Create fleet.
createFleet 1 param body → 201
GET
/v1/projects/{projectID}/fleets
Fleets.
fleets 6 params → 200
GET
/v1/projects/{projectID}/fleets/status
Fleets Status for a Project.
fleetsstatus 1 param → 200
GET
/v1/fleets/{fleetID}
Fleet.
fleet 2 params → 200
PATCH
/v1/fleets/{fleetID}
Update fleet.
updateFleet 1 param body → 200
DELETE
/v1/fleets/{fleetID}
Delete fleet.
deleteFleet 1 param → 200
GET
/v1/fleets/{fleetID}/status
Fleet Status.
fleetstatus 1 param → 200
GET
/v1/fleets/{fleetID}/config
get the configuration for a fleet ID.
fleetConfig 3 params → 200
GET
/v1/fleets/{fleetID}/files
Fleet.
fleetFiles 3 params → 200
POST
/v1/fleets/{fleetID}/files
Create Fleet File.
createFleetFile 1 param body → 200
GET
/v1/fleet_files/{fleetFileID}
retrieve a fleet file.
fleetFile 1 param → 200
PATCH
/v1/fleet_files/{fleetFileID}
Update fleet file.
updateFleetFile 1 param body → 204
DELETE
/v1/fleet_files/{fleetFileID}
Delete fleet file.
deleteFleetFile 1 param → 204

Schemas 12

The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are Fleet (10 properties), CreateFleet (6 properties), UpdateFleet (5 properties), FleetFile (5 properties). Each schema is shown below with its type and property counts.

DeletedFleet
object
2 properties 2 required
CreateFleetFile
object
2 properties 2 required
FleetFile
object
5 properties
UpdateFleetFile
object
2 properties
Fleet
object
Group of agents sharing the same config.
10 properties 10 required
CreatedFleetFile
object
Created fleet file response body.
2 properties 2 required
FleetsStatus
object
Show the numerical count of the status of all Agents within a Fleet or all Fleets within a Project. The status is one of: Managed: the full total of agents man…
4 properties
CreateFleet
object
6 properties 5 required
CreatedFleet
object
2 properties 2 required
FleetAgentsCount
object
Both active and inactive can sum up to the total count of agents that the fleet has. withErrors is the count of particular agents that have some errors that ha…
3 properties 3 required
UpdateFleet
object
5 properties 1 required
UpdatedFleet
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

calyptia-fleet-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