Schema Reference
Cetacean API responses include JSON-LD metadata (@context, @id, @type) for self-description. This page documents the vocabulary. The machine-readable context document is available at /api/schema.jsonld.
Types
Each API response includes an @type value identifying the resource kind.
CollectionA paginated list of resources.
NodeA Docker Swarm node (manager or worker).
ServiceA Docker Swarm service.
TaskA single running or completed container instance.
StackA group of services deployed together via `com.docker.stack.namespace` labels.
ConfigA Docker Swarm config object.
SecretA Docker Swarm secret (data always redacted).
NetworkA Docker network.
VolumeA Docker volume.
PluginAn installed Docker plugin.
ClusterCluster-wide overview with counts and resource totals.
SwarmSwarm configuration: join tokens, Raft config, CA config.
ServiceEnvService environment variables.
ServicePortsService port bindings.
ServiceLabelsService labels.
ServiceResourcesService CPU/memory reservations and limits.
ServicePlacementService placement constraints and preferences.
ServiceUpdatePolicyRolling update configuration for a service.
ServiceRollbackPolicyRollback configuration for a service.
ServiceLogDriverLog driver configuration for a service.
ServiceHealthcheckHealthcheck configuration for a service.
ServiceConfigsConfig references attached to a service.
ServiceSecretsSecret references attached to a service.
ServiceNetworksNetwork attachments for a service.
ServiceMountsMount configuration for a service.
ServiceModeService scheduling mode and replica count.
ServiceEndpointModeService endpoint mode (vip or dnsrr).
NodeLabelsNode labels.
NodeRoleNode role in the swarm.
ClusterCapacityCluster resource capacity: max single-node values and totals.
SearchResultCross-resource search results.
RecommendationCollectionCluster health recommendations from the recommendation engine.
HistoryEntryA resource change event from the history ring buffer or SSE stream.
ServiceRefA cross-reference to a service (used in config/secret/network/volume detail responses).
HealthHealth check response with build metadata and operations level.
ProblemDetailAn error response following RFC 9457 Problem Details.
Properties
Properties are mapped to IRIs via the @context. The urn:cetacean: namespace is the default vocabulary; RFC 9457 problem detail fields use urn:ietf:rfc:9457#.
actionThe action performed on a resource (create, update, remove).
aliasesDNS aliases for a service on a given network.
availabilityThe scheduling availability of a node: active, pause, or drain.
buildDateBuild timestamp of the running binary.
changes@listSpec changes from the previous service version.
commitGit commit SHA of the build.
computedAtTimestamp when recommendations were last computed.
configThe Docker config object.
configs@listConfig references attached to a service.
countsResult counts per resource type.
detailA human-readable explanation specific to this occurrence (RFC 9457).
driverThe driver backing a network or volume (e.g., overlay, local).
endpointModeEndpoint mode for a service: vip or dnsrr.
envEnvironment variables as a key-value map.
healthcheckContainer healthcheck configuration.
hostnameNode hostname in a task cross-reference.
imageThe container image reference (registry/name:tag@digest).
instanceA URI reference identifying the specific occurrence of the problem (RFC 9457).
integrations@listDetected third-party integrations for a service.
isLeaderWhether this manager node is the Raft leader.
items@setThe set of resources in a collection response.
kindThe resource kind for history and SSE events (e.g., service, node).
labelsLabels as a key-value map.
limitPage size limit for a collection response.
logDriverLog driver name and options.
managerAddrManager node address for remote Docker API access.
managerCountTotal number of manager nodes in the swarm.
maxNodeCPUCPU capacity (nanoCPUs) of the largest node in the cluster.
maxNodeMemoryMemory capacity (bytes) of the largest node in the cluster.
modeThe scheduling mode of a service: replicated or global.
mounts@listMount configuration attached to a service.
nameThe human-readable name of a resource. For nodes this is the hostname; for services, configs, secrets, networks, and volumes it is the Docker object name.
networkThe Docker network object.
networks@listThe networks a service is attached to.
nodeThe Docker node object.
nodeCountNumber of nodes in the cluster.
nodesDownNumber of nodes in down state.
nodesDrainingNumber of nodes in drain state.
nodesReadyNumber of nodes in ready state.
offsetPage offset for a collection response.
operationsLevelCurrent operations level (0=read-only, 1=operational, 2=configuration, 3=impactful).
placementPlacement constraints and preferences for a service.
pluginThe Docker plugin object.
ports@listPublished port bindings for a service, ordered by target port.
prometheusConfiguredWhether a Prometheus instance is configured.
queryThe search query string.
replicasThe configured number of replicas for a replicated service.
requestIdUnique request identifier for error correlation.
reservedCPUTotal reserved CPU (nanoCPUs) across all services.
reservedMemoryTotal reserved memory (bytes) across all services.
resourceIdThe ID of the affected resource.
resourcesCPU/memory reservations and limits for a service.
resultsSearch results grouped by resource type.
roleThe role of a node in the swarm: manager or worker.
rollbackPolicyRollback configuration for a service.
scopeThe scope of a network or volume: swarm or local.
secretThe Docker secret object (data always redacted).
secrets@listSecret references attached to a service.
serviceThe Docker service object.
serviceCountNumber of services in the cluster.
services@listCross-referenced services using this resource.
servicesConvergedNumber of services with all tasks running.
servicesDegradedNumber of services with fewer tasks than desired.
slotThe slot number of a task within a replicated service. Each replica occupies a unique slot.
stackThe stack detail with member resources.
stackCountNumber of stacks in the cluster.
stateThe current state of a resource. For nodes: ready, down, or unknown. For tasks: running, failed, complete, etc. For services: a derived state based on running/desired task counts.
statusThe HTTP status code for the problem (RFC 9457).
summarySeverity summary (critical/warning/info counts).
taskThe Docker task object, enriched with ServiceName and NodeHostname.
taskCountNumber of tasks in the cluster.
tasks@listThe list of tasks belonging to a service or running on a node.
tasksByStateTask counts grouped by state.
timestampWhen the event occurred.
titleA short human-readable summary of the problem type (RFC 9457).
totalTotal count of items.
totalCPUTotal cluster CPU capacity (nanoCPUs).
totalMemoryTotal cluster memory capacity (bytes).
typeA URI reference identifying the problem type (RFC 9457).
updatePolicyRolling update configuration for a service.
updateStatusThe status of a rolling update for a service, if one is in progress.
versionSoftware version string.
volumeThe Docker volume object.