Expand description
Generated Docker models
Structs§
- Address
- Address represents an IPv4 or IPv6 IP address.
- Auth
Config - Aux
- Build
Cache - BuildCache contains information about a build cache record.
- Build
Info - Build
Prune200 Response - No error
- Cluster
Info - ClusterInfo represents information about the swarm as is returned by the “/info” endpoint. Join-tokens are not included.
- Cluster
Volume - Options and information specific to, and only present on, Swarm CSI cluster volumes.
- Cluster
Volume Info Inline Item - Information about the global status of the volume.
- Cluster
Volume Publish Status Inline Item - Cluster
Volume Spec - Cluster-specific options used to create the volume.
- Cluster
Volume Spec Access Mode Inline Item - Defines how the volume is used by tasks.
- Cluster
Volume Spec Access Mode Inline Item Accessibility Requirements Inline Item - Requirements for the accessible topology of the volume. These fields are optional. For an in-depth description of what these fields mean, see the CSI specification.
- Cluster
Volume Spec Access Mode Inline Item Capacity Range Inline Item - The desired capacity that the volume should be created with. If empty, the plugin will decide the capacity.
- Cluster
Volume Spec Access Mode Inline Item Secrets Inline Item - One cluster volume secret entry. Defines a key-value pair that is passed to the plugin.
- Commit
- Commit holds the Git-commit (SHA1) that a binary was built from, as
reported in the version-string of external tools, such as
containerd, orrunC. - Component
Version - Config
- Config
Create Body Param - Config
Spec - Container
Change Response Item - change item in response to ContainerChanges operation
- Container
Config - Configuration for a container that is portable between hosts.
- Container
Create Body Param - Configuration for a container that is portable between hosts.
- Container
Create Response - OK response to ContainerCreate operation
- Container
Exec Exec Config Param - Container
Inspect200 Response - no error
- Container
Prune200 Response - No error
- Container
State - ContainerState stores container’s running state. It’s part of ContainerJSONBase and will be returned by the “inspect” command.
- Container
Summary - Container
Summary Host Config Inline Item - Container
Summary Network Settings Inline Item - A summary of the container’s network settings
- Container
Top200 Response - no error
- Container
Update200 Response - The container has been updated.
- Container
Update Update Param - A container’s resources (cgroups config, ulimits, etc)
- Container
Update Update Param Blkio Weight Device Inline Item - Container
Update Update Param Ulimits Inline Item - Container
Wait Exit Error - container waiting error, if any
- Container
Wait Response - OK response to ContainerWait operation
- Create
Image Info - Device
Mapping - A device mapping between the host and container
- Device
Request - A request for devices to be sent to device drivers
- Distribution
Inspect - Describes the result obtained from contacting the registry to retrieve image metadata.
- Driver
- Driver represents a driver (network, logging, secrets).
- Endpoint
Ipam Config - EndpointIPAMConfig represents an endpoint’s IPAM configuration.
- Endpoint
Port Config - Endpoint
Settings - Configuration for a network endpoint.
- Endpoint
Spec - Properties that can be configured to access and load balance a service.
- Engine
Description - EngineDescription provides information about an engine.
- Engine
Description Plugins Inline Item - Error
Detail - Error
Response - Represents an error.
- Event
Actor - Actor describes something that generates events, like a container, network, or a volume.
- Event
Message - EventMessage represents the information an event contains.
- Exec
Inspect200 Response - No error
- Exec
Start Exec Start Config Param - Generic
Resources Inline Item - Generic
Resources Inline Item Discrete Resource Spec Inline Item - Generic
Resources Inline Item Named Resource Spec Inline Item - Graph
Driver Data - Information about the storage driver used to store the container’s and image’s filesystem.
- Health
- Health stores information about the container’s healthcheck results.
- Health
Config - A test to perform to check that the container is healthy.
- Healthcheck
Result - HealthcheckResult stores information about a single run of a healthcheck probe
- History
Response Item - individual image layer information in response to ImageHistory operation
- Host
Config - Container configuration that depends on the host we are running on
- Host
Config Blkio Weight Device Inline Item - Host
Config LogConfig Inline Item - The logging configuration for this container
- Host
Config Ulimits Inline Item - IdResponse
- Response to an API call that returns just an Id
- Image
Delete Response Item - ImageId
- Image ID or Digest
- Image
Inspect - Information about an image in the local image cache.
- Image
Inspect Metadata Inline Item - Additional metadata of the image in the local cache. This information is local to the daemon, and not part of the image itself.
- Image
Inspect Root FsInline Item - Information about the image’s RootFS, including the layer IDs.
- Image
Prune200 Response - No error
- Image
Search Response Item - Image
Summary - Index
Info - IndexInfo contains information about a registry.
- Ipam
- Ipam
Config - Join
Tokens - JoinTokens contains the tokens workers and managers need to join the swarm.
- Limit
- An object describing a limit on resources which can be requested by a task.
- Manager
Status - ManagerStatus represents the status of a manager.
- Mount
- Mount
Bind Options Inline Item - Optional configuration for the
bindtype. - Mount
Point - MountPoint represents a mount point configuration inside the container. This is used for reporting the mountpoints in use by a container.
- Mount
Tmpfs Options Inline Item - Optional configuration for the
tmpfstype. - Mount
Volume Options Inline Item - Optional configuration for the
volumetype. - Mount
Volume Options Inline Item Driver Config Inline Item - Map of driver specific options
- Network
- Network
Attachment Config - Specifies how a service should be attached to a particular network.
- Network
Connect Container Param - Network
Container - Network
Create201 Response - No error
- Network
Create Network Config Param - Network
Disconnect Container Param - Network
Prune200 Response - No error
- Network
Settings - NetworkSettings exposes the network settings in the API
- Networking
Config - NetworkingConfig represents the container’s networking configuration for
each of its interfaces.
It is used for the networking configs specified in the
docker createanddocker network connectcommands. - Node
- Node
Description - NodeDescription encapsulates the properties of the Node as reported by the agent.
- Node
Spec - Node
Status - NodeStatus represents the status of a node.
- Object
Version - The version number of the object such as node, service, etc. This is needed to avoid conflicting writes. The client must send the version number along with the modified specification when updating these objects.
- OciDescriptor
- A descriptor struct containing digest, media type, and size, as defined in the OCI Content Descriptors Specification.
- OciPlatform
- Describes the platform which the image in the manifest runs on, as defined in the OCI Image Index Specification.
- Peer
Node - Represents a peer-node in the swarm
- Ping
Info - Platform
- Platform represents the platform (Arch/OS).
- Plugin
- A plugin for the Engine API
- Plugin
Config Inline Item - The config of a plugin.
- Plugin
Config Inline Item Args Inline Item - Plugin
Config Inline Item Interface Inline Item - The interface between Docker and the plugin
- Plugin
Config Inline Item Linux Inline Item - Plugin
Config Inline Item Network Inline Item - Plugin
Config Inline Item User Inline Item - Plugin
Config Inline Itemrootfs Inline Item - Plugin
Device - Plugin
Env - Plugin
Interface Type - Plugin
Mount - Plugin
Privilege - Describes a permission the user has to accept upon installing the plugin.
- Plugin
Settings Inline Item - Settings that can be modified by users.
- Plugins
Info - Available plugins per type.
- Port
- An open port on a container
- Port
Binding - PortBinding represents a binding between a host IP address and a host port.
- Process
Config - Progress
Detail - Push
Image Info - Registry
Service Config - RegistryServiceConfig stores daemon registry services configuration.
- Resource
Object - An object describing the resources which can be advertised by a node and requested by a task.
- Resources
- A container’s resources (cgroups config, ulimits, etc)
- Resources
Blkio Weight Device Inline Item - Resources
Ulimits Inline Item - Restart
Policy - The behavior to apply when the container exits. The default is not to restart.
- Runtime
- Runtime describes an OCI compliant runtime.
- Secret
- Secret
Create Body Param - Secret
Spec - Service
- Service
Create201 Response - no error
- Service
Create Body Param - User modifiable configuration for a service.
- Service
Create Body Param Mode Inline Item - Scheduling mode for the service.
- Service
Create Body Param Mode Inline Item Replicated Inline Item - Service
Create Body Param Mode Inline Item Replicated JobInline Item - The mode used for services with a finite number of tasks that run to a completed state.
- Service
Create Body Param Rollback Config Inline Item - Specification for the rollback strategy of the service.
- Service
Create Body Param Update Config Inline Item - Specification for the update strategy of the service.
- Service
Endpoint Inline Item - Service
Endpoint Inline Item VirtualI PsInline Item - Service
JobStatus Inline Item - The status of the service when it is in one of ReplicatedJob or GlobalJob modes. Absent on Replicated and Global mode services. The JobIteration is an ObjectVersion, but unlike the Service’s version, does not need to be sent with an update request.
- Service
Service Status Inline Item - The status of the service’s tasks. Provided only when requested as part of a ServiceList operation.
- Service
Spec - User modifiable configuration for a service.
- Service
Spec Mode Inline Item - Scheduling mode for the service.
- Service
Spec Mode Inline Item Replicated Inline Item - Service
Spec Mode Inline Item Replicated JobInline Item - The mode used for services with a finite number of tasks that run to a completed state.
- Service
Spec Rollback Config Inline Item - Specification for the rollback strategy of the service.
- Service
Spec Update Config Inline Item - Specification for the update strategy of the service.
- Service
Update Body Param - User modifiable configuration for a service.
- Service
Update Body Param Mode Inline Item - Scheduling mode for the service.
- Service
Update Body Param Mode Inline Item Replicated Inline Item - Service
Update Body Param Mode Inline Item Replicated JobInline Item - The mode used for services with a finite number of tasks that run to a completed state.
- Service
Update Body Param Rollback Config Inline Item - Specification for the rollback strategy of the service.
- Service
Update Body Param Update Config Inline Item - Specification for the update strategy of the service.
- Service
Update Response - Service
Update Status Inline Item - The status of a service update.
- Swarm
- ClusterInfo represents information about the swarm as is returned by the “/info” endpoint. Join-tokens are not included.
- Swarm
Info - Represents generic information about swarm.
- Swarm
Init Body Param - Swarm
Join Body Param - Swarm
Spec - User modifiable swarm configuration.
- Swarm
Spec CaConfig Inline Item - CA configuration.
- Swarm
Spec CaConfig Inline Item ExternalC AsInline Item - Swarm
Spec Dispatcher Inline Item - Dispatcher configuration.
- Swarm
Spec Encryption Config Inline Item - Parameters related to encryption-at-rest.
- Swarm
Spec Orchestration Inline Item - Orchestration configuration.
- Swarm
Spec Raft Inline Item - Raft configuration.
- Swarm
Spec Task Defaults Inline Item - Defaults for creating tasks in this cluster.
- Swarm
Spec Task Defaults Inline Item LogDriver Inline Item - The log driver to use for tasks created in the orchestrator if unspecified by a service.
- Swarm
Unlock Body Param - Swarm
Unlockkey200 Response - no error
- System
Auth200 Response - An identity token was generated successfully.
- System
Data Usage200 Response - no error
- System
Info - System
Info Default Address Pools Inline Item - System
Version - Response of Engine API: GET “/version”
- System
Version Platform Inline Item - Task
- Task
Spec - User modifiable task configuration.
- Task
Spec Container Spec Inline Item - Container spec for the service.
- Task
Spec Container Spec Inline Item Configs Inline Item - Task
Spec Container Spec Inline Item Configs Inline Item File Inline Item - File represents a specific target that is backed by a file.
- Task
Spec Container Spec Inline Item DnsConfig Inline Item - Specification for DNS related configurations in resolver configuration
file (
resolv.conf). - Task
Spec Container Spec Inline Item Privileges Inline Item - Security options for the container
- Task
Spec Container Spec Inline Item Privileges Inline Item Credential Spec Inline Item - CredentialSpec for managed service account (Windows only)
- Task
Spec Container Spec Inline Item Privileges Inline Item SeLinux Context Inline Item - SELinux labels of the container
- Task
Spec Container Spec Inline Item Secrets Inline Item - Task
Spec Container Spec Inline Item Secrets Inline Item File Inline Item - File represents a specific target that is backed by a file.
- Task
Spec Container Spec Inline Item Ulimits Inline Item - Task
Spec LogDriver Inline Item - Specifies the log driver to use for tasks created from this spec. If not present, the default one for the swarm will be used, finally falling back to the engine default if not specified.
- Task
Spec Network Attachment Spec Inline Item - Read-only spec type for non-swarm containers attached to swarm overlay networks.
- Task
Spec Placement Inline Item - Task
Spec Placement Inline Item Preferences Inline Item - Task
Spec Placement Inline Item Preferences Inline Item Spread Inline Item - Task
Spec Plugin Spec Inline Item - Plugin spec for the service. (Experimental release only.)
- Task
Spec Resources Inline Item - Resource requirements which apply to each individual container created as part of the service.
- Task
Spec Restart Policy Inline Item - Specification for the restart policy which applies to containers created as part of this service.
- Task
Status Inline Item - Task
Status Inline Item Container Status Inline Item - Throttle
Device - TlsInfo
- Information about the issuer of leaf TLS certificates and the trusted root CA certificate.
- Usage
Data - Usage details about the volume. This information is used by the
GET /system/dfendpoint, and omitted in other endpoints. - Volume
- Volume
Create Options - Volume configuration
- Volume
List Response - Volume list response
- Volume
Prune200 Response - No error
- Volume
Update Body Param - Volume configuration
Enums§
- Build
Cache Type Inline Item - Cache record type.
- Cluster
Volume Publish Status Inline Item State Inline Item - The published state of the volume.
- Cluster
Volume Spec Access Mode Inline Item Availability Inline Item - The availability of the volume for use in tasks.
- Cluster
Volume Spec Access Mode Inline Item Scope Inline Item - The set of nodes this volume can be used on at one time.
- Cluster
Volume Spec Access Mode Inline Item Sharing Inline Item - The number and way that different tasks can use this volume at one time.
- Container
State Status Inline Item - String representation of the container state. Can be one of “created”, “running”, “paused”, “restarting”, “removing”, “exited”, or “dead”.
- Endpoint
Port Config Protocol Inline Item - Endpoint
Port Config Publish Mode Inline Item - The mode in which port is published.
- Endpoint
Spec Mode Inline Item - The mode of resolution to use for internal load balancing between tasks.
- Event
Message Type Inline Item - The type of object emitting the event
- Event
Messagescope Inline Item - Scope of the event. Engine events are
localscope. Cluster (Swarm) events areswarmscope. - Health
Status Inline Item - Status is one of
none,starting,healthyorunhealthy - Host
Config Cgroupns Mode Inline Item - cgroup namespace mode for the container. Possible values are:
- Host
Config Isolation Inline Item - Isolation technology of the container. (Windows only)
- Host
Config LogConfig Inline Item Type Inline Item - Image
Build Chunk - Represents a response chunk from Docker api when building, pulling or importing an image.
- Local
Node State - Current local status of this node.
- Mount
Bind Options Inline Item Propagation Inline Item - A propagation mode with the value
[r]private,[r]shared, or[r]slave. - Mount
Point Type Inline Item - The mount type:
- Mount
Type Inline Item - The mount type. Available types:
- Node
Spec Availability Inline Item - Availability of the node.
- Node
Spec Role Inline Item - Role of the node.
- Node
State - NodeState represents the state of a node.
- Plugin
Config Inline Item Interface Inline Item Protocol Scheme Inline Item - Protocol to use for clients connecting to the plugin.
- Port
Type Inline Item - Reachability
- Reachability represents the reachability of a node.
- Restart
Policy Name Inline Item - Empty string means not to restart
noDo not automatically restartalwaysAlways restartunless-stoppedRestart always except when the user has manually stopped the containeron-failureRestart only when the container exit code is non-zero - Service
Create Body Param Rollback Config Inline Item Failure Action Inline Item - Action to take if an rolled back task fails to run, or stops running during the rollback.
- Service
Create Body Param Rollback Config Inline Item Order Inline Item - The order of operations when rolling back a task. Either the old task is shut down before the new task is started, or the new task is started before the old task is shut down.
- Service
Create Body Param Update Config Inline Item Failure Action Inline Item - Action to take if an updated task fails to run, or stops running during the update.
- Service
Create Body Param Update Config Inline Item Order Inline Item - The order of operations when rolling out an updated task. Either the old task is shut down before the new task is started, or the new task is started before the old task is shut down.
- Service
Spec Rollback Config Inline Item Failure Action Inline Item - Action to take if an rolled back task fails to run, or stops running during the rollback.
- Service
Spec Rollback Config Inline Item Order Inline Item - The order of operations when rolling back a task. Either the old task is shut down before the new task is started, or the new task is started before the old task is shut down.
- Service
Spec Update Config Inline Item Failure Action Inline Item - Action to take if an updated task fails to run, or stops running during the update.
- Service
Spec Update Config Inline Item Order Inline Item - The order of operations when rolling out an updated task. Either the old task is shut down before the new task is started, or the new task is started before the old task is shut down.
- Service
Update Body Param Rollback Config Inline Item Failure Action Inline Item - Action to take if an rolled back task fails to run, or stops running during the rollback.
- Service
Update Body Param Rollback Config Inline Item Order Inline Item - The order of operations when rolling back a task. Either the old task is shut down before the new task is started, or the new task is started before the old task is shut down.
- Service
Update Body Param Update Config Inline Item Failure Action Inline Item - Action to take if an updated task fails to run, or stops running during the update.
- Service
Update Body Param Update Config Inline Item Order Inline Item - The order of operations when rolling out an updated task. Either the old task is shut down before the new task is started, or the new task is started before the old task is shut down.
- Service
Update Status Inline Item State Inline Item - Swarm
Spec CaConfig Inline Item ExternalC AsInline Item Protocol Inline Item - Protocol for communication with the external CA (currently
only
cfsslis supported). - System
Info Cgroup Driver Inline Item - The driver to use for managing cgroups.
- System
Info Cgroup Version Inline Item - The version of the cgroup.
- System
Info Isolation Inline Item - Represents the isolation technology to use as a default for containers. The supported values are platform-specific.
- Task
Spec Container Spec Inline Item Isolation Inline Item - Isolation technology of the containers running the service. (Windows only)
- Task
Spec Restart Policy Inline Item Condition Inline Item - Condition for restart.
- Task
State - Volume
Scope Inline Item - The level at which the volume exists. Either
globalfor cluster-wide, orlocalfor machine level.
Type Aliases§
- Config
List200 Response - no error
- Config
Update Body Param - Container
Changes200 Response - The list of changes
- Container
List200 Response - no error
- Container
Logs200 Response - logs returned as a stream in response body. For the stream format, see the documentation for the attach endpoint. Note that unlike the attach endpoint, the logs endpoint does not upgrade the connection and does not set Content-Type.
- Container
Stats200 Response - no error
- Generic
Resources - User-defined resources can be either Integer resources (e.g,
SSD=3) or String resources (e.g,GPU=UUID1). - GetPlugin
Privileges200 Response - no error
- Image
Build Input Stream Param - Image
Commit Container Config Param - Configuration for a container that is portable between hosts.
- Image
Create Input Image Param - Image
Delete200 Response - The image was deleted successfully
- Image
Get200 Response - no error
- Image
GetAll200 Response - no error
- Image
History200 Response - List of image layers
- Image
List200 Response - Summary image data for the images matching the query
- Image
Load Images Tarball Param - Image
Search200 Response - No error
- Labels
- Network
List200 Response - No error
- Node
List200 Response - no error
- Node
Update Body Param - Plugin
Create TarContext Param - Plugin
List200 Response - No error
- Plugin
Pull Body Param - Plugin
SetBody Param - Plugin
Upgrade Body Param - PortMap
- PortMap describes the mapping of container ports to host ports, using the
container’s port-number and protocol as key in the format
<port>/<protocol>, for example,80/udp. - PutContainer
Archive Input Stream Param - Secret
List200 Response - no error
- Secret
Update Body Param - Service
List200 Response - no error
- Service
Logs200 Response - logs returned as a stream in response body
- Swarm
Init200 Response - no error
- Swarm
Update Body Param - User modifiable swarm configuration.
- System
Auth Auth Config Param - System
Ping200 Response - no error
- System
Ping Head200 Response - no error
- Task
List200 Response - no error
- Task
Logs200 Response - logs returned as a stream in response body
- Topology
- A map of topological domains to topological segments. For in depth details, see documentation for the Topology object in the CSI specification.
- Volume
Create Volume Config Param - Volume configuration