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.
Collection A paginated list of resources.
Node A Docker Swarm node (manager or worker).
Service A Docker Swarm service.
Task A single running or completed container instance.
Stack A group of services deployed together via `com.docker.stack.namespace` labels.
Config A Docker Swarm config object.
Secret A Docker Swarm secret (data always redacted).
Network A Docker network.
Volume A Docker volume.
Plugin An installed Docker plugin.
Cluster Cluster-wide overview with counts and resource totals.
Swarm Swarm configuration: join tokens, Raft config, CA config.
ServiceEnv Service environment variables.
ServicePorts Service port bindings.
ServiceLabels Service labels.
ServiceResources Service CPU/memory reservations and limits.
ServicePlacement Service placement constraints and preferences.
ServiceUpdatePolicy Rolling update configuration for a service.
ServiceRollbackPolicy Rollback configuration for a service.
ServiceLogDriver Log driver configuration for a service.
ServiceHealthcheck Healthcheck configuration for a service.
ServiceConfigs Config references attached to a service.
ServiceSecrets Secret references attached to a service.
ServiceNetworks Network attachments for a service.
ServiceMounts Mount configuration for a service.
ServiceMode Service scheduling mode and replica count.
ServiceEndpointMode Service endpoint mode (vip or dnsrr).
NodeLabels Node labels.
NodeRole Node role in the swarm.
ClusterCapacity Cluster resource capacity: max single-node values and totals.
SearchResult Cross-resource search results.
RecommendationCollection Cluster health recommendations from the recommendation engine.
HistoryEntry A resource change event from the history ring buffer or SSE stream.
ServiceRef A cross-reference to a service (used in config/secret/network/volume detail responses).
Health Health check response with build metadata and operations level.
ProblemDetail An 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#.
action The action performed on a resource (create, update, remove).
aliases DNS aliases for a service on a given network.
availability The scheduling availability of a node: active, pause, or drain.
buildDate Build timestamp of the running binary.
changes @list Spec changes from the previous service version.
commit Git commit SHA of the build.
computedAt Timestamp when recommendations were last computed.
config The Docker config object.
configs @list Config references attached to a service.
counts Result counts per resource type.
detail A human-readable explanation specific to this occurrence (RFC 9457).
driver The driver backing a network or volume (e.g., overlay, local).
endpointMode Endpoint mode for a service: vip or dnsrr.
env Environment variables as a key-value map.
healthcheck Container healthcheck configuration.
hostname Node hostname in a task cross-reference.
image The container image reference (registry/name:tag@digest).
instance A URI reference identifying the specific occurrence of the problem (RFC 9457).
integrations @list Detected third-party integrations for a service.
isLeader Whether this manager node is the Raft leader.
items @set The set of resources in a collection response.
kind The resource kind for history and SSE events (e.g., service, node).
labels Labels as a key-value map.
limit Page size limit for a collection response.
logDriver Log driver name and options.
managerAddr Manager node address for remote Docker API access.
managerCount Total number of manager nodes in the swarm.
maxNodeCPU CPU capacity (nanoCPUs) of the largest node in the cluster.
maxNodeMemory Memory capacity (bytes) of the largest node in the cluster.
mode The scheduling mode of a service: replicated or global.
mounts @list Mount configuration attached to a service.
name The 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.
network The Docker network object.
networks @list The networks a service is attached to.
node The Docker node object.
nodeCount Number of nodes in the cluster.
nodesDown Number of nodes in down state.
nodesDraining Number of nodes in drain state.
nodesReady Number of nodes in ready state.
offset Page offset for a collection response.
operationsLevel Current operations level (0=read-only, 1=operational, 2=configuration, 3=impactful).
placement Placement constraints and preferences for a service.
plugin The Docker plugin object.
ports @list Published port bindings for a service, ordered by target port.
prometheusConfigured Whether a Prometheus instance is configured.
query The search query string.
replicas The configured number of replicas for a replicated service.
requestId Unique request identifier for error correlation.
reservedCPU Total reserved CPU (nanoCPUs) across all services.
reservedMemory Total reserved memory (bytes) across all services.
resourceId The ID of the affected resource.
resources CPU/memory reservations and limits for a service.
results Search results grouped by resource type.
role The role of a node in the swarm: manager or worker.
rollbackPolicy Rollback configuration for a service.
scope The scope of a network or volume: swarm or local.
secret The Docker secret object (data always redacted).
secrets @list Secret references attached to a service.
service The Docker service object.
serviceCount Number of services in the cluster.
services @list Cross-referenced services using this resource.
servicesConverged Number of services with all tasks running.
servicesDegraded Number of services with fewer tasks than desired.
slot The slot number of a task within a replicated service. Each replica occupies a unique slot.
stack The stack detail with member resources.
stackCount Number of stacks in the cluster.
state The 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.
status The HTTP status code for the problem (RFC 9457).
summary Severity summary (critical/warning/info counts).
task The Docker task object, enriched with ServiceName and NodeHostname.
taskCount Number of tasks in the cluster.
tasks @list The list of tasks belonging to a service or running on a node.
tasksByState Task counts grouped by state.
timestamp When the event occurred.
title A short human-readable summary of the problem type (RFC 9457).
total Total count of items.
totalCPU Total cluster CPU capacity (nanoCPUs).
totalMemory Total cluster memory capacity (bytes).
type A URI reference identifying the problem type (RFC 9457).
updatePolicy Rolling update configuration for a service.
updateStatus The status of a rolling update for a service, if one is in progress.
version Software version string.
volume The Docker volume object.