| Class | Description |
|---|---|
| AuthConfig | |
| AuthConfigurations | |
| AuthResponse | |
| Bind |
Represents a host path being bind mounted as a
Volume in a Docker container. |
| BindOptions | |
| Binds | |
| BlkioRateDevice | |
| BlkioStatEntry |
BlkioStat is not documented in pubic docker swapper.yaml yet, reference:
https://github.com/moby/moby/blob/master/api/types/stats.go
|
| BlkioStatsConfig |
Used in
Statistics |
| BlkioWeightDevice | |
| BuildResponseItem |
Represents a build response stream item
|
| ChangeLog | |
| ClusterInfo |
Used for creating swarms.
|
| Config |
Used for Listing config.
|
| ConfigSpec | |
| Container |
Used for Listing containers.
|
| ContainerConfig |
Used as part of 'images/IMAGE/someimage' response.
|
| ContainerDNSConfig |
Specification for DNS related configurations in resolver configuration file (`resolv.conf`).
|
| ContainerHostConfig |
Used in
Container |
| ContainerMount | |
| ContainerNetwork |
Types taken form
https://github.com/docker/engine-api/blob/release/1.10/types/network/network.go
Docker named it EndpointSettings |
| ContainerNetwork.Ipam |
Docker named it EndpointIPAMConfig
|
| ContainerNetworkSettings |
Sub-object in
Container |
| ContainerPort | |
| ContainerSpec |
The specification for containers as used in
TaskSpec |
| ContainerSpecConfig |
docker configs that will be exposed to the service
|
| ContainerSpecFile |
File represents a specific target that is backed by a file.
|
| ContainerSpecPrivileges |
Security options for the container
|
| ContainerSpecPrivilegesCredential |
Credential for managed service account (Windows only)
|
| ContainerSpecPrivilegesSELinuxContext |
SELinux labels of the container
|
| ContainerSpecSecret |
docker secrets that will be exposed to the service
|
| CpuStatsConfig |
Used in
Statistics |
| CpuUsageConfig |
Used in
Statistics |
| Device | |
| DeviceRequest | |
| DiscreteResourceSpec | Deprecated |
| DockerObject | |
| DockerObjectAccessor | |
| Driver | |
| DriverStatus | |
| Endpoint | |
| EndpointSpec | |
| EndpointVirtualIP | |
| ErrorDetail | |
| ErrorResponse | Deprecated |
| Event |
Representation of a Docker event.
|
| EventActor | |
| ExposedPort |
Represents a container port that Docker exposes to external clients.
|
| ExposedPorts | |
| ExternalCA | |
| Frame |
Represents a logging frame.
|
| GenericResource<T> | |
| HealthCheck | |
| HostConfig |
Used in `/containers/create`, and in inspect container.
|
| Identifier | |
| Image | |
| ImageOptions | |
| Info |
Used for `/info`
|
| InfoRegistryConfig | |
| InfoRegistryConfig.IndexConfig | |
| Link |
Represents a network link between two Docker containers.
|
| Links | |
| LoadResponseItem | |
| LogConfig |
Log driver to use for a created/running container.
|
| LxcConf | |
| MemoryStatsConfig |
Used in
Statistics |
| Mount | |
| NamedResourceSpec | Deprecated |
| Network | |
| Network.ContainerNetworkConfig | |
| Network.Ipam | |
| Network.Ipam.Config | |
| NetworkAttachmentConfig | |
| NetworkSettings | |
| Node |
A node as returned by the /events API, for instance, when Swarm is used.
|
| ObjectVersion | |
| PeerNode | |
| PidsStatsConfig |
Used in
Statistics |
| PortBinding |
In a
PortBinding, a network socket on the Docker host, expressed as a Ports.Binding, is bound to an ExposedPort of a
container. |
| PortConfig | |
| Ports |
A container for port bindings, made available as a
Map via its Ports.getBindings() method. |
| Ports.Binding |
A
Ports.Binding represents a socket on the Docker host that is used in a PortBinding. |
| PruneResponse |
Delete unused content (containers, images, volumes, networks, build relicts)
|
| PullResponseItem |
Represents a pull response stream item
|
| PushResponseItem |
Represents a push response stream item
|
| Repository |
A repository or image name.
|
| ResourceRequirements | |
| ResourceSpecs | |
| ResourceVersion | |
| ResponseItem |
Represents a pull response stream item
|
| ResponseItem.AuxDetail | |
| ResponseItem.ErrorDetail | |
| ResponseItem.ProgressDetail | |
| RestartPolicy |
Container restart policy
no
Do not restart the container if it dies.
|
| RuntimeInfo | |
| SearchItem | |
| Secret |
Used for Listing secret.
|
| SecretSpec | |
| Service |
Used for Listing services.
|
| ServiceGlobalModeOptions | |
| ServiceModeConfig | |
| ServicePlacement | |
| ServiceReplicatedModeOptions | |
| ServiceRestartPolicy | |
| ServiceSpec | |
| ServiceUpdateStatus | |
| StatisticNetworksConfig |
Used in
Statistics |
| Statistics |
Representation of a Docker statistics.
|
| StatsConfig | |
| Swarm | |
| SwarmCAConfig | |
| SwarmDispatcherConfig | |
| SwarmInfo | |
| SwarmJoinTokens | |
| SwarmNode |
Used for Listing SwarmNodes.
|
| SwarmNodeDescription | |
| SwarmNodeEngineDescription | |
| SwarmNodeManagerStatus | |
| SwarmNodePlatform | |
| SwarmNodePluginDescription | |
| SwarmNodeResources | |
| SwarmNodeSpec | |
| SwarmNodeStatus | |
| SwarmNodeVersion | |
| SwarmOrchestration | |
| SwarmRaftConfig | |
| SwarmSpec | |
| SwarmVersion | |
| Task | |
| TaskDefaults | |
| TaskSpec | |
| TaskStatus | |
| TaskStatusContainerStatus | |
| ThrottlingDataConfig |
Used in
Statistics |
| TmpfsOptions | |
| Ulimit | |
| UpdateConfig | |
| UpdateContainerResponse | |
| Version |
Used for `/version`
|
| VersionComponent |
Part of
Version |
| VersionPlatform |
Part of
Version |
| Volume |
Represents a bind mounted volume in a Docker container.
|
| VolumeBind | |
| VolumeBinds | |
| VolumeOptions | |
| VolumeRW | Deprecated
since
RemoteApiVersion#VERSION_1_20 |
| Volumes | |
| VolumesFrom | |
| VolumesRW | |
| WaitResponse |
Represents a wait container command response
|
| Enum | Description |
|---|---|
| AccessMode |
The access mode of a file system or file:
read-write or read-only. |
| BindPropagation | |
| Capability |
The Linux capabilities supported by Docker.
|
| EndpointResolutionMode | |
| EventType | |
| ExternalCAProtocol | |
| InternetProtocol |
The IP protocols supported by Docker.
|
| Isolation | |
| LocalNodeState |
https://github.com/moby/moby/blob/master/api/types/swarm/swarm.go#L174-L188
|
| LogConfig.LoggingType | |
| MountType | |
| PortConfig.PublishMode | |
| PortConfigProtocol | |
| PropagationMode |
The propagation mode of a file system or file:
shared, slave or private. |
| PruneType | |
| Reachability | |
| SELContext |
The context mode of bound volume in SELinux.
|
| ServiceMode | |
| ServiceRestartCondition | |
| ServiceUpdateState | |
| StreamType | |
| SwarmNodeAvailability | |
| SwarmNodeRole | |
| SwarmNodeState | |
| TaskState | |
| UpdateFailureAction | |
| UpdateOrder |
Copyright © 2025. All rights reserved.