Module docker_api::models

Generated Docker models

Structs

• Address
  Address represents an IPv4 or IPv6 IP address.
• AuthConfig
• Aux
• BuildCache
  BuildCache contains information about a build cache record.
• BuildInfo
• BuildPrune200Response
  No error
• ClusterInfo
  ClusterInfo represents information about the swarm as is returned by the “/info” endpoint. Join-tokens are not included.
• ClusterVolume
  Options and information specific to, and only present on, Swarm CSI cluster volumes.
• ClusterVolumeInfoInlineItem
  Information about the global status of the volume.
• ClusterVolumePublishStatusInlineItem
• ClusterVolumeSpec
  Cluster-specific options used to create the volume.
• ClusterVolumeSpecAccessModeInlineItem
  Defines how the volume is used by tasks.
• ClusterVolumeSpecAccessModeInlineItemAccessibilityRequirementsInlineItem
  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.
• ClusterVolumeSpecAccessModeInlineItemCapacityRangeInlineItem
  The desired capacity that the volume should be created with. If empty, the plugin will decide the capacity.
• ClusterVolumeSpecAccessModeInlineItemSecretsInlineItem
  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, or runC.
• ComponentVersion
• Config
• ConfigCreateBodyParam
• ConfigSpec
• ContainerChangeResponseItem
  change item in response to ContainerChanges operation
• ContainerConfig
  Configuration for a container that is portable between hosts.
• ContainerCreateBodyParam
  Configuration for a container that is portable between hosts.
• ContainerCreateResponse
  OK response to ContainerCreate operation
• ContainerExecExecConfigParam
• ContainerInspect200Response
  no error
• ContainerPrune200Response
  No error
• ContainerState
  ContainerState stores container’s running state. It’s part of ContainerJSONBase and will be returned by the “inspect” command.
• ContainerSummary
• ContainerSummaryHostConfigInlineItem
• ContainerSummaryNetworkSettingsInlineItem
  A summary of the container’s network settings
• ContainerTop200Response
  no error
• ContainerUpdate200Response
  The container has been updated.
• ContainerUpdateUpdateParam
  A container’s resources (cgroups config, ulimits, etc)
• ContainerUpdateUpdateParamBlkioWeightDeviceInlineItem
• ContainerUpdateUpdateParamUlimitsInlineItem
• ContainerWaitExitError
  container waiting error, if any
• ContainerWaitResponse
  OK response to ContainerWait operation
• CreateImageInfo
• DeviceMapping
  A device mapping between the host and container
• DeviceRequest
  A request for devices to be sent to device drivers
• DistributionInspect
  Describes the result obtained from contacting the registry to retrieve image metadata.
• Driver
  Driver represents a driver (network, logging, secrets).
• EndpointIpamConfig
  EndpointIPAMConfig represents an endpoint’s IPAM configuration.
• EndpointPortConfig
• EndpointSettings
  Configuration for a network endpoint.
• EndpointSpec
  Properties that can be configured to access and load balance a service.
• EngineDescription
  EngineDescription provides information about an engine.
• EngineDescriptionPluginsInlineItem
• ErrorDetail
• ErrorResponse
  Represents an error.
• EventActor
  Actor describes something that generates events, like a container, network, or a volume.
• EventMessage
  EventMessage represents the information an event contains.
• ExecInspect200Response
  No error
• ExecStartExecStartConfigParam
• GenericResourcesInlineItem
• GenericResourcesInlineItemDiscreteResourceSpecInlineItem
• GenericResourcesInlineItemNamedResourceSpecInlineItem
• GraphDriverData
  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.
• HealthConfig
  A test to perform to check that the container is healthy.
• HealthcheckResult
  HealthcheckResult stores information about a single run of a healthcheck probe
• HistoryResponseItem
  individual image layer information in response to ImageHistory operation
• HostConfig
  Container configuration that depends on the host we are running on
• HostConfigBlkioWeightDeviceInlineItem
• HostConfigLogConfigInlineItem
  The logging configuration for this container
• HostConfigUlimitsInlineItem
• IdResponse
  Response to an API call that returns just an Id
• ImageDeleteResponseItem
• ImageId
  Image ID or Digest
• ImageInspect
  Information about an image in the local image cache.
• ImageInspectMetadataInlineItem
  Additional metadata of the image in the local cache. This information is local to the daemon, and not part of the image itself.
• ImageInspectRootFsInlineItem
  Information about the image’s RootFS, including the layer IDs.
• ImagePrune200Response
  No error
• ImageSearchResponseItem
• ImageSummary
• IndexInfo
  IndexInfo contains information about a registry.
• Ipam
• IpamConfig
• JoinTokens
  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.
• ManagerStatus
  ManagerStatus represents the status of a manager.
• Mount
• MountBindOptionsInlineItem
  Optional configuration for the bind type.
• MountPoint
  MountPoint represents a mount point configuration inside the container. This is used for reporting the mountpoints in use by a container.
• MountTmpfsOptionsInlineItem
  Optional configuration for the tmpfs type.
• MountVolumeOptionsInlineItem
  Optional configuration for the volume type.
• MountVolumeOptionsInlineItemDriverConfigInlineItem
  Map of driver specific options
• Network
• NetworkAttachmentConfig
  Specifies how a service should be attached to a particular network.
• NetworkConnectContainerParam
• NetworkContainer
• NetworkCreate201Response
  No error
• NetworkCreateNetworkConfigParam
• NetworkDisconnectContainerParam
• NetworkPrune200Response
  No error
• NetworkSettings
  NetworkSettings exposes the network settings in the API
• NetworkingConfig
  NetworkingConfig represents the container’s networking configuration for each of its interfaces. It is used for the networking configs specified in the docker create and docker network connect commands.
• Node
• NodeDescription
  NodeDescription encapsulates the properties of the Node as reported by the agent.
• NodeSpec
• NodeStatus
  NodeStatus represents the status of a node.
• ObjectVersion
  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.
• PeerNode
  Represents a peer-node in the swarm
• PingInfo
• Platform
  Platform represents the platform (Arch/OS).
• Plugin
  A plugin for the Engine API
• PluginConfigInlineItem
  The config of a plugin.
• PluginConfigInlineItemArgsInlineItem
• PluginConfigInlineItemInterfaceInlineItem
  The interface between Docker and the plugin
• PluginConfigInlineItemLinuxInlineItem
• PluginConfigInlineItemNetworkInlineItem
• PluginConfigInlineItemUserInlineItem
• PluginConfigInlineItemrootfsInlineItem
• PluginDevice
• PluginEnv
• PluginInterfaceType
• PluginMount
• PluginPrivilege
  Describes a permission the user has to accept upon installing the plugin.
• PluginSettingsInlineItem
  Settings that can be modified by users.
• PluginsInfo
  Available plugins per type.
• Port
  An open port on a container
• PortBinding
  PortBinding represents a binding between a host IP address and a host port.
• ProcessConfig
• ProgressDetail
• PushImageInfo
• RegistryServiceConfig
  RegistryServiceConfig stores daemon registry services configuration.
• ResourceObject
  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)
• ResourcesBlkioWeightDeviceInlineItem
• ResourcesUlimitsInlineItem
• RestartPolicy
  The behavior to apply when the container exits. The default is not to restart.
• Runtime
  Runtime describes an OCI compliant runtime.
• Secret
• SecretCreateBodyParam
• SecretSpec
• Service
• ServiceCreate201Response
  no error
• ServiceCreateBodyParam
  User modifiable configuration for a service.
• ServiceCreateBodyParamModeInlineItem
  Scheduling mode for the service.
• ServiceCreateBodyParamModeInlineItemReplicatedInlineItem
• ServiceCreateBodyParamModeInlineItemReplicatedJobInlineItem
  The mode used for services with a finite number of tasks that run to a completed state.
• ServiceCreateBodyParamRollbackConfigInlineItem
  Specification for the rollback strategy of the service.
• ServiceCreateBodyParamUpdateConfigInlineItem
  Specification for the update strategy of the service.
• ServiceEndpointInlineItem
• ServiceEndpointInlineItemVirtualIPsInlineItem
• ServiceJobStatusInlineItem
  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.
• ServiceServiceStatusInlineItem
  The status of the service’s tasks. Provided only when requested as part of a ServiceList operation.
• ServiceSpec
  User modifiable configuration for a service.
• ServiceSpecModeInlineItem
  Scheduling mode for the service.
• ServiceSpecModeInlineItemReplicatedInlineItem
• ServiceSpecModeInlineItemReplicatedJobInlineItem
  The mode used for services with a finite number of tasks that run to a completed state.
• ServiceSpecRollbackConfigInlineItem
  Specification for the rollback strategy of the service.
• ServiceSpecUpdateConfigInlineItem
  Specification for the update strategy of the service.
• ServiceUpdateBodyParam
  User modifiable configuration for a service.
• ServiceUpdateBodyParamModeInlineItem
  Scheduling mode for the service.
• ServiceUpdateBodyParamModeInlineItemReplicatedInlineItem
• ServiceUpdateBodyParamModeInlineItemReplicatedJobInlineItem
  The mode used for services with a finite number of tasks that run to a completed state.
• ServiceUpdateBodyParamRollbackConfigInlineItem
  Specification for the rollback strategy of the service.
• ServiceUpdateBodyParamUpdateConfigInlineItem
  Specification for the update strategy of the service.
• ServiceUpdateResponse
• ServiceUpdateStatusInlineItem
  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.
• SwarmInfo
  Represents generic information about swarm.
• SwarmInitBodyParam
• SwarmJoinBodyParam
• SwarmSpec
  User modifiable swarm configuration.
• SwarmSpecCaConfigInlineItem
  CA configuration.
• SwarmSpecCaConfigInlineItemExternalCAsInlineItem
• SwarmSpecDispatcherInlineItem
  Dispatcher configuration.
• SwarmSpecEncryptionConfigInlineItem
  Parameters related to encryption-at-rest.
• SwarmSpecOrchestrationInlineItem
  Orchestration configuration.
• SwarmSpecRaftInlineItem
  Raft configuration.
• SwarmSpecTaskDefaultsInlineItem
  Defaults for creating tasks in this cluster.
• SwarmSpecTaskDefaultsInlineItemLogDriverInlineItem
  The log driver to use for tasks created in the orchestrator if unspecified by a service.
• SwarmUnlockBodyParam
• SwarmUnlockkey200Response
  no error
• SystemAuth200Response
  An identity token was generated successfully.
• SystemDataUsage200Response
  no error
• SystemInfo
• SystemInfoDefaultAddressPoolsInlineItem
• SystemVersion
  Response of Engine API: GET “/version”
• SystemVersionPlatformInlineItem
• Task
• TaskSpec
  User modifiable task configuration.
• TaskSpecContainerSpecInlineItem
  Container spec for the service.
• TaskSpecContainerSpecInlineItemConfigsInlineItem
• TaskSpecContainerSpecInlineItemConfigsInlineItemFileInlineItem
  File represents a specific target that is backed by a file.
• TaskSpecContainerSpecInlineItemDnsConfigInlineItem
  Specification for DNS related configurations in resolver configuration file (resolv.conf).
• TaskSpecContainerSpecInlineItemPrivilegesInlineItem
  Security options for the container
• TaskSpecContainerSpecInlineItemPrivilegesInlineItemCredentialSpecInlineItem
  CredentialSpec for managed service account (Windows only)
• TaskSpecContainerSpecInlineItemPrivilegesInlineItemSeLinuxContextInlineItem
  SELinux labels of the container
• TaskSpecContainerSpecInlineItemSecretsInlineItem
• TaskSpecContainerSpecInlineItemSecretsInlineItemFileInlineItem
  File represents a specific target that is backed by a file.
• TaskSpecContainerSpecInlineItemUlimitsInlineItem
• TaskSpecLogDriverInlineItem
  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.
• TaskSpecNetworkAttachmentSpecInlineItem
  Read-only spec type for non-swarm containers attached to swarm overlay networks.
• TaskSpecPlacementInlineItem
• TaskSpecPlacementInlineItemPreferencesInlineItem
• TaskSpecPlacementInlineItemPreferencesInlineItemSpreadInlineItem
• TaskSpecPluginSpecInlineItem
  Plugin spec for the service. (Experimental release only.)
• TaskSpecResourcesInlineItem
  Resource requirements which apply to each individual container created as part of the service.
• TaskSpecRestartPolicyInlineItem
  Specification for the restart policy which applies to containers created as part of this service.
• TaskStatusInlineItem
• TaskStatusInlineItemContainerStatusInlineItem
• ThrottleDevice
• TlsInfo
  Information about the issuer of leaf TLS certificates and the trusted root CA certificate.
• UsageData
  Usage details about the volume. This information is used by the GET /system/df endpoint, and omitted in other endpoints.
• Volume
• VolumeCreateOptions
  Volume configuration
• VolumeListResponse
  Volume list response
• VolumePrune200Response
  No error
• VolumeUpdateBodyParam
  Volume configuration

Enums

• BuildCacheTypeInlineItem
  Cache record type.
• ClusterVolumePublishStatusInlineItemStateInlineItem
  The published state of the volume.
• ClusterVolumeSpecAccessModeInlineItemAvailabilityInlineItem
  The availability of the volume for use in tasks.
• ClusterVolumeSpecAccessModeInlineItemScopeInlineItem
  The set of nodes this volume can be used on at one time.
• ClusterVolumeSpecAccessModeInlineItemSharingInlineItem
  The number and way that different tasks can use this volume at one time.
• ContainerStateStatusInlineItem
  String representation of the container state. Can be one of “created”, “running”, “paused”, “restarting”, “removing”, “exited”, or “dead”.
• EndpointPortConfigProtocolInlineItem
• EndpointPortConfigPublishModeInlineItem
  The mode in which port is published.
• EndpointSpecModeInlineItem
  The mode of resolution to use for internal load balancing between tasks.
• EventMessageTypeInlineItem
  The type of object emitting the event
• EventMessagescopeInlineItem
  Scope of the event. Engine events are local scope. Cluster (Swarm) events are swarm scope.
• HealthStatusInlineItem
  Status is one of none, starting, healthy or unhealthy
• HostConfigCgroupnsModeInlineItem
  cgroup namespace mode for the container. Possible values are:
• HostConfigIsolationInlineItem
  Isolation technology of the container. (Windows only)
• HostConfigLogConfigInlineItemTypeInlineItem
• ImageBuildChunk
  Represents a response chunk from Docker api when building, pulling or importing an image.
• LocalNodeState
  Current local status of this node.
• MountBindOptionsInlineItemPropagationInlineItem
  A propagation mode with the value [r]private, [r]shared, or [r]slave.
• MountPointTypeInlineItem
  The mount type:
• MountTypeInlineItem
  The mount type. Available types:
• NodeSpecAvailabilityInlineItem
  Availability of the node.
• NodeSpecRoleInlineItem
  Role of the node.
• NodeState
  NodeState represents the state of a node.
• PluginConfigInlineItemInterfaceInlineItemProtocolSchemeInlineItem
  Protocol to use for clients connecting to the plugin.
• PortTypeInlineItem
• Reachability
  Reachability represents the reachability of a node.
• RestartPolicyNameInlineItem
  Empty string means not to restartno Do not automatically restartalways Always restartunless-stopped Restart always except when the user has manually stopped the containeron-failure Restart only when the container exit code is non-zero
• ServiceCreateBodyParamRollbackConfigInlineItemFailureActionInlineItem
  Action to take if an rolled back task fails to run, or stops running during the rollback.
• ServiceCreateBodyParamRollbackConfigInlineItemOrderInlineItem
  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.
• ServiceCreateBodyParamUpdateConfigInlineItemFailureActionInlineItem
  Action to take if an updated task fails to run, or stops running during the update.
• ServiceCreateBodyParamUpdateConfigInlineItemOrderInlineItem
  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.
• ServiceSpecRollbackConfigInlineItemFailureActionInlineItem
  Action to take if an rolled back task fails to run, or stops running during the rollback.
• ServiceSpecRollbackConfigInlineItemOrderInlineItem
  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.
• ServiceSpecUpdateConfigInlineItemFailureActionInlineItem
  Action to take if an updated task fails to run, or stops running during the update.
• ServiceSpecUpdateConfigInlineItemOrderInlineItem
  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.
• ServiceUpdateBodyParamRollbackConfigInlineItemFailureActionInlineItem
  Action to take if an rolled back task fails to run, or stops running during the rollback.
• ServiceUpdateBodyParamRollbackConfigInlineItemOrderInlineItem
  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.
• ServiceUpdateBodyParamUpdateConfigInlineItemFailureActionInlineItem
  Action to take if an updated task fails to run, or stops running during the update.
• ServiceUpdateBodyParamUpdateConfigInlineItemOrderInlineItem
  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.
• ServiceUpdateStatusInlineItemStateInlineItem
• SwarmSpecCaConfigInlineItemExternalCAsInlineItemProtocolInlineItem
  Protocol for communication with the external CA (currently only cfssl is supported).
• SystemInfoCgroupDriverInlineItem
  The driver to use for managing cgroups.
• SystemInfoCgroupVersionInlineItem
  The version of the cgroup.
• SystemInfoIsolationInlineItem
  Represents the isolation technology to use as a default for containers. The supported values are platform-specific.
• TaskSpecContainerSpecInlineItemIsolationInlineItem
  Isolation technology of the containers running the service. (Windows only)
• TaskSpecRestartPolicyInlineItemConditionInlineItem
  Condition for restart.
• TaskState
• VolumeScopeInlineItem
  The level at which the volume exists. Either global for cluster-wide, or local for machine level.

Type Definitions

• ConfigList200Response
  no error
• ConfigUpdateBodyParam
• ContainerChanges200Response
  The list of changes
• ContainerList200Response
  no error
• ContainerLogs200Response
  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.
• ContainerStats200Response
  no error
• GenericResources
  User-defined resources can be either Integer resources (e.g, SSD=3) or String resources (e.g, GPU=UUID1).
• GetPluginPrivileges200Response
  no error
• ImageBuildInputStreamParam
• ImageCommitContainerConfigParam
  Configuration for a container that is portable between hosts.
• ImageCreateInputImageParam
• ImageDelete200Response
  The image was deleted successfully
• ImageGet200Response
  no error
• ImageGetAll200Response
  no error
• ImageHistory200Response
  List of image layers
• ImageList200Response
  Summary image data for the images matching the query
• ImageLoadImagesTarballParam
• ImageSearch200Response
  No error
• Labels
• NetworkList200Response
  No error
• NodeList200Response
  no error
• NodeUpdateBodyParam
• PluginCreateTarContextParam
• PluginList200Response
  No error
• PluginPullBodyParam
• PluginSetBodyParam
• PluginUpgradeBodyParam
• 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.
• PutContainerArchiveInputStreamParam
• SecretList200Response
  no error
• SecretUpdateBodyParam
• ServiceList200Response
  no error
• ServiceLogs200Response
  logs returned as a stream in response body
• SwarmInit200Response
  no error
• SwarmUpdateBodyParam
  User modifiable swarm configuration.
• SystemAuthAuthConfigParam
• SystemPing200Response
  no error
• SystemPingHead200Response
  no error
• TaskList200Response
  no error
• TaskLogs200Response
  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.
• VolumeCreateVolumeConfigParam
  Volume configuration