genereated from openapi generator
This commit is contained in:
Pakin
commit
381e758fdf
500 changed files with 25844 additions and 0 deletions
3
.gitignore
vendored
Normal file
3
.gitignore
vendored
Normal file
|
|
@ -0,0 +1,3 @@
|
||||||
|
/target/
|
||||||
|
**/*.rs.bk
|
||||||
|
Cargo.lock
|
||||||
23
.openapi-generator-ignore
Normal file
23
.openapi-generator-ignore
Normal file
|
|
@ -0,0 +1,23 @@
|
||||||
|
# OpenAPI Generator Ignore
|
||||||
|
# Generated by openapi-generator https://github.com/openapitools/openapi-generator
|
||||||
|
|
||||||
|
# Use this file to prevent files from being overwritten by the generator.
|
||||||
|
# The patterns follow closely to .gitignore or .dockerignore.
|
||||||
|
|
||||||
|
# As an example, the C# client generator defines ApiClient.cs.
|
||||||
|
# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line:
|
||||||
|
#ApiClient.cs
|
||||||
|
|
||||||
|
# You can match any string of characters against a directory, file or extension with a single asterisk (*):
|
||||||
|
#foo/*/qux
|
||||||
|
# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux
|
||||||
|
|
||||||
|
# You can recursively match patterns against a directory, file or extension with a double asterisk (**):
|
||||||
|
#foo/**/qux
|
||||||
|
# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux
|
||||||
|
|
||||||
|
# You can also negate patterns with an exclamation (!).
|
||||||
|
# For example, you can ignore all files in a docs folder with the file extension .md:
|
||||||
|
#docs/*.md
|
||||||
|
# Then explicitly reverse the ignore rule for a single file:
|
||||||
|
#!docs/README.md
|
||||||
498
.openapi-generator/FILES
Normal file
498
.openapi-generator/FILES
Normal file
|
|
@ -0,0 +1,498 @@
|
||||||
|
.gitignore
|
||||||
|
.openapi-generator-ignore
|
||||||
|
.travis.yml
|
||||||
|
Cargo.toml
|
||||||
|
README.md
|
||||||
|
docs/Address.md
|
||||||
|
docs/AuthConfig.md
|
||||||
|
docs/BuildCache.md
|
||||||
|
docs/BuildInfo.md
|
||||||
|
docs/BuildPruneResponse.md
|
||||||
|
docs/ChangeType.md
|
||||||
|
docs/ClusterInfo.md
|
||||||
|
docs/ClusterVolume.md
|
||||||
|
docs/ClusterVolumeInfo.md
|
||||||
|
docs/ClusterVolumePublishStatusInner.md
|
||||||
|
docs/ClusterVolumeSpec.md
|
||||||
|
docs/ClusterVolumeSpecAccessMode.md
|
||||||
|
docs/ClusterVolumeSpecAccessModeAccessibilityRequirements.md
|
||||||
|
docs/ClusterVolumeSpecAccessModeCapacityRange.md
|
||||||
|
docs/ClusterVolumeSpecAccessModeSecretsInner.md
|
||||||
|
docs/Commit.md
|
||||||
|
docs/Config.md
|
||||||
|
docs/ConfigApi.md
|
||||||
|
docs/ConfigCreateRequest.md
|
||||||
|
docs/ConfigReference.md
|
||||||
|
docs/ConfigSpec.md
|
||||||
|
docs/ContainerApi.md
|
||||||
|
docs/ContainerBlkioStatEntry.md
|
||||||
|
docs/ContainerBlkioStats.md
|
||||||
|
docs/ContainerConfig.md
|
||||||
|
docs/ContainerCpuStats.md
|
||||||
|
docs/ContainerCpuUsage.md
|
||||||
|
docs/ContainerCreateRequest.md
|
||||||
|
docs/ContainerCreateResponse.md
|
||||||
|
docs/ContainerInspectResponse.md
|
||||||
|
docs/ContainerMemoryStats.md
|
||||||
|
docs/ContainerNetworkStats.md
|
||||||
|
docs/ContainerPidsStats.md
|
||||||
|
docs/ContainerPruneResponse.md
|
||||||
|
docs/ContainerState.md
|
||||||
|
docs/ContainerStatsResponse.md
|
||||||
|
docs/ContainerStatus.md
|
||||||
|
docs/ContainerStorageStats.md
|
||||||
|
docs/ContainerSummary.md
|
||||||
|
docs/ContainerSummaryHostConfig.md
|
||||||
|
docs/ContainerSummaryNetworkSettings.md
|
||||||
|
docs/ContainerThrottlingData.md
|
||||||
|
docs/ContainerTopResponse.md
|
||||||
|
docs/ContainerUpdateRequest.md
|
||||||
|
docs/ContainerUpdateResponse.md
|
||||||
|
docs/ContainerWaitExitError.md
|
||||||
|
docs/ContainerWaitResponse.md
|
||||||
|
docs/ContainerdInfo.md
|
||||||
|
docs/ContainerdInfoNamespaces.md
|
||||||
|
docs/CreateImageInfo.md
|
||||||
|
docs/DeviceInfo.md
|
||||||
|
docs/DeviceMapping.md
|
||||||
|
docs/DeviceRequest.md
|
||||||
|
docs/DistributionApi.md
|
||||||
|
docs/DistributionInspect.md
|
||||||
|
docs/Driver.md
|
||||||
|
docs/DriverData.md
|
||||||
|
docs/EndpointIpamConfig.md
|
||||||
|
docs/EndpointPortConfig.md
|
||||||
|
docs/EndpointSettings.md
|
||||||
|
docs/EndpointSpec.md
|
||||||
|
docs/EngineDescription.md
|
||||||
|
docs/EngineDescriptionPluginsInner.md
|
||||||
|
docs/ErrorDetail.md
|
||||||
|
docs/ErrorResponse.md
|
||||||
|
docs/EventActor.md
|
||||||
|
docs/EventMessage.md
|
||||||
|
docs/ExecApi.md
|
||||||
|
docs/ExecConfig.md
|
||||||
|
docs/ExecInspectResponse.md
|
||||||
|
docs/ExecStartConfig.md
|
||||||
|
docs/FilesystemChange.md
|
||||||
|
docs/FirewallInfo.md
|
||||||
|
docs/GenericResourcesInner.md
|
||||||
|
docs/GenericResourcesInnerDiscreteResourceSpec.md
|
||||||
|
docs/GenericResourcesInnerNamedResourceSpec.md
|
||||||
|
docs/Health.md
|
||||||
|
docs/HealthConfig.md
|
||||||
|
docs/HealthcheckResult.md
|
||||||
|
docs/HistoryResponseItem.md
|
||||||
|
docs/HostConfig.md
|
||||||
|
docs/HostConfigAllOfLogConfig.md
|
||||||
|
docs/IdResponse.md
|
||||||
|
docs/ImageApi.md
|
||||||
|
docs/ImageConfig.md
|
||||||
|
docs/ImageDeleteResponseItem.md
|
||||||
|
docs/ImageId.md
|
||||||
|
docs/ImageInspect.md
|
||||||
|
docs/ImageInspectMetadata.md
|
||||||
|
docs/ImageInspectRootFs.md
|
||||||
|
docs/ImageManifestSummary.md
|
||||||
|
docs/ImageManifestSummaryAttestationData.md
|
||||||
|
docs/ImageManifestSummaryImageData.md
|
||||||
|
docs/ImageManifestSummaryImageDataSize.md
|
||||||
|
docs/ImageManifestSummarySize.md
|
||||||
|
docs/ImagePruneResponse.md
|
||||||
|
docs/ImageSearchResponseItem.md
|
||||||
|
docs/ImageSummary.md
|
||||||
|
docs/IndexInfo.md
|
||||||
|
docs/Ipam.md
|
||||||
|
docs/IpamConfig.md
|
||||||
|
docs/JoinTokens.md
|
||||||
|
docs/Limit.md
|
||||||
|
docs/LocalNodeState.md
|
||||||
|
docs/ManagerStatus.md
|
||||||
|
docs/Mount.md
|
||||||
|
docs/MountBindOptions.md
|
||||||
|
docs/MountImageOptions.md
|
||||||
|
docs/MountPoint.md
|
||||||
|
docs/MountTmpfsOptions.md
|
||||||
|
docs/MountVolumeOptions.md
|
||||||
|
docs/MountVolumeOptionsDriverConfig.md
|
||||||
|
docs/Network.md
|
||||||
|
docs/NetworkApi.md
|
||||||
|
docs/NetworkAttachmentConfig.md
|
||||||
|
docs/NetworkConnectRequest.md
|
||||||
|
docs/NetworkContainer.md
|
||||||
|
docs/NetworkCreateRequest.md
|
||||||
|
docs/NetworkCreateResponse.md
|
||||||
|
docs/NetworkDisconnectRequest.md
|
||||||
|
docs/NetworkPruneResponse.md
|
||||||
|
docs/NetworkSettings.md
|
||||||
|
docs/NetworkingConfig.md
|
||||||
|
docs/Node.md
|
||||||
|
docs/NodeApi.md
|
||||||
|
docs/NodeDescription.md
|
||||||
|
docs/NodeSpec.md
|
||||||
|
docs/NodeState.md
|
||||||
|
docs/NodeStatus.md
|
||||||
|
docs/ObjectVersion.md
|
||||||
|
docs/OciDescriptor.md
|
||||||
|
docs/OciPlatform.md
|
||||||
|
docs/PeerInfo.md
|
||||||
|
docs/PeerNode.md
|
||||||
|
docs/Platform.md
|
||||||
|
docs/Plugin.md
|
||||||
|
docs/PluginApi.md
|
||||||
|
docs/PluginConfig.md
|
||||||
|
docs/PluginConfigArgs.md
|
||||||
|
docs/PluginConfigInterface.md
|
||||||
|
docs/PluginConfigLinux.md
|
||||||
|
docs/PluginConfigNetwork.md
|
||||||
|
docs/PluginConfigRootfs.md
|
||||||
|
docs/PluginConfigUser.md
|
||||||
|
docs/PluginDevice.md
|
||||||
|
docs/PluginEnv.md
|
||||||
|
docs/PluginInterfaceType.md
|
||||||
|
docs/PluginMount.md
|
||||||
|
docs/PluginPrivilege.md
|
||||||
|
docs/PluginSettings.md
|
||||||
|
docs/PluginsInfo.md
|
||||||
|
docs/Port.md
|
||||||
|
docs/PortBinding.md
|
||||||
|
docs/PortStatus.md
|
||||||
|
docs/ProcessConfig.md
|
||||||
|
docs/ProgressDetail.md
|
||||||
|
docs/PushImageInfo.md
|
||||||
|
docs/Reachability.md
|
||||||
|
docs/RegistryServiceConfig.md
|
||||||
|
docs/ResourceObject.md
|
||||||
|
docs/Resources.md
|
||||||
|
docs/ResourcesBlkioWeightDeviceInner.md
|
||||||
|
docs/ResourcesUlimitsInner.md
|
||||||
|
docs/RestartPolicy.md
|
||||||
|
docs/Runtime.md
|
||||||
|
docs/Secret.md
|
||||||
|
docs/SecretApi.md
|
||||||
|
docs/SecretCreateRequest.md
|
||||||
|
docs/SecretSpec.md
|
||||||
|
docs/Service.md
|
||||||
|
docs/ServiceApi.md
|
||||||
|
docs/ServiceCreateRequest.md
|
||||||
|
docs/ServiceCreateResponse.md
|
||||||
|
docs/ServiceEndpoint.md
|
||||||
|
docs/ServiceEndpointVirtualIpsInner.md
|
||||||
|
docs/ServiceJobStatus.md
|
||||||
|
docs/ServiceServiceStatus.md
|
||||||
|
docs/ServiceSpec.md
|
||||||
|
docs/ServiceSpecMode.md
|
||||||
|
docs/ServiceSpecModeReplicated.md
|
||||||
|
docs/ServiceSpecModeReplicatedJob.md
|
||||||
|
docs/ServiceSpecRollbackConfig.md
|
||||||
|
docs/ServiceSpecUpdateConfig.md
|
||||||
|
docs/ServiceUpdateRequest.md
|
||||||
|
docs/ServiceUpdateResponse.md
|
||||||
|
docs/ServiceUpdateStatus.md
|
||||||
|
docs/SessionApi.md
|
||||||
|
docs/Swarm.md
|
||||||
|
docs/SwarmApi.md
|
||||||
|
docs/SwarmInfo.md
|
||||||
|
docs/SwarmInitRequest.md
|
||||||
|
docs/SwarmJoinRequest.md
|
||||||
|
docs/SwarmSpec.md
|
||||||
|
docs/SwarmSpecCaConfig.md
|
||||||
|
docs/SwarmSpecCaConfigExternalCasInner.md
|
||||||
|
docs/SwarmSpecDispatcher.md
|
||||||
|
docs/SwarmSpecEncryptionConfig.md
|
||||||
|
docs/SwarmSpecOrchestration.md
|
||||||
|
docs/SwarmSpecRaft.md
|
||||||
|
docs/SwarmSpecTaskDefaults.md
|
||||||
|
docs/SwarmSpecTaskDefaultsLogDriver.md
|
||||||
|
docs/SwarmUnlockRequest.md
|
||||||
|
docs/SystemApi.md
|
||||||
|
docs/SystemAuthResponse.md
|
||||||
|
docs/SystemDataUsageResponse.md
|
||||||
|
docs/SystemInfo.md
|
||||||
|
docs/SystemInfoDefaultAddressPoolsInner.md
|
||||||
|
docs/SystemVersion.md
|
||||||
|
docs/SystemVersionComponentsInner.md
|
||||||
|
docs/SystemVersionPlatform.md
|
||||||
|
docs/Task.md
|
||||||
|
docs/TaskApi.md
|
||||||
|
docs/TaskSpec.md
|
||||||
|
docs/TaskSpecContainerSpec.md
|
||||||
|
docs/TaskSpecContainerSpecConfigsInner.md
|
||||||
|
docs/TaskSpecContainerSpecConfigsInnerFile.md
|
||||||
|
docs/TaskSpecContainerSpecDnsConfig.md
|
||||||
|
docs/TaskSpecContainerSpecPrivileges.md
|
||||||
|
docs/TaskSpecContainerSpecPrivilegesAppArmor.md
|
||||||
|
docs/TaskSpecContainerSpecPrivilegesCredentialSpec.md
|
||||||
|
docs/TaskSpecContainerSpecPrivilegesSeLinuxContext.md
|
||||||
|
docs/TaskSpecContainerSpecPrivilegesSeccomp.md
|
||||||
|
docs/TaskSpecContainerSpecSecretsInner.md
|
||||||
|
docs/TaskSpecContainerSpecSecretsInnerFile.md
|
||||||
|
docs/TaskSpecLogDriver.md
|
||||||
|
docs/TaskSpecNetworkAttachmentSpec.md
|
||||||
|
docs/TaskSpecPlacement.md
|
||||||
|
docs/TaskSpecPlacementPreferencesInner.md
|
||||||
|
docs/TaskSpecPlacementPreferencesInnerSpread.md
|
||||||
|
docs/TaskSpecPluginSpec.md
|
||||||
|
docs/TaskSpecResources.md
|
||||||
|
docs/TaskSpecRestartPolicy.md
|
||||||
|
docs/TaskState.md
|
||||||
|
docs/TaskStatus.md
|
||||||
|
docs/ThrottleDevice.md
|
||||||
|
docs/TlsInfo.md
|
||||||
|
docs/UnlockKeyResponse.md
|
||||||
|
docs/Volume.md
|
||||||
|
docs/VolumeApi.md
|
||||||
|
docs/VolumeCreateOptions.md
|
||||||
|
docs/VolumeListResponse.md
|
||||||
|
docs/VolumePruneResponse.md
|
||||||
|
docs/VolumeUpdateRequest.md
|
||||||
|
docs/VolumeUsageData.md
|
||||||
|
git_push.sh
|
||||||
|
src/apis/config_api.rs
|
||||||
|
src/apis/configuration.rs
|
||||||
|
src/apis/container_api.rs
|
||||||
|
src/apis/distribution_api.rs
|
||||||
|
src/apis/exec_api.rs
|
||||||
|
src/apis/image_api.rs
|
||||||
|
src/apis/mod.rs
|
||||||
|
src/apis/network_api.rs
|
||||||
|
src/apis/node_api.rs
|
||||||
|
src/apis/plugin_api.rs
|
||||||
|
src/apis/secret_api.rs
|
||||||
|
src/apis/service_api.rs
|
||||||
|
src/apis/session_api.rs
|
||||||
|
src/apis/swarm_api.rs
|
||||||
|
src/apis/system_api.rs
|
||||||
|
src/apis/task_api.rs
|
||||||
|
src/apis/volume_api.rs
|
||||||
|
src/lib.rs
|
||||||
|
src/models/address.rs
|
||||||
|
src/models/auth_config.rs
|
||||||
|
src/models/build_cache.rs
|
||||||
|
src/models/build_info.rs
|
||||||
|
src/models/build_prune_response.rs
|
||||||
|
src/models/change_type.rs
|
||||||
|
src/models/cluster_info.rs
|
||||||
|
src/models/cluster_volume.rs
|
||||||
|
src/models/cluster_volume_info.rs
|
||||||
|
src/models/cluster_volume_publish_status_inner.rs
|
||||||
|
src/models/cluster_volume_spec.rs
|
||||||
|
src/models/cluster_volume_spec_access_mode.rs
|
||||||
|
src/models/cluster_volume_spec_access_mode_accessibility_requirements.rs
|
||||||
|
src/models/cluster_volume_spec_access_mode_capacity_range.rs
|
||||||
|
src/models/cluster_volume_spec_access_mode_secrets_inner.rs
|
||||||
|
src/models/commit.rs
|
||||||
|
src/models/config.rs
|
||||||
|
src/models/config_create_request.rs
|
||||||
|
src/models/config_reference.rs
|
||||||
|
src/models/config_spec.rs
|
||||||
|
src/models/container_blkio_stat_entry.rs
|
||||||
|
src/models/container_blkio_stats.rs
|
||||||
|
src/models/container_config.rs
|
||||||
|
src/models/container_cpu_stats.rs
|
||||||
|
src/models/container_cpu_usage.rs
|
||||||
|
src/models/container_create_request.rs
|
||||||
|
src/models/container_create_response.rs
|
||||||
|
src/models/container_inspect_response.rs
|
||||||
|
src/models/container_memory_stats.rs
|
||||||
|
src/models/container_network_stats.rs
|
||||||
|
src/models/container_pids_stats.rs
|
||||||
|
src/models/container_prune_response.rs
|
||||||
|
src/models/container_state.rs
|
||||||
|
src/models/container_stats_response.rs
|
||||||
|
src/models/container_status.rs
|
||||||
|
src/models/container_storage_stats.rs
|
||||||
|
src/models/container_summary.rs
|
||||||
|
src/models/container_summary_host_config.rs
|
||||||
|
src/models/container_summary_network_settings.rs
|
||||||
|
src/models/container_throttling_data.rs
|
||||||
|
src/models/container_top_response.rs
|
||||||
|
src/models/container_update_request.rs
|
||||||
|
src/models/container_update_response.rs
|
||||||
|
src/models/container_wait_exit_error.rs
|
||||||
|
src/models/container_wait_response.rs
|
||||||
|
src/models/containerd_info.rs
|
||||||
|
src/models/containerd_info_namespaces.rs
|
||||||
|
src/models/create_image_info.rs
|
||||||
|
src/models/device_info.rs
|
||||||
|
src/models/device_mapping.rs
|
||||||
|
src/models/device_request.rs
|
||||||
|
src/models/distribution_inspect.rs
|
||||||
|
src/models/driver.rs
|
||||||
|
src/models/driver_data.rs
|
||||||
|
src/models/endpoint_ipam_config.rs
|
||||||
|
src/models/endpoint_port_config.rs
|
||||||
|
src/models/endpoint_settings.rs
|
||||||
|
src/models/endpoint_spec.rs
|
||||||
|
src/models/engine_description.rs
|
||||||
|
src/models/engine_description_plugins_inner.rs
|
||||||
|
src/models/error_detail.rs
|
||||||
|
src/models/error_response.rs
|
||||||
|
src/models/event_actor.rs
|
||||||
|
src/models/event_message.rs
|
||||||
|
src/models/exec_config.rs
|
||||||
|
src/models/exec_inspect_response.rs
|
||||||
|
src/models/exec_start_config.rs
|
||||||
|
src/models/filesystem_change.rs
|
||||||
|
src/models/firewall_info.rs
|
||||||
|
src/models/generic_resources_inner.rs
|
||||||
|
src/models/generic_resources_inner_discrete_resource_spec.rs
|
||||||
|
src/models/generic_resources_inner_named_resource_spec.rs
|
||||||
|
src/models/health.rs
|
||||||
|
src/models/health_config.rs
|
||||||
|
src/models/healthcheck_result.rs
|
||||||
|
src/models/history_response_item.rs
|
||||||
|
src/models/host_config.rs
|
||||||
|
src/models/host_config_all_of_log_config.rs
|
||||||
|
src/models/id_response.rs
|
||||||
|
src/models/image_config.rs
|
||||||
|
src/models/image_delete_response_item.rs
|
||||||
|
src/models/image_id.rs
|
||||||
|
src/models/image_inspect.rs
|
||||||
|
src/models/image_inspect_metadata.rs
|
||||||
|
src/models/image_inspect_root_fs.rs
|
||||||
|
src/models/image_manifest_summary.rs
|
||||||
|
src/models/image_manifest_summary_attestation_data.rs
|
||||||
|
src/models/image_manifest_summary_image_data.rs
|
||||||
|
src/models/image_manifest_summary_image_data_size.rs
|
||||||
|
src/models/image_manifest_summary_size.rs
|
||||||
|
src/models/image_prune_response.rs
|
||||||
|
src/models/image_search_response_item.rs
|
||||||
|
src/models/image_summary.rs
|
||||||
|
src/models/index_info.rs
|
||||||
|
src/models/ipam.rs
|
||||||
|
src/models/ipam_config.rs
|
||||||
|
src/models/join_tokens.rs
|
||||||
|
src/models/limit.rs
|
||||||
|
src/models/local_node_state.rs
|
||||||
|
src/models/manager_status.rs
|
||||||
|
src/models/mod.rs
|
||||||
|
src/models/mount.rs
|
||||||
|
src/models/mount_bind_options.rs
|
||||||
|
src/models/mount_image_options.rs
|
||||||
|
src/models/mount_point.rs
|
||||||
|
src/models/mount_tmpfs_options.rs
|
||||||
|
src/models/mount_volume_options.rs
|
||||||
|
src/models/mount_volume_options_driver_config.rs
|
||||||
|
src/models/network.rs
|
||||||
|
src/models/network_attachment_config.rs
|
||||||
|
src/models/network_connect_request.rs
|
||||||
|
src/models/network_container.rs
|
||||||
|
src/models/network_create_request.rs
|
||||||
|
src/models/network_create_response.rs
|
||||||
|
src/models/network_disconnect_request.rs
|
||||||
|
src/models/network_prune_response.rs
|
||||||
|
src/models/network_settings.rs
|
||||||
|
src/models/networking_config.rs
|
||||||
|
src/models/node.rs
|
||||||
|
src/models/node_description.rs
|
||||||
|
src/models/node_spec.rs
|
||||||
|
src/models/node_state.rs
|
||||||
|
src/models/node_status.rs
|
||||||
|
src/models/object_version.rs
|
||||||
|
src/models/oci_descriptor.rs
|
||||||
|
src/models/oci_platform.rs
|
||||||
|
src/models/peer_info.rs
|
||||||
|
src/models/peer_node.rs
|
||||||
|
src/models/platform.rs
|
||||||
|
src/models/plugin.rs
|
||||||
|
src/models/plugin_config.rs
|
||||||
|
src/models/plugin_config_args.rs
|
||||||
|
src/models/plugin_config_interface.rs
|
||||||
|
src/models/plugin_config_linux.rs
|
||||||
|
src/models/plugin_config_network.rs
|
||||||
|
src/models/plugin_config_rootfs.rs
|
||||||
|
src/models/plugin_config_user.rs
|
||||||
|
src/models/plugin_device.rs
|
||||||
|
src/models/plugin_env.rs
|
||||||
|
src/models/plugin_interface_type.rs
|
||||||
|
src/models/plugin_mount.rs
|
||||||
|
src/models/plugin_privilege.rs
|
||||||
|
src/models/plugin_settings.rs
|
||||||
|
src/models/plugins_info.rs
|
||||||
|
src/models/port.rs
|
||||||
|
src/models/port_binding.rs
|
||||||
|
src/models/port_status.rs
|
||||||
|
src/models/process_config.rs
|
||||||
|
src/models/progress_detail.rs
|
||||||
|
src/models/push_image_info.rs
|
||||||
|
src/models/reachability.rs
|
||||||
|
src/models/registry_service_config.rs
|
||||||
|
src/models/resource_object.rs
|
||||||
|
src/models/resources.rs
|
||||||
|
src/models/resources_blkio_weight_device_inner.rs
|
||||||
|
src/models/resources_ulimits_inner.rs
|
||||||
|
src/models/restart_policy.rs
|
||||||
|
src/models/runtime.rs
|
||||||
|
src/models/secret.rs
|
||||||
|
src/models/secret_create_request.rs
|
||||||
|
src/models/secret_spec.rs
|
||||||
|
src/models/service.rs
|
||||||
|
src/models/service_create_request.rs
|
||||||
|
src/models/service_create_response.rs
|
||||||
|
src/models/service_endpoint.rs
|
||||||
|
src/models/service_endpoint_virtual_ips_inner.rs
|
||||||
|
src/models/service_job_status.rs
|
||||||
|
src/models/service_service_status.rs
|
||||||
|
src/models/service_spec.rs
|
||||||
|
src/models/service_spec_mode.rs
|
||||||
|
src/models/service_spec_mode_replicated.rs
|
||||||
|
src/models/service_spec_mode_replicated_job.rs
|
||||||
|
src/models/service_spec_rollback_config.rs
|
||||||
|
src/models/service_spec_update_config.rs
|
||||||
|
src/models/service_update_request.rs
|
||||||
|
src/models/service_update_response.rs
|
||||||
|
src/models/service_update_status.rs
|
||||||
|
src/models/swarm.rs
|
||||||
|
src/models/swarm_info.rs
|
||||||
|
src/models/swarm_init_request.rs
|
||||||
|
src/models/swarm_join_request.rs
|
||||||
|
src/models/swarm_spec.rs
|
||||||
|
src/models/swarm_spec_ca_config.rs
|
||||||
|
src/models/swarm_spec_ca_config_external_cas_inner.rs
|
||||||
|
src/models/swarm_spec_dispatcher.rs
|
||||||
|
src/models/swarm_spec_encryption_config.rs
|
||||||
|
src/models/swarm_spec_orchestration.rs
|
||||||
|
src/models/swarm_spec_raft.rs
|
||||||
|
src/models/swarm_spec_task_defaults.rs
|
||||||
|
src/models/swarm_spec_task_defaults_log_driver.rs
|
||||||
|
src/models/swarm_unlock_request.rs
|
||||||
|
src/models/system_auth_response.rs
|
||||||
|
src/models/system_data_usage_response.rs
|
||||||
|
src/models/system_info.rs
|
||||||
|
src/models/system_info_default_address_pools_inner.rs
|
||||||
|
src/models/system_version.rs
|
||||||
|
src/models/system_version_components_inner.rs
|
||||||
|
src/models/system_version_platform.rs
|
||||||
|
src/models/task.rs
|
||||||
|
src/models/task_spec.rs
|
||||||
|
src/models/task_spec_container_spec.rs
|
||||||
|
src/models/task_spec_container_spec_configs_inner.rs
|
||||||
|
src/models/task_spec_container_spec_configs_inner_file.rs
|
||||||
|
src/models/task_spec_container_spec_dns_config.rs
|
||||||
|
src/models/task_spec_container_spec_privileges.rs
|
||||||
|
src/models/task_spec_container_spec_privileges_app_armor.rs
|
||||||
|
src/models/task_spec_container_spec_privileges_credential_spec.rs
|
||||||
|
src/models/task_spec_container_spec_privileges_se_linux_context.rs
|
||||||
|
src/models/task_spec_container_spec_privileges_seccomp.rs
|
||||||
|
src/models/task_spec_container_spec_secrets_inner.rs
|
||||||
|
src/models/task_spec_container_spec_secrets_inner_file.rs
|
||||||
|
src/models/task_spec_log_driver.rs
|
||||||
|
src/models/task_spec_network_attachment_spec.rs
|
||||||
|
src/models/task_spec_placement.rs
|
||||||
|
src/models/task_spec_placement_preferences_inner.rs
|
||||||
|
src/models/task_spec_placement_preferences_inner_spread.rs
|
||||||
|
src/models/task_spec_plugin_spec.rs
|
||||||
|
src/models/task_spec_resources.rs
|
||||||
|
src/models/task_spec_restart_policy.rs
|
||||||
|
src/models/task_state.rs
|
||||||
|
src/models/task_status.rs
|
||||||
|
src/models/throttle_device.rs
|
||||||
|
src/models/tls_info.rs
|
||||||
|
src/models/unlock_key_response.rs
|
||||||
|
src/models/volume.rs
|
||||||
|
src/models/volume_create_options.rs
|
||||||
|
src/models/volume_list_response.rs
|
||||||
|
src/models/volume_prune_response.rs
|
||||||
|
src/models/volume_update_request.rs
|
||||||
|
src/models/volume_usage_data.rs
|
||||||
1
.openapi-generator/VERSION
Normal file
1
.openapi-generator/VERSION
Normal file
|
|
@ -0,0 +1 @@
|
||||||
|
7.13.0
|
||||||
1
.travis.yml
Normal file
1
.travis.yml
Normal file
|
|
@ -0,0 +1 @@
|
||||||
|
language: rust
|
||||||
23
Cargo.toml
Normal file
23
Cargo.toml
Normal file
|
|
@ -0,0 +1,23 @@
|
||||||
|
[package]
|
||||||
|
name = "docker_sdk_rust"
|
||||||
|
version = "1.51.0"
|
||||||
|
authors = ["OpenAPI Generator team and contributors"]
|
||||||
|
description = "The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.50) is used. For example, calling `/info` is the same as calling `/v1.51/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means the server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` "
|
||||||
|
# Override this license by providing a License Object in the OpenAPI.
|
||||||
|
license = "Unlicense"
|
||||||
|
edition = "2021"
|
||||||
|
|
||||||
|
[dependencies]
|
||||||
|
serde = { version = "^1.0", features = ["derive"] }
|
||||||
|
serde_with = { version = "^3.8", default-features = false, features = [
|
||||||
|
"base64",
|
||||||
|
"std",
|
||||||
|
"macros",
|
||||||
|
] }
|
||||||
|
serde_json = "^1.0"
|
||||||
|
serde_repr = "^0.1"
|
||||||
|
url = "^2.5"
|
||||||
|
reqwest = { version = "^0.12", default-features = false, features = [
|
||||||
|
"json",
|
||||||
|
"multipart",
|
||||||
|
] }
|
||||||
451
README.md
Normal file
451
README.md
Normal file
|
|
@ -0,0 +1,451 @@
|
||||||
|
# Rust API client for openapi
|
||||||
|
|
||||||
|
The Engine API is an HTTP API served by Docker Engine. It is the API the
|
||||||
|
Docker client uses to communicate with the Engine, so everything the Docker
|
||||||
|
client can do can be done with the API.
|
||||||
|
|
||||||
|
Most of the client's commands map directly to API endpoints (e.g. `docker ps`
|
||||||
|
is `GET /containers/json`). The notable exception is running containers,
|
||||||
|
which consists of several API calls.
|
||||||
|
|
||||||
|
# Errors
|
||||||
|
|
||||||
|
The API uses standard HTTP status codes to indicate the success or failure
|
||||||
|
of the API call. The body of the response will be JSON in the following
|
||||||
|
format:
|
||||||
|
|
||||||
|
```
|
||||||
|
{
|
||||||
|
\"message\": \"page not found\"
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
# Versioning
|
||||||
|
|
||||||
|
The API is usually changed in each release, so API calls are versioned to
|
||||||
|
ensure that clients don't break. To lock to a specific version of the API,
|
||||||
|
you prefix the URL with its version, for example, call `/v1.30/info` to use
|
||||||
|
the v1.30 version of the `/info` endpoint. If the API version specified in
|
||||||
|
the URL is not supported by the daemon, a HTTP `400 Bad Request` error message
|
||||||
|
is returned.
|
||||||
|
|
||||||
|
If you omit the version-prefix, the current version of the API (v1.50) is used.
|
||||||
|
For example, calling `/info` is the same as calling `/v1.51/info`. Using the
|
||||||
|
API without a version-prefix is deprecated and will be removed in a future release.
|
||||||
|
|
||||||
|
Engine releases in the near future should support this version of the API,
|
||||||
|
so your client will continue to work even if it is talking to a newer Engine.
|
||||||
|
|
||||||
|
The API uses an open schema model, which means the server may add extra properties
|
||||||
|
to responses. Likewise, the server will ignore any extra query parameters and
|
||||||
|
request body properties. When you write clients, you need to ignore additional
|
||||||
|
properties in responses to ensure they do not break when talking to newer
|
||||||
|
daemons.
|
||||||
|
|
||||||
|
|
||||||
|
# Authentication
|
||||||
|
|
||||||
|
Authentication for registries is handled client side. The client has to send
|
||||||
|
authentication details to various endpoints that need to communicate with
|
||||||
|
registries, such as `POST /images/(name)/push`. These are sent as
|
||||||
|
`X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5)
|
||||||
|
(JSON) string with the following structure:
|
||||||
|
|
||||||
|
```
|
||||||
|
{
|
||||||
|
\"username\": \"string\",
|
||||||
|
\"password\": \"string\",
|
||||||
|
\"email\": \"string\",
|
||||||
|
\"serveraddress\": \"string\"
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
The `serveraddress` is a domain/IP without a protocol. Throughout this
|
||||||
|
structure, double quotes are required.
|
||||||
|
|
||||||
|
If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth),
|
||||||
|
you can just pass this instead of credentials:
|
||||||
|
|
||||||
|
```
|
||||||
|
{
|
||||||
|
\"identitytoken\": \"9cbaf023786cd7...\"
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## Overview
|
||||||
|
|
||||||
|
This API client was generated by the [OpenAPI Generator](https://openapi-generator.tech) project. By using the [openapi-spec](https://openapis.org) from a remote server, you can easily generate an API client.
|
||||||
|
|
||||||
|
- API version: 1.51
|
||||||
|
- Package version: 1.51
|
||||||
|
- Generator version: 7.13.0
|
||||||
|
- Build package: `org.openapitools.codegen.languages.RustClientCodegen`
|
||||||
|
|
||||||
|
## Installation
|
||||||
|
|
||||||
|
Put the package under your project folder in a directory named `openapi` and add the following to `Cargo.toml` under `[dependencies]`:
|
||||||
|
|
||||||
|
```
|
||||||
|
openapi = { path = "./openapi" }
|
||||||
|
```
|
||||||
|
|
||||||
|
## Documentation for API Endpoints
|
||||||
|
|
||||||
|
All URIs are relative to *http://localhost/v1.51*
|
||||||
|
|
||||||
|
Class | Method | HTTP request | Description
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
*ConfigApi* | [**config_create**](docs/ConfigApi.md#config_create) | **POST** /configs/create | Create a config
|
||||||
|
*ConfigApi* | [**config_delete**](docs/ConfigApi.md#config_delete) | **DELETE** /configs/{id} | Delete a config
|
||||||
|
*ConfigApi* | [**config_inspect**](docs/ConfigApi.md#config_inspect) | **GET** /configs/{id} | Inspect a config
|
||||||
|
*ConfigApi* | [**config_list**](docs/ConfigApi.md#config_list) | **GET** /configs | List configs
|
||||||
|
*ConfigApi* | [**config_update**](docs/ConfigApi.md#config_update) | **POST** /configs/{id}/update | Update a Config
|
||||||
|
*ContainerApi* | [**container_archive**](docs/ContainerApi.md#container_archive) | **GET** /containers/{id}/archive | Get an archive of a filesystem resource in a container
|
||||||
|
*ContainerApi* | [**container_archive_info**](docs/ContainerApi.md#container_archive_info) | **HEAD** /containers/{id}/archive | Get information about files in a container
|
||||||
|
*ContainerApi* | [**container_attach**](docs/ContainerApi.md#container_attach) | **POST** /containers/{id}/attach | Attach to a container
|
||||||
|
*ContainerApi* | [**container_attach_websocket**](docs/ContainerApi.md#container_attach_websocket) | **GET** /containers/{id}/attach/ws | Attach to a container via a websocket
|
||||||
|
*ContainerApi* | [**container_changes**](docs/ContainerApi.md#container_changes) | **GET** /containers/{id}/changes | Get changes on a container’s filesystem
|
||||||
|
*ContainerApi* | [**container_create**](docs/ContainerApi.md#container_create) | **POST** /containers/create | Create a container
|
||||||
|
*ContainerApi* | [**container_delete**](docs/ContainerApi.md#container_delete) | **DELETE** /containers/{id} | Remove a container
|
||||||
|
*ContainerApi* | [**container_export**](docs/ContainerApi.md#container_export) | **GET** /containers/{id}/export | Export a container
|
||||||
|
*ContainerApi* | [**container_inspect**](docs/ContainerApi.md#container_inspect) | **GET** /containers/{id}/json | Inspect a container
|
||||||
|
*ContainerApi* | [**container_kill**](docs/ContainerApi.md#container_kill) | **POST** /containers/{id}/kill | Kill a container
|
||||||
|
*ContainerApi* | [**container_list**](docs/ContainerApi.md#container_list) | **GET** /containers/json | List containers
|
||||||
|
*ContainerApi* | [**container_logs**](docs/ContainerApi.md#container_logs) | **GET** /containers/{id}/logs | Get container logs
|
||||||
|
*ContainerApi* | [**container_pause**](docs/ContainerApi.md#container_pause) | **POST** /containers/{id}/pause | Pause a container
|
||||||
|
*ContainerApi* | [**container_prune**](docs/ContainerApi.md#container_prune) | **POST** /containers/prune | Delete stopped containers
|
||||||
|
*ContainerApi* | [**container_rename**](docs/ContainerApi.md#container_rename) | **POST** /containers/{id}/rename | Rename a container
|
||||||
|
*ContainerApi* | [**container_resize**](docs/ContainerApi.md#container_resize) | **POST** /containers/{id}/resize | Resize a container TTY
|
||||||
|
*ContainerApi* | [**container_restart**](docs/ContainerApi.md#container_restart) | **POST** /containers/{id}/restart | Restart a container
|
||||||
|
*ContainerApi* | [**container_start**](docs/ContainerApi.md#container_start) | **POST** /containers/{id}/start | Start a container
|
||||||
|
*ContainerApi* | [**container_stats**](docs/ContainerApi.md#container_stats) | **GET** /containers/{id}/stats | Get container stats based on resource usage
|
||||||
|
*ContainerApi* | [**container_stop**](docs/ContainerApi.md#container_stop) | **POST** /containers/{id}/stop | Stop a container
|
||||||
|
*ContainerApi* | [**container_top**](docs/ContainerApi.md#container_top) | **GET** /containers/{id}/top | List processes running inside a container
|
||||||
|
*ContainerApi* | [**container_unpause**](docs/ContainerApi.md#container_unpause) | **POST** /containers/{id}/unpause | Unpause a container
|
||||||
|
*ContainerApi* | [**container_update**](docs/ContainerApi.md#container_update) | **POST** /containers/{id}/update | Update a container
|
||||||
|
*ContainerApi* | [**container_wait**](docs/ContainerApi.md#container_wait) | **POST** /containers/{id}/wait | Wait for a container
|
||||||
|
*ContainerApi* | [**put_container_archive**](docs/ContainerApi.md#put_container_archive) | **PUT** /containers/{id}/archive | Extract an archive of files or folders to a directory in a container
|
||||||
|
*DistributionApi* | [**distribution_inspect**](docs/DistributionApi.md#distribution_inspect) | **GET** /distribution/{name}/json | Get image information from the registry
|
||||||
|
*ExecApi* | [**container_exec**](docs/ExecApi.md#container_exec) | **POST** /containers/{id}/exec | Create an exec instance
|
||||||
|
*ExecApi* | [**exec_inspect**](docs/ExecApi.md#exec_inspect) | **GET** /exec/{id}/json | Inspect an exec instance
|
||||||
|
*ExecApi* | [**exec_resize**](docs/ExecApi.md#exec_resize) | **POST** /exec/{id}/resize | Resize an exec instance
|
||||||
|
*ExecApi* | [**exec_start**](docs/ExecApi.md#exec_start) | **POST** /exec/{id}/start | Start an exec instance
|
||||||
|
*ImageApi* | [**build_prune**](docs/ImageApi.md#build_prune) | **POST** /build/prune | Delete builder cache
|
||||||
|
*ImageApi* | [**image_build**](docs/ImageApi.md#image_build) | **POST** /build | Build an image
|
||||||
|
*ImageApi* | [**image_commit**](docs/ImageApi.md#image_commit) | **POST** /commit | Create a new image from a container
|
||||||
|
*ImageApi* | [**image_create**](docs/ImageApi.md#image_create) | **POST** /images/create | Create an image
|
||||||
|
*ImageApi* | [**image_delete**](docs/ImageApi.md#image_delete) | **DELETE** /images/{name} | Remove an image
|
||||||
|
*ImageApi* | [**image_get**](docs/ImageApi.md#image_get) | **GET** /images/{name}/get | Export an image
|
||||||
|
*ImageApi* | [**image_get_all**](docs/ImageApi.md#image_get_all) | **GET** /images/get | Export several images
|
||||||
|
*ImageApi* | [**image_history**](docs/ImageApi.md#image_history) | **GET** /images/{name}/history | Get the history of an image
|
||||||
|
*ImageApi* | [**image_inspect**](docs/ImageApi.md#image_inspect) | **GET** /images/{name}/json | Inspect an image
|
||||||
|
*ImageApi* | [**image_list**](docs/ImageApi.md#image_list) | **GET** /images/json | List Images
|
||||||
|
*ImageApi* | [**image_load**](docs/ImageApi.md#image_load) | **POST** /images/load | Import images
|
||||||
|
*ImageApi* | [**image_prune**](docs/ImageApi.md#image_prune) | **POST** /images/prune | Delete unused images
|
||||||
|
*ImageApi* | [**image_push**](docs/ImageApi.md#image_push) | **POST** /images/{name}/push | Push an image
|
||||||
|
*ImageApi* | [**image_search**](docs/ImageApi.md#image_search) | **GET** /images/search | Search images
|
||||||
|
*ImageApi* | [**image_tag**](docs/ImageApi.md#image_tag) | **POST** /images/{name}/tag | Tag an image
|
||||||
|
*NetworkApi* | [**network_connect**](docs/NetworkApi.md#network_connect) | **POST** /networks/{id}/connect | Connect a container to a network
|
||||||
|
*NetworkApi* | [**network_create**](docs/NetworkApi.md#network_create) | **POST** /networks/create | Create a network
|
||||||
|
*NetworkApi* | [**network_delete**](docs/NetworkApi.md#network_delete) | **DELETE** /networks/{id} | Remove a network
|
||||||
|
*NetworkApi* | [**network_disconnect**](docs/NetworkApi.md#network_disconnect) | **POST** /networks/{id}/disconnect | Disconnect a container from a network
|
||||||
|
*NetworkApi* | [**network_inspect**](docs/NetworkApi.md#network_inspect) | **GET** /networks/{id} | Inspect a network
|
||||||
|
*NetworkApi* | [**network_list**](docs/NetworkApi.md#network_list) | **GET** /networks | List networks
|
||||||
|
*NetworkApi* | [**network_prune**](docs/NetworkApi.md#network_prune) | **POST** /networks/prune | Delete unused networks
|
||||||
|
*NodeApi* | [**node_delete**](docs/NodeApi.md#node_delete) | **DELETE** /nodes/{id} | Delete a node
|
||||||
|
*NodeApi* | [**node_inspect**](docs/NodeApi.md#node_inspect) | **GET** /nodes/{id} | Inspect a node
|
||||||
|
*NodeApi* | [**node_list**](docs/NodeApi.md#node_list) | **GET** /nodes | List nodes
|
||||||
|
*NodeApi* | [**node_update**](docs/NodeApi.md#node_update) | **POST** /nodes/{id}/update | Update a node
|
||||||
|
*PluginApi* | [**get_plugin_privileges**](docs/PluginApi.md#get_plugin_privileges) | **GET** /plugins/privileges | Get plugin privileges
|
||||||
|
*PluginApi* | [**plugin_create**](docs/PluginApi.md#plugin_create) | **POST** /plugins/create | Create a plugin
|
||||||
|
*PluginApi* | [**plugin_delete**](docs/PluginApi.md#plugin_delete) | **DELETE** /plugins/{name} | Remove a plugin
|
||||||
|
*PluginApi* | [**plugin_disable**](docs/PluginApi.md#plugin_disable) | **POST** /plugins/{name}/disable | Disable a plugin
|
||||||
|
*PluginApi* | [**plugin_enable**](docs/PluginApi.md#plugin_enable) | **POST** /plugins/{name}/enable | Enable a plugin
|
||||||
|
*PluginApi* | [**plugin_inspect**](docs/PluginApi.md#plugin_inspect) | **GET** /plugins/{name}/json | Inspect a plugin
|
||||||
|
*PluginApi* | [**plugin_list**](docs/PluginApi.md#plugin_list) | **GET** /plugins | List plugins
|
||||||
|
*PluginApi* | [**plugin_pull**](docs/PluginApi.md#plugin_pull) | **POST** /plugins/pull | Install a plugin
|
||||||
|
*PluginApi* | [**plugin_push**](docs/PluginApi.md#plugin_push) | **POST** /plugins/{name}/push | Push a plugin
|
||||||
|
*PluginApi* | [**plugin_set**](docs/PluginApi.md#plugin_set) | **POST** /plugins/{name}/set | Configure a plugin
|
||||||
|
*PluginApi* | [**plugin_upgrade**](docs/PluginApi.md#plugin_upgrade) | **POST** /plugins/{name}/upgrade | Upgrade a plugin
|
||||||
|
*SecretApi* | [**secret_create**](docs/SecretApi.md#secret_create) | **POST** /secrets/create | Create a secret
|
||||||
|
*SecretApi* | [**secret_delete**](docs/SecretApi.md#secret_delete) | **DELETE** /secrets/{id} | Delete a secret
|
||||||
|
*SecretApi* | [**secret_inspect**](docs/SecretApi.md#secret_inspect) | **GET** /secrets/{id} | Inspect a secret
|
||||||
|
*SecretApi* | [**secret_list**](docs/SecretApi.md#secret_list) | **GET** /secrets | List secrets
|
||||||
|
*SecretApi* | [**secret_update**](docs/SecretApi.md#secret_update) | **POST** /secrets/{id}/update | Update a Secret
|
||||||
|
*ServiceApi* | [**service_create**](docs/ServiceApi.md#service_create) | **POST** /services/create | Create a service
|
||||||
|
*ServiceApi* | [**service_delete**](docs/ServiceApi.md#service_delete) | **DELETE** /services/{id} | Delete a service
|
||||||
|
*ServiceApi* | [**service_inspect**](docs/ServiceApi.md#service_inspect) | **GET** /services/{id} | Inspect a service
|
||||||
|
*ServiceApi* | [**service_list**](docs/ServiceApi.md#service_list) | **GET** /services | List services
|
||||||
|
*ServiceApi* | [**service_logs**](docs/ServiceApi.md#service_logs) | **GET** /services/{id}/logs | Get service logs
|
||||||
|
*ServiceApi* | [**service_update**](docs/ServiceApi.md#service_update) | **POST** /services/{id}/update | Update a service
|
||||||
|
*SessionApi* | [**session**](docs/SessionApi.md#session) | **POST** /session | Initialize interactive session
|
||||||
|
*SwarmApi* | [**swarm_init**](docs/SwarmApi.md#swarm_init) | **POST** /swarm/init | Initialize a new swarm
|
||||||
|
*SwarmApi* | [**swarm_inspect**](docs/SwarmApi.md#swarm_inspect) | **GET** /swarm | Inspect swarm
|
||||||
|
*SwarmApi* | [**swarm_join**](docs/SwarmApi.md#swarm_join) | **POST** /swarm/join | Join an existing swarm
|
||||||
|
*SwarmApi* | [**swarm_leave**](docs/SwarmApi.md#swarm_leave) | **POST** /swarm/leave | Leave a swarm
|
||||||
|
*SwarmApi* | [**swarm_unlock**](docs/SwarmApi.md#swarm_unlock) | **POST** /swarm/unlock | Unlock a locked manager
|
||||||
|
*SwarmApi* | [**swarm_unlockkey**](docs/SwarmApi.md#swarm_unlockkey) | **GET** /swarm/unlockkey | Get the unlock key
|
||||||
|
*SwarmApi* | [**swarm_update**](docs/SwarmApi.md#swarm_update) | **POST** /swarm/update | Update a swarm
|
||||||
|
*SystemApi* | [**system_auth**](docs/SystemApi.md#system_auth) | **POST** /auth | Check auth configuration
|
||||||
|
*SystemApi* | [**system_data_usage**](docs/SystemApi.md#system_data_usage) | **GET** /system/df | Get data usage information
|
||||||
|
*SystemApi* | [**system_events**](docs/SystemApi.md#system_events) | **GET** /events | Monitor events
|
||||||
|
*SystemApi* | [**system_info**](docs/SystemApi.md#system_info) | **GET** /info | Get system information
|
||||||
|
*SystemApi* | [**system_ping**](docs/SystemApi.md#system_ping) | **GET** /_ping | Ping
|
||||||
|
*SystemApi* | [**system_ping_head**](docs/SystemApi.md#system_ping_head) | **HEAD** /_ping | Ping
|
||||||
|
*SystemApi* | [**system_version**](docs/SystemApi.md#system_version) | **GET** /version | Get version
|
||||||
|
*TaskApi* | [**task_inspect**](docs/TaskApi.md#task_inspect) | **GET** /tasks/{id} | Inspect a task
|
||||||
|
*TaskApi* | [**task_list**](docs/TaskApi.md#task_list) | **GET** /tasks | List tasks
|
||||||
|
*TaskApi* | [**task_logs**](docs/TaskApi.md#task_logs) | **GET** /tasks/{id}/logs | Get task logs
|
||||||
|
*VolumeApi* | [**volume_create**](docs/VolumeApi.md#volume_create) | **POST** /volumes/create | Create a volume
|
||||||
|
*VolumeApi* | [**volume_delete**](docs/VolumeApi.md#volume_delete) | **DELETE** /volumes/{name} | Remove a volume
|
||||||
|
*VolumeApi* | [**volume_inspect**](docs/VolumeApi.md#volume_inspect) | **GET** /volumes/{name} | Inspect a volume
|
||||||
|
*VolumeApi* | [**volume_list**](docs/VolumeApi.md#volume_list) | **GET** /volumes | List volumes
|
||||||
|
*VolumeApi* | [**volume_prune**](docs/VolumeApi.md#volume_prune) | **POST** /volumes/prune | Delete unused volumes
|
||||||
|
*VolumeApi* | [**volume_update**](docs/VolumeApi.md#volume_update) | **PUT** /volumes/{name} | \"Update a volume. Valid only for Swarm cluster volumes\"
|
||||||
|
|
||||||
|
|
||||||
|
## Documentation For Models
|
||||||
|
|
||||||
|
- [Address](docs/Address.md)
|
||||||
|
- [AuthConfig](docs/AuthConfig.md)
|
||||||
|
- [BuildCache](docs/BuildCache.md)
|
||||||
|
- [BuildInfo](docs/BuildInfo.md)
|
||||||
|
- [BuildPruneResponse](docs/BuildPruneResponse.md)
|
||||||
|
- [ChangeType](docs/ChangeType.md)
|
||||||
|
- [ClusterInfo](docs/ClusterInfo.md)
|
||||||
|
- [ClusterVolume](docs/ClusterVolume.md)
|
||||||
|
- [ClusterVolumeInfo](docs/ClusterVolumeInfo.md)
|
||||||
|
- [ClusterVolumePublishStatusInner](docs/ClusterVolumePublishStatusInner.md)
|
||||||
|
- [ClusterVolumeSpec](docs/ClusterVolumeSpec.md)
|
||||||
|
- [ClusterVolumeSpecAccessMode](docs/ClusterVolumeSpecAccessMode.md)
|
||||||
|
- [ClusterVolumeSpecAccessModeAccessibilityRequirements](docs/ClusterVolumeSpecAccessModeAccessibilityRequirements.md)
|
||||||
|
- [ClusterVolumeSpecAccessModeCapacityRange](docs/ClusterVolumeSpecAccessModeCapacityRange.md)
|
||||||
|
- [ClusterVolumeSpecAccessModeSecretsInner](docs/ClusterVolumeSpecAccessModeSecretsInner.md)
|
||||||
|
- [Commit](docs/Commit.md)
|
||||||
|
- [Config](docs/Config.md)
|
||||||
|
- [ConfigCreateRequest](docs/ConfigCreateRequest.md)
|
||||||
|
- [ConfigReference](docs/ConfigReference.md)
|
||||||
|
- [ConfigSpec](docs/ConfigSpec.md)
|
||||||
|
- [ContainerBlkioStatEntry](docs/ContainerBlkioStatEntry.md)
|
||||||
|
- [ContainerBlkioStats](docs/ContainerBlkioStats.md)
|
||||||
|
- [ContainerConfig](docs/ContainerConfig.md)
|
||||||
|
- [ContainerCpuStats](docs/ContainerCpuStats.md)
|
||||||
|
- [ContainerCpuUsage](docs/ContainerCpuUsage.md)
|
||||||
|
- [ContainerCreateRequest](docs/ContainerCreateRequest.md)
|
||||||
|
- [ContainerCreateResponse](docs/ContainerCreateResponse.md)
|
||||||
|
- [ContainerInspectResponse](docs/ContainerInspectResponse.md)
|
||||||
|
- [ContainerMemoryStats](docs/ContainerMemoryStats.md)
|
||||||
|
- [ContainerNetworkStats](docs/ContainerNetworkStats.md)
|
||||||
|
- [ContainerPidsStats](docs/ContainerPidsStats.md)
|
||||||
|
- [ContainerPruneResponse](docs/ContainerPruneResponse.md)
|
||||||
|
- [ContainerState](docs/ContainerState.md)
|
||||||
|
- [ContainerStatsResponse](docs/ContainerStatsResponse.md)
|
||||||
|
- [ContainerStatus](docs/ContainerStatus.md)
|
||||||
|
- [ContainerStorageStats](docs/ContainerStorageStats.md)
|
||||||
|
- [ContainerSummary](docs/ContainerSummary.md)
|
||||||
|
- [ContainerSummaryHostConfig](docs/ContainerSummaryHostConfig.md)
|
||||||
|
- [ContainerSummaryNetworkSettings](docs/ContainerSummaryNetworkSettings.md)
|
||||||
|
- [ContainerThrottlingData](docs/ContainerThrottlingData.md)
|
||||||
|
- [ContainerTopResponse](docs/ContainerTopResponse.md)
|
||||||
|
- [ContainerUpdateRequest](docs/ContainerUpdateRequest.md)
|
||||||
|
- [ContainerUpdateResponse](docs/ContainerUpdateResponse.md)
|
||||||
|
- [ContainerWaitExitError](docs/ContainerWaitExitError.md)
|
||||||
|
- [ContainerWaitResponse](docs/ContainerWaitResponse.md)
|
||||||
|
- [ContainerdInfo](docs/ContainerdInfo.md)
|
||||||
|
- [ContainerdInfoNamespaces](docs/ContainerdInfoNamespaces.md)
|
||||||
|
- [CreateImageInfo](docs/CreateImageInfo.md)
|
||||||
|
- [DeviceInfo](docs/DeviceInfo.md)
|
||||||
|
- [DeviceMapping](docs/DeviceMapping.md)
|
||||||
|
- [DeviceRequest](docs/DeviceRequest.md)
|
||||||
|
- [DistributionInspect](docs/DistributionInspect.md)
|
||||||
|
- [Driver](docs/Driver.md)
|
||||||
|
- [DriverData](docs/DriverData.md)
|
||||||
|
- [EndpointIpamConfig](docs/EndpointIpamConfig.md)
|
||||||
|
- [EndpointPortConfig](docs/EndpointPortConfig.md)
|
||||||
|
- [EndpointSettings](docs/EndpointSettings.md)
|
||||||
|
- [EndpointSpec](docs/EndpointSpec.md)
|
||||||
|
- [EngineDescription](docs/EngineDescription.md)
|
||||||
|
- [EngineDescriptionPluginsInner](docs/EngineDescriptionPluginsInner.md)
|
||||||
|
- [ErrorDetail](docs/ErrorDetail.md)
|
||||||
|
- [ErrorResponse](docs/ErrorResponse.md)
|
||||||
|
- [EventActor](docs/EventActor.md)
|
||||||
|
- [EventMessage](docs/EventMessage.md)
|
||||||
|
- [ExecConfig](docs/ExecConfig.md)
|
||||||
|
- [ExecInspectResponse](docs/ExecInspectResponse.md)
|
||||||
|
- [ExecStartConfig](docs/ExecStartConfig.md)
|
||||||
|
- [FilesystemChange](docs/FilesystemChange.md)
|
||||||
|
- [FirewallInfo](docs/FirewallInfo.md)
|
||||||
|
- [GenericResourcesInner](docs/GenericResourcesInner.md)
|
||||||
|
- [GenericResourcesInnerDiscreteResourceSpec](docs/GenericResourcesInnerDiscreteResourceSpec.md)
|
||||||
|
- [GenericResourcesInnerNamedResourceSpec](docs/GenericResourcesInnerNamedResourceSpec.md)
|
||||||
|
- [Health](docs/Health.md)
|
||||||
|
- [HealthConfig](docs/HealthConfig.md)
|
||||||
|
- [HealthcheckResult](docs/HealthcheckResult.md)
|
||||||
|
- [HistoryResponseItem](docs/HistoryResponseItem.md)
|
||||||
|
- [HostConfig](docs/HostConfig.md)
|
||||||
|
- [HostConfigAllOfLogConfig](docs/HostConfigAllOfLogConfig.md)
|
||||||
|
- [IdResponse](docs/IdResponse.md)
|
||||||
|
- [ImageConfig](docs/ImageConfig.md)
|
||||||
|
- [ImageDeleteResponseItem](docs/ImageDeleteResponseItem.md)
|
||||||
|
- [ImageId](docs/ImageId.md)
|
||||||
|
- [ImageInspect](docs/ImageInspect.md)
|
||||||
|
- [ImageInspectMetadata](docs/ImageInspectMetadata.md)
|
||||||
|
- [ImageInspectRootFs](docs/ImageInspectRootFs.md)
|
||||||
|
- [ImageManifestSummary](docs/ImageManifestSummary.md)
|
||||||
|
- [ImageManifestSummaryAttestationData](docs/ImageManifestSummaryAttestationData.md)
|
||||||
|
- [ImageManifestSummaryImageData](docs/ImageManifestSummaryImageData.md)
|
||||||
|
- [ImageManifestSummaryImageDataSize](docs/ImageManifestSummaryImageDataSize.md)
|
||||||
|
- [ImageManifestSummarySize](docs/ImageManifestSummarySize.md)
|
||||||
|
- [ImagePruneResponse](docs/ImagePruneResponse.md)
|
||||||
|
- [ImageSearchResponseItem](docs/ImageSearchResponseItem.md)
|
||||||
|
- [ImageSummary](docs/ImageSummary.md)
|
||||||
|
- [IndexInfo](docs/IndexInfo.md)
|
||||||
|
- [Ipam](docs/Ipam.md)
|
||||||
|
- [IpamConfig](docs/IpamConfig.md)
|
||||||
|
- [JoinTokens](docs/JoinTokens.md)
|
||||||
|
- [Limit](docs/Limit.md)
|
||||||
|
- [LocalNodeState](docs/LocalNodeState.md)
|
||||||
|
- [ManagerStatus](docs/ManagerStatus.md)
|
||||||
|
- [Mount](docs/Mount.md)
|
||||||
|
- [MountBindOptions](docs/MountBindOptions.md)
|
||||||
|
- [MountImageOptions](docs/MountImageOptions.md)
|
||||||
|
- [MountPoint](docs/MountPoint.md)
|
||||||
|
- [MountTmpfsOptions](docs/MountTmpfsOptions.md)
|
||||||
|
- [MountVolumeOptions](docs/MountVolumeOptions.md)
|
||||||
|
- [MountVolumeOptionsDriverConfig](docs/MountVolumeOptionsDriverConfig.md)
|
||||||
|
- [Network](docs/Network.md)
|
||||||
|
- [NetworkAttachmentConfig](docs/NetworkAttachmentConfig.md)
|
||||||
|
- [NetworkConnectRequest](docs/NetworkConnectRequest.md)
|
||||||
|
- [NetworkContainer](docs/NetworkContainer.md)
|
||||||
|
- [NetworkCreateRequest](docs/NetworkCreateRequest.md)
|
||||||
|
- [NetworkCreateResponse](docs/NetworkCreateResponse.md)
|
||||||
|
- [NetworkDisconnectRequest](docs/NetworkDisconnectRequest.md)
|
||||||
|
- [NetworkPruneResponse](docs/NetworkPruneResponse.md)
|
||||||
|
- [NetworkSettings](docs/NetworkSettings.md)
|
||||||
|
- [NetworkingConfig](docs/NetworkingConfig.md)
|
||||||
|
- [Node](docs/Node.md)
|
||||||
|
- [NodeDescription](docs/NodeDescription.md)
|
||||||
|
- [NodeSpec](docs/NodeSpec.md)
|
||||||
|
- [NodeState](docs/NodeState.md)
|
||||||
|
- [NodeStatus](docs/NodeStatus.md)
|
||||||
|
- [ObjectVersion](docs/ObjectVersion.md)
|
||||||
|
- [OciDescriptor](docs/OciDescriptor.md)
|
||||||
|
- [OciPlatform](docs/OciPlatform.md)
|
||||||
|
- [PeerInfo](docs/PeerInfo.md)
|
||||||
|
- [PeerNode](docs/PeerNode.md)
|
||||||
|
- [Platform](docs/Platform.md)
|
||||||
|
- [Plugin](docs/Plugin.md)
|
||||||
|
- [PluginConfig](docs/PluginConfig.md)
|
||||||
|
- [PluginConfigArgs](docs/PluginConfigArgs.md)
|
||||||
|
- [PluginConfigInterface](docs/PluginConfigInterface.md)
|
||||||
|
- [PluginConfigLinux](docs/PluginConfigLinux.md)
|
||||||
|
- [PluginConfigNetwork](docs/PluginConfigNetwork.md)
|
||||||
|
- [PluginConfigRootfs](docs/PluginConfigRootfs.md)
|
||||||
|
- [PluginConfigUser](docs/PluginConfigUser.md)
|
||||||
|
- [PluginDevice](docs/PluginDevice.md)
|
||||||
|
- [PluginEnv](docs/PluginEnv.md)
|
||||||
|
- [PluginInterfaceType](docs/PluginInterfaceType.md)
|
||||||
|
- [PluginMount](docs/PluginMount.md)
|
||||||
|
- [PluginPrivilege](docs/PluginPrivilege.md)
|
||||||
|
- [PluginSettings](docs/PluginSettings.md)
|
||||||
|
- [PluginsInfo](docs/PluginsInfo.md)
|
||||||
|
- [Port](docs/Port.md)
|
||||||
|
- [PortBinding](docs/PortBinding.md)
|
||||||
|
- [PortStatus](docs/PortStatus.md)
|
||||||
|
- [ProcessConfig](docs/ProcessConfig.md)
|
||||||
|
- [ProgressDetail](docs/ProgressDetail.md)
|
||||||
|
- [PushImageInfo](docs/PushImageInfo.md)
|
||||||
|
- [Reachability](docs/Reachability.md)
|
||||||
|
- [RegistryServiceConfig](docs/RegistryServiceConfig.md)
|
||||||
|
- [ResourceObject](docs/ResourceObject.md)
|
||||||
|
- [Resources](docs/Resources.md)
|
||||||
|
- [ResourcesBlkioWeightDeviceInner](docs/ResourcesBlkioWeightDeviceInner.md)
|
||||||
|
- [ResourcesUlimitsInner](docs/ResourcesUlimitsInner.md)
|
||||||
|
- [RestartPolicy](docs/RestartPolicy.md)
|
||||||
|
- [Runtime](docs/Runtime.md)
|
||||||
|
- [Secret](docs/Secret.md)
|
||||||
|
- [SecretCreateRequest](docs/SecretCreateRequest.md)
|
||||||
|
- [SecretSpec](docs/SecretSpec.md)
|
||||||
|
- [Service](docs/Service.md)
|
||||||
|
- [ServiceCreateRequest](docs/ServiceCreateRequest.md)
|
||||||
|
- [ServiceCreateResponse](docs/ServiceCreateResponse.md)
|
||||||
|
- [ServiceEndpoint](docs/ServiceEndpoint.md)
|
||||||
|
- [ServiceEndpointVirtualIpsInner](docs/ServiceEndpointVirtualIpsInner.md)
|
||||||
|
- [ServiceJobStatus](docs/ServiceJobStatus.md)
|
||||||
|
- [ServiceServiceStatus](docs/ServiceServiceStatus.md)
|
||||||
|
- [ServiceSpec](docs/ServiceSpec.md)
|
||||||
|
- [ServiceSpecMode](docs/ServiceSpecMode.md)
|
||||||
|
- [ServiceSpecModeReplicated](docs/ServiceSpecModeReplicated.md)
|
||||||
|
- [ServiceSpecModeReplicatedJob](docs/ServiceSpecModeReplicatedJob.md)
|
||||||
|
- [ServiceSpecRollbackConfig](docs/ServiceSpecRollbackConfig.md)
|
||||||
|
- [ServiceSpecUpdateConfig](docs/ServiceSpecUpdateConfig.md)
|
||||||
|
- [ServiceUpdateRequest](docs/ServiceUpdateRequest.md)
|
||||||
|
- [ServiceUpdateResponse](docs/ServiceUpdateResponse.md)
|
||||||
|
- [ServiceUpdateStatus](docs/ServiceUpdateStatus.md)
|
||||||
|
- [Swarm](docs/Swarm.md)
|
||||||
|
- [SwarmInfo](docs/SwarmInfo.md)
|
||||||
|
- [SwarmInitRequest](docs/SwarmInitRequest.md)
|
||||||
|
- [SwarmJoinRequest](docs/SwarmJoinRequest.md)
|
||||||
|
- [SwarmSpec](docs/SwarmSpec.md)
|
||||||
|
- [SwarmSpecCaConfig](docs/SwarmSpecCaConfig.md)
|
||||||
|
- [SwarmSpecCaConfigExternalCasInner](docs/SwarmSpecCaConfigExternalCasInner.md)
|
||||||
|
- [SwarmSpecDispatcher](docs/SwarmSpecDispatcher.md)
|
||||||
|
- [SwarmSpecEncryptionConfig](docs/SwarmSpecEncryptionConfig.md)
|
||||||
|
- [SwarmSpecOrchestration](docs/SwarmSpecOrchestration.md)
|
||||||
|
- [SwarmSpecRaft](docs/SwarmSpecRaft.md)
|
||||||
|
- [SwarmSpecTaskDefaults](docs/SwarmSpecTaskDefaults.md)
|
||||||
|
- [SwarmSpecTaskDefaultsLogDriver](docs/SwarmSpecTaskDefaultsLogDriver.md)
|
||||||
|
- [SwarmUnlockRequest](docs/SwarmUnlockRequest.md)
|
||||||
|
- [SystemAuthResponse](docs/SystemAuthResponse.md)
|
||||||
|
- [SystemDataUsageResponse](docs/SystemDataUsageResponse.md)
|
||||||
|
- [SystemInfo](docs/SystemInfo.md)
|
||||||
|
- [SystemInfoDefaultAddressPoolsInner](docs/SystemInfoDefaultAddressPoolsInner.md)
|
||||||
|
- [SystemVersion](docs/SystemVersion.md)
|
||||||
|
- [SystemVersionComponentsInner](docs/SystemVersionComponentsInner.md)
|
||||||
|
- [SystemVersionPlatform](docs/SystemVersionPlatform.md)
|
||||||
|
- [Task](docs/Task.md)
|
||||||
|
- [TaskSpec](docs/TaskSpec.md)
|
||||||
|
- [TaskSpecContainerSpec](docs/TaskSpecContainerSpec.md)
|
||||||
|
- [TaskSpecContainerSpecConfigsInner](docs/TaskSpecContainerSpecConfigsInner.md)
|
||||||
|
- [TaskSpecContainerSpecConfigsInnerFile](docs/TaskSpecContainerSpecConfigsInnerFile.md)
|
||||||
|
- [TaskSpecContainerSpecDnsConfig](docs/TaskSpecContainerSpecDnsConfig.md)
|
||||||
|
- [TaskSpecContainerSpecPrivileges](docs/TaskSpecContainerSpecPrivileges.md)
|
||||||
|
- [TaskSpecContainerSpecPrivilegesAppArmor](docs/TaskSpecContainerSpecPrivilegesAppArmor.md)
|
||||||
|
- [TaskSpecContainerSpecPrivilegesCredentialSpec](docs/TaskSpecContainerSpecPrivilegesCredentialSpec.md)
|
||||||
|
- [TaskSpecContainerSpecPrivilegesSeLinuxContext](docs/TaskSpecContainerSpecPrivilegesSeLinuxContext.md)
|
||||||
|
- [TaskSpecContainerSpecPrivilegesSeccomp](docs/TaskSpecContainerSpecPrivilegesSeccomp.md)
|
||||||
|
- [TaskSpecContainerSpecSecretsInner](docs/TaskSpecContainerSpecSecretsInner.md)
|
||||||
|
- [TaskSpecContainerSpecSecretsInnerFile](docs/TaskSpecContainerSpecSecretsInnerFile.md)
|
||||||
|
- [TaskSpecLogDriver](docs/TaskSpecLogDriver.md)
|
||||||
|
- [TaskSpecNetworkAttachmentSpec](docs/TaskSpecNetworkAttachmentSpec.md)
|
||||||
|
- [TaskSpecPlacement](docs/TaskSpecPlacement.md)
|
||||||
|
- [TaskSpecPlacementPreferencesInner](docs/TaskSpecPlacementPreferencesInner.md)
|
||||||
|
- [TaskSpecPlacementPreferencesInnerSpread](docs/TaskSpecPlacementPreferencesInnerSpread.md)
|
||||||
|
- [TaskSpecPluginSpec](docs/TaskSpecPluginSpec.md)
|
||||||
|
- [TaskSpecResources](docs/TaskSpecResources.md)
|
||||||
|
- [TaskSpecRestartPolicy](docs/TaskSpecRestartPolicy.md)
|
||||||
|
- [TaskState](docs/TaskState.md)
|
||||||
|
- [TaskStatus](docs/TaskStatus.md)
|
||||||
|
- [ThrottleDevice](docs/ThrottleDevice.md)
|
||||||
|
- [TlsInfo](docs/TlsInfo.md)
|
||||||
|
- [UnlockKeyResponse](docs/UnlockKeyResponse.md)
|
||||||
|
- [Volume](docs/Volume.md)
|
||||||
|
- [VolumeCreateOptions](docs/VolumeCreateOptions.md)
|
||||||
|
- [VolumeListResponse](docs/VolumeListResponse.md)
|
||||||
|
- [VolumePruneResponse](docs/VolumePruneResponse.md)
|
||||||
|
- [VolumeUpdateRequest](docs/VolumeUpdateRequest.md)
|
||||||
|
- [VolumeUsageData](docs/VolumeUsageData.md)
|
||||||
|
|
||||||
|
|
||||||
|
To get access to the crate's generated documentation, use:
|
||||||
|
|
||||||
|
```
|
||||||
|
cargo doc --open
|
||||||
|
```
|
||||||
|
|
||||||
|
## Author
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
12
docs/Address.md
Normal file
12
docs/Address.md
Normal file
|
|
@ -0,0 +1,12 @@
|
||||||
|
# Address
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
**addr** | Option<**String**> | IP address. | [optional]
|
||||||
|
**prefix_len** | Option<**i32**> | Mask length of the IP address. | [optional]
|
||||||
|
|
||||||
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||||
|
|
||||||
|
|
||||||
14
docs/AuthConfig.md
Normal file
14
docs/AuthConfig.md
Normal file
|
|
@ -0,0 +1,14 @@
|
||||||
|
# AuthConfig
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
**username** | Option<**String**> | | [optional]
|
||||||
|
**password** | Option<**String**> | | [optional]
|
||||||
|
**email** | Option<**String**> | | [optional]
|
||||||
|
**serveraddress** | Option<**String**> | | [optional]
|
||||||
|
|
||||||
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||||
|
|
||||||
|
|
||||||
21
docs/BuildCache.md
Normal file
21
docs/BuildCache.md
Normal file
|
|
@ -0,0 +1,21 @@
|
||||||
|
# BuildCache
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
**id** | Option<**String**> | Unique ID of the build cache record. | [optional]
|
||||||
|
**parent** | Option<**String**> | ID of the parent build cache record. > **Deprecated**: This field is deprecated, and omitted if empty. | [optional]
|
||||||
|
**parents** | Option<**Vec<String>**> | List of parent build cache record IDs. | [optional]
|
||||||
|
**r#type** | Option<**String**> | Cache record type. | [optional]
|
||||||
|
**description** | Option<**String**> | Description of the build-step that produced the build cache. | [optional]
|
||||||
|
**in_use** | Option<**bool**> | Indicates if the build cache is in use. | [optional]
|
||||||
|
**shared** | Option<**bool**> | Indicates if the build cache is shared. | [optional]
|
||||||
|
**size** | Option<**i32**> | Amount of disk space used by the build cache (in bytes). | [optional]
|
||||||
|
**created_at** | Option<**String**> | Date and time at which the build cache was created in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. | [optional]
|
||||||
|
**last_used_at** | Option<**String**> | Date and time at which the build cache was last used in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. | [optional]
|
||||||
|
**usage_count** | Option<**i32**> | | [optional]
|
||||||
|
|
||||||
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||||
|
|
||||||
|
|
||||||
18
docs/BuildInfo.md
Normal file
18
docs/BuildInfo.md
Normal file
|
|
@ -0,0 +1,18 @@
|
||||||
|
# BuildInfo
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
**id** | Option<**String**> | | [optional]
|
||||||
|
**stream** | Option<**String**> | | [optional]
|
||||||
|
**error** | Option<**String**> | errors encountered during the operation. > **Deprecated**: This field is deprecated since API v1.4, and will be omitted in a future API version. Use the information in errorDetail instead. | [optional]
|
||||||
|
**error_detail** | Option<[**models::ErrorDetail**](ErrorDetail.md)> | | [optional]
|
||||||
|
**status** | Option<**String**> | | [optional]
|
||||||
|
**progress** | Option<**String**> | Progress is a pre-formatted presentation of progressDetail. > **Deprecated**: This field is deprecated since API v1.8, and will be omitted in a future API version. Use the information in progressDetail instead. | [optional]
|
||||||
|
**progress_detail** | Option<[**models::ProgressDetail**](ProgressDetail.md)> | | [optional]
|
||||||
|
**aux** | Option<[**models::ImageId**](ImageID.md)> | | [optional]
|
||||||
|
|
||||||
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||||
|
|
||||||
|
|
||||||
12
docs/BuildPruneResponse.md
Normal file
12
docs/BuildPruneResponse.md
Normal file
|
|
@ -0,0 +1,12 @@
|
||||||
|
# BuildPruneResponse
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
**caches_deleted** | Option<**Vec<String>**> | | [optional]
|
||||||
|
**space_reclaimed** | Option<**i64**> | Disk space reclaimed in bytes | [optional]
|
||||||
|
|
||||||
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||||
|
|
||||||
|
|
||||||
14
docs/ChangeType.md
Normal file
14
docs/ChangeType.md
Normal file
|
|
@ -0,0 +1,14 @@
|
||||||
|
# ChangeType
|
||||||
|
|
||||||
|
## Enum Variants
|
||||||
|
|
||||||
|
| Name | Value |
|
||||||
|
|---- | -----|
|
||||||
|
| Variant0 | 0 |
|
||||||
|
| Variant1 | 1 |
|
||||||
|
| Variant2 | 2 |
|
||||||
|
|
||||||
|
|
||||||
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||||
|
|
||||||
|
|
||||||
20
docs/ClusterInfo.md
Normal file
20
docs/ClusterInfo.md
Normal file
|
|
@ -0,0 +1,20 @@
|
||||||
|
# ClusterInfo
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
**id** | Option<**String**> | The ID of the swarm. | [optional]
|
||||||
|
**version** | Option<[**models::ObjectVersion**](ObjectVersion.md)> | | [optional]
|
||||||
|
**created_at** | Option<**String**> | Date and time at which the swarm was initialised in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. | [optional]
|
||||||
|
**updated_at** | Option<**String**> | Date and time at which the swarm was last updated in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. | [optional]
|
||||||
|
**spec** | Option<[**models::SwarmSpec**](SwarmSpec.md)> | | [optional]
|
||||||
|
**tls_info** | Option<[**models::TlsInfo**](TLSInfo.md)> | | [optional]
|
||||||
|
**root_rotation_in_progress** | Option<**bool**> | Whether there is currently a root CA rotation in progress for the swarm | [optional]
|
||||||
|
**data_path_port** | Option<**i32**> | DataPathPort specifies the data path port number for data traffic. Acceptable port range is 1024 to 49151. If no port is set or is set to 0, the default port (4789) is used. | [optional]
|
||||||
|
**default_addr_pool** | Option<**Vec<String>**> | Default Address Pool specifies default subnet pools for global scope networks. | [optional]
|
||||||
|
**subnet_size** | Option<**i32**> | SubnetSize specifies the subnet size of the networks created from the default subnet pool. | [optional]
|
||||||
|
|
||||||
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||||
|
|
||||||
|
|
||||||
17
docs/ClusterVolume.md
Normal file
17
docs/ClusterVolume.md
Normal file
|
|
@ -0,0 +1,17 @@
|
||||||
|
# ClusterVolume
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
**id** | Option<**String**> | The Swarm ID of this volume. Because cluster volumes are Swarm objects, they have an ID, unlike non-cluster volumes. This ID can be used to refer to the Volume instead of the name. | [optional]
|
||||||
|
**version** | Option<[**models::ObjectVersion**](ObjectVersion.md)> | | [optional]
|
||||||
|
**created_at** | Option<**String**> | | [optional]
|
||||||
|
**updated_at** | Option<**String**> | | [optional]
|
||||||
|
**spec** | Option<[**models::ClusterVolumeSpec**](ClusterVolumeSpec.md)> | | [optional]
|
||||||
|
**info** | Option<[**models::ClusterVolumeInfo**](ClusterVolume_Info.md)> | | [optional]
|
||||||
|
**publish_status** | Option<[**Vec<models::ClusterVolumePublishStatusInner>**](ClusterVolume_PublishStatus_inner.md)> | The status of the volume as it pertains to its publishing and use on specific nodes | [optional]
|
||||||
|
|
||||||
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||||
|
|
||||||
|
|
||||||
14
docs/ClusterVolumeInfo.md
Normal file
14
docs/ClusterVolumeInfo.md
Normal file
|
|
@ -0,0 +1,14 @@
|
||||||
|
# ClusterVolumeInfo
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
**capacity_bytes** | Option<**i64**> | The capacity of the volume in bytes. A value of 0 indicates that the capacity is unknown. | [optional]
|
||||||
|
**volume_context** | Option<**std::collections::HashMap<String, String>**> | A map of strings to strings returned from the storage plugin when the volume is created. | [optional]
|
||||||
|
**volume_id** | Option<**String**> | The ID of the volume as returned by the CSI storage plugin. This is distinct from the volume's ID as provided by Docker. This ID is never used by the user when communicating with Docker to refer to this volume. If the ID is blank, then the Volume has not been successfully created in the plugin yet. | [optional]
|
||||||
|
**accessible_topology** | Option<[**Vec<std::collections::HashMap<String, String>>**](std::collections::HashMap.md)> | The topology this volume is actually accessible from. | [optional]
|
||||||
|
|
||||||
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||||
|
|
||||||
|
|
||||||
13
docs/ClusterVolumePublishStatusInner.md
Normal file
13
docs/ClusterVolumePublishStatusInner.md
Normal file
|
|
@ -0,0 +1,13 @@
|
||||||
|
# ClusterVolumePublishStatusInner
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
**node_id** | Option<**String**> | The ID of the Swarm node the volume is published on. | [optional]
|
||||||
|
**state** | Option<**String**> | The published state of the volume. * `pending-publish` The volume should be published to this node, but the call to the controller plugin to do so has not yet been successfully completed. * `published` The volume is published successfully to the node. * `pending-node-unpublish` The volume should be unpublished from the node, and the manager is awaiting confirmation from the worker that it has done so. * `pending-controller-unpublish` The volume is successfully unpublished from the node, but has not yet been successfully unpublished on the controller. | [optional]
|
||||||
|
**publish_context** | Option<**std::collections::HashMap<String, String>**> | A map of strings to strings returned by the CSI controller plugin when a volume is published. | [optional]
|
||||||
|
|
||||||
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||||
|
|
||||||
|
|
||||||
12
docs/ClusterVolumeSpec.md
Normal file
12
docs/ClusterVolumeSpec.md
Normal file
|
|
@ -0,0 +1,12 @@
|
||||||
|
# ClusterVolumeSpec
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
**group** | Option<**String**> | Group defines the volume group of this volume. Volumes belonging to the same group can be referred to by group name when creating Services. Referring to a volume by group instructs Swarm to treat volumes in that group interchangeably for the purpose of scheduling. Volumes with an empty string for a group technically all belong to the same, emptystring group. | [optional]
|
||||||
|
**access_mode** | Option<[**models::ClusterVolumeSpecAccessMode**](ClusterVolumeSpec_AccessMode.md)> | | [optional]
|
||||||
|
|
||||||
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||||
|
|
||||||
|
|
||||||
17
docs/ClusterVolumeSpecAccessMode.md
Normal file
17
docs/ClusterVolumeSpecAccessMode.md
Normal file
|
|
@ -0,0 +1,17 @@
|
||||||
|
# ClusterVolumeSpecAccessMode
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
**scope** | Option<**String**> | The set of nodes this volume can be used on at one time. - `single` The volume may only be scheduled to one node at a time. - `multi` the volume may be scheduled to any supported number of nodes at a time. | [optional][default to Single]
|
||||||
|
**sharing** | Option<**String**> | The number and way that different tasks can use this volume at one time. - `none` The volume may only be used by one task at a time. - `readonly` The volume may be used by any number of tasks, but they all must mount the volume as readonly - `onewriter` The volume may be used by any number of tasks, but only one may mount it as read/write. - `all` The volume may have any number of readers and writers. | [optional][default to None]
|
||||||
|
**mount_volume** | Option<[**serde_json::Value**](.md)> | Options for using this volume as a Mount-type volume. Either MountVolume or BlockVolume, but not both, must be present. properties: FsType: type: \"string\" description: | Specifies the filesystem type for the mount volume. Optional. MountFlags: type: \"array\" description: | Flags to pass when mounting the volume. Optional. items: type: \"string\" BlockVolume: type: \"object\" description: | Options for using this volume as a Block-type volume. Intentionally empty. | [optional]
|
||||||
|
**secrets** | Option<[**Vec<models::ClusterVolumeSpecAccessModeSecretsInner>**](ClusterVolumeSpec_AccessMode_Secrets_inner.md)> | Swarm Secrets that are passed to the CSI storage plugin when operating on this volume. | [optional]
|
||||||
|
**accessibility_requirements** | Option<[**models::ClusterVolumeSpecAccessModeAccessibilityRequirements**](ClusterVolumeSpec_AccessMode_AccessibilityRequirements.md)> | | [optional]
|
||||||
|
**capacity_range** | Option<[**models::ClusterVolumeSpecAccessModeCapacityRange**](ClusterVolumeSpec_AccessMode_CapacityRange.md)> | | [optional]
|
||||||
|
**availability** | Option<**String**> | The availability of the volume for use in tasks. - `active` The volume is fully available for scheduling on the cluster - `pause` No new workloads should use the volume, but existing workloads are not stopped. - `drain` All workloads using this volume should be stopped and rescheduled, and no new ones should be started. | [optional][default to Active]
|
||||||
|
|
||||||
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||||
|
|
||||||
|
|
||||||
12
docs/ClusterVolumeSpecAccessModeAccessibilityRequirements.md
Normal file
12
docs/ClusterVolumeSpecAccessModeAccessibilityRequirements.md
Normal file
|
|
@ -0,0 +1,12 @@
|
||||||
|
# ClusterVolumeSpecAccessModeAccessibilityRequirements
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
**requisite** | Option<[**Vec<std::collections::HashMap<String, String>>**](std::collections::HashMap.md)> | A list of required topologies, at least one of which the volume must be accessible from. | [optional]
|
||||||
|
**preferred** | Option<[**Vec<std::collections::HashMap<String, String>>**](std::collections::HashMap.md)> | A list of topologies that the volume should attempt to be provisioned in. | [optional]
|
||||||
|
|
||||||
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||||
|
|
||||||
|
|
||||||
12
docs/ClusterVolumeSpecAccessModeCapacityRange.md
Normal file
12
docs/ClusterVolumeSpecAccessModeCapacityRange.md
Normal file
|
|
@ -0,0 +1,12 @@
|
||||||
|
# ClusterVolumeSpecAccessModeCapacityRange
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
**required_bytes** | Option<**i64**> | The volume must be at least this big. The value of 0 indicates an unspecified minimum | [optional]
|
||||||
|
**limit_bytes** | Option<**i64**> | The volume must not be bigger than this. The value of 0 indicates an unspecified maximum. | [optional]
|
||||||
|
|
||||||
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||||
|
|
||||||
|
|
||||||
12
docs/ClusterVolumeSpecAccessModeSecretsInner.md
Normal file
12
docs/ClusterVolumeSpecAccessModeSecretsInner.md
Normal file
|
|
@ -0,0 +1,12 @@
|
||||||
|
# ClusterVolumeSpecAccessModeSecretsInner
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
**key** | Option<**String**> | Key is the name of the key of the key-value pair passed to the plugin. | [optional]
|
||||||
|
**secret** | Option<**String**> | Secret is the swarm Secret object from which to read data. This can be a Secret name or ID. The Secret data is retrieved by swarm and used as the value of the key-value pair passed to the plugin. | [optional]
|
||||||
|
|
||||||
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||||
|
|
||||||
|
|
||||||
11
docs/Commit.md
Normal file
11
docs/Commit.md
Normal file
|
|
@ -0,0 +1,11 @@
|
||||||
|
# Commit
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
**id** | Option<**String**> | Actual commit ID of external tool. | [optional]
|
||||||
|
|
||||||
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||||
|
|
||||||
|
|
||||||
15
docs/Config.md
Normal file
15
docs/Config.md
Normal file
|
|
@ -0,0 +1,15 @@
|
||||||
|
# Config
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
**id** | Option<**String**> | | [optional]
|
||||||
|
**version** | Option<[**models::ObjectVersion**](ObjectVersion.md)> | | [optional]
|
||||||
|
**created_at** | Option<**String**> | | [optional]
|
||||||
|
**updated_at** | Option<**String**> | | [optional]
|
||||||
|
**spec** | Option<[**models::ConfigSpec**](ConfigSpec.md)> | | [optional]
|
||||||
|
|
||||||
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||||
|
|
||||||
|
|
||||||
155
docs/ConfigApi.md
Normal file
155
docs/ConfigApi.md
Normal file
|
|
@ -0,0 +1,155 @@
|
||||||
|
# \ConfigApi
|
||||||
|
|
||||||
|
All URIs are relative to *http://localhost/v1.51*
|
||||||
|
|
||||||
|
Method | HTTP request | Description
|
||||||
|
------------- | ------------- | -------------
|
||||||
|
[**config_create**](ConfigApi.md#config_create) | **POST** /configs/create | Create a config
|
||||||
|
[**config_delete**](ConfigApi.md#config_delete) | **DELETE** /configs/{id} | Delete a config
|
||||||
|
[**config_inspect**](ConfigApi.md#config_inspect) | **GET** /configs/{id} | Inspect a config
|
||||||
|
[**config_list**](ConfigApi.md#config_list) | **GET** /configs | List configs
|
||||||
|
[**config_update**](ConfigApi.md#config_update) | **POST** /configs/{id}/update | Update a Config
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## config_create
|
||||||
|
|
||||||
|
> models::IdResponse config_create(body)
|
||||||
|
Create a config
|
||||||
|
|
||||||
|
### Parameters
|
||||||
|
|
||||||
|
|
||||||
|
Name | Type | Description | Required | Notes
|
||||||
|
------------- | ------------- | ------------- | ------------- | -------------
|
||||||
|
**body** | Option<[**ConfigCreateRequest**](ConfigCreateRequest.md)> | | |
|
||||||
|
|
||||||
|
### Return type
|
||||||
|
|
||||||
|
[**models::IdResponse**](IDResponse.md)
|
||||||
|
|
||||||
|
### Authorization
|
||||||
|
|
||||||
|
No authorization required
|
||||||
|
|
||||||
|
### HTTP request headers
|
||||||
|
|
||||||
|
- **Content-Type**: application/json
|
||||||
|
- **Accept**: application/json
|
||||||
|
|
||||||
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||||
|
|
||||||
|
|
||||||
|
## config_delete
|
||||||
|
|
||||||
|
> config_delete(id)
|
||||||
|
Delete a config
|
||||||
|
|
||||||
|
### Parameters
|
||||||
|
|
||||||
|
|
||||||
|
Name | Type | Description | Required | Notes
|
||||||
|
------------- | ------------- | ------------- | ------------- | -------------
|
||||||
|
**id** | **String** | ID of the config | [required] |
|
||||||
|
|
||||||
|
### Return type
|
||||||
|
|
||||||
|
(empty response body)
|
||||||
|
|
||||||
|
### Authorization
|
||||||
|
|
||||||
|
No authorization required
|
||||||
|
|
||||||
|
### HTTP request headers
|
||||||
|
|
||||||
|
- **Content-Type**: Not defined
|
||||||
|
- **Accept**: application/json
|
||||||
|
|
||||||
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||||
|
|
||||||
|
|
||||||
|
## config_inspect
|
||||||
|
|
||||||
|
> models::Config config_inspect(id)
|
||||||
|
Inspect a config
|
||||||
|
|
||||||
|
### Parameters
|
||||||
|
|
||||||
|
|
||||||
|
Name | Type | Description | Required | Notes
|
||||||
|
------------- | ------------- | ------------- | ------------- | -------------
|
||||||
|
**id** | **String** | ID of the config | [required] |
|
||||||
|
|
||||||
|
### Return type
|
||||||
|
|
||||||
|
[**models::Config**](Config.md)
|
||||||
|
|
||||||
|
### Authorization
|
||||||
|
|
||||||
|
No authorization required
|
||||||
|
|
||||||
|
### HTTP request headers
|
||||||
|
|
||||||
|
- **Content-Type**: Not defined
|
||||||
|
- **Accept**: application/json
|
||||||
|
|
||||||
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||||
|
|
||||||
|
|
||||||
|
## config_list
|
||||||
|
|
||||||
|
> Vec<models::Config> config_list(filters)
|
||||||
|
List configs
|
||||||
|
|
||||||
|
### Parameters
|
||||||
|
|
||||||
|
|
||||||
|
Name | Type | Description | Required | Notes
|
||||||
|
------------- | ------------- | ------------- | ------------- | -------------
|
||||||
|
**filters** | Option<**String**> | A JSON encoded value of the filters (a `map[string][]string`) to process on the configs list. Available filters: - `id=<config id>` - `label=<key> or label=<key>=value` - `name=<config name>` - `names=<config name>` | |
|
||||||
|
|
||||||
|
### Return type
|
||||||
|
|
||||||
|
[**Vec<models::Config>**](Config.md)
|
||||||
|
|
||||||
|
### Authorization
|
||||||
|
|
||||||
|
No authorization required
|
||||||
|
|
||||||
|
### HTTP request headers
|
||||||
|
|
||||||
|
- **Content-Type**: Not defined
|
||||||
|
- **Accept**: application/json
|
||||||
|
|
||||||
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||||
|
|
||||||
|
|
||||||
|
## config_update
|
||||||
|
|
||||||
|
> config_update(id, version, body)
|
||||||
|
Update a Config
|
||||||
|
|
||||||
|
### Parameters
|
||||||
|
|
||||||
|
|
||||||
|
Name | Type | Description | Required | Notes
|
||||||
|
------------- | ------------- | ------------- | ------------- | -------------
|
||||||
|
**id** | **String** | The ID or name of the config | [required] |
|
||||||
|
**version** | **i64** | The version number of the config object being updated. This is required to avoid conflicting writes. | [required] |
|
||||||
|
**body** | Option<[**ConfigSpec**](ConfigSpec.md)> | The spec of the config to update. Currently, only the Labels field can be updated. All other fields must remain unchanged from the [ConfigInspect endpoint](#operation/ConfigInspect) response values. | |
|
||||||
|
|
||||||
|
### Return type
|
||||||
|
|
||||||
|
(empty response body)
|
||||||
|
|
||||||
|
### Authorization
|
||||||
|
|
||||||
|
No authorization required
|
||||||
|
|
||||||
|
### HTTP request headers
|
||||||
|
|
||||||
|
- **Content-Type**: application/json, text/plain
|
||||||
|
- **Accept**: application/json, text/plain
|
||||||
|
|
||||||
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||||
|
|
||||||
14
docs/ConfigCreateRequest.md
Normal file
14
docs/ConfigCreateRequest.md
Normal file
|
|
@ -0,0 +1,14 @@
|
||||||
|
# ConfigCreateRequest
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
**name** | Option<**String**> | User-defined name of the config. | [optional]
|
||||||
|
**labels** | Option<**std::collections::HashMap<String, String>**> | User-defined key/value metadata. | [optional]
|
||||||
|
**data** | Option<**String**> | Data is the data to store as a config, formatted as a Base64-url-safe-encoded ([RFC 4648](https://tools.ietf.org/html/rfc4648#section-5)) string. The maximum allowed size is 1000KB, as defined in [MaxConfigSize](https://pkg.go.dev/github.com/moby/swarmkit/v2@v2.0.0-20250103191802-8c1959736554/manager/controlapi#MaxConfigSize). | [optional]
|
||||||
|
**templating** | Option<[**models::Driver**](Driver.md)> | | [optional]
|
||||||
|
|
||||||
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||||
|
|
||||||
|
|
||||||
11
docs/ConfigReference.md
Normal file
11
docs/ConfigReference.md
Normal file
|
|
@ -0,0 +1,11 @@
|
||||||
|
# ConfigReference
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
**network** | Option<**String**> | The name of the config-only network that provides the network's configuration. The specified network must be an existing config-only network. Only network names are allowed, not network IDs. | [optional]
|
||||||
|
|
||||||
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||||
|
|
||||||
|
|
||||||
14
docs/ConfigSpec.md
Normal file
14
docs/ConfigSpec.md
Normal file
|
|
@ -0,0 +1,14 @@
|
||||||
|
# ConfigSpec
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
**name** | Option<**String**> | User-defined name of the config. | [optional]
|
||||||
|
**labels** | Option<**std::collections::HashMap<String, String>**> | User-defined key/value metadata. | [optional]
|
||||||
|
**data** | Option<**String**> | Data is the data to store as a config, formatted as a Base64-url-safe-encoded ([RFC 4648](https://tools.ietf.org/html/rfc4648#section-5)) string. The maximum allowed size is 1000KB, as defined in [MaxConfigSize](https://pkg.go.dev/github.com/moby/swarmkit/v2@v2.0.0-20250103191802-8c1959736554/manager/controlapi#MaxConfigSize). | [optional]
|
||||||
|
**templating** | Option<[**models::Driver**](Driver.md)> | | [optional]
|
||||||
|
|
||||||
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||||
|
|
||||||
|
|
||||||
815
docs/ContainerApi.md
Normal file
815
docs/ContainerApi.md
Normal file
|
|
@ -0,0 +1,815 @@
|
||||||
|
# \ContainerApi
|
||||||
|
|
||||||
|
All URIs are relative to *http://localhost/v1.51*
|
||||||
|
|
||||||
|
Method | HTTP request | Description
|
||||||
|
------------- | ------------- | -------------
|
||||||
|
[**container_archive**](ContainerApi.md#container_archive) | **GET** /containers/{id}/archive | Get an archive of a filesystem resource in a container
|
||||||
|
[**container_archive_info**](ContainerApi.md#container_archive_info) | **HEAD** /containers/{id}/archive | Get information about files in a container
|
||||||
|
[**container_attach**](ContainerApi.md#container_attach) | **POST** /containers/{id}/attach | Attach to a container
|
||||||
|
[**container_attach_websocket**](ContainerApi.md#container_attach_websocket) | **GET** /containers/{id}/attach/ws | Attach to a container via a websocket
|
||||||
|
[**container_changes**](ContainerApi.md#container_changes) | **GET** /containers/{id}/changes | Get changes on a container’s filesystem
|
||||||
|
[**container_create**](ContainerApi.md#container_create) | **POST** /containers/create | Create a container
|
||||||
|
[**container_delete**](ContainerApi.md#container_delete) | **DELETE** /containers/{id} | Remove a container
|
||||||
|
[**container_export**](ContainerApi.md#container_export) | **GET** /containers/{id}/export | Export a container
|
||||||
|
[**container_inspect**](ContainerApi.md#container_inspect) | **GET** /containers/{id}/json | Inspect a container
|
||||||
|
[**container_kill**](ContainerApi.md#container_kill) | **POST** /containers/{id}/kill | Kill a container
|
||||||
|
[**container_list**](ContainerApi.md#container_list) | **GET** /containers/json | List containers
|
||||||
|
[**container_logs**](ContainerApi.md#container_logs) | **GET** /containers/{id}/logs | Get container logs
|
||||||
|
[**container_pause**](ContainerApi.md#container_pause) | **POST** /containers/{id}/pause | Pause a container
|
||||||
|
[**container_prune**](ContainerApi.md#container_prune) | **POST** /containers/prune | Delete stopped containers
|
||||||
|
[**container_rename**](ContainerApi.md#container_rename) | **POST** /containers/{id}/rename | Rename a container
|
||||||
|
[**container_resize**](ContainerApi.md#container_resize) | **POST** /containers/{id}/resize | Resize a container TTY
|
||||||
|
[**container_restart**](ContainerApi.md#container_restart) | **POST** /containers/{id}/restart | Restart a container
|
||||||
|
[**container_start**](ContainerApi.md#container_start) | **POST** /containers/{id}/start | Start a container
|
||||||
|
[**container_stats**](ContainerApi.md#container_stats) | **GET** /containers/{id}/stats | Get container stats based on resource usage
|
||||||
|
[**container_stop**](ContainerApi.md#container_stop) | **POST** /containers/{id}/stop | Stop a container
|
||||||
|
[**container_top**](ContainerApi.md#container_top) | **GET** /containers/{id}/top | List processes running inside a container
|
||||||
|
[**container_unpause**](ContainerApi.md#container_unpause) | **POST** /containers/{id}/unpause | Unpause a container
|
||||||
|
[**container_update**](ContainerApi.md#container_update) | **POST** /containers/{id}/update | Update a container
|
||||||
|
[**container_wait**](ContainerApi.md#container_wait) | **POST** /containers/{id}/wait | Wait for a container
|
||||||
|
[**put_container_archive**](ContainerApi.md#put_container_archive) | **PUT** /containers/{id}/archive | Extract an archive of files or folders to a directory in a container
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## container_archive
|
||||||
|
|
||||||
|
> container_archive(id, path)
|
||||||
|
Get an archive of a filesystem resource in a container
|
||||||
|
|
||||||
|
Get a tar archive of a resource in the filesystem of container id.
|
||||||
|
|
||||||
|
### Parameters
|
||||||
|
|
||||||
|
|
||||||
|
Name | Type | Description | Required | Notes
|
||||||
|
------------- | ------------- | ------------- | ------------- | -------------
|
||||||
|
**id** | **String** | ID or name of the container | [required] |
|
||||||
|
**path** | **String** | Resource in the container’s filesystem to archive. | [required] |
|
||||||
|
|
||||||
|
### Return type
|
||||||
|
|
||||||
|
(empty response body)
|
||||||
|
|
||||||
|
### Authorization
|
||||||
|
|
||||||
|
No authorization required
|
||||||
|
|
||||||
|
### HTTP request headers
|
||||||
|
|
||||||
|
- **Content-Type**: Not defined
|
||||||
|
- **Accept**: application/x-tar, application/json
|
||||||
|
|
||||||
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||||
|
|
||||||
|
|
||||||
|
## container_archive_info
|
||||||
|
|
||||||
|
> container_archive_info(id, path)
|
||||||
|
Get information about files in a container
|
||||||
|
|
||||||
|
A response header `X-Docker-Container-Path-Stat` is returned, containing a base64 - encoded JSON object with some filesystem header information about the path.
|
||||||
|
|
||||||
|
### Parameters
|
||||||
|
|
||||||
|
|
||||||
|
Name | Type | Description | Required | Notes
|
||||||
|
------------- | ------------- | ------------- | ------------- | -------------
|
||||||
|
**id** | **String** | ID or name of the container | [required] |
|
||||||
|
**path** | **String** | Resource in the container’s filesystem to archive. | [required] |
|
||||||
|
|
||||||
|
### Return type
|
||||||
|
|
||||||
|
(empty response body)
|
||||||
|
|
||||||
|
### Authorization
|
||||||
|
|
||||||
|
No authorization required
|
||||||
|
|
||||||
|
### HTTP request headers
|
||||||
|
|
||||||
|
- **Content-Type**: Not defined
|
||||||
|
- **Accept**: application/json, text/plain
|
||||||
|
|
||||||
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||||
|
|
||||||
|
|
||||||
|
## container_attach
|
||||||
|
|
||||||
|
> container_attach(id, detach_keys, logs, stream, stdin, stdout, stderr)
|
||||||
|
Attach to a container
|
||||||
|
|
||||||
|
Attach to a container to read its output or send it input. You can attach to the same container multiple times and you can reattach to containers that have been detached. Either the `stream` or `logs` parameter must be `true` for this endpoint to do anything. See the [documentation for the `docker attach` command](https://docs.docker.com/engine/reference/commandline/attach/) for more details. ### Hijacking This endpoint hijacks the HTTP connection to transport `stdin`, `stdout`, and `stderr` on the same socket. This is the response from the daemon for an attach request: ``` HTTP/1.1 200 OK Content-Type: application/vnd.docker.raw-stream [STREAM] ``` After the headers and two new lines, the TCP connection can now be used for raw, bidirectional communication between the client and server. To hint potential proxies about connection hijacking, the Docker client can also optionally send connection upgrade headers. For example, the client sends this request to upgrade the connection: ``` POST /containers/16253994b7c4/attach?stream=1&stdout=1 HTTP/1.1 Upgrade: tcp Connection: Upgrade ``` The Docker daemon will respond with a `101 UPGRADED` response, and will similarly follow with the raw stream: ``` HTTP/1.1 101 UPGRADED Content-Type: application/vnd.docker.raw-stream Connection: Upgrade Upgrade: tcp [STREAM] ``` ### Stream format When the TTY setting is disabled in [`POST /containers/create`](#operation/ContainerCreate), the HTTP Content-Type header is set to application/vnd.docker.multiplexed-stream and the stream over the hijacked connected is multiplexed to separate out `stdout` and `stderr`. The stream consists of a series of frames, each containing a header and a payload. The header contains the information which the stream writes (`stdout` or `stderr`). It also contains the size of the associated frame encoded in the last four bytes (`uint32`). It is encoded on the first eight bytes like this: ```go header := [8]byte{STREAM_TYPE, 0, 0, 0, SIZE1, SIZE2, SIZE3, SIZE4} ``` `STREAM_TYPE` can be: - 0: `stdin` (is written on `stdout`) - 1: `stdout` - 2: `stderr` `SIZE1, SIZE2, SIZE3, SIZE4` are the four bytes of the `uint32` size encoded as big endian. Following the header is the payload, which is the specified number of bytes of `STREAM_TYPE`. The simplest way to implement this protocol is the following: 1. Read 8 bytes. 2. Choose `stdout` or `stderr` depending on the first byte. 3. Extract the frame size from the last four bytes. 4. Read the extracted size and output it on the correct output. 5. Goto 1. ### Stream format when using a TTY When the TTY setting is enabled in [`POST /containers/create`](#operation/ContainerCreate), the stream is not multiplexed. The data exchanged over the hijacked connection is simply the raw data from the process PTY and client's `stdin`.
|
||||||
|
|
||||||
|
### Parameters
|
||||||
|
|
||||||
|
|
||||||
|
Name | Type | Description | Required | Notes
|
||||||
|
------------- | ------------- | ------------- | ------------- | -------------
|
||||||
|
**id** | **String** | ID or name of the container | [required] |
|
||||||
|
**detach_keys** | Option<**String**> | Override the key sequence for detaching a container.Format is a single character `[a-Z]` or `ctrl-<value>` where `<value>` is one of: `a-z`, `@`, `^`, `[`, `,` or `_`. | |
|
||||||
|
**logs** | Option<**bool**> | Replay previous logs from the container. This is useful for attaching to a container that has started and you want to output everything since the container started. If `stream` is also enabled, once all the previous output has been returned, it will seamlessly transition into streaming current output. | |[default to false]
|
||||||
|
**stream** | Option<**bool**> | Stream attached streams from the time the request was made onwards. | |[default to false]
|
||||||
|
**stdin** | Option<**bool**> | Attach to `stdin` | |[default to false]
|
||||||
|
**stdout** | Option<**bool**> | Attach to `stdout` | |[default to false]
|
||||||
|
**stderr** | Option<**bool**> | Attach to `stderr` | |[default to false]
|
||||||
|
|
||||||
|
### Return type
|
||||||
|
|
||||||
|
(empty response body)
|
||||||
|
|
||||||
|
### Authorization
|
||||||
|
|
||||||
|
No authorization required
|
||||||
|
|
||||||
|
### HTTP request headers
|
||||||
|
|
||||||
|
- **Content-Type**: Not defined
|
||||||
|
- **Accept**: application/vnd.docker.raw-stream, application/vnd.docker.multiplexed-stream, application/json
|
||||||
|
|
||||||
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||||
|
|
||||||
|
|
||||||
|
## container_attach_websocket
|
||||||
|
|
||||||
|
> container_attach_websocket(id, detach_keys, logs, stream, stdin, stdout, stderr)
|
||||||
|
Attach to a container via a websocket
|
||||||
|
|
||||||
|
### Parameters
|
||||||
|
|
||||||
|
|
||||||
|
Name | Type | Description | Required | Notes
|
||||||
|
------------- | ------------- | ------------- | ------------- | -------------
|
||||||
|
**id** | **String** | ID or name of the container | [required] |
|
||||||
|
**detach_keys** | Option<**String**> | Override the key sequence for detaching a container.Format is a single character `[a-Z]` or `ctrl-<value>` where `<value>` is one of: `a-z`, `@`, `^`, `[`, `,`, or `_`. | |
|
||||||
|
**logs** | Option<**bool**> | Return logs | |[default to false]
|
||||||
|
**stream** | Option<**bool**> | Return stream | |[default to false]
|
||||||
|
**stdin** | Option<**bool**> | Attach to `stdin` | |[default to false]
|
||||||
|
**stdout** | Option<**bool**> | Attach to `stdout` | |[default to false]
|
||||||
|
**stderr** | Option<**bool**> | Attach to `stderr` | |[default to false]
|
||||||
|
|
||||||
|
### Return type
|
||||||
|
|
||||||
|
(empty response body)
|
||||||
|
|
||||||
|
### Authorization
|
||||||
|
|
||||||
|
No authorization required
|
||||||
|
|
||||||
|
### HTTP request headers
|
||||||
|
|
||||||
|
- **Content-Type**: Not defined
|
||||||
|
- **Accept**: application/json, text/plain
|
||||||
|
|
||||||
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||||
|
|
||||||
|
|
||||||
|
## container_changes
|
||||||
|
|
||||||
|
> Vec<models::FilesystemChange> container_changes(id)
|
||||||
|
Get changes on a container’s filesystem
|
||||||
|
|
||||||
|
Returns which files in a container's filesystem have been added, deleted, or modified. The `Kind` of modification can be one of: - `0`: Modified (\"C\") - `1`: Added (\"A\") - `2`: Deleted (\"D\")
|
||||||
|
|
||||||
|
### Parameters
|
||||||
|
|
||||||
|
|
||||||
|
Name | Type | Description | Required | Notes
|
||||||
|
------------- | ------------- | ------------- | ------------- | -------------
|
||||||
|
**id** | **String** | ID or name of the container | [required] |
|
||||||
|
|
||||||
|
### Return type
|
||||||
|
|
||||||
|
[**Vec<models::FilesystemChange>**](FilesystemChange.md)
|
||||||
|
|
||||||
|
### Authorization
|
||||||
|
|
||||||
|
No authorization required
|
||||||
|
|
||||||
|
### HTTP request headers
|
||||||
|
|
||||||
|
- **Content-Type**: Not defined
|
||||||
|
- **Accept**: application/json
|
||||||
|
|
||||||
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||||
|
|
||||||
|
|
||||||
|
## container_create
|
||||||
|
|
||||||
|
> models::ContainerCreateResponse container_create(body, name, platform)
|
||||||
|
Create a container
|
||||||
|
|
||||||
|
### Parameters
|
||||||
|
|
||||||
|
|
||||||
|
Name | Type | Description | Required | Notes
|
||||||
|
------------- | ------------- | ------------- | ------------- | -------------
|
||||||
|
**body** | [**ContainerCreateRequest**](ContainerCreateRequest.md) | Container to create | [required] |
|
||||||
|
**name** | Option<**String**> | Assign the specified name to the container. Must match `/?[a-zA-Z0-9][a-zA-Z0-9_.-]+`. | |
|
||||||
|
**platform** | Option<**String**> | Platform in the format `os[/arch[/variant]]` used for image lookup. When specified, the daemon checks if the requested image is present in the local image cache with the given OS and Architecture, and otherwise returns a `404` status. If the option is not set, the host's native OS and Architecture are used to look up the image in the image cache. However, if no platform is passed and the given image does exist in the local image cache, but its OS or architecture does not match, the container is created with the available image, and a warning is added to the `Warnings` field in the response, for example; WARNING: The requested image's platform (linux/arm64/v8) does not match the detected host platform (linux/amd64) and no specific platform was requested | |
|
||||||
|
|
||||||
|
### Return type
|
||||||
|
|
||||||
|
[**models::ContainerCreateResponse**](ContainerCreateResponse.md)
|
||||||
|
|
||||||
|
### Authorization
|
||||||
|
|
||||||
|
No authorization required
|
||||||
|
|
||||||
|
### HTTP request headers
|
||||||
|
|
||||||
|
- **Content-Type**: application/json, application/octet-stream
|
||||||
|
- **Accept**: application/json
|
||||||
|
|
||||||
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||||
|
|
||||||
|
|
||||||
|
## container_delete
|
||||||
|
|
||||||
|
> container_delete(id, v, force, link)
|
||||||
|
Remove a container
|
||||||
|
|
||||||
|
### Parameters
|
||||||
|
|
||||||
|
|
||||||
|
Name | Type | Description | Required | Notes
|
||||||
|
------------- | ------------- | ------------- | ------------- | -------------
|
||||||
|
**id** | **String** | ID or name of the container | [required] |
|
||||||
|
**v** | Option<**bool**> | Remove anonymous volumes associated with the container. | |[default to false]
|
||||||
|
**force** | Option<**bool**> | If the container is running, kill it before removing it. | |[default to false]
|
||||||
|
**link** | Option<**bool**> | Remove the specified link associated with the container. | |[default to false]
|
||||||
|
|
||||||
|
### Return type
|
||||||
|
|
||||||
|
(empty response body)
|
||||||
|
|
||||||
|
### Authorization
|
||||||
|
|
||||||
|
No authorization required
|
||||||
|
|
||||||
|
### HTTP request headers
|
||||||
|
|
||||||
|
- **Content-Type**: Not defined
|
||||||
|
- **Accept**: application/json, text/plain
|
||||||
|
|
||||||
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||||
|
|
||||||
|
|
||||||
|
## container_export
|
||||||
|
|
||||||
|
> container_export(id)
|
||||||
|
Export a container
|
||||||
|
|
||||||
|
Export the contents of a container as a tarball.
|
||||||
|
|
||||||
|
### Parameters
|
||||||
|
|
||||||
|
|
||||||
|
Name | Type | Description | Required | Notes
|
||||||
|
------------- | ------------- | ------------- | ------------- | -------------
|
||||||
|
**id** | **String** | ID or name of the container | [required] |
|
||||||
|
|
||||||
|
### Return type
|
||||||
|
|
||||||
|
(empty response body)
|
||||||
|
|
||||||
|
### Authorization
|
||||||
|
|
||||||
|
No authorization required
|
||||||
|
|
||||||
|
### HTTP request headers
|
||||||
|
|
||||||
|
- **Content-Type**: Not defined
|
||||||
|
- **Accept**: application/octet-stream, application/json
|
||||||
|
|
||||||
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||||
|
|
||||||
|
|
||||||
|
## container_inspect
|
||||||
|
|
||||||
|
> models::ContainerInspectResponse container_inspect(id, size)
|
||||||
|
Inspect a container
|
||||||
|
|
||||||
|
Return low-level information about a container.
|
||||||
|
|
||||||
|
### Parameters
|
||||||
|
|
||||||
|
|
||||||
|
Name | Type | Description | Required | Notes
|
||||||
|
------------- | ------------- | ------------- | ------------- | -------------
|
||||||
|
**id** | **String** | ID or name of the container | [required] |
|
||||||
|
**size** | Option<**bool**> | Return the size of container as fields `SizeRw` and `SizeRootFs` | |[default to false]
|
||||||
|
|
||||||
|
### Return type
|
||||||
|
|
||||||
|
[**models::ContainerInspectResponse**](ContainerInspectResponse.md)
|
||||||
|
|
||||||
|
### Authorization
|
||||||
|
|
||||||
|
No authorization required
|
||||||
|
|
||||||
|
### HTTP request headers
|
||||||
|
|
||||||
|
- **Content-Type**: Not defined
|
||||||
|
- **Accept**: application/json
|
||||||
|
|
||||||
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||||
|
|
||||||
|
|
||||||
|
## container_kill
|
||||||
|
|
||||||
|
> container_kill(id, signal)
|
||||||
|
Kill a container
|
||||||
|
|
||||||
|
Send a POSIX signal to a container, defaulting to killing to the container.
|
||||||
|
|
||||||
|
### Parameters
|
||||||
|
|
||||||
|
|
||||||
|
Name | Type | Description | Required | Notes
|
||||||
|
------------- | ------------- | ------------- | ------------- | -------------
|
||||||
|
**id** | **String** | ID or name of the container | [required] |
|
||||||
|
**signal** | Option<**String**> | Signal to send to the container as an integer or string (e.g. `SIGINT`). | |[default to SIGKILL]
|
||||||
|
|
||||||
|
### Return type
|
||||||
|
|
||||||
|
(empty response body)
|
||||||
|
|
||||||
|
### Authorization
|
||||||
|
|
||||||
|
No authorization required
|
||||||
|
|
||||||
|
### HTTP request headers
|
||||||
|
|
||||||
|
- **Content-Type**: Not defined
|
||||||
|
- **Accept**: application/json, text/plain
|
||||||
|
|
||||||
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||||
|
|
||||||
|
|
||||||
|
## container_list
|
||||||
|
|
||||||
|
> Vec<models::ContainerSummary> container_list(all, limit, size, filters)
|
||||||
|
List containers
|
||||||
|
|
||||||
|
Returns a list of containers. For details on the format, see the [inspect endpoint](#operation/ContainerInspect). Note that it uses a different, smaller representation of a container than inspecting a single container. For example, the list of linked containers is not propagated .
|
||||||
|
|
||||||
|
### Parameters
|
||||||
|
|
||||||
|
|
||||||
|
Name | Type | Description | Required | Notes
|
||||||
|
------------- | ------------- | ------------- | ------------- | -------------
|
||||||
|
**all** | Option<**bool**> | Return all containers. By default, only running containers are shown. | |[default to false]
|
||||||
|
**limit** | Option<**i32**> | Return this number of most recently created containers, including non-running ones. | |
|
||||||
|
**size** | Option<**bool**> | Return the size of container as fields `SizeRw` and `SizeRootFs`. | |[default to false]
|
||||||
|
**filters** | Option<**String**> | Filters to process on the container list, encoded as JSON (a `map[string][]string`). For example, `{\"status\": [\"paused\"]}` will only return paused containers. Available filters: - `ancestor`=(`<image-name>[:<tag>]`, `<image id>`, or `<image@digest>`) - `before`=(`<container id>` or `<container name>`) - `expose`=(`<port>[/<proto>]`|`<startport-endport>/[<proto>]`) - `exited=<int>` containers with exit code of `<int>` - `health`=(`starting`|`healthy`|`unhealthy`|`none`) - `id=<ID>` a container's ID - `isolation=`(`default`|`process`|`hyperv`) (Windows daemon only) - `is-task=`(`true`|`false`) - `label=key` or `label=\"key=value\"` of a container label - `name=<name>` a container's name - `network`=(`<network id>` or `<network name>`) - `publish`=(`<port>[/<proto>]`|`<startport-endport>/[<proto>]`) - `since`=(`<container id>` or `<container name>`) - `status=`(`created`|`restarting`|`running`|`removing`|`paused`|`exited`|`dead`) - `volume`=(`<volume name>` or `<mount point destination>`) | |
|
||||||
|
|
||||||
|
### Return type
|
||||||
|
|
||||||
|
[**Vec<models::ContainerSummary>**](ContainerSummary.md)
|
||||||
|
|
||||||
|
### Authorization
|
||||||
|
|
||||||
|
No authorization required
|
||||||
|
|
||||||
|
### HTTP request headers
|
||||||
|
|
||||||
|
- **Content-Type**: Not defined
|
||||||
|
- **Accept**: application/json
|
||||||
|
|
||||||
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||||
|
|
||||||
|
|
||||||
|
## container_logs
|
||||||
|
|
||||||
|
> std::path::PathBuf container_logs(id, follow, stdout, stderr, since, until, timestamps, tail)
|
||||||
|
Get container logs
|
||||||
|
|
||||||
|
Get `stdout` and `stderr` logs from a container. Note: This endpoint works only for containers with the `json-file` or `journald` logging driver.
|
||||||
|
|
||||||
|
### Parameters
|
||||||
|
|
||||||
|
|
||||||
|
Name | Type | Description | Required | Notes
|
||||||
|
------------- | ------------- | ------------- | ------------- | -------------
|
||||||
|
**id** | **String** | ID or name of the container | [required] |
|
||||||
|
**follow** | Option<**bool**> | Keep connection after returning logs. | |[default to false]
|
||||||
|
**stdout** | Option<**bool**> | Return logs from `stdout` | |[default to false]
|
||||||
|
**stderr** | Option<**bool**> | Return logs from `stderr` | |[default to false]
|
||||||
|
**since** | Option<**i32**> | Only return logs since this time, as a UNIX timestamp | |[default to 0]
|
||||||
|
**until** | Option<**i32**> | Only return logs before this time, as a UNIX timestamp | |[default to 0]
|
||||||
|
**timestamps** | Option<**bool**> | Add timestamps to every log line | |[default to false]
|
||||||
|
**tail** | Option<**String**> | Only return this number of log lines from the end of the logs. Specify as an integer or `all` to output all log lines. | |[default to all]
|
||||||
|
|
||||||
|
### Return type
|
||||||
|
|
||||||
|
[**std::path::PathBuf**](std::path::PathBuf.md)
|
||||||
|
|
||||||
|
### Authorization
|
||||||
|
|
||||||
|
No authorization required
|
||||||
|
|
||||||
|
### HTTP request headers
|
||||||
|
|
||||||
|
- **Content-Type**: Not defined
|
||||||
|
- **Accept**: application/vnd.docker.raw-stream, application/vnd.docker.multiplexed-stream, application/json
|
||||||
|
|
||||||
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||||
|
|
||||||
|
|
||||||
|
## container_pause
|
||||||
|
|
||||||
|
> container_pause(id)
|
||||||
|
Pause a container
|
||||||
|
|
||||||
|
Use the freezer cgroup to suspend all processes in a container. Traditionally, when suspending a process the `SIGSTOP` signal is used, which is observable by the process being suspended. With the freezer cgroup the process is unaware, and unable to capture, that it is being suspended, and subsequently resumed.
|
||||||
|
|
||||||
|
### Parameters
|
||||||
|
|
||||||
|
|
||||||
|
Name | Type | Description | Required | Notes
|
||||||
|
------------- | ------------- | ------------- | ------------- | -------------
|
||||||
|
**id** | **String** | ID or name of the container | [required] |
|
||||||
|
|
||||||
|
### Return type
|
||||||
|
|
||||||
|
(empty response body)
|
||||||
|
|
||||||
|
### Authorization
|
||||||
|
|
||||||
|
No authorization required
|
||||||
|
|
||||||
|
### HTTP request headers
|
||||||
|
|
||||||
|
- **Content-Type**: Not defined
|
||||||
|
- **Accept**: application/json, text/plain
|
||||||
|
|
||||||
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||||
|
|
||||||
|
|
||||||
|
## container_prune
|
||||||
|
|
||||||
|
> models::ContainerPruneResponse container_prune(filters)
|
||||||
|
Delete stopped containers
|
||||||
|
|
||||||
|
### Parameters
|
||||||
|
|
||||||
|
|
||||||
|
Name | Type | Description | Required | Notes
|
||||||
|
------------- | ------------- | ------------- | ------------- | -------------
|
||||||
|
**filters** | Option<**String**> | Filters to process on the prune list, encoded as JSON (a `map[string][]string`). Available filters: - `until=<timestamp>` Prune containers created before this timestamp. The `<timestamp>` can be Unix timestamps, date formatted timestamps, or Go duration strings (e.g. `10m`, `1h30m`) computed relative to the daemon machine’s time. - `label` (`label=<key>`, `label=<key>=<value>`, `label!=<key>`, or `label!=<key>=<value>`) Prune containers with (or without, in case `label!=...` is used) the specified labels. | |
|
||||||
|
|
||||||
|
### Return type
|
||||||
|
|
||||||
|
[**models::ContainerPruneResponse**](ContainerPruneResponse.md)
|
||||||
|
|
||||||
|
### Authorization
|
||||||
|
|
||||||
|
No authorization required
|
||||||
|
|
||||||
|
### HTTP request headers
|
||||||
|
|
||||||
|
- **Content-Type**: Not defined
|
||||||
|
- **Accept**: application/json
|
||||||
|
|
||||||
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||||
|
|
||||||
|
|
||||||
|
## container_rename
|
||||||
|
|
||||||
|
> container_rename(id, name)
|
||||||
|
Rename a container
|
||||||
|
|
||||||
|
### Parameters
|
||||||
|
|
||||||
|
|
||||||
|
Name | Type | Description | Required | Notes
|
||||||
|
------------- | ------------- | ------------- | ------------- | -------------
|
||||||
|
**id** | **String** | ID or name of the container | [required] |
|
||||||
|
**name** | **String** | New name for the container | [required] |
|
||||||
|
|
||||||
|
### Return type
|
||||||
|
|
||||||
|
(empty response body)
|
||||||
|
|
||||||
|
### Authorization
|
||||||
|
|
||||||
|
No authorization required
|
||||||
|
|
||||||
|
### HTTP request headers
|
||||||
|
|
||||||
|
- **Content-Type**: Not defined
|
||||||
|
- **Accept**: application/json, text/plain
|
||||||
|
|
||||||
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||||
|
|
||||||
|
|
||||||
|
## container_resize
|
||||||
|
|
||||||
|
> container_resize(id, h, w)
|
||||||
|
Resize a container TTY
|
||||||
|
|
||||||
|
Resize the TTY for a container.
|
||||||
|
|
||||||
|
### Parameters
|
||||||
|
|
||||||
|
|
||||||
|
Name | Type | Description | Required | Notes
|
||||||
|
------------- | ------------- | ------------- | ------------- | -------------
|
||||||
|
**id** | **String** | ID or name of the container | [required] |
|
||||||
|
**h** | **i32** | Height of the TTY session in characters | [required] |
|
||||||
|
**w** | **i32** | Width of the TTY session in characters | [required] |
|
||||||
|
|
||||||
|
### Return type
|
||||||
|
|
||||||
|
(empty response body)
|
||||||
|
|
||||||
|
### Authorization
|
||||||
|
|
||||||
|
No authorization required
|
||||||
|
|
||||||
|
### HTTP request headers
|
||||||
|
|
||||||
|
- **Content-Type**: Not defined
|
||||||
|
- **Accept**: text/plain, application/json
|
||||||
|
|
||||||
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||||
|
|
||||||
|
|
||||||
|
## container_restart
|
||||||
|
|
||||||
|
> container_restart(id, signal, t)
|
||||||
|
Restart a container
|
||||||
|
|
||||||
|
### Parameters
|
||||||
|
|
||||||
|
|
||||||
|
Name | Type | Description | Required | Notes
|
||||||
|
------------- | ------------- | ------------- | ------------- | -------------
|
||||||
|
**id** | **String** | ID or name of the container | [required] |
|
||||||
|
**signal** | Option<**String**> | Signal to send to the container as an integer or string (e.g. `SIGINT`). | |
|
||||||
|
**t** | Option<**i32**> | Number of seconds to wait before killing the container | |
|
||||||
|
|
||||||
|
### Return type
|
||||||
|
|
||||||
|
(empty response body)
|
||||||
|
|
||||||
|
### Authorization
|
||||||
|
|
||||||
|
No authorization required
|
||||||
|
|
||||||
|
### HTTP request headers
|
||||||
|
|
||||||
|
- **Content-Type**: Not defined
|
||||||
|
- **Accept**: application/json, text/plain
|
||||||
|
|
||||||
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||||
|
|
||||||
|
|
||||||
|
## container_start
|
||||||
|
|
||||||
|
> container_start(id, detach_keys)
|
||||||
|
Start a container
|
||||||
|
|
||||||
|
### Parameters
|
||||||
|
|
||||||
|
|
||||||
|
Name | Type | Description | Required | Notes
|
||||||
|
------------- | ------------- | ------------- | ------------- | -------------
|
||||||
|
**id** | **String** | ID or name of the container | [required] |
|
||||||
|
**detach_keys** | Option<**String**> | Override the key sequence for detaching a container. Format is a single character `[a-Z]` or `ctrl-<value>` where `<value>` is one of: `a-z`, `@`, `^`, `[`, `,` or `_`. | |
|
||||||
|
|
||||||
|
### Return type
|
||||||
|
|
||||||
|
(empty response body)
|
||||||
|
|
||||||
|
### Authorization
|
||||||
|
|
||||||
|
No authorization required
|
||||||
|
|
||||||
|
### HTTP request headers
|
||||||
|
|
||||||
|
- **Content-Type**: Not defined
|
||||||
|
- **Accept**: application/json, text/plain
|
||||||
|
|
||||||
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||||
|
|
||||||
|
|
||||||
|
## container_stats
|
||||||
|
|
||||||
|
> models::ContainerStatsResponse container_stats(id, stream, one_shot)
|
||||||
|
Get container stats based on resource usage
|
||||||
|
|
||||||
|
This endpoint returns a live stream of a container’s resource usage statistics. The `precpu_stats` is the CPU statistic of the *previous* read, and is used to calculate the CPU usage percentage. It is not an exact copy of the `cpu_stats` field. If either `precpu_stats.online_cpus` or `cpu_stats.online_cpus` is nil then for compatibility with older daemons the length of the corresponding `cpu_usage.percpu_usage` array should be used. On a cgroup v2 host, the following fields are not set * `blkio_stats`: all fields other than `io_service_bytes_recursive` * `cpu_stats`: `cpu_usage.percpu_usage` * `memory_stats`: `max_usage` and `failcnt` Also, `memory_stats.stats` fields are incompatible with cgroup v1. To calculate the values shown by the `stats` command of the docker cli tool the following formulas can be used: * used_memory = `memory_stats.usage - memory_stats.stats.cache` * available_memory = `memory_stats.limit` * Memory usage % = `(used_memory / available_memory) * 100.0` * cpu_delta = `cpu_stats.cpu_usage.total_usage - precpu_stats.cpu_usage.total_usage` * system_cpu_delta = `cpu_stats.system_cpu_usage - precpu_stats.system_cpu_usage` * number_cpus = `length(cpu_stats.cpu_usage.percpu_usage)` or `cpu_stats.online_cpus` * CPU usage % = `(cpu_delta / system_cpu_delta) * number_cpus * 100.0`
|
||||||
|
|
||||||
|
### Parameters
|
||||||
|
|
||||||
|
|
||||||
|
Name | Type | Description | Required | Notes
|
||||||
|
------------- | ------------- | ------------- | ------------- | -------------
|
||||||
|
**id** | **String** | ID or name of the container | [required] |
|
||||||
|
**stream** | Option<**bool**> | Stream the output. If false, the stats will be output once and then it will disconnect. | |[default to true]
|
||||||
|
**one_shot** | Option<**bool**> | Only get a single stat instead of waiting for 2 cycles. Must be used with `stream=false`. | |[default to false]
|
||||||
|
|
||||||
|
### Return type
|
||||||
|
|
||||||
|
[**models::ContainerStatsResponse**](ContainerStatsResponse.md)
|
||||||
|
|
||||||
|
### Authorization
|
||||||
|
|
||||||
|
No authorization required
|
||||||
|
|
||||||
|
### HTTP request headers
|
||||||
|
|
||||||
|
- **Content-Type**: Not defined
|
||||||
|
- **Accept**: application/json
|
||||||
|
|
||||||
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||||
|
|
||||||
|
|
||||||
|
## container_stop
|
||||||
|
|
||||||
|
> container_stop(id, signal, t)
|
||||||
|
Stop a container
|
||||||
|
|
||||||
|
### Parameters
|
||||||
|
|
||||||
|
|
||||||
|
Name | Type | Description | Required | Notes
|
||||||
|
------------- | ------------- | ------------- | ------------- | -------------
|
||||||
|
**id** | **String** | ID or name of the container | [required] |
|
||||||
|
**signal** | Option<**String**> | Signal to send to the container as an integer or string (e.g. `SIGINT`). | |
|
||||||
|
**t** | Option<**i32**> | Number of seconds to wait before killing the container | |
|
||||||
|
|
||||||
|
### Return type
|
||||||
|
|
||||||
|
(empty response body)
|
||||||
|
|
||||||
|
### Authorization
|
||||||
|
|
||||||
|
No authorization required
|
||||||
|
|
||||||
|
### HTTP request headers
|
||||||
|
|
||||||
|
- **Content-Type**: Not defined
|
||||||
|
- **Accept**: application/json, text/plain
|
||||||
|
|
||||||
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||||
|
|
||||||
|
|
||||||
|
## container_top
|
||||||
|
|
||||||
|
> models::ContainerTopResponse container_top(id, ps_args)
|
||||||
|
List processes running inside a container
|
||||||
|
|
||||||
|
On Unix systems, this is done by running the `ps` command. This endpoint is not supported on Windows.
|
||||||
|
|
||||||
|
### Parameters
|
||||||
|
|
||||||
|
|
||||||
|
Name | Type | Description | Required | Notes
|
||||||
|
------------- | ------------- | ------------- | ------------- | -------------
|
||||||
|
**id** | **String** | ID or name of the container | [required] |
|
||||||
|
**ps_args** | Option<**String**> | The arguments to pass to `ps`. For example, `aux` | |[default to -ef]
|
||||||
|
|
||||||
|
### Return type
|
||||||
|
|
||||||
|
[**models::ContainerTopResponse**](ContainerTopResponse.md)
|
||||||
|
|
||||||
|
### Authorization
|
||||||
|
|
||||||
|
No authorization required
|
||||||
|
|
||||||
|
### HTTP request headers
|
||||||
|
|
||||||
|
- **Content-Type**: Not defined
|
||||||
|
- **Accept**: application/json, text/plain
|
||||||
|
|
||||||
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||||
|
|
||||||
|
|
||||||
|
## container_unpause
|
||||||
|
|
||||||
|
> container_unpause(id)
|
||||||
|
Unpause a container
|
||||||
|
|
||||||
|
Resume a container which has been paused.
|
||||||
|
|
||||||
|
### Parameters
|
||||||
|
|
||||||
|
|
||||||
|
Name | Type | Description | Required | Notes
|
||||||
|
------------- | ------------- | ------------- | ------------- | -------------
|
||||||
|
**id** | **String** | ID or name of the container | [required] |
|
||||||
|
|
||||||
|
### Return type
|
||||||
|
|
||||||
|
(empty response body)
|
||||||
|
|
||||||
|
### Authorization
|
||||||
|
|
||||||
|
No authorization required
|
||||||
|
|
||||||
|
### HTTP request headers
|
||||||
|
|
||||||
|
- **Content-Type**: Not defined
|
||||||
|
- **Accept**: application/json, text/plain
|
||||||
|
|
||||||
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||||
|
|
||||||
|
|
||||||
|
## container_update
|
||||||
|
|
||||||
|
> models::ContainerUpdateResponse container_update(id, update)
|
||||||
|
Update a container
|
||||||
|
|
||||||
|
Change various configuration options of a container without having to recreate it.
|
||||||
|
|
||||||
|
### Parameters
|
||||||
|
|
||||||
|
|
||||||
|
Name | Type | Description | Required | Notes
|
||||||
|
------------- | ------------- | ------------- | ------------- | -------------
|
||||||
|
**id** | **String** | ID or name of the container | [required] |
|
||||||
|
**update** | [**ContainerUpdateRequest**](ContainerUpdateRequest.md) | | [required] |
|
||||||
|
|
||||||
|
### Return type
|
||||||
|
|
||||||
|
[**models::ContainerUpdateResponse**](ContainerUpdateResponse.md)
|
||||||
|
|
||||||
|
### Authorization
|
||||||
|
|
||||||
|
No authorization required
|
||||||
|
|
||||||
|
### HTTP request headers
|
||||||
|
|
||||||
|
- **Content-Type**: application/json
|
||||||
|
- **Accept**: application/json
|
||||||
|
|
||||||
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||||
|
|
||||||
|
|
||||||
|
## container_wait
|
||||||
|
|
||||||
|
> models::ContainerWaitResponse container_wait(id, condition)
|
||||||
|
Wait for a container
|
||||||
|
|
||||||
|
Block until a container stops, then returns the exit code.
|
||||||
|
|
||||||
|
### Parameters
|
||||||
|
|
||||||
|
|
||||||
|
Name | Type | Description | Required | Notes
|
||||||
|
------------- | ------------- | ------------- | ------------- | -------------
|
||||||
|
**id** | **String** | ID or name of the container | [required] |
|
||||||
|
**condition** | Option<**String**> | Wait until a container state reaches the given condition. Defaults to `not-running` if omitted or empty. | |[default to not-running]
|
||||||
|
|
||||||
|
### Return type
|
||||||
|
|
||||||
|
[**models::ContainerWaitResponse**](ContainerWaitResponse.md)
|
||||||
|
|
||||||
|
### Authorization
|
||||||
|
|
||||||
|
No authorization required
|
||||||
|
|
||||||
|
### HTTP request headers
|
||||||
|
|
||||||
|
- **Content-Type**: Not defined
|
||||||
|
- **Accept**: application/json
|
||||||
|
|
||||||
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||||
|
|
||||||
|
|
||||||
|
## put_container_archive
|
||||||
|
|
||||||
|
> put_container_archive(id, path, input_stream, no_overwrite_dir_non_dir, copy_uidgid)
|
||||||
|
Extract an archive of files or folders to a directory in a container
|
||||||
|
|
||||||
|
Upload a tar archive to be extracted to a path in the filesystem of container id. `path` parameter is asserted to be a directory. If it exists as a file, 400 error will be returned with message \"not a directory\".
|
||||||
|
|
||||||
|
### Parameters
|
||||||
|
|
||||||
|
|
||||||
|
Name | Type | Description | Required | Notes
|
||||||
|
------------- | ------------- | ------------- | ------------- | -------------
|
||||||
|
**id** | **String** | ID or name of the container | [required] |
|
||||||
|
**path** | **String** | Path to a directory in the container to extract the archive’s contents into. | [required] |
|
||||||
|
**input_stream** | **std::path::PathBuf** | The input stream must be a tar archive compressed with one of the following algorithms: `identity` (no compression), `gzip`, `bzip2`, or `xz`. | [required] |
|
||||||
|
**no_overwrite_dir_non_dir** | Option<**String**> | If `1`, `true`, or `True` then it will be an error if unpacking the given content would cause an existing directory to be replaced with a non-directory and vice versa. | |
|
||||||
|
**copy_uidgid** | Option<**String**> | If `1`, `true`, then it will copy UID/GID maps to the dest file or dir | |
|
||||||
|
|
||||||
|
### Return type
|
||||||
|
|
||||||
|
(empty response body)
|
||||||
|
|
||||||
|
### Authorization
|
||||||
|
|
||||||
|
No authorization required
|
||||||
|
|
||||||
|
### HTTP request headers
|
||||||
|
|
||||||
|
- **Content-Type**: application/x-tar, application/octet-stream
|
||||||
|
- **Accept**: application/json, text/plain
|
||||||
|
|
||||||
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||||
|
|
||||||
14
docs/ContainerBlkioStatEntry.md
Normal file
14
docs/ContainerBlkioStatEntry.md
Normal file
|
|
@ -0,0 +1,14 @@
|
||||||
|
# ContainerBlkioStatEntry
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
**major** | Option<**i32**> | | [optional]
|
||||||
|
**minor** | Option<**i32**> | | [optional]
|
||||||
|
**op** | Option<**String**> | | [optional]
|
||||||
|
**value** | Option<**i32**> | | [optional]
|
||||||
|
|
||||||
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||||
|
|
||||||
|
|
||||||
18
docs/ContainerBlkioStats.md
Normal file
18
docs/ContainerBlkioStats.md
Normal file
|
|
@ -0,0 +1,18 @@
|
||||||
|
# ContainerBlkioStats
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
**io_service_bytes_recursive** | Option<[**Vec<models::ContainerBlkioStatEntry>**](ContainerBlkioStatEntry.md)> | | [optional]
|
||||||
|
**io_serviced_recursive** | Option<[**Vec<models::ContainerBlkioStatEntry>**](ContainerBlkioStatEntry.md)> | This field is only available when using Linux containers with cgroups v1. It is omitted or `null` when using cgroups v2. | [optional]
|
||||||
|
**io_queue_recursive** | Option<[**Vec<models::ContainerBlkioStatEntry>**](ContainerBlkioStatEntry.md)> | This field is only available when using Linux containers with cgroups v1. It is omitted or `null` when using cgroups v2. | [optional]
|
||||||
|
**io_service_time_recursive** | Option<[**Vec<models::ContainerBlkioStatEntry>**](ContainerBlkioStatEntry.md)> | This field is only available when using Linux containers with cgroups v1. It is omitted or `null` when using cgroups v2. | [optional]
|
||||||
|
**io_wait_time_recursive** | Option<[**Vec<models::ContainerBlkioStatEntry>**](ContainerBlkioStatEntry.md)> | This field is only available when using Linux containers with cgroups v1. It is omitted or `null` when using cgroups v2. | [optional]
|
||||||
|
**io_merged_recursive** | Option<[**Vec<models::ContainerBlkioStatEntry>**](ContainerBlkioStatEntry.md)> | This field is only available when using Linux containers with cgroups v1. It is omitted or `null` when using cgroups v2. | [optional]
|
||||||
|
**io_time_recursive** | Option<[**Vec<models::ContainerBlkioStatEntry>**](ContainerBlkioStatEntry.md)> | This field is only available when using Linux containers with cgroups v1. It is omitted or `null` when using cgroups v2. | [optional]
|
||||||
|
**sectors_recursive** | Option<[**Vec<models::ContainerBlkioStatEntry>**](ContainerBlkioStatEntry.md)> | This field is only available when using Linux containers with cgroups v1. It is omitted or `null` when using cgroups v2. | [optional]
|
||||||
|
|
||||||
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||||
|
|
||||||
|
|
||||||
35
docs/ContainerConfig.md
Normal file
35
docs/ContainerConfig.md
Normal file
|
|
@ -0,0 +1,35 @@
|
||||||
|
# ContainerConfig
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
**hostname** | Option<**String**> | The hostname to use for the container, as a valid RFC 1123 hostname. | [optional]
|
||||||
|
**domainname** | Option<**String**> | The domain name to use for the container. | [optional]
|
||||||
|
**user** | Option<**String**> | Commands run as this user inside the container. If omitted, commands run as the user specified in the image the container was started from. Can be either user-name or UID, and optional group-name or GID, separated by a colon (`<user-name|UID>[<:group-name|GID>]`). | [optional]
|
||||||
|
**attach_stdin** | Option<**bool**> | Whether to attach to `stdin`. | [optional][default to false]
|
||||||
|
**attach_stdout** | Option<**bool**> | Whether to attach to `stdout`. | [optional][default to true]
|
||||||
|
**attach_stderr** | Option<**bool**> | Whether to attach to `stderr`. | [optional][default to true]
|
||||||
|
**exposed_ports** | Option<[**std::collections::HashMap<String, serde_json::Value>**](serde_json::Value.md)> | An object mapping ports to an empty object in the form: `{\"<port>/<tcp|udp|sctp>\": {}}` | [optional]
|
||||||
|
**tty** | Option<**bool**> | Attach standard streams to a TTY, including `stdin` if it is not closed. | [optional][default to false]
|
||||||
|
**open_stdin** | Option<**bool**> | Open `stdin` | [optional][default to false]
|
||||||
|
**stdin_once** | Option<**bool**> | Close `stdin` after one attached client disconnects | [optional][default to false]
|
||||||
|
**env** | Option<**Vec<String>**> | A list of environment variables to set inside the container in the form `[\"VAR=value\", ...]`. A variable without `=` is removed from the environment, rather than to have an empty value. | [optional]
|
||||||
|
**cmd** | Option<**Vec<String>**> | Command to run specified as a string or an array of strings. | [optional]
|
||||||
|
**healthcheck** | Option<[**models::HealthConfig**](HealthConfig.md)> | | [optional]
|
||||||
|
**args_escaped** | Option<**bool**> | Command is already escaped (Windows only) | [optional][default to false]
|
||||||
|
**image** | Option<**String**> | The name (or reference) of the image to use when creating the container, or which was used when the container was created. | [optional]
|
||||||
|
**volumes** | Option<[**std::collections::HashMap<String, serde_json::Value>**](serde_json::Value.md)> | An object mapping mount point paths inside the container to empty objects. | [optional]
|
||||||
|
**working_dir** | Option<**String**> | The working directory for commands to run in. | [optional]
|
||||||
|
**entrypoint** | Option<**Vec<String>**> | The entry point for the container as a string or an array of strings. If the array consists of exactly one empty string (`[\"\"]`) then the entry point is reset to system default (i.e., the entry point used by docker when there is no `ENTRYPOINT` instruction in the `Dockerfile`). | [optional]
|
||||||
|
**network_disabled** | Option<**bool**> | Disable networking for the container. | [optional]
|
||||||
|
**mac_address** | Option<**String**> | MAC address of the container. Deprecated: this field is deprecated in API v1.44 and up. Use EndpointSettings.MacAddress instead. | [optional]
|
||||||
|
**on_build** | Option<**Vec<String>**> | `ONBUILD` metadata that were defined in the image's `Dockerfile`. | [optional]
|
||||||
|
**labels** | Option<**std::collections::HashMap<String, String>**> | User-defined key/value metadata. | [optional]
|
||||||
|
**stop_signal** | Option<**String**> | Signal to stop a container as a string or unsigned integer. | [optional]
|
||||||
|
**stop_timeout** | Option<**i32**> | Timeout to stop a container in seconds. | [optional]
|
||||||
|
**shell** | Option<**Vec<String>**> | Shell for when `RUN`, `CMD`, and `ENTRYPOINT` uses a shell. | [optional]
|
||||||
|
|
||||||
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||||
|
|
||||||
|
|
||||||
14
docs/ContainerCpuStats.md
Normal file
14
docs/ContainerCpuStats.md
Normal file
|
|
@ -0,0 +1,14 @@
|
||||||
|
# ContainerCpuStats
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
**cpu_usage** | Option<[**models::ContainerCpuUsage**](ContainerCPUUsage.md)> | | [optional]
|
||||||
|
**system_cpu_usage** | Option<**i32**> | System Usage. This field is Linux-specific and omitted for Windows containers. | [optional]
|
||||||
|
**online_cpus** | Option<**i32**> | Number of online CPUs. This field is Linux-specific and omitted for Windows containers. | [optional]
|
||||||
|
**throttling_data** | Option<[**models::ContainerThrottlingData**](ContainerThrottlingData.md)> | | [optional]
|
||||||
|
|
||||||
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||||
|
|
||||||
|
|
||||||
14
docs/ContainerCpuUsage.md
Normal file
14
docs/ContainerCpuUsage.md
Normal file
|
|
@ -0,0 +1,14 @@
|
||||||
|
# ContainerCpuUsage
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
**total_usage** | Option<**i32**> | Total CPU time consumed in nanoseconds (Linux) or 100's of nanoseconds (Windows). | [optional]
|
||||||
|
**percpu_usage** | Option<**Vec<i32>**> | Total CPU time (in nanoseconds) consumed per core (Linux). This field is Linux-specific when using cgroups v1. It is omitted when using cgroups v2 and Windows containers. | [optional]
|
||||||
|
**usage_in_kernelmode** | Option<**i32**> | Time (in nanoseconds) spent by tasks of the cgroup in kernel mode (Linux), or time spent (in 100's of nanoseconds) by all container processes in kernel mode (Windows). Not populated for Windows containers using Hyper-V isolation. | [optional]
|
||||||
|
**usage_in_usermode** | Option<**i32**> | Time (in nanoseconds) spent by tasks of the cgroup in user mode (Linux), or time spent (in 100's of nanoseconds) by all container processes in kernel mode (Windows). Not populated for Windows containers using Hyper-V isolation. | [optional]
|
||||||
|
|
||||||
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||||
|
|
||||||
|
|
||||||
37
docs/ContainerCreateRequest.md
Normal file
37
docs/ContainerCreateRequest.md
Normal file
|
|
@ -0,0 +1,37 @@
|
||||||
|
# ContainerCreateRequest
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
**hostname** | Option<**String**> | The hostname to use for the container, as a valid RFC 1123 hostname. | [optional]
|
||||||
|
**domainname** | Option<**String**> | The domain name to use for the container. | [optional]
|
||||||
|
**user** | Option<**String**> | Commands run as this user inside the container. If omitted, commands run as the user specified in the image the container was started from. Can be either user-name or UID, and optional group-name or GID, separated by a colon (`<user-name|UID>[<:group-name|GID>]`). | [optional]
|
||||||
|
**attach_stdin** | Option<**bool**> | Whether to attach to `stdin`. | [optional][default to false]
|
||||||
|
**attach_stdout** | Option<**bool**> | Whether to attach to `stdout`. | [optional][default to true]
|
||||||
|
**attach_stderr** | Option<**bool**> | Whether to attach to `stderr`. | [optional][default to true]
|
||||||
|
**exposed_ports** | Option<[**std::collections::HashMap<String, serde_json::Value>**](serde_json::Value.md)> | An object mapping ports to an empty object in the form: `{\"<port>/<tcp|udp|sctp>\": {}}` | [optional]
|
||||||
|
**tty** | Option<**bool**> | Attach standard streams to a TTY, including `stdin` if it is not closed. | [optional][default to false]
|
||||||
|
**open_stdin** | Option<**bool**> | Open `stdin` | [optional][default to false]
|
||||||
|
**stdin_once** | Option<**bool**> | Close `stdin` after one attached client disconnects | [optional][default to false]
|
||||||
|
**env** | Option<**Vec<String>**> | A list of environment variables to set inside the container in the form `[\"VAR=value\", ...]`. A variable without `=` is removed from the environment, rather than to have an empty value. | [optional]
|
||||||
|
**cmd** | Option<**Vec<String>**> | Command to run specified as a string or an array of strings. | [optional]
|
||||||
|
**healthcheck** | Option<[**models::HealthConfig**](HealthConfig.md)> | | [optional]
|
||||||
|
**args_escaped** | Option<**bool**> | Command is already escaped (Windows only) | [optional][default to false]
|
||||||
|
**image** | Option<**String**> | The name (or reference) of the image to use when creating the container, or which was used when the container was created. | [optional]
|
||||||
|
**volumes** | Option<[**std::collections::HashMap<String, serde_json::Value>**](serde_json::Value.md)> | An object mapping mount point paths inside the container to empty objects. | [optional]
|
||||||
|
**working_dir** | Option<**String**> | The working directory for commands to run in. | [optional]
|
||||||
|
**entrypoint** | Option<**Vec<String>**> | The entry point for the container as a string or an array of strings. If the array consists of exactly one empty string (`[\"\"]`) then the entry point is reset to system default (i.e., the entry point used by docker when there is no `ENTRYPOINT` instruction in the `Dockerfile`). | [optional]
|
||||||
|
**network_disabled** | Option<**bool**> | Disable networking for the container. | [optional]
|
||||||
|
**mac_address** | Option<**String**> | MAC address of the container. Deprecated: this field is deprecated in API v1.44 and up. Use EndpointSettings.MacAddress instead. | [optional]
|
||||||
|
**on_build** | Option<**Vec<String>**> | `ONBUILD` metadata that were defined in the image's `Dockerfile`. | [optional]
|
||||||
|
**labels** | Option<**std::collections::HashMap<String, String>**> | User-defined key/value metadata. | [optional]
|
||||||
|
**stop_signal** | Option<**String**> | Signal to stop a container as a string or unsigned integer. | [optional]
|
||||||
|
**stop_timeout** | Option<**i32**> | Timeout to stop a container in seconds. | [optional]
|
||||||
|
**shell** | Option<**Vec<String>**> | Shell for when `RUN`, `CMD`, and `ENTRYPOINT` uses a shell. | [optional]
|
||||||
|
**host_config** | Option<[**models::HostConfig**](HostConfig.md)> | | [optional]
|
||||||
|
**networking_config** | Option<[**models::NetworkingConfig**](NetworkingConfig.md)> | | [optional]
|
||||||
|
|
||||||
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||||
|
|
||||||
|
|
||||||
12
docs/ContainerCreateResponse.md
Normal file
12
docs/ContainerCreateResponse.md
Normal file
|
|
@ -0,0 +1,12 @@
|
||||||
|
# ContainerCreateResponse
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
**id** | **String** | The ID of the created container |
|
||||||
|
**warnings** | **Vec<String>** | Warnings encountered when creating the container |
|
||||||
|
|
||||||
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||||
|
|
||||||
|
|
||||||
36
docs/ContainerInspectResponse.md
Normal file
36
docs/ContainerInspectResponse.md
Normal file
|
|
@ -0,0 +1,36 @@
|
||||||
|
# ContainerInspectResponse
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
**id** | Option<**String**> | The ID of this container as a 128-bit (64-character) hexadecimal string (32 bytes). | [optional]
|
||||||
|
**created** | Option<**String**> | Date and time at which the container was created, formatted in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. | [optional]
|
||||||
|
**path** | Option<**String**> | The path to the command being run | [optional]
|
||||||
|
**args** | Option<**Vec<String>**> | The arguments to the command being run | [optional]
|
||||||
|
**state** | Option<[**models::ContainerState**](ContainerState.md)> | | [optional]
|
||||||
|
**image** | Option<**String**> | The ID (digest) of the image that this container was created from. | [optional]
|
||||||
|
**resolv_conf_path** | Option<**String**> | Location of the `/etc/resolv.conf` generated for the container on the host. This file is managed through the docker daemon, and should not be accessed or modified by other tools. | [optional]
|
||||||
|
**hostname_path** | Option<**String**> | Location of the `/etc/hostname` generated for the container on the host. This file is managed through the docker daemon, and should not be accessed or modified by other tools. | [optional]
|
||||||
|
**hosts_path** | Option<**String**> | Location of the `/etc/hosts` generated for the container on the host. This file is managed through the docker daemon, and should not be accessed or modified by other tools. | [optional]
|
||||||
|
**log_path** | Option<**String**> | Location of the file used to buffer the container's logs. Depending on the logging-driver used for the container, this field may be omitted. This file is managed through the docker daemon, and should not be accessed or modified by other tools. | [optional]
|
||||||
|
**name** | Option<**String**> | The name associated with this container. For historic reasons, the name may be prefixed with a forward-slash (`/`). | [optional]
|
||||||
|
**restart_count** | Option<**i32**> | Number of times the container was restarted since it was created, or since daemon was started. | [optional]
|
||||||
|
**driver** | Option<**String**> | The storage-driver used for the container's filesystem (graph-driver or snapshotter). | [optional]
|
||||||
|
**platform** | Option<**String**> | The platform (operating system) for which the container was created. This field was introduced for the experimental \"LCOW\" (Linux Containers On Windows) features, which has been removed. In most cases, this field is equal to the host's operating system (`linux` or `windows`). | [optional]
|
||||||
|
**image_manifest_descriptor** | Option<[**models::OciDescriptor**](OCIDescriptor.md)> | | [optional]
|
||||||
|
**mount_label** | Option<**String**> | SELinux mount label set for the container. | [optional]
|
||||||
|
**process_label** | Option<**String**> | SELinux process label set for the container. | [optional]
|
||||||
|
**app_armor_profile** | Option<**String**> | The AppArmor profile set for the container. | [optional]
|
||||||
|
**exec_ids** | Option<**Vec<String>**> | IDs of exec instances that are running in the container. | [optional]
|
||||||
|
**host_config** | Option<[**models::HostConfig**](HostConfig.md)> | | [optional]
|
||||||
|
**graph_driver** | Option<[**models::DriverData**](DriverData.md)> | | [optional]
|
||||||
|
**size_rw** | Option<**i64**> | The size of files that have been created or changed by this container. This field is omitted by default, and only set when size is requested in the API request. | [optional]
|
||||||
|
**size_root_fs** | Option<**i64**> | The total size of all files in the read-only layers from the image that the container uses. These layers can be shared between containers. This field is omitted by default, and only set when size is requested in the API request. | [optional]
|
||||||
|
**mounts** | Option<[**Vec<models::MountPoint>**](MountPoint.md)> | List of mounts used by the container. | [optional]
|
||||||
|
**config** | Option<[**models::ContainerConfig**](ContainerConfig.md)> | | [optional]
|
||||||
|
**network_settings** | Option<[**models::NetworkSettings**](NetworkSettings.md)> | | [optional]
|
||||||
|
|
||||||
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||||
|
|
||||||
|
|
||||||
18
docs/ContainerMemoryStats.md
Normal file
18
docs/ContainerMemoryStats.md
Normal file
|
|
@ -0,0 +1,18 @@
|
||||||
|
# ContainerMemoryStats
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
**usage** | Option<**i32**> | Current `res_counter` usage for memory. This field is Linux-specific and omitted for Windows containers. | [optional]
|
||||||
|
**max_usage** | Option<**i32**> | Maximum usage ever recorded. This field is Linux-specific and only supported on cgroups v1. It is omitted when using cgroups v2 and for Windows containers. | [optional]
|
||||||
|
**stats** | Option<**std::collections::HashMap<String, i32>**> | All the stats exported via memory.stat. when using cgroups v2. This field is Linux-specific and omitted for Windows containers. | [optional]
|
||||||
|
**failcnt** | Option<**i32**> | Number of times memory usage hits limits. This field is Linux-specific and only supported on cgroups v1. It is omitted when using cgroups v2 and for Windows containers. | [optional]
|
||||||
|
**limit** | Option<**i32**> | This field is Linux-specific and omitted for Windows containers. | [optional]
|
||||||
|
**commitbytes** | Option<**i32**> | Committed bytes. This field is Windows-specific and omitted for Linux containers. | [optional]
|
||||||
|
**commitpeakbytes** | Option<**i32**> | Peak committed bytes. This field is Windows-specific and omitted for Linux containers. | [optional]
|
||||||
|
**privateworkingset** | Option<**i32**> | Private working set. This field is Windows-specific and omitted for Linux containers. | [optional]
|
||||||
|
|
||||||
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||||
|
|
||||||
|
|
||||||
20
docs/ContainerNetworkStats.md
Normal file
20
docs/ContainerNetworkStats.md
Normal file
|
|
@ -0,0 +1,20 @@
|
||||||
|
# ContainerNetworkStats
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
**rx_bytes** | Option<**i32**> | Bytes received. Windows and Linux. | [optional]
|
||||||
|
**rx_packets** | Option<**i32**> | Packets received. Windows and Linux. | [optional]
|
||||||
|
**rx_errors** | Option<**i32**> | Received errors. Not used on Windows. This field is Linux-specific and always zero for Windows containers. | [optional]
|
||||||
|
**rx_dropped** | Option<**i32**> | Incoming packets dropped. Windows and Linux. | [optional]
|
||||||
|
**tx_bytes** | Option<**i32**> | Bytes sent. Windows and Linux. | [optional]
|
||||||
|
**tx_packets** | Option<**i32**> | Packets sent. Windows and Linux. | [optional]
|
||||||
|
**tx_errors** | Option<**i32**> | Sent errors. Not used on Windows. This field is Linux-specific and always zero for Windows containers. | [optional]
|
||||||
|
**tx_dropped** | Option<**i32**> | Outgoing packets dropped. Windows and Linux. | [optional]
|
||||||
|
**endpoint_id** | Option<**String**> | Endpoint ID. Not used on Linux. This field is Windows-specific and omitted for Linux containers. | [optional]
|
||||||
|
**instance_id** | Option<**String**> | Instance ID. Not used on Linux. This field is Windows-specific and omitted for Linux containers. | [optional]
|
||||||
|
|
||||||
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||||
|
|
||||||
|
|
||||||
12
docs/ContainerPidsStats.md
Normal file
12
docs/ContainerPidsStats.md
Normal file
|
|
@ -0,0 +1,12 @@
|
||||||
|
# ContainerPidsStats
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
**current** | Option<**i32**> | Current is the number of PIDs in the cgroup. | [optional]
|
||||||
|
**limit** | Option<**i32**> | Limit is the hard limit on the number of pids in the cgroup. A \"Limit\" of 0 means that there is no limit. | [optional]
|
||||||
|
|
||||||
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||||
|
|
||||||
|
|
||||||
12
docs/ContainerPruneResponse.md
Normal file
12
docs/ContainerPruneResponse.md
Normal file
|
|
@ -0,0 +1,12 @@
|
||||||
|
# ContainerPruneResponse
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
**containers_deleted** | Option<**Vec<String>**> | Container IDs that were deleted | [optional]
|
||||||
|
**space_reclaimed** | Option<**i64**> | Disk space reclaimed in bytes | [optional]
|
||||||
|
|
||||||
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||||
|
|
||||||
|
|
||||||
22
docs/ContainerState.md
Normal file
22
docs/ContainerState.md
Normal file
|
|
@ -0,0 +1,22 @@
|
||||||
|
# ContainerState
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
**status** | Option<**String**> | String representation of the container state. Can be one of \"created\", \"running\", \"paused\", \"restarting\", \"removing\", \"exited\", or \"dead\". | [optional]
|
||||||
|
**running** | Option<**bool**> | Whether this container is running. Note that a running container can be _paused_. The `Running` and `Paused` booleans are not mutually exclusive: When pausing a container (on Linux), the freezer cgroup is used to suspend all processes in the container. Freezing the process requires the process to be running. As a result, paused containers are both `Running` _and_ `Paused`. Use the `Status` field instead to determine if a container's state is \"running\". | [optional]
|
||||||
|
**paused** | Option<**bool**> | Whether this container is paused. | [optional]
|
||||||
|
**restarting** | Option<**bool**> | Whether this container is restarting. | [optional]
|
||||||
|
**oom_killed** | Option<**bool**> | Whether a process within this container has been killed because it ran out of memory since the container was last started. | [optional]
|
||||||
|
**dead** | Option<**bool**> | | [optional]
|
||||||
|
**pid** | Option<**i32**> | The process ID of this container | [optional]
|
||||||
|
**exit_code** | Option<**i32**> | The last exit code of this container | [optional]
|
||||||
|
**error** | Option<**String**> | | [optional]
|
||||||
|
**started_at** | Option<**String**> | The time when this container was last started. | [optional]
|
||||||
|
**finished_at** | Option<**String**> | The time when this container last exited. | [optional]
|
||||||
|
**health** | Option<[**models::Health**](Health.md)> | | [optional]
|
||||||
|
|
||||||
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||||
|
|
||||||
|
|
||||||
22
docs/ContainerStatsResponse.md
Normal file
22
docs/ContainerStatsResponse.md
Normal file
|
|
@ -0,0 +1,22 @@
|
||||||
|
# ContainerStatsResponse
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
**name** | Option<**String**> | Name of the container | [optional]
|
||||||
|
**id** | Option<**String**> | ID of the container | [optional]
|
||||||
|
**read** | Option<**String**> | Date and time at which this sample was collected. The value is formatted as [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) with nano-seconds. | [optional]
|
||||||
|
**preread** | Option<**String**> | Date and time at which this first sample was collected. This field is not propagated if the \"one-shot\" option is set. If the \"one-shot\" option is set, this field may be omitted, empty, or set to a default date (`0001-01-01T00:00:00Z`). The value is formatted as [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) with nano-seconds. | [optional]
|
||||||
|
**pids_stats** | Option<[**models::ContainerPidsStats**](ContainerPidsStats.md)> | | [optional]
|
||||||
|
**blkio_stats** | Option<[**models::ContainerBlkioStats**](ContainerBlkioStats.md)> | | [optional]
|
||||||
|
**num_procs** | Option<**i32**> | The number of processors on the system. This field is Windows-specific and always zero for Linux containers. | [optional]
|
||||||
|
**storage_stats** | Option<[**models::ContainerStorageStats**](ContainerStorageStats.md)> | | [optional]
|
||||||
|
**cpu_stats** | Option<[**models::ContainerCpuStats**](ContainerCPUStats.md)> | | [optional]
|
||||||
|
**precpu_stats** | Option<[**models::ContainerCpuStats**](ContainerCPUStats.md)> | | [optional]
|
||||||
|
**memory_stats** | Option<[**models::ContainerMemoryStats**](ContainerMemoryStats.md)> | | [optional]
|
||||||
|
**networks** | Option<[**serde_json::Value**](.md)> | Network statistics for the container per interface. This field is omitted if the container has no networking enabled. | [optional]
|
||||||
|
|
||||||
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||||
|
|
||||||
|
|
||||||
13
docs/ContainerStatus.md
Normal file
13
docs/ContainerStatus.md
Normal file
|
|
@ -0,0 +1,13 @@
|
||||||
|
# ContainerStatus
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
**container_id** | Option<**String**> | | [optional]
|
||||||
|
**pid** | Option<**i32**> | | [optional]
|
||||||
|
**exit_code** | Option<**i32**> | | [optional]
|
||||||
|
|
||||||
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||||
|
|
||||||
|
|
||||||
14
docs/ContainerStorageStats.md
Normal file
14
docs/ContainerStorageStats.md
Normal file
|
|
@ -0,0 +1,14 @@
|
||||||
|
# ContainerStorageStats
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
**read_count_normalized** | Option<**i32**> | | [optional]
|
||||||
|
**read_size_bytes** | Option<**i32**> | | [optional]
|
||||||
|
**write_count_normalized** | Option<**i32**> | | [optional]
|
||||||
|
**write_size_bytes** | Option<**i32**> | | [optional]
|
||||||
|
|
||||||
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||||
|
|
||||||
|
|
||||||
26
docs/ContainerSummary.md
Normal file
26
docs/ContainerSummary.md
Normal file
|
|
@ -0,0 +1,26 @@
|
||||||
|
# ContainerSummary
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
**id** | Option<**String**> | The ID of this container as a 128-bit (64-character) hexadecimal string (32 bytes). | [optional]
|
||||||
|
**names** | Option<**Vec<String>**> | The names associated with this container. Most containers have a single name, but when using legacy \"links\", the container can have multiple names. For historic reasons, names are prefixed with a forward-slash (`/`). | [optional]
|
||||||
|
**image** | Option<**String**> | The name or ID of the image used to create the container. This field shows the image reference as was specified when creating the container, which can be in its canonical form (e.g., `docker.io/library/ubuntu:latest` or `docker.io/library/ubuntu@sha256:72297848456d5d37d1262630108ab308d3e9ec7ed1c3286a32fe09856619a782`), short form (e.g., `ubuntu:latest`)), or the ID(-prefix) of the image (e.g., `72297848456d`). The content of this field can be updated at runtime if the image used to create the container is untagged, in which case the field is updated to contain the the image ID (digest) it was resolved to in its canonical, non-truncated form (e.g., `sha256:72297848456d5d37d1262630108ab308d3e9ec7ed1c3286a32fe09856619a782`). | [optional]
|
||||||
|
**image_id** | Option<**String**> | The ID (digest) of the image that this container was created from. | [optional]
|
||||||
|
**image_manifest_descriptor** | Option<[**models::OciDescriptor**](OCIDescriptor.md)> | | [optional]
|
||||||
|
**command** | Option<**String**> | Command to run when starting the container | [optional]
|
||||||
|
**created** | Option<**i64**> | Date and time at which the container was created as a Unix timestamp (number of seconds since EPOCH). | [optional]
|
||||||
|
**ports** | Option<[**Vec<models::Port>**](Port.md)> | Port-mappings for the container. | [optional]
|
||||||
|
**size_rw** | Option<**i64**> | The size of files that have been created or changed by this container. This field is omitted by default, and only set when size is requested in the API request. | [optional]
|
||||||
|
**size_root_fs** | Option<**i64**> | The total size of all files in the read-only layers from the image that the container uses. These layers can be shared between containers. This field is omitted by default, and only set when size is requested in the API request. | [optional]
|
||||||
|
**labels** | Option<**std::collections::HashMap<String, String>**> | User-defined key/value metadata. | [optional]
|
||||||
|
**state** | Option<**String**> | The state of this container. | [optional]
|
||||||
|
**status** | Option<**String**> | Additional human-readable status of this container (e.g. `Exit 0`) | [optional]
|
||||||
|
**host_config** | Option<[**models::ContainerSummaryHostConfig**](ContainerSummary_HostConfig.md)> | | [optional]
|
||||||
|
**network_settings** | Option<[**models::ContainerSummaryNetworkSettings**](ContainerSummary_NetworkSettings.md)> | | [optional]
|
||||||
|
**mounts** | Option<[**Vec<models::MountPoint>**](MountPoint.md)> | List of mounts used by the container. | [optional]
|
||||||
|
|
||||||
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||||
|
|
||||||
|
|
||||||
12
docs/ContainerSummaryHostConfig.md
Normal file
12
docs/ContainerSummaryHostConfig.md
Normal file
|
|
@ -0,0 +1,12 @@
|
||||||
|
# ContainerSummaryHostConfig
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
**network_mode** | Option<**String**> | Networking mode (`host`, `none`, `container:<id>`) or name of the primary network the container is using. This field is primarily for backward compatibility. The container can be connected to multiple networks for which information can be found in the `NetworkSettings.Networks` field, which enumerates settings per network. | [optional]
|
||||||
|
**annotations** | Option<**std::collections::HashMap<String, String>**> | Arbitrary key-value metadata attached to the container. | [optional]
|
||||||
|
|
||||||
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||||
|
|
||||||
|
|
||||||
11
docs/ContainerSummaryNetworkSettings.md
Normal file
11
docs/ContainerSummaryNetworkSettings.md
Normal file
|
|
@ -0,0 +1,11 @@
|
||||||
|
# ContainerSummaryNetworkSettings
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
**networks** | Option<[**std::collections::HashMap<String, models::EndpointSettings>**](EndpointSettings.md)> | Summary of network-settings for each network the container is attached to. | [optional]
|
||||||
|
|
||||||
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||||
|
|
||||||
|
|
||||||
13
docs/ContainerThrottlingData.md
Normal file
13
docs/ContainerThrottlingData.md
Normal file
|
|
@ -0,0 +1,13 @@
|
||||||
|
# ContainerThrottlingData
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
**periods** | Option<**i32**> | Number of periods with throttling active. | [optional]
|
||||||
|
**throttled_periods** | Option<**i32**> | Number of periods when the container hit its throttling limit. | [optional]
|
||||||
|
**throttled_time** | Option<**i32**> | Aggregated time (in nanoseconds) the container was throttled for. | [optional]
|
||||||
|
|
||||||
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||||
|
|
||||||
|
|
||||||
12
docs/ContainerTopResponse.md
Normal file
12
docs/ContainerTopResponse.md
Normal file
|
|
@ -0,0 +1,12 @@
|
||||||
|
# ContainerTopResponse
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
**titles** | Option<**Vec<String>**> | The ps column titles | [optional]
|
||||||
|
**processes** | Option<[**Vec<Vec<String>>**](Vec.md)> | Each process running in the container, where each process is an array of values corresponding to the titles. | [optional]
|
||||||
|
|
||||||
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||||
|
|
||||||
|
|
||||||
42
docs/ContainerUpdateRequest.md
Normal file
42
docs/ContainerUpdateRequest.md
Normal file
|
|
@ -0,0 +1,42 @@
|
||||||
|
# ContainerUpdateRequest
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
**cpu_shares** | Option<**i32**> | An integer value representing this container's relative CPU weight versus other containers. | [optional]
|
||||||
|
**memory** | Option<**i64**> | Memory limit in bytes. | [optional][default to 0]
|
||||||
|
**cgroup_parent** | Option<**String**> | Path to `cgroups` under which the container's `cgroup` is created. If the path is not absolute, the path is considered to be relative to the `cgroups` path of the init process. Cgroups are created if they do not already exist. | [optional]
|
||||||
|
**blkio_weight** | Option<**i32**> | Block IO weight (relative weight). | [optional]
|
||||||
|
**blkio_weight_device** | Option<[**Vec<models::ResourcesBlkioWeightDeviceInner>**](Resources_BlkioWeightDevice_inner.md)> | Block IO weight (relative device weight) in the form: ``` [{\"Path\": \"device_path\", \"Weight\": weight}] ``` | [optional]
|
||||||
|
**blkio_device_read_bps** | Option<[**Vec<models::ThrottleDevice>**](ThrottleDevice.md)> | Limit read rate (bytes per second) from a device, in the form: ``` [{\"Path\": \"device_path\", \"Rate\": rate}] ``` | [optional]
|
||||||
|
**blkio_device_write_bps** | Option<[**Vec<models::ThrottleDevice>**](ThrottleDevice.md)> | Limit write rate (bytes per second) to a device, in the form: ``` [{\"Path\": \"device_path\", \"Rate\": rate}] ``` | [optional]
|
||||||
|
**blkio_device_read_i_ops** | Option<[**Vec<models::ThrottleDevice>**](ThrottleDevice.md)> | Limit read rate (IO per second) from a device, in the form: ``` [{\"Path\": \"device_path\", \"Rate\": rate}] ``` | [optional]
|
||||||
|
**blkio_device_write_i_ops** | Option<[**Vec<models::ThrottleDevice>**](ThrottleDevice.md)> | Limit write rate (IO per second) to a device, in the form: ``` [{\"Path\": \"device_path\", \"Rate\": rate}] ``` | [optional]
|
||||||
|
**cpu_period** | Option<**i64**> | The length of a CPU period in microseconds. | [optional]
|
||||||
|
**cpu_quota** | Option<**i64**> | Microseconds of CPU time that the container can get in a CPU period. | [optional]
|
||||||
|
**cpu_realtime_period** | Option<**i64**> | The length of a CPU real-time period in microseconds. Set to 0 to allocate no time allocated to real-time tasks. | [optional]
|
||||||
|
**cpu_realtime_runtime** | Option<**i64**> | The length of a CPU real-time runtime in microseconds. Set to 0 to allocate no time allocated to real-time tasks. | [optional]
|
||||||
|
**cpuset_cpus** | Option<**String**> | CPUs in which to allow execution (e.g., `0-3`, `0,1`). | [optional]
|
||||||
|
**cpuset_mems** | Option<**String**> | Memory nodes (MEMs) in which to allow execution (0-3, 0,1). Only effective on NUMA systems. | [optional]
|
||||||
|
**devices** | Option<[**Vec<models::DeviceMapping>**](DeviceMapping.md)> | A list of devices to add to the container. | [optional]
|
||||||
|
**device_cgroup_rules** | Option<**Vec<String>**> | a list of cgroup rules to apply to the container | [optional]
|
||||||
|
**device_requests** | Option<[**Vec<models::DeviceRequest>**](DeviceRequest.md)> | A list of requests for devices to be sent to device drivers. | [optional]
|
||||||
|
**kernel_memory_tcp** | Option<**i64**> | Hard limit for kernel TCP buffer memory (in bytes). Depending on the OCI runtime in use, this option may be ignored. It is no longer supported by the default (runc) runtime. This field is omitted when empty. | [optional]
|
||||||
|
**memory_reservation** | Option<**i64**> | Memory soft limit in bytes. | [optional]
|
||||||
|
**memory_swap** | Option<**i64**> | Total memory limit (memory + swap). Set as `-1` to enable unlimited swap. | [optional]
|
||||||
|
**memory_swappiness** | Option<**i64**> | Tune a container's memory swappiness behavior. Accepts an integer between 0 and 100. | [optional]
|
||||||
|
**nano_cpus** | Option<**i64**> | CPU quota in units of 10<sup>-9</sup> CPUs. | [optional]
|
||||||
|
**oom_kill_disable** | Option<**bool**> | Disable OOM Killer for the container. | [optional]
|
||||||
|
**init** | Option<**bool**> | Run an init inside the container that forwards signals and reaps processes. This field is omitted if empty, and the default (as configured on the daemon) is used. | [optional]
|
||||||
|
**pids_limit** | Option<**i64**> | Tune a container's PIDs limit. Set `0` or `-1` for unlimited, or `null` to not change. | [optional]
|
||||||
|
**ulimits** | Option<[**Vec<models::ResourcesUlimitsInner>**](Resources_Ulimits_inner.md)> | A list of resource limits to set in the container. For example: ``` {\"Name\": \"nofile\", \"Soft\": 1024, \"Hard\": 2048} ``` | [optional]
|
||||||
|
**cpu_count** | Option<**i64**> | The number of usable CPUs (Windows only). On Windows Server containers, the processor resource controls are mutually exclusive. The order of precedence is `CPUCount` first, then `CPUShares`, and `CPUPercent` last. | [optional]
|
||||||
|
**cpu_percent** | Option<**i64**> | The usable percentage of the available CPUs (Windows only). On Windows Server containers, the processor resource controls are mutually exclusive. The order of precedence is `CPUCount` first, then `CPUShares`, and `CPUPercent` last. | [optional]
|
||||||
|
**io_maximum_i_ops** | Option<**i64**> | Maximum IOps for the container system drive (Windows only) | [optional]
|
||||||
|
**io_maximum_bandwidth** | Option<**i64**> | Maximum IO in bytes per second for the container system drive (Windows only). | [optional]
|
||||||
|
**restart_policy** | Option<[**models::RestartPolicy**](RestartPolicy.md)> | | [optional]
|
||||||
|
|
||||||
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||||
|
|
||||||
|
|
||||||
11
docs/ContainerUpdateResponse.md
Normal file
11
docs/ContainerUpdateResponse.md
Normal file
|
|
@ -0,0 +1,11 @@
|
||||||
|
# ContainerUpdateResponse
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
**warnings** | Option<**Vec<String>**> | Warnings encountered when updating the container. | [optional]
|
||||||
|
|
||||||
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||||
|
|
||||||
|
|
||||||
11
docs/ContainerWaitExitError.md
Normal file
11
docs/ContainerWaitExitError.md
Normal file
|
|
@ -0,0 +1,11 @@
|
||||||
|
# ContainerWaitExitError
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
**message** | Option<**String**> | Details of an error | [optional]
|
||||||
|
|
||||||
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||||
|
|
||||||
|
|
||||||
12
docs/ContainerWaitResponse.md
Normal file
12
docs/ContainerWaitResponse.md
Normal file
|
|
@ -0,0 +1,12 @@
|
||||||
|
# ContainerWaitResponse
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
**status_code** | **i64** | Exit code of the container |
|
||||||
|
**error** | Option<[**models::ContainerWaitExitError**](ContainerWaitExitError.md)> | | [optional]
|
||||||
|
|
||||||
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||||
|
|
||||||
|
|
||||||
12
docs/ContainerdInfo.md
Normal file
12
docs/ContainerdInfo.md
Normal file
|
|
@ -0,0 +1,12 @@
|
||||||
|
# ContainerdInfo
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
**address** | Option<**String**> | The address of the containerd socket. | [optional]
|
||||||
|
**namespaces** | Option<[**models::ContainerdInfoNamespaces**](ContainerdInfo_Namespaces.md)> | | [optional]
|
||||||
|
|
||||||
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||||
|
|
||||||
|
|
||||||
12
docs/ContainerdInfoNamespaces.md
Normal file
12
docs/ContainerdInfoNamespaces.md
Normal file
|
|
@ -0,0 +1,12 @@
|
||||||
|
# ContainerdInfoNamespaces
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
**containers** | Option<**String**> | The default containerd namespace used for containers managed by the daemon. The default namespace for containers is \"moby\", but will be suffixed with the `<uid>.<gid>` of the remapped `root` if user-namespaces are enabled and the containerd image-store is used. | [optional][default to moby]
|
||||||
|
**plugins** | Option<**String**> | The default containerd namespace used for plugins managed by the daemon. The default namespace for plugins is \"plugins.moby\", but will be suffixed with the `<uid>.<gid>` of the remapped `root` if user-namespaces are enabled and the containerd image-store is used. | [optional][default to plugins.moby]
|
||||||
|
|
||||||
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||||
|
|
||||||
|
|
||||||
16
docs/CreateImageInfo.md
Normal file
16
docs/CreateImageInfo.md
Normal file
|
|
@ -0,0 +1,16 @@
|
||||||
|
# CreateImageInfo
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
**id** | Option<**String**> | | [optional]
|
||||||
|
**error** | Option<**String**> | errors encountered during the operation. > **Deprecated**: This field is deprecated since API v1.4, and will be omitted in a future API version. Use the information in errorDetail instead. | [optional]
|
||||||
|
**error_detail** | Option<[**models::ErrorDetail**](ErrorDetail.md)> | | [optional]
|
||||||
|
**status** | Option<**String**> | | [optional]
|
||||||
|
**progress** | Option<**String**> | Progress is a pre-formatted presentation of progressDetail. > **Deprecated**: This field is deprecated since API v1.8, and will be omitted in a future API version. Use the information in progressDetail instead. | [optional]
|
||||||
|
**progress_detail** | Option<[**models::ProgressDetail**](ProgressDetail.md)> | | [optional]
|
||||||
|
|
||||||
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||||
|
|
||||||
|
|
||||||
12
docs/DeviceInfo.md
Normal file
12
docs/DeviceInfo.md
Normal file
|
|
@ -0,0 +1,12 @@
|
||||||
|
# DeviceInfo
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
**source** | Option<**String**> | The origin device driver. | [optional]
|
||||||
|
**id** | Option<**String**> | The unique identifier for the device within its source driver. For CDI devices, this would be an FQDN like \"vendor.com/gpu=0\". | [optional]
|
||||||
|
|
||||||
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||||
|
|
||||||
|
|
||||||
13
docs/DeviceMapping.md
Normal file
13
docs/DeviceMapping.md
Normal file
|
|
@ -0,0 +1,13 @@
|
||||||
|
# DeviceMapping
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
**path_on_host** | Option<**String**> | | [optional]
|
||||||
|
**path_in_container** | Option<**String**> | | [optional]
|
||||||
|
**cgroup_permissions** | Option<**String**> | | [optional]
|
||||||
|
|
||||||
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||||
|
|
||||||
|
|
||||||
15
docs/DeviceRequest.md
Normal file
15
docs/DeviceRequest.md
Normal file
|
|
@ -0,0 +1,15 @@
|
||||||
|
# DeviceRequest
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
**driver** | Option<**String**> | | [optional]
|
||||||
|
**count** | Option<**i32**> | | [optional]
|
||||||
|
**device_ids** | Option<**Vec<String>**> | | [optional]
|
||||||
|
**capabilities** | Option<[**Vec<Vec<String>>**](Vec.md)> | A list of capabilities; an OR list of AND lists of capabilities. | [optional]
|
||||||
|
**options** | Option<**std::collections::HashMap<String, String>**> | Driver-specific options, specified as a key/value pairs. These options are passed directly to the driver. | [optional]
|
||||||
|
|
||||||
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||||
|
|
||||||
|
|
||||||
39
docs/DistributionApi.md
Normal file
39
docs/DistributionApi.md
Normal file
|
|
@ -0,0 +1,39 @@
|
||||||
|
# \DistributionApi
|
||||||
|
|
||||||
|
All URIs are relative to *http://localhost/v1.51*
|
||||||
|
|
||||||
|
Method | HTTP request | Description
|
||||||
|
------------- | ------------- | -------------
|
||||||
|
[**distribution_inspect**](DistributionApi.md#distribution_inspect) | **GET** /distribution/{name}/json | Get image information from the registry
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## distribution_inspect
|
||||||
|
|
||||||
|
> models::DistributionInspect distribution_inspect(name)
|
||||||
|
Get image information from the registry
|
||||||
|
|
||||||
|
Return image digest and platform information by contacting the registry.
|
||||||
|
|
||||||
|
### Parameters
|
||||||
|
|
||||||
|
|
||||||
|
Name | Type | Description | Required | Notes
|
||||||
|
------------- | ------------- | ------------- | ------------- | -------------
|
||||||
|
**name** | **String** | Image name or id | [required] |
|
||||||
|
|
||||||
|
### Return type
|
||||||
|
|
||||||
|
[**models::DistributionInspect**](DistributionInspect.md)
|
||||||
|
|
||||||
|
### Authorization
|
||||||
|
|
||||||
|
No authorization required
|
||||||
|
|
||||||
|
### HTTP request headers
|
||||||
|
|
||||||
|
- **Content-Type**: Not defined
|
||||||
|
- **Accept**: application/json
|
||||||
|
|
||||||
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||||
|
|
||||||
12
docs/DistributionInspect.md
Normal file
12
docs/DistributionInspect.md
Normal file
|
|
@ -0,0 +1,12 @@
|
||||||
|
# DistributionInspect
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
**descriptor** | [**models::OciDescriptor**](OCIDescriptor.md) | |
|
||||||
|
**platforms** | [**Vec<models::OciPlatform>**](OCIPlatform.md) | An array containing all platforms supported by the image. |
|
||||||
|
|
||||||
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||||
|
|
||||||
|
|
||||||
12
docs/Driver.md
Normal file
12
docs/Driver.md
Normal file
|
|
@ -0,0 +1,12 @@
|
||||||
|
# Driver
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
**name** | **String** | Name of the driver. |
|
||||||
|
**options** | Option<**std::collections::HashMap<String, String>**> | Key/value map of driver-specific options. | [optional]
|
||||||
|
|
||||||
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||||
|
|
||||||
|
|
||||||
12
docs/DriverData.md
Normal file
12
docs/DriverData.md
Normal file
|
|
@ -0,0 +1,12 @@
|
||||||
|
# DriverData
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
**name** | **String** | Name of the storage driver. |
|
||||||
|
**data** | **std::collections::HashMap<String, String>** | Low-level storage metadata, provided as key/value pairs. This information is driver-specific, and depends on the storage-driver in use, and should be used for informational purposes only. |
|
||||||
|
|
||||||
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||||
|
|
||||||
|
|
||||||
13
docs/EndpointIpamConfig.md
Normal file
13
docs/EndpointIpamConfig.md
Normal file
|
|
@ -0,0 +1,13 @@
|
||||||
|
# EndpointIpamConfig
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
**ipv4_address** | Option<**String**> | | [optional]
|
||||||
|
**ipv6_address** | Option<**String**> | | [optional]
|
||||||
|
**link_local_ips** | Option<**Vec<String>**> | | [optional]
|
||||||
|
|
||||||
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||||
|
|
||||||
|
|
||||||
15
docs/EndpointPortConfig.md
Normal file
15
docs/EndpointPortConfig.md
Normal file
|
|
@ -0,0 +1,15 @@
|
||||||
|
# EndpointPortConfig
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
**name** | Option<**String**> | | [optional]
|
||||||
|
**protocol** | Option<**String**> | | [optional]
|
||||||
|
**target_port** | Option<**i32**> | The port inside the container. | [optional]
|
||||||
|
**published_port** | Option<**i32**> | The port on the swarm hosts. | [optional]
|
||||||
|
**publish_mode** | Option<**String**> | The mode in which port is published. <p><br /></p> - \"ingress\" makes the target port accessible on every node, regardless of whether there is a task for the service running on that node or not. - \"host\" bypasses the routing mesh and publish the port directly on the swarm node where that service is running. | [optional][default to Ingress]
|
||||||
|
|
||||||
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||||
|
|
||||||
|
|
||||||
25
docs/EndpointSettings.md
Normal file
25
docs/EndpointSettings.md
Normal file
|
|
@ -0,0 +1,25 @@
|
||||||
|
# EndpointSettings
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
**ipam_config** | Option<[**models::EndpointIpamConfig**](EndpointIPAMConfig.md)> | | [optional]
|
||||||
|
**links** | Option<**Vec<String>**> | | [optional]
|
||||||
|
**mac_address** | Option<**String**> | MAC address for the endpoint on this network. The network driver might ignore this parameter. | [optional]
|
||||||
|
**aliases** | Option<**Vec<String>**> | | [optional]
|
||||||
|
**driver_opts** | Option<**std::collections::HashMap<String, String>**> | DriverOpts is a mapping of driver options and values. These options are passed directly to the driver and are driver specific. | [optional]
|
||||||
|
**gw_priority** | Option<**f64**> | This property determines which endpoint will provide the default gateway for a container. The endpoint with the highest priority will be used. If multiple endpoints have the same priority, endpoints are lexicographically sorted based on their network name, and the one that sorts first is picked. | [optional]
|
||||||
|
**network_id** | Option<**String**> | Unique ID of the network. | [optional]
|
||||||
|
**endpoint_id** | Option<**String**> | Unique ID for the service endpoint in a Sandbox. | [optional]
|
||||||
|
**gateway** | Option<**String**> | Gateway address for this network. | [optional]
|
||||||
|
**ip_address** | Option<**String**> | IPv4 address. | [optional]
|
||||||
|
**ip_prefix_len** | Option<**i32**> | Mask length of the IPv4 address. | [optional]
|
||||||
|
**ipv6_gateway** | Option<**String**> | IPv6 gateway address. | [optional]
|
||||||
|
**global_ipv6_address** | Option<**String**> | Global IPv6 address. | [optional]
|
||||||
|
**global_ipv6_prefix_len** | Option<**i64**> | Mask length of the global IPv6 address. | [optional]
|
||||||
|
**dns_names** | Option<**Vec<String>**> | List of all DNS names an endpoint has on a specific network. This list is based on the container name, network aliases, container short ID, and hostname. These DNS names are non-fully qualified but can contain several dots. You can get fully qualified DNS names by appending `.<network-name>`. For instance, if container name is `my.ctr` and the network is named `testnet`, `DNSNames` will contain `my.ctr` and the FQDN will be `my.ctr.testnet`. | [optional]
|
||||||
|
|
||||||
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||||
|
|
||||||
|
|
||||||
12
docs/EndpointSpec.md
Normal file
12
docs/EndpointSpec.md
Normal file
|
|
@ -0,0 +1,12 @@
|
||||||
|
# EndpointSpec
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
**mode** | Option<**String**> | The mode of resolution to use for internal load balancing between tasks. | [optional][default to Vip]
|
||||||
|
**ports** | Option<[**Vec<models::EndpointPortConfig>**](EndpointPortConfig.md)> | List of exposed ports that this service is accessible on from the outside. Ports can only be provided if `vip` resolution mode is used. | [optional]
|
||||||
|
|
||||||
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||||
|
|
||||||
|
|
||||||
13
docs/EngineDescription.md
Normal file
13
docs/EngineDescription.md
Normal file
|
|
@ -0,0 +1,13 @@
|
||||||
|
# EngineDescription
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
**engine_version** | Option<**String**> | | [optional]
|
||||||
|
**labels** | Option<**std::collections::HashMap<String, String>**> | | [optional]
|
||||||
|
**plugins** | Option<[**Vec<models::EngineDescriptionPluginsInner>**](EngineDescription_Plugins_inner.md)> | | [optional]
|
||||||
|
|
||||||
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||||
|
|
||||||
|
|
||||||
12
docs/EngineDescriptionPluginsInner.md
Normal file
12
docs/EngineDescriptionPluginsInner.md
Normal file
|
|
@ -0,0 +1,12 @@
|
||||||
|
# EngineDescriptionPluginsInner
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
**r#type** | Option<**String**> | | [optional]
|
||||||
|
**name** | Option<**String**> | | [optional]
|
||||||
|
|
||||||
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||||
|
|
||||||
|
|
||||||
12
docs/ErrorDetail.md
Normal file
12
docs/ErrorDetail.md
Normal file
|
|
@ -0,0 +1,12 @@
|
||||||
|
# ErrorDetail
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
**code** | Option<**i32**> | | [optional]
|
||||||
|
**message** | Option<**String**> | | [optional]
|
||||||
|
|
||||||
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||||
|
|
||||||
|
|
||||||
11
docs/ErrorResponse.md
Normal file
11
docs/ErrorResponse.md
Normal file
|
|
@ -0,0 +1,11 @@
|
||||||
|
# ErrorResponse
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
**message** | **String** | The error message. |
|
||||||
|
|
||||||
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||||
|
|
||||||
|
|
||||||
12
docs/EventActor.md
Normal file
12
docs/EventActor.md
Normal file
|
|
@ -0,0 +1,12 @@
|
||||||
|
# EventActor
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
**id** | Option<**String**> | The ID of the object emitting the event | [optional]
|
||||||
|
**attributes** | Option<**std::collections::HashMap<String, String>**> | Various key/value attributes of the object, depending on its type. | [optional]
|
||||||
|
|
||||||
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||||
|
|
||||||
|
|
||||||
16
docs/EventMessage.md
Normal file
16
docs/EventMessage.md
Normal file
|
|
@ -0,0 +1,16 @@
|
||||||
|
# EventMessage
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
**r#type** | Option<**String**> | The type of object emitting the event | [optional]
|
||||||
|
**action** | Option<**String**> | The type of event | [optional]
|
||||||
|
**actor** | Option<[**models::EventActor**](EventActor.md)> | | [optional]
|
||||||
|
**scope** | Option<**String**> | Scope of the event. Engine events are `local` scope. Cluster (Swarm) events are `swarm` scope. | [optional]
|
||||||
|
**time** | Option<**i64**> | Timestamp of event | [optional]
|
||||||
|
**time_nano** | Option<**i64**> | Timestamp of event, with nanosecond accuracy | [optional]
|
||||||
|
|
||||||
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||||
|
|
||||||
|
|
||||||
136
docs/ExecApi.md
Normal file
136
docs/ExecApi.md
Normal file
|
|
@ -0,0 +1,136 @@
|
||||||
|
# \ExecApi
|
||||||
|
|
||||||
|
All URIs are relative to *http://localhost/v1.51*
|
||||||
|
|
||||||
|
Method | HTTP request | Description
|
||||||
|
------------- | ------------- | -------------
|
||||||
|
[**container_exec**](ExecApi.md#container_exec) | **POST** /containers/{id}/exec | Create an exec instance
|
||||||
|
[**exec_inspect**](ExecApi.md#exec_inspect) | **GET** /exec/{id}/json | Inspect an exec instance
|
||||||
|
[**exec_resize**](ExecApi.md#exec_resize) | **POST** /exec/{id}/resize | Resize an exec instance
|
||||||
|
[**exec_start**](ExecApi.md#exec_start) | **POST** /exec/{id}/start | Start an exec instance
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## container_exec
|
||||||
|
|
||||||
|
> models::IdResponse container_exec(id, exec_config)
|
||||||
|
Create an exec instance
|
||||||
|
|
||||||
|
Run a command inside a running container.
|
||||||
|
|
||||||
|
### Parameters
|
||||||
|
|
||||||
|
|
||||||
|
Name | Type | Description | Required | Notes
|
||||||
|
------------- | ------------- | ------------- | ------------- | -------------
|
||||||
|
**id** | **String** | ID or name of container | [required] |
|
||||||
|
**exec_config** | [**ExecConfig**](ExecConfig.md) | Exec configuration | [required] |
|
||||||
|
|
||||||
|
### Return type
|
||||||
|
|
||||||
|
[**models::IdResponse**](IDResponse.md)
|
||||||
|
|
||||||
|
### Authorization
|
||||||
|
|
||||||
|
No authorization required
|
||||||
|
|
||||||
|
### HTTP request headers
|
||||||
|
|
||||||
|
- **Content-Type**: application/json
|
||||||
|
- **Accept**: application/json
|
||||||
|
|
||||||
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||||
|
|
||||||
|
|
||||||
|
## exec_inspect
|
||||||
|
|
||||||
|
> models::ExecInspectResponse exec_inspect(id)
|
||||||
|
Inspect an exec instance
|
||||||
|
|
||||||
|
Return low-level information about an exec instance.
|
||||||
|
|
||||||
|
### Parameters
|
||||||
|
|
||||||
|
|
||||||
|
Name | Type | Description | Required | Notes
|
||||||
|
------------- | ------------- | ------------- | ------------- | -------------
|
||||||
|
**id** | **String** | Exec instance ID | [required] |
|
||||||
|
|
||||||
|
### Return type
|
||||||
|
|
||||||
|
[**models::ExecInspectResponse**](ExecInspectResponse.md)
|
||||||
|
|
||||||
|
### Authorization
|
||||||
|
|
||||||
|
No authorization required
|
||||||
|
|
||||||
|
### HTTP request headers
|
||||||
|
|
||||||
|
- **Content-Type**: Not defined
|
||||||
|
- **Accept**: application/json
|
||||||
|
|
||||||
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||||
|
|
||||||
|
|
||||||
|
## exec_resize
|
||||||
|
|
||||||
|
> exec_resize(id, h, w)
|
||||||
|
Resize an exec instance
|
||||||
|
|
||||||
|
Resize the TTY session used by an exec instance. This endpoint only works if `tty` was specified as part of creating and starting the exec instance.
|
||||||
|
|
||||||
|
### Parameters
|
||||||
|
|
||||||
|
|
||||||
|
Name | Type | Description | Required | Notes
|
||||||
|
------------- | ------------- | ------------- | ------------- | -------------
|
||||||
|
**id** | **String** | Exec instance ID | [required] |
|
||||||
|
**h** | **i32** | Height of the TTY session in characters | [required] |
|
||||||
|
**w** | **i32** | Width of the TTY session in characters | [required] |
|
||||||
|
|
||||||
|
### Return type
|
||||||
|
|
||||||
|
(empty response body)
|
||||||
|
|
||||||
|
### Authorization
|
||||||
|
|
||||||
|
No authorization required
|
||||||
|
|
||||||
|
### HTTP request headers
|
||||||
|
|
||||||
|
- **Content-Type**: Not defined
|
||||||
|
- **Accept**: application/json, text/plain
|
||||||
|
|
||||||
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||||
|
|
||||||
|
|
||||||
|
## exec_start
|
||||||
|
|
||||||
|
> exec_start(id, exec_start_config)
|
||||||
|
Start an exec instance
|
||||||
|
|
||||||
|
Starts a previously set up exec instance. If detach is true, this endpoint returns immediately after starting the command. Otherwise, it sets up an interactive session with the command.
|
||||||
|
|
||||||
|
### Parameters
|
||||||
|
|
||||||
|
|
||||||
|
Name | Type | Description | Required | Notes
|
||||||
|
------------- | ------------- | ------------- | ------------- | -------------
|
||||||
|
**id** | **String** | Exec instance ID | [required] |
|
||||||
|
**exec_start_config** | Option<[**ExecStartConfig**](ExecStartConfig.md)> | | |
|
||||||
|
|
||||||
|
### Return type
|
||||||
|
|
||||||
|
(empty response body)
|
||||||
|
|
||||||
|
### Authorization
|
||||||
|
|
||||||
|
No authorization required
|
||||||
|
|
||||||
|
### HTTP request headers
|
||||||
|
|
||||||
|
- **Content-Type**: application/json
|
||||||
|
- **Accept**: application/vnd.docker.raw-stream, application/vnd.docker.multiplexed-stream
|
||||||
|
|
||||||
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||||
|
|
||||||
21
docs/ExecConfig.md
Normal file
21
docs/ExecConfig.md
Normal file
|
|
@ -0,0 +1,21 @@
|
||||||
|
# ExecConfig
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
**attach_stdin** | Option<**bool**> | Attach to `stdin` of the exec command. | [optional]
|
||||||
|
**attach_stdout** | Option<**bool**> | Attach to `stdout` of the exec command. | [optional]
|
||||||
|
**attach_stderr** | Option<**bool**> | Attach to `stderr` of the exec command. | [optional]
|
||||||
|
**console_size** | Option<**Vec<i32>**> | Initial console size, as an `[height, width]` array. | [optional]
|
||||||
|
**detach_keys** | Option<**String**> | Override the key sequence for detaching a container. Format is a single character `[a-Z]` or `ctrl-<value>` where `<value>` is one of: `a-z`, `@`, `^`, `[`, `,` or `_`. | [optional]
|
||||||
|
**tty** | Option<**bool**> | Allocate a pseudo-TTY. | [optional]
|
||||||
|
**env** | Option<**Vec<String>**> | A list of environment variables in the form `[\"VAR=value\", ...]`. | [optional]
|
||||||
|
**cmd** | Option<**Vec<String>**> | Command to run, as a string or array of strings. | [optional]
|
||||||
|
**privileged** | Option<**bool**> | Runs the exec process with extended privileges. | [optional][default to false]
|
||||||
|
**user** | Option<**String**> | The user, and optionally, group to run the exec process inside the container. Format is one of: `user`, `user:group`, `uid`, or `uid:gid`. | [optional]
|
||||||
|
**working_dir** | Option<**String**> | The working directory for the exec process inside the container. | [optional]
|
||||||
|
|
||||||
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||||
|
|
||||||
|
|
||||||
21
docs/ExecInspectResponse.md
Normal file
21
docs/ExecInspectResponse.md
Normal file
|
|
@ -0,0 +1,21 @@
|
||||||
|
# ExecInspectResponse
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
**can_remove** | Option<**bool**> | | [optional]
|
||||||
|
**detach_keys** | Option<**String**> | | [optional]
|
||||||
|
**id** | Option<**String**> | | [optional]
|
||||||
|
**running** | Option<**bool**> | | [optional]
|
||||||
|
**exit_code** | Option<**i32**> | | [optional]
|
||||||
|
**process_config** | Option<[**models::ProcessConfig**](ProcessConfig.md)> | | [optional]
|
||||||
|
**open_stdin** | Option<**bool**> | | [optional]
|
||||||
|
**open_stderr** | Option<**bool**> | | [optional]
|
||||||
|
**open_stdout** | Option<**bool**> | | [optional]
|
||||||
|
**container_id** | Option<**String**> | | [optional]
|
||||||
|
**pid** | Option<**i32**> | The system process ID for the exec process. | [optional]
|
||||||
|
|
||||||
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||||
|
|
||||||
|
|
||||||
13
docs/ExecStartConfig.md
Normal file
13
docs/ExecStartConfig.md
Normal file
|
|
@ -0,0 +1,13 @@
|
||||||
|
# ExecStartConfig
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
**detach** | Option<**bool**> | Detach from the command. | [optional]
|
||||||
|
**tty** | Option<**bool**> | Allocate a pseudo-TTY. | [optional]
|
||||||
|
**console_size** | Option<**Vec<i32>**> | Initial console size, as an `[height, width]` array. | [optional]
|
||||||
|
|
||||||
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||||
|
|
||||||
|
|
||||||
12
docs/FilesystemChange.md
Normal file
12
docs/FilesystemChange.md
Normal file
|
|
@ -0,0 +1,12 @@
|
||||||
|
# FilesystemChange
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
**path** | **String** | Path to file or directory that has changed. |
|
||||||
|
**kind** | [**models::ChangeType**](ChangeType.md) | |
|
||||||
|
|
||||||
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||||
|
|
||||||
|
|
||||||
12
docs/FirewallInfo.md
Normal file
12
docs/FirewallInfo.md
Normal file
|
|
@ -0,0 +1,12 @@
|
||||||
|
# FirewallInfo
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
**driver** | Option<**String**> | The name of the firewall backend driver. | [optional]
|
||||||
|
**info** | Option<[**Vec<Vec<String>>**](Vec.md)> | Information about the firewall backend, provided as \"label\" / \"value\" pairs. <p><br /></p> > **Note**: The information returned in this field, including the > formatting of values and labels, should not be considered stable, > and may change without notice. | [optional]
|
||||||
|
|
||||||
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||||
|
|
||||||
|
|
||||||
12
docs/GenericResourcesInner.md
Normal file
12
docs/GenericResourcesInner.md
Normal file
|
|
@ -0,0 +1,12 @@
|
||||||
|
# GenericResourcesInner
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
**named_resource_spec** | Option<[**models::GenericResourcesInnerNamedResourceSpec**](GenericResources_inner_NamedResourceSpec.md)> | | [optional]
|
||||||
|
**discrete_resource_spec** | Option<[**models::GenericResourcesInnerDiscreteResourceSpec**](GenericResources_inner_DiscreteResourceSpec.md)> | | [optional]
|
||||||
|
|
||||||
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||||
|
|
||||||
|
|
||||||
12
docs/GenericResourcesInnerDiscreteResourceSpec.md
Normal file
12
docs/GenericResourcesInnerDiscreteResourceSpec.md
Normal file
|
|
@ -0,0 +1,12 @@
|
||||||
|
# GenericResourcesInnerDiscreteResourceSpec
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
**kind** | Option<**String**> | | [optional]
|
||||||
|
**value** | Option<**i64**> | | [optional]
|
||||||
|
|
||||||
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||||
|
|
||||||
|
|
||||||
12
docs/GenericResourcesInnerNamedResourceSpec.md
Normal file
12
docs/GenericResourcesInnerNamedResourceSpec.md
Normal file
|
|
@ -0,0 +1,12 @@
|
||||||
|
# GenericResourcesInnerNamedResourceSpec
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
**kind** | Option<**String**> | | [optional]
|
||||||
|
**value** | Option<**String**> | | [optional]
|
||||||
|
|
||||||
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||||
|
|
||||||
|
|
||||||
13
docs/Health.md
Normal file
13
docs/Health.md
Normal file
|
|
@ -0,0 +1,13 @@
|
||||||
|
# Health
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
**status** | Option<**String**> | Status is one of `none`, `starting`, `healthy` or `unhealthy` - \"none\" Indicates there is no healthcheck - \"starting\" Starting indicates that the container is not yet ready - \"healthy\" Healthy indicates that the container is running correctly - \"unhealthy\" Unhealthy indicates that the container has a problem | [optional]
|
||||||
|
**failing_streak** | Option<**i32**> | FailingStreak is the number of consecutive failures | [optional]
|
||||||
|
**log** | Option<[**Vec<models::HealthcheckResult>**](HealthcheckResult.md)> | Log contains the last few results (oldest first) | [optional]
|
||||||
|
|
||||||
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||||
|
|
||||||
|
|
||||||
16
docs/HealthConfig.md
Normal file
16
docs/HealthConfig.md
Normal file
|
|
@ -0,0 +1,16 @@
|
||||||
|
# HealthConfig
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
**test** | Option<**Vec<String>**> | The test to perform. Possible values are: - `[]` inherit healthcheck from image or parent image - `[\"NONE\"]` disable healthcheck - `[\"CMD\", args...]` exec arguments directly - `[\"CMD-SHELL\", command]` run command with system's default shell | [optional]
|
||||||
|
**interval** | Option<**i64**> | The time to wait between checks in nanoseconds. It should be 0 or at least 1000000 (1 ms). 0 means inherit. | [optional]
|
||||||
|
**timeout** | Option<**i64**> | The time to wait before considering the check to have hung. It should be 0 or at least 1000000 (1 ms). 0 means inherit. | [optional]
|
||||||
|
**retries** | Option<**i32**> | The number of consecutive failures needed to consider a container as unhealthy. 0 means inherit. | [optional]
|
||||||
|
**start_period** | Option<**i64**> | Start period for the container to initialize before starting health-retries countdown in nanoseconds. It should be 0 or at least 1000000 (1 ms). 0 means inherit. | [optional]
|
||||||
|
**start_interval** | Option<**i64**> | The time to wait between checks in nanoseconds during the start period. It should be 0 or at least 1000000 (1 ms). 0 means inherit. | [optional]
|
||||||
|
|
||||||
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||||
|
|
||||||
|
|
||||||
14
docs/HealthcheckResult.md
Normal file
14
docs/HealthcheckResult.md
Normal file
|
|
@ -0,0 +1,14 @@
|
||||||
|
# HealthcheckResult
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
**start** | Option<**String**> | Date and time at which this check started in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. | [optional]
|
||||||
|
**end** | Option<**String**> | Date and time at which this check ended in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. | [optional]
|
||||||
|
**exit_code** | Option<**i32**> | ExitCode meanings: - `0` healthy - `1` unhealthy - `2` reserved (considered unhealthy) - other values: error running probe | [optional]
|
||||||
|
**output** | Option<**String**> | Output from last check | [optional]
|
||||||
|
|
||||||
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||||
|
|
||||||
|
|
||||||
16
docs/HistoryResponseItem.md
Normal file
16
docs/HistoryResponseItem.md
Normal file
|
|
@ -0,0 +1,16 @@
|
||||||
|
# HistoryResponseItem
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
**id** | **String** | |
|
||||||
|
**created** | **i64** | |
|
||||||
|
**created_by** | **String** | |
|
||||||
|
**tags** | **Vec<String>** | |
|
||||||
|
**size** | **i64** | |
|
||||||
|
**comment** | **String** | |
|
||||||
|
|
||||||
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||||
|
|
||||||
|
|
||||||
80
docs/HostConfig.md
Normal file
80
docs/HostConfig.md
Normal file
|
|
@ -0,0 +1,80 @@
|
||||||
|
# HostConfig
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
**cpu_shares** | Option<**i32**> | An integer value representing this container's relative CPU weight versus other containers. | [optional]
|
||||||
|
**memory** | Option<**i64**> | Memory limit in bytes. | [optional][default to 0]
|
||||||
|
**cgroup_parent** | Option<**String**> | Path to `cgroups` under which the container's `cgroup` is created. If the path is not absolute, the path is considered to be relative to the `cgroups` path of the init process. Cgroups are created if they do not already exist. | [optional]
|
||||||
|
**blkio_weight** | Option<**i32**> | Block IO weight (relative weight). | [optional]
|
||||||
|
**blkio_weight_device** | Option<[**Vec<models::ResourcesBlkioWeightDeviceInner>**](Resources_BlkioWeightDevice_inner.md)> | Block IO weight (relative device weight) in the form: ``` [{\"Path\": \"device_path\", \"Weight\": weight}] ``` | [optional]
|
||||||
|
**blkio_device_read_bps** | Option<[**Vec<models::ThrottleDevice>**](ThrottleDevice.md)> | Limit read rate (bytes per second) from a device, in the form: ``` [{\"Path\": \"device_path\", \"Rate\": rate}] ``` | [optional]
|
||||||
|
**blkio_device_write_bps** | Option<[**Vec<models::ThrottleDevice>**](ThrottleDevice.md)> | Limit write rate (bytes per second) to a device, in the form: ``` [{\"Path\": \"device_path\", \"Rate\": rate}] ``` | [optional]
|
||||||
|
**blkio_device_read_i_ops** | Option<[**Vec<models::ThrottleDevice>**](ThrottleDevice.md)> | Limit read rate (IO per second) from a device, in the form: ``` [{\"Path\": \"device_path\", \"Rate\": rate}] ``` | [optional]
|
||||||
|
**blkio_device_write_i_ops** | Option<[**Vec<models::ThrottleDevice>**](ThrottleDevice.md)> | Limit write rate (IO per second) to a device, in the form: ``` [{\"Path\": \"device_path\", \"Rate\": rate}] ``` | [optional]
|
||||||
|
**cpu_period** | Option<**i64**> | The length of a CPU period in microseconds. | [optional]
|
||||||
|
**cpu_quota** | Option<**i64**> | Microseconds of CPU time that the container can get in a CPU period. | [optional]
|
||||||
|
**cpu_realtime_period** | Option<**i64**> | The length of a CPU real-time period in microseconds. Set to 0 to allocate no time allocated to real-time tasks. | [optional]
|
||||||
|
**cpu_realtime_runtime** | Option<**i64**> | The length of a CPU real-time runtime in microseconds. Set to 0 to allocate no time allocated to real-time tasks. | [optional]
|
||||||
|
**cpuset_cpus** | Option<**String**> | CPUs in which to allow execution (e.g., `0-3`, `0,1`). | [optional]
|
||||||
|
**cpuset_mems** | Option<**String**> | Memory nodes (MEMs) in which to allow execution (0-3, 0,1). Only effective on NUMA systems. | [optional]
|
||||||
|
**devices** | Option<[**Vec<models::DeviceMapping>**](DeviceMapping.md)> | A list of devices to add to the container. | [optional]
|
||||||
|
**device_cgroup_rules** | Option<**Vec<String>**> | a list of cgroup rules to apply to the container | [optional]
|
||||||
|
**device_requests** | Option<[**Vec<models::DeviceRequest>**](DeviceRequest.md)> | A list of requests for devices to be sent to device drivers. | [optional]
|
||||||
|
**kernel_memory_tcp** | Option<**i64**> | Hard limit for kernel TCP buffer memory (in bytes). Depending on the OCI runtime in use, this option may be ignored. It is no longer supported by the default (runc) runtime. This field is omitted when empty. | [optional]
|
||||||
|
**memory_reservation** | Option<**i64**> | Memory soft limit in bytes. | [optional]
|
||||||
|
**memory_swap** | Option<**i64**> | Total memory limit (memory + swap). Set as `-1` to enable unlimited swap. | [optional]
|
||||||
|
**memory_swappiness** | Option<**i64**> | Tune a container's memory swappiness behavior. Accepts an integer between 0 and 100. | [optional]
|
||||||
|
**nano_cpus** | Option<**i64**> | CPU quota in units of 10<sup>-9</sup> CPUs. | [optional]
|
||||||
|
**oom_kill_disable** | Option<**bool**> | Disable OOM Killer for the container. | [optional]
|
||||||
|
**init** | Option<**bool**> | Run an init inside the container that forwards signals and reaps processes. This field is omitted if empty, and the default (as configured on the daemon) is used. | [optional]
|
||||||
|
**pids_limit** | Option<**i64**> | Tune a container's PIDs limit. Set `0` or `-1` for unlimited, or `null` to not change. | [optional]
|
||||||
|
**ulimits** | Option<[**Vec<models::ResourcesUlimitsInner>**](Resources_Ulimits_inner.md)> | A list of resource limits to set in the container. For example: ``` {\"Name\": \"nofile\", \"Soft\": 1024, \"Hard\": 2048} ``` | [optional]
|
||||||
|
**cpu_count** | Option<**i64**> | The number of usable CPUs (Windows only). On Windows Server containers, the processor resource controls are mutually exclusive. The order of precedence is `CPUCount` first, then `CPUShares`, and `CPUPercent` last. | [optional]
|
||||||
|
**cpu_percent** | Option<**i64**> | The usable percentage of the available CPUs (Windows only). On Windows Server containers, the processor resource controls are mutually exclusive. The order of precedence is `CPUCount` first, then `CPUShares`, and `CPUPercent` last. | [optional]
|
||||||
|
**io_maximum_i_ops** | Option<**i64**> | Maximum IOps for the container system drive (Windows only) | [optional]
|
||||||
|
**io_maximum_bandwidth** | Option<**i64**> | Maximum IO in bytes per second for the container system drive (Windows only). | [optional]
|
||||||
|
**binds** | Option<**Vec<String>**> | A list of volume bindings for this container. Each volume binding is a string in one of these forms: - `host-src:container-dest[:options]` to bind-mount a host path into the container. Both `host-src`, and `container-dest` must be an _absolute_ path. - `volume-name:container-dest[:options]` to bind-mount a volume managed by a volume driver into the container. `container-dest` must be an _absolute_ path. `options` is an optional, comma-delimited list of: - `nocopy` disables automatic copying of data from the container path to the volume. The `nocopy` flag only applies to named volumes. - `[ro|rw]` mounts a volume read-only or read-write, respectively. If omitted or set to `rw`, volumes are mounted read-write. - `[z|Z]` applies SELinux labels to allow or deny multiple containers to read and write to the same volume. - `z`: a _shared_ content label is applied to the content. This label indicates that multiple containers can share the volume content, for both reading and writing. - `Z`: a _private unshared_ label is applied to the content. This label indicates that only the current container can use a private volume. Labeling systems such as SELinux require proper labels to be placed on volume content that is mounted into a container. Without a label, the security system can prevent a container's processes from using the content. By default, the labels set by the host operating system are not modified. - `[[r]shared|[r]slave|[r]private]` specifies mount [propagation behavior](https://www.kernel.org/doc/Documentation/filesystems/sharedsubtree.txt). This only applies to bind-mounted volumes, not internal volumes or named volumes. Mount propagation requires the source mount point (the location where the source directory is mounted in the host operating system) to have the correct propagation properties. For shared volumes, the source mount point must be set to `shared`. For slave volumes, the mount must be set to either `shared` or `slave`. | [optional]
|
||||||
|
**container_id_file** | Option<**String**> | Path to a file where the container ID is written | [optional]
|
||||||
|
**log_config** | Option<[**models::HostConfigAllOfLogConfig**](HostConfig_allOf_LogConfig.md)> | | [optional]
|
||||||
|
**network_mode** | Option<**String**> | Network mode to use for this container. Supported standard values are: `bridge`, `host`, `none`, and `container:<name|id>`. Any other value is taken as a custom network's name to which this container should connect to. | [optional]
|
||||||
|
**port_bindings** | Option<[**std::collections::HashMap<String, Vec<models::PortBinding>>**](Vec.md)> | 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`. If a container's port is mapped for multiple protocols, separate entries are added to the mapping table. | [optional]
|
||||||
|
**restart_policy** | Option<[**models::RestartPolicy**](RestartPolicy.md)> | | [optional]
|
||||||
|
**auto_remove** | Option<**bool**> | Automatically remove the container when the container's process exits. This has no effect if `RestartPolicy` is set. | [optional]
|
||||||
|
**volume_driver** | Option<**String**> | Driver that this container uses to mount volumes. | [optional]
|
||||||
|
**volumes_from** | Option<**Vec<String>**> | A list of volumes to inherit from another container, specified in the form `<container name>[:<ro|rw>]`. | [optional]
|
||||||
|
**mounts** | Option<[**Vec<models::Mount>**](Mount.md)> | Specification for mounts to be added to the container. | [optional]
|
||||||
|
**console_size** | Option<**Vec<i32>**> | Initial console size, as an `[height, width]` array. | [optional]
|
||||||
|
**annotations** | Option<**std::collections::HashMap<String, String>**> | Arbitrary non-identifying metadata attached to container and provided to the runtime when the container is started. | [optional]
|
||||||
|
**cap_add** | Option<**Vec<String>**> | A list of kernel capabilities to add to the container. Conflicts with option 'Capabilities'. | [optional]
|
||||||
|
**cap_drop** | Option<**Vec<String>**> | A list of kernel capabilities to drop from the container. Conflicts with option 'Capabilities'. | [optional]
|
||||||
|
**cgroupns_mode** | Option<**String**> | cgroup namespace mode for the container. Possible values are: - `\"private\"`: the container runs in its own private cgroup namespace - `\"host\"`: use the host system's cgroup namespace If not specified, the daemon default is used, which can either be `\"private\"` or `\"host\"`, depending on daemon version, kernel support and configuration. | [optional]
|
||||||
|
**dns** | Option<**Vec<String>**> | A list of DNS servers for the container to use. | [optional]
|
||||||
|
**dns_options** | Option<**Vec<String>**> | A list of DNS options. | [optional]
|
||||||
|
**dns_search** | Option<**Vec<String>**> | A list of DNS search domains. | [optional]
|
||||||
|
**extra_hosts** | Option<**Vec<String>**> | A list of hostnames/IP mappings to add to the container's `/etc/hosts` file. Specified in the form `[\"hostname:IP\"]`. | [optional]
|
||||||
|
**group_add** | Option<**Vec<String>**> | A list of additional groups that the container process will run as. | [optional]
|
||||||
|
**ipc_mode** | Option<**String**> | IPC sharing mode for the container. Possible values are: - `\"none\"`: own private IPC namespace, with /dev/shm not mounted - `\"private\"`: own private IPC namespace - `\"shareable\"`: own private IPC namespace, with a possibility to share it with other containers - `\"container:<name|id>\"`: join another (shareable) container's IPC namespace - `\"host\"`: use the host system's IPC namespace If not specified, daemon default is used, which can either be `\"private\"` or `\"shareable\"`, depending on daemon version and configuration. | [optional]
|
||||||
|
**cgroup** | Option<**String**> | Cgroup to use for the container. | [optional]
|
||||||
|
**links** | Option<**Vec<String>**> | A list of links for the container in the form `container_name:alias`. | [optional]
|
||||||
|
**oom_score_adj** | Option<**i32**> | An integer value containing the score given to the container in order to tune OOM killer preferences. | [optional]
|
||||||
|
**pid_mode** | Option<**String**> | Set the PID (Process) Namespace mode for the container. It can be either: - `\"container:<name|id>\"`: joins another container's PID namespace - `\"host\"`: use the host's PID namespace inside the container | [optional]
|
||||||
|
**privileged** | Option<**bool**> | Gives the container full access to the host. | [optional]
|
||||||
|
**publish_all_ports** | Option<**bool**> | Allocates an ephemeral host port for all of a container's exposed ports. Ports are de-allocated when the container stops and allocated when the container starts. The allocated port might be changed when restarting the container. The port is selected from the ephemeral port range that depends on the kernel. For example, on Linux the range is defined by `/proc/sys/net/ipv4/ip_local_port_range`. | [optional]
|
||||||
|
**readonly_rootfs** | Option<**bool**> | Mount the container's root filesystem as read only. | [optional]
|
||||||
|
**security_opt** | Option<**Vec<String>**> | A list of string values to customize labels for MLS systems, such as SELinux. | [optional]
|
||||||
|
**storage_opt** | Option<**std::collections::HashMap<String, String>**> | Storage driver options for this container, in the form `{\"size\": \"120G\"}`. | [optional]
|
||||||
|
**tmpfs** | Option<**std::collections::HashMap<String, String>**> | A map of container directories which should be replaced by tmpfs mounts, and their corresponding mount options. For example: ``` { \"/run\": \"rw,noexec,nosuid,size=65536k\" } ``` | [optional]
|
||||||
|
**uts_mode** | Option<**String**> | UTS namespace to use for the container. | [optional]
|
||||||
|
**userns_mode** | Option<**String**> | Sets the usernamespace mode for the container when usernamespace remapping option is enabled. | [optional]
|
||||||
|
**shm_size** | Option<**i64**> | Size of `/dev/shm` in bytes. If omitted, the system uses 64MB. | [optional]
|
||||||
|
**sysctls** | Option<**std::collections::HashMap<String, String>**> | A list of kernel parameters (sysctls) to set in the container. This field is omitted if not set. | [optional]
|
||||||
|
**runtime** | Option<**String**> | Runtime to use with this container. | [optional]
|
||||||
|
**isolation** | Option<**String**> | Isolation technology of the container. (Windows only) | [optional]
|
||||||
|
**masked_paths** | Option<**Vec<String>**> | The list of paths to be masked inside the container (this overrides the default set of paths). | [optional]
|
||||||
|
**readonly_paths** | Option<**Vec<String>**> | The list of paths to be set as read-only inside the container (this overrides the default set of paths). | [optional]
|
||||||
|
|
||||||
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||||
|
|
||||||
|
|
||||||
12
docs/HostConfigAllOfLogConfig.md
Normal file
12
docs/HostConfigAllOfLogConfig.md
Normal file
|
|
@ -0,0 +1,12 @@
|
||||||
|
# HostConfigAllOfLogConfig
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
**r#type** | Option<**String**> | Name of the logging driver used for the container or \"none\" if logging is disabled. | [optional]
|
||||||
|
**config** | Option<**std::collections::HashMap<String, String>**> | Driver-specific configuration options for the logging driver. | [optional]
|
||||||
|
|
||||||
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||||
|
|
||||||
|
|
||||||
11
docs/IdResponse.md
Normal file
11
docs/IdResponse.md
Normal file
|
|
@ -0,0 +1,11 @@
|
||||||
|
# IdResponse
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
**id** | **String** | The id of the newly created object. |
|
||||||
|
|
||||||
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||||
|
|
||||||
|
|
||||||
534
docs/ImageApi.md
Normal file
534
docs/ImageApi.md
Normal file
|
|
@ -0,0 +1,534 @@
|
||||||
|
# \ImageApi
|
||||||
|
|
||||||
|
All URIs are relative to *http://localhost/v1.51*
|
||||||
|
|
||||||
|
Method | HTTP request | Description
|
||||||
|
------------- | ------------- | -------------
|
||||||
|
[**build_prune**](ImageApi.md#build_prune) | **POST** /build/prune | Delete builder cache
|
||||||
|
[**image_build**](ImageApi.md#image_build) | **POST** /build | Build an image
|
||||||
|
[**image_commit**](ImageApi.md#image_commit) | **POST** /commit | Create a new image from a container
|
||||||
|
[**image_create**](ImageApi.md#image_create) | **POST** /images/create | Create an image
|
||||||
|
[**image_delete**](ImageApi.md#image_delete) | **DELETE** /images/{name} | Remove an image
|
||||||
|
[**image_get**](ImageApi.md#image_get) | **GET** /images/{name}/get | Export an image
|
||||||
|
[**image_get_all**](ImageApi.md#image_get_all) | **GET** /images/get | Export several images
|
||||||
|
[**image_history**](ImageApi.md#image_history) | **GET** /images/{name}/history | Get the history of an image
|
||||||
|
[**image_inspect**](ImageApi.md#image_inspect) | **GET** /images/{name}/json | Inspect an image
|
||||||
|
[**image_list**](ImageApi.md#image_list) | **GET** /images/json | List Images
|
||||||
|
[**image_load**](ImageApi.md#image_load) | **POST** /images/load | Import images
|
||||||
|
[**image_prune**](ImageApi.md#image_prune) | **POST** /images/prune | Delete unused images
|
||||||
|
[**image_push**](ImageApi.md#image_push) | **POST** /images/{name}/push | Push an image
|
||||||
|
[**image_search**](ImageApi.md#image_search) | **GET** /images/search | Search images
|
||||||
|
[**image_tag**](ImageApi.md#image_tag) | **POST** /images/{name}/tag | Tag an image
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## build_prune
|
||||||
|
|
||||||
|
> models::BuildPruneResponse build_prune(keep_storage, reserved_space, max_used_space, min_free_space, all, filters)
|
||||||
|
Delete builder cache
|
||||||
|
|
||||||
|
### Parameters
|
||||||
|
|
||||||
|
|
||||||
|
Name | Type | Description | Required | Notes
|
||||||
|
------------- | ------------- | ------------- | ------------- | -------------
|
||||||
|
**keep_storage** | Option<**i64**> | Amount of disk space in bytes to keep for cache > **Deprecated**: This parameter is deprecated and has been renamed to \"reserved-space\". > It is kept for backward compatibility and will be removed in API v1.49. | |
|
||||||
|
**reserved_space** | Option<**i64**> | Amount of disk space in bytes to keep for cache | |
|
||||||
|
**max_used_space** | Option<**i64**> | Maximum amount of disk space allowed to keep for cache | |
|
||||||
|
**min_free_space** | Option<**i64**> | Target amount of free disk space after pruning | |
|
||||||
|
**all** | Option<**bool**> | Remove all types of build cache | |
|
||||||
|
**filters** | Option<**String**> | A JSON encoded value of the filters (a `map[string][]string`) to process on the list of build cache objects. Available filters: - `until=<timestamp>` remove cache older than `<timestamp>`. The `<timestamp>` can be Unix timestamps, date formatted timestamps, or Go duration strings (e.g. `10m`, `1h30m`) computed relative to the daemon's local time. - `id=<id>` - `parent=<id>` - `type=<string>` - `description=<string>` - `inuse` - `shared` - `private` | |
|
||||||
|
|
||||||
|
### Return type
|
||||||
|
|
||||||
|
[**models::BuildPruneResponse**](BuildPruneResponse.md)
|
||||||
|
|
||||||
|
### Authorization
|
||||||
|
|
||||||
|
No authorization required
|
||||||
|
|
||||||
|
### HTTP request headers
|
||||||
|
|
||||||
|
- **Content-Type**: Not defined
|
||||||
|
- **Accept**: application/json
|
||||||
|
|
||||||
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||||
|
|
||||||
|
|
||||||
|
## image_build
|
||||||
|
|
||||||
|
> image_build(dockerfile, t, extrahosts, remote, q, nocache, cachefrom, pull, rm, forcerm, memory, memswap, cpushares, cpusetcpus, cpuperiod, cpuquota, buildargs, shmsize, squash, labels, networkmode, content_type, x_registry_config, platform, target, outputs, version, input_stream)
|
||||||
|
Build an image
|
||||||
|
|
||||||
|
Build an image from a tar archive with a `Dockerfile` in it. The `Dockerfile` specifies how the image is built from the tar archive. It is typically in the archive's root, but can be at a different path or have a different name by specifying the `dockerfile` parameter. [See the `Dockerfile` reference for more information](https://docs.docker.com/engine/reference/builder/). The Docker daemon performs a preliminary validation of the `Dockerfile` before starting the build, and returns an error if the syntax is incorrect. After that, each instruction is run one-by-one until the ID of the new image is output. The build is canceled if the client drops the connection by quitting or being killed.
|
||||||
|
|
||||||
|
### Parameters
|
||||||
|
|
||||||
|
|
||||||
|
Name | Type | Description | Required | Notes
|
||||||
|
------------- | ------------- | ------------- | ------------- | -------------
|
||||||
|
**dockerfile** | Option<**String**> | Path within the build context to the `Dockerfile`. This is ignored if `remote` is specified and points to an external `Dockerfile`. | |[default to Dockerfile]
|
||||||
|
**t** | Option<**String**> | A name and optional tag to apply to the image in the `name:tag` format. If you omit the tag the default `latest` value is assumed. You can provide several `t` parameters. | |
|
||||||
|
**extrahosts** | Option<**String**> | Extra hosts to add to /etc/hosts | |
|
||||||
|
**remote** | Option<**String**> | A Git repository URI or HTTP/HTTPS context URI. If the URI points to a single text file, the file’s contents are placed into a file called `Dockerfile` and the image is built from that file. If the URI points to a tarball, the file is downloaded by the daemon and the contents therein used as the context for the build. If the URI points to a tarball and the `dockerfile` parameter is also specified, there must be a file with the corresponding path inside the tarball. | |
|
||||||
|
**q** | Option<**bool**> | Suppress verbose build output. | |[default to false]
|
||||||
|
**nocache** | Option<**bool**> | Do not use the cache when building the image. | |[default to false]
|
||||||
|
**cachefrom** | Option<**String**> | JSON array of images used for build cache resolution. | |
|
||||||
|
**pull** | Option<**String**> | Attempt to pull the image even if an older image exists locally. | |
|
||||||
|
**rm** | Option<**bool**> | Remove intermediate containers after a successful build. | |[default to true]
|
||||||
|
**forcerm** | Option<**bool**> | Always remove intermediate containers, even upon failure. | |[default to false]
|
||||||
|
**memory** | Option<**i32**> | Set memory limit for build. | |
|
||||||
|
**memswap** | Option<**i32**> | Total memory (memory + swap). Set as `-1` to disable swap. | |
|
||||||
|
**cpushares** | Option<**i32**> | CPU shares (relative weight). | |
|
||||||
|
**cpusetcpus** | Option<**String**> | CPUs in which to allow execution (e.g., `0-3`, `0,1`). | |
|
||||||
|
**cpuperiod** | Option<**i32**> | The length of a CPU period in microseconds. | |
|
||||||
|
**cpuquota** | Option<**i32**> | Microseconds of CPU time that the container can get in a CPU period. | |
|
||||||
|
**buildargs** | Option<**String**> | JSON map of string pairs for build-time variables. Users pass these values at build-time. Docker uses the buildargs as the environment context for commands run via the `Dockerfile` RUN instruction, or for variable expansion in other `Dockerfile` instructions. This is not meant for passing secret values. For example, the build arg `FOO=bar` would become `{\"FOO\":\"bar\"}` in JSON. This would result in the query parameter `buildargs={\"FOO\":\"bar\"}`. Note that `{\"FOO\":\"bar\"}` should be URI component encoded. [Read more about the buildargs instruction.](https://docs.docker.com/engine/reference/builder/#arg) | |
|
||||||
|
**shmsize** | Option<**i32**> | Size of `/dev/shm` in bytes. The size must be greater than 0. If omitted the system uses 64MB. | |
|
||||||
|
**squash** | Option<**bool**> | Squash the resulting images layers into a single layer. *(Experimental release only.)* | |
|
||||||
|
**labels** | Option<**String**> | Arbitrary key/value labels to set on the image, as a JSON map of string pairs. | |
|
||||||
|
**networkmode** | Option<**String**> | Sets the networking mode for the run commands during build. Supported standard values are: `bridge`, `host`, `none`, and `container:<name|id>`. Any other value is taken as a custom network's name or ID to which this container should connect to. | |
|
||||||
|
**content_type** | Option<**String**> | | |[default to application/x-tar]
|
||||||
|
**x_registry_config** | Option<**String**> | This is a base64-encoded JSON object with auth configurations for multiple registries that a build may refer to. The key is a registry URL, and the value is an auth configuration object, [as described in the authentication section](#section/Authentication). For example: ``` { \"docker.example.com\": { \"username\": \"janedoe\", \"password\": \"hunter2\" }, \"https://index.docker.io/v1/\": { \"username\": \"mobydock\", \"password\": \"conta1n3rize14\" } } ``` Only the registry domain name (and port if not the default 443) are required. However, for legacy reasons, the Docker Hub registry must be specified with both a `https://` prefix and a `/v1/` suffix even though Docker will prefer to use the v2 registry API. | |
|
||||||
|
**platform** | Option<**String**> | Platform in the format os[/arch[/variant]] | |
|
||||||
|
**target** | Option<**String**> | Target build stage | |
|
||||||
|
**outputs** | Option<**String**> | BuildKit output configuration | |
|
||||||
|
**version** | Option<**String**> | Version of the builder backend to use. - `1` is the first generation classic (deprecated) builder in the Docker daemon (default) - `2` is [BuildKit](https://github.com/moby/buildkit) | |[default to 1]
|
||||||
|
**input_stream** | Option<**std::path::PathBuf**> | A tar archive compressed with one of the following algorithms: identity (no compression), gzip, bzip2, xz. | |
|
||||||
|
|
||||||
|
### Return type
|
||||||
|
|
||||||
|
(empty response body)
|
||||||
|
|
||||||
|
### Authorization
|
||||||
|
|
||||||
|
No authorization required
|
||||||
|
|
||||||
|
### HTTP request headers
|
||||||
|
|
||||||
|
- **Content-Type**: application/octet-stream
|
||||||
|
- **Accept**: application/json
|
||||||
|
|
||||||
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||||
|
|
||||||
|
|
||||||
|
## image_commit
|
||||||
|
|
||||||
|
> models::IdResponse image_commit(container, repo, tag, comment, author, pause, changes, container_config)
|
||||||
|
Create a new image from a container
|
||||||
|
|
||||||
|
### Parameters
|
||||||
|
|
||||||
|
|
||||||
|
Name | Type | Description | Required | Notes
|
||||||
|
------------- | ------------- | ------------- | ------------- | -------------
|
||||||
|
**container** | Option<**String**> | The ID or name of the container to commit | |
|
||||||
|
**repo** | Option<**String**> | Repository name for the created image | |
|
||||||
|
**tag** | Option<**String**> | Tag name for the create image | |
|
||||||
|
**comment** | Option<**String**> | Commit message | |
|
||||||
|
**author** | Option<**String**> | Author of the image (e.g., `John Hannibal Smith <hannibal@a-team.com>`) | |
|
||||||
|
**pause** | Option<**bool**> | Whether to pause the container before committing | |[default to true]
|
||||||
|
**changes** | Option<**String**> | `Dockerfile` instructions to apply while committing | |
|
||||||
|
**container_config** | Option<[**ContainerConfig**](ContainerConfig.md)> | The container configuration | |
|
||||||
|
|
||||||
|
### Return type
|
||||||
|
|
||||||
|
[**models::IdResponse**](IDResponse.md)
|
||||||
|
|
||||||
|
### Authorization
|
||||||
|
|
||||||
|
No authorization required
|
||||||
|
|
||||||
|
### HTTP request headers
|
||||||
|
|
||||||
|
- **Content-Type**: application/json
|
||||||
|
- **Accept**: application/json
|
||||||
|
|
||||||
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||||
|
|
||||||
|
|
||||||
|
## image_create
|
||||||
|
|
||||||
|
> image_create(from_image, from_src, repo, tag, message, x_registry_auth, changes, platform, input_image)
|
||||||
|
Create an image
|
||||||
|
|
||||||
|
Pull or import an image.
|
||||||
|
|
||||||
|
### Parameters
|
||||||
|
|
||||||
|
|
||||||
|
Name | Type | Description | Required | Notes
|
||||||
|
------------- | ------------- | ------------- | ------------- | -------------
|
||||||
|
**from_image** | Option<**String**> | Name of the image to pull. If the name includes a tag or digest, specific behavior applies: - If only `fromImage` includes a tag, that tag is used. - If both `fromImage` and `tag` are provided, `tag` takes precedence. - If `fromImage` includes a digest, the image is pulled by digest, and `tag` is ignored. - If neither a tag nor digest is specified, all tags are pulled. | |
|
||||||
|
**from_src** | Option<**String**> | Source to import. The value may be a URL from which the image can be retrieved or `-` to read the image from the request body. This parameter may only be used when importing an image. | |
|
||||||
|
**repo** | Option<**String**> | Repository name given to an image when it is imported. The repo may include a tag. This parameter may only be used when importing an image. | |
|
||||||
|
**tag** | Option<**String**> | Tag or digest. If empty when pulling an image, this causes all tags for the given image to be pulled. | |
|
||||||
|
**message** | Option<**String**> | Set commit message for imported image. | |
|
||||||
|
**x_registry_auth** | Option<**String**> | A base64url-encoded auth configuration. Refer to the [authentication section](#section/Authentication) for details. | |
|
||||||
|
**changes** | Option<[**Vec<String>**](String.md)> | Apply `Dockerfile` instructions to the image that is created, for example: `changes=ENV DEBUG=true`. Note that `ENV DEBUG=true` should be URI component encoded. Supported `Dockerfile` instructions: `CMD`|`ENTRYPOINT`|`ENV`|`EXPOSE`|`ONBUILD`|`USER`|`VOLUME`|`WORKDIR` | |
|
||||||
|
**platform** | Option<**String**> | Platform in the format os[/arch[/variant]]. When used in combination with the `fromImage` option, the daemon checks if the given image is present in the local image cache with the given OS and Architecture, and otherwise attempts to pull the image. If the option is not set, the host's native OS and Architecture are used. If the given image does not exist in the local image cache, the daemon attempts to pull the image with the host's native OS and Architecture. If the given image does exists in the local image cache, but its OS or architecture does not match, a warning is produced. When used with the `fromSrc` option to import an image from an archive, this option sets the platform information for the imported image. If the option is not set, the host's native OS and Architecture are used for the imported image. | |
|
||||||
|
**input_image** | Option<**String**> | Image content if the value `-` has been specified in fromSrc query parameter | |
|
||||||
|
|
||||||
|
### Return type
|
||||||
|
|
||||||
|
(empty response body)
|
||||||
|
|
||||||
|
### Authorization
|
||||||
|
|
||||||
|
No authorization required
|
||||||
|
|
||||||
|
### HTTP request headers
|
||||||
|
|
||||||
|
- **Content-Type**: text/plain, application/octet-stream
|
||||||
|
- **Accept**: application/json
|
||||||
|
|
||||||
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||||
|
|
||||||
|
|
||||||
|
## image_delete
|
||||||
|
|
||||||
|
> Vec<models::ImageDeleteResponseItem> image_delete(name, force, noprune, platforms)
|
||||||
|
Remove an image
|
||||||
|
|
||||||
|
Remove an image, along with any untagged parent images that were referenced by that image. Images can't be removed if they have descendant images, are being used by a running container or are being used by a build.
|
||||||
|
|
||||||
|
### Parameters
|
||||||
|
|
||||||
|
|
||||||
|
Name | Type | Description | Required | Notes
|
||||||
|
------------- | ------------- | ------------- | ------------- | -------------
|
||||||
|
**name** | **String** | Image name or ID | [required] |
|
||||||
|
**force** | Option<**bool**> | Remove the image even if it is being used by stopped containers or has other tags | |[default to false]
|
||||||
|
**noprune** | Option<**bool**> | Do not delete untagged parent images | |[default to false]
|
||||||
|
**platforms** | Option<[**Vec<String>**](String.md)> | Select platform-specific content to delete. Multiple values are accepted. Each platform is a OCI platform encoded as a JSON string. | |
|
||||||
|
|
||||||
|
### Return type
|
||||||
|
|
||||||
|
[**Vec<models::ImageDeleteResponseItem>**](ImageDeleteResponseItem.md)
|
||||||
|
|
||||||
|
### Authorization
|
||||||
|
|
||||||
|
No authorization required
|
||||||
|
|
||||||
|
### HTTP request headers
|
||||||
|
|
||||||
|
- **Content-Type**: Not defined
|
||||||
|
- **Accept**: application/json
|
||||||
|
|
||||||
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||||
|
|
||||||
|
|
||||||
|
## image_get
|
||||||
|
|
||||||
|
> std::path::PathBuf image_get(name, platform)
|
||||||
|
Export an image
|
||||||
|
|
||||||
|
Get a tarball containing all images and metadata for a repository. If `name` is a specific name and tag (e.g. `ubuntu:latest`), then only that image (and its parents) are returned. If `name` is an image ID, similarly only that image (and its parents) are returned, but with the exclusion of the `repositories` file in the tarball, as there were no image names referenced. ### Image tarball format An image tarball contains [Content as defined in the OCI Image Layout Specification](https://github.com/opencontainers/image-spec/blob/v1.1.1/image-layout.md#content). Additionally, includes the manifest.json file associated with a backwards compatible docker save format. If the tarball defines a repository, the tarball should also include a `repositories` file at the root that contains a list of repository and tag names mapped to layer IDs. ```json { \"hello-world\": { \"latest\": \"565a9d68a73f6706862bfe8409a7f659776d4d60a8d096eb4a3cbce6999cc2a1\" } } ```
|
||||||
|
|
||||||
|
### Parameters
|
||||||
|
|
||||||
|
|
||||||
|
Name | Type | Description | Required | Notes
|
||||||
|
------------- | ------------- | ------------- | ------------- | -------------
|
||||||
|
**name** | **String** | Image name or ID | [required] |
|
||||||
|
**platform** | Option<**String**> | JSON encoded OCI platform describing a platform which will be used to select a platform-specific image to be saved if the image is multi-platform. If not provided, the full multi-platform image will be saved. Example: `{\"os\": \"linux\", \"architecture\": \"arm\", \"variant\": \"v5\"}` | |
|
||||||
|
|
||||||
|
### Return type
|
||||||
|
|
||||||
|
[**std::path::PathBuf**](std::path::PathBuf.md)
|
||||||
|
|
||||||
|
### Authorization
|
||||||
|
|
||||||
|
No authorization required
|
||||||
|
|
||||||
|
### HTTP request headers
|
||||||
|
|
||||||
|
- **Content-Type**: Not defined
|
||||||
|
- **Accept**: application/x-tar
|
||||||
|
|
||||||
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||||
|
|
||||||
|
|
||||||
|
## image_get_all
|
||||||
|
|
||||||
|
> std::path::PathBuf image_get_all(names, platform)
|
||||||
|
Export several images
|
||||||
|
|
||||||
|
Get a tarball containing all images and metadata for several image repositories. For each value of the `names` parameter: if it is a specific name and tag (e.g. `ubuntu:latest`), then only that image (and its parents) are returned; if it is an image ID, similarly only that image (and its parents) are returned and there would be no names referenced in the 'repositories' file for this image ID. For details on the format, see the [export image endpoint](#operation/ImageGet).
|
||||||
|
|
||||||
|
### Parameters
|
||||||
|
|
||||||
|
|
||||||
|
Name | Type | Description | Required | Notes
|
||||||
|
------------- | ------------- | ------------- | ------------- | -------------
|
||||||
|
**names** | Option<[**Vec<String>**](String.md)> | Image names to filter by | |
|
||||||
|
**platform** | Option<**String**> | JSON encoded OCI platform describing a platform which will be used to select a platform-specific image to be saved if the image is multi-platform. If not provided, the full multi-platform image will be saved. Example: `{\"os\": \"linux\", \"architecture\": \"arm\", \"variant\": \"v5\"}` | |
|
||||||
|
|
||||||
|
### Return type
|
||||||
|
|
||||||
|
[**std::path::PathBuf**](std::path::PathBuf.md)
|
||||||
|
|
||||||
|
### Authorization
|
||||||
|
|
||||||
|
No authorization required
|
||||||
|
|
||||||
|
### HTTP request headers
|
||||||
|
|
||||||
|
- **Content-Type**: Not defined
|
||||||
|
- **Accept**: application/x-tar
|
||||||
|
|
||||||
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||||
|
|
||||||
|
|
||||||
|
## image_history
|
||||||
|
|
||||||
|
> Vec<models::HistoryResponseItem> image_history(name, platform)
|
||||||
|
Get the history of an image
|
||||||
|
|
||||||
|
Return parent layers of an image.
|
||||||
|
|
||||||
|
### Parameters
|
||||||
|
|
||||||
|
|
||||||
|
Name | Type | Description | Required | Notes
|
||||||
|
------------- | ------------- | ------------- | ------------- | -------------
|
||||||
|
**name** | **String** | Image name or ID | [required] |
|
||||||
|
**platform** | Option<**String**> | JSON-encoded OCI platform to select the platform-variant. If omitted, it defaults to any locally available platform, prioritizing the daemon's host platform. If the daemon provides a multi-platform image store, this selects the platform-variant to show the history for. If the image is a single-platform image, or if the multi-platform image does not provide a variant matching the given platform, an error is returned. Example: `{\"os\": \"linux\", \"architecture\": \"arm\", \"variant\": \"v5\"}` | |
|
||||||
|
|
||||||
|
### Return type
|
||||||
|
|
||||||
|
[**Vec<models::HistoryResponseItem>**](HistoryResponseItem.md)
|
||||||
|
|
||||||
|
### Authorization
|
||||||
|
|
||||||
|
No authorization required
|
||||||
|
|
||||||
|
### HTTP request headers
|
||||||
|
|
||||||
|
- **Content-Type**: Not defined
|
||||||
|
- **Accept**: application/json
|
||||||
|
|
||||||
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||||
|
|
||||||
|
|
||||||
|
## image_inspect
|
||||||
|
|
||||||
|
> models::ImageInspect image_inspect(name, manifests)
|
||||||
|
Inspect an image
|
||||||
|
|
||||||
|
Return low-level information about an image.
|
||||||
|
|
||||||
|
### Parameters
|
||||||
|
|
||||||
|
|
||||||
|
Name | Type | Description | Required | Notes
|
||||||
|
------------- | ------------- | ------------- | ------------- | -------------
|
||||||
|
**name** | **String** | Image name or id | [required] |
|
||||||
|
**manifests** | Option<**bool**> | Include Manifests in the image summary. | |[default to false]
|
||||||
|
|
||||||
|
### Return type
|
||||||
|
|
||||||
|
[**models::ImageInspect**](ImageInspect.md)
|
||||||
|
|
||||||
|
### Authorization
|
||||||
|
|
||||||
|
No authorization required
|
||||||
|
|
||||||
|
### HTTP request headers
|
||||||
|
|
||||||
|
- **Content-Type**: Not defined
|
||||||
|
- **Accept**: application/json
|
||||||
|
|
||||||
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||||
|
|
||||||
|
|
||||||
|
## image_list
|
||||||
|
|
||||||
|
> Vec<models::ImageSummary> image_list(all, filters, shared_size, digests, manifests)
|
||||||
|
List Images
|
||||||
|
|
||||||
|
Returns a list of images on the server. Note that it uses a different, smaller representation of an image than inspecting a single image.
|
||||||
|
|
||||||
|
### Parameters
|
||||||
|
|
||||||
|
|
||||||
|
Name | Type | Description | Required | Notes
|
||||||
|
------------- | ------------- | ------------- | ------------- | -------------
|
||||||
|
**all** | Option<**bool**> | Show all images. Only images from a final layer (no children) are shown by default. | |[default to false]
|
||||||
|
**filters** | Option<**String**> | A JSON encoded value of the filters (a `map[string][]string`) to process on the images list. Available filters: - `before`=(`<image-name>[:<tag>]`, `<image id>` or `<image@digest>`) - `dangling=true` - `label=key` or `label=\"key=value\"` of an image label - `reference`=(`<image-name>[:<tag>]`) - `since`=(`<image-name>[:<tag>]`, `<image id>` or `<image@digest>`) - `until=<timestamp>` | |
|
||||||
|
**shared_size** | Option<**bool**> | Compute and show shared size as a `SharedSize` field on each image. | |[default to false]
|
||||||
|
**digests** | Option<**bool**> | Show digest information as a `RepoDigests` field on each image. | |[default to false]
|
||||||
|
**manifests** | Option<**bool**> | Include `Manifests` in the image summary. | |[default to false]
|
||||||
|
|
||||||
|
### Return type
|
||||||
|
|
||||||
|
[**Vec<models::ImageSummary>**](ImageSummary.md)
|
||||||
|
|
||||||
|
### Authorization
|
||||||
|
|
||||||
|
No authorization required
|
||||||
|
|
||||||
|
### HTTP request headers
|
||||||
|
|
||||||
|
- **Content-Type**: Not defined
|
||||||
|
- **Accept**: application/json
|
||||||
|
|
||||||
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||||
|
|
||||||
|
|
||||||
|
## image_load
|
||||||
|
|
||||||
|
> image_load(quiet, platform, images_tarball)
|
||||||
|
Import images
|
||||||
|
|
||||||
|
Load a set of images and tags into a repository. For details on the format, see the [export image endpoint](#operation/ImageGet).
|
||||||
|
|
||||||
|
### Parameters
|
||||||
|
|
||||||
|
|
||||||
|
Name | Type | Description | Required | Notes
|
||||||
|
------------- | ------------- | ------------- | ------------- | -------------
|
||||||
|
**quiet** | Option<**bool**> | Suppress progress details during load. | |[default to false]
|
||||||
|
**platform** | Option<**String**> | JSON encoded OCI platform describing a platform which will be used to select a platform-specific image to be load if the image is multi-platform. If not provided, the full multi-platform image will be loaded. Example: `{\"os\": \"linux\", \"architecture\": \"arm\", \"variant\": \"v5\"}` | |
|
||||||
|
**images_tarball** | Option<**std::path::PathBuf**> | Tar archive containing images | |
|
||||||
|
|
||||||
|
### Return type
|
||||||
|
|
||||||
|
(empty response body)
|
||||||
|
|
||||||
|
### Authorization
|
||||||
|
|
||||||
|
No authorization required
|
||||||
|
|
||||||
|
### HTTP request headers
|
||||||
|
|
||||||
|
- **Content-Type**: application/x-tar
|
||||||
|
- **Accept**: application/json
|
||||||
|
|
||||||
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||||
|
|
||||||
|
|
||||||
|
## image_prune
|
||||||
|
|
||||||
|
> models::ImagePruneResponse image_prune(filters)
|
||||||
|
Delete unused images
|
||||||
|
|
||||||
|
### Parameters
|
||||||
|
|
||||||
|
|
||||||
|
Name | Type | Description | Required | Notes
|
||||||
|
------------- | ------------- | ------------- | ------------- | -------------
|
||||||
|
**filters** | Option<**String**> | Filters to process on the prune list, encoded as JSON (a `map[string][]string`). Available filters: - `dangling=<boolean>` When set to `true` (or `1`), prune only unused *and* untagged images. When set to `false` (or `0`), all unused images are pruned. - `until=<string>` Prune images created before this timestamp. The `<timestamp>` can be Unix timestamps, date formatted timestamps, or Go duration strings (e.g. `10m`, `1h30m`) computed relative to the daemon machine’s time. - `label` (`label=<key>`, `label=<key>=<value>`, `label!=<key>`, or `label!=<key>=<value>`) Prune images with (or without, in case `label!=...` is used) the specified labels. | |
|
||||||
|
|
||||||
|
### Return type
|
||||||
|
|
||||||
|
[**models::ImagePruneResponse**](ImagePruneResponse.md)
|
||||||
|
|
||||||
|
### Authorization
|
||||||
|
|
||||||
|
No authorization required
|
||||||
|
|
||||||
|
### HTTP request headers
|
||||||
|
|
||||||
|
- **Content-Type**: Not defined
|
||||||
|
- **Accept**: application/json
|
||||||
|
|
||||||
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||||
|
|
||||||
|
|
||||||
|
## image_push
|
||||||
|
|
||||||
|
> image_push(name, x_registry_auth, tag, platform)
|
||||||
|
Push an image
|
||||||
|
|
||||||
|
Push an image to a registry. If you wish to push an image on to a private registry, that image must already have a tag which references the registry. For example, `registry.example.com/myimage:latest`. The push is cancelled if the HTTP connection is closed.
|
||||||
|
|
||||||
|
### Parameters
|
||||||
|
|
||||||
|
|
||||||
|
Name | Type | Description | Required | Notes
|
||||||
|
------------- | ------------- | ------------- | ------------- | -------------
|
||||||
|
**name** | **String** | Name of the image to push. For example, `registry.example.com/myimage`. The image must be present in the local image store with the same name. The name should be provided without tag; if a tag is provided, it is ignored. For example, `registry.example.com/myimage:latest` is considered equivalent to `registry.example.com/myimage`. Use the `tag` parameter to specify the tag to push. | [required] |
|
||||||
|
**x_registry_auth** | **String** | A base64url-encoded auth configuration. Refer to the [authentication section](#section/Authentication) for details. | [required] |
|
||||||
|
**tag** | Option<**String**> | Tag of the image to push. For example, `latest`. If no tag is provided, all tags of the given image that are present in the local image store are pushed. | |
|
||||||
|
**platform** | Option<**String**> | JSON-encoded OCI platform to select the platform-variant to push. If not provided, all available variants will attempt to be pushed. If the daemon provides a multi-platform image store, this selects the platform-variant to push to the registry. If the image is a single-platform image, or if the multi-platform image does not provide a variant matching the given platform, an error is returned. Example: `{\"os\": \"linux\", \"architecture\": \"arm\", \"variant\": \"v5\"}` | |
|
||||||
|
|
||||||
|
### Return type
|
||||||
|
|
||||||
|
(empty response body)
|
||||||
|
|
||||||
|
### Authorization
|
||||||
|
|
||||||
|
No authorization required
|
||||||
|
|
||||||
|
### HTTP request headers
|
||||||
|
|
||||||
|
- **Content-Type**: Not defined
|
||||||
|
- **Accept**: application/json, text/plain
|
||||||
|
|
||||||
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||||
|
|
||||||
|
|
||||||
|
## image_search
|
||||||
|
|
||||||
|
> Vec<models::ImageSearchResponseItem> image_search(term, limit, filters)
|
||||||
|
Search images
|
||||||
|
|
||||||
|
Search for an image on Docker Hub.
|
||||||
|
|
||||||
|
### Parameters
|
||||||
|
|
||||||
|
|
||||||
|
Name | Type | Description | Required | Notes
|
||||||
|
------------- | ------------- | ------------- | ------------- | -------------
|
||||||
|
**term** | **String** | Term to search | [required] |
|
||||||
|
**limit** | Option<**i32**> | Maximum number of results to return | |
|
||||||
|
**filters** | Option<**String**> | A JSON encoded value of the filters (a `map[string][]string`) to process on the images list. Available filters: - `is-official=(true|false)` - `stars=<number>` Matches images that has at least 'number' stars. | |
|
||||||
|
|
||||||
|
### Return type
|
||||||
|
|
||||||
|
[**Vec<models::ImageSearchResponseItem>**](ImageSearchResponseItem.md)
|
||||||
|
|
||||||
|
### Authorization
|
||||||
|
|
||||||
|
No authorization required
|
||||||
|
|
||||||
|
### HTTP request headers
|
||||||
|
|
||||||
|
- **Content-Type**: Not defined
|
||||||
|
- **Accept**: application/json
|
||||||
|
|
||||||
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||||
|
|
||||||
|
|
||||||
|
## image_tag
|
||||||
|
|
||||||
|
> image_tag(name, repo, tag)
|
||||||
|
Tag an image
|
||||||
|
|
||||||
|
Tag an image so that it becomes part of a repository.
|
||||||
|
|
||||||
|
### Parameters
|
||||||
|
|
||||||
|
|
||||||
|
Name | Type | Description | Required | Notes
|
||||||
|
------------- | ------------- | ------------- | ------------- | -------------
|
||||||
|
**name** | **String** | Image name or ID to tag. | [required] |
|
||||||
|
**repo** | Option<**String**> | The repository to tag in. For example, `someuser/someimage`. | |
|
||||||
|
**tag** | Option<**String**> | The name of the new tag. | |
|
||||||
|
|
||||||
|
### Return type
|
||||||
|
|
||||||
|
(empty response body)
|
||||||
|
|
||||||
|
### Authorization
|
||||||
|
|
||||||
|
No authorization required
|
||||||
|
|
||||||
|
### HTTP request headers
|
||||||
|
|
||||||
|
- **Content-Type**: Not defined
|
||||||
|
- **Accept**: application/json, text/plain
|
||||||
|
|
||||||
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||||
|
|
||||||
23
docs/ImageConfig.md
Normal file
23
docs/ImageConfig.md
Normal file
|
|
@ -0,0 +1,23 @@
|
||||||
|
# ImageConfig
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
**user** | Option<**String**> | The user that commands are run as inside the container. | [optional]
|
||||||
|
**exposed_ports** | Option<[**std::collections::HashMap<String, serde_json::Value>**](serde_json::Value.md)> | An object mapping ports to an empty object in the form: `{\"<port>/<tcp|udp|sctp>\": {}}` | [optional]
|
||||||
|
**env** | Option<**Vec<String>**> | A list of environment variables to set inside the container in the form `[\"VAR=value\", ...]`. A variable without `=` is removed from the environment, rather than to have an empty value. | [optional]
|
||||||
|
**cmd** | Option<**Vec<String>**> | Command to run specified as a string or an array of strings. | [optional]
|
||||||
|
**healthcheck** | Option<[**models::HealthConfig**](HealthConfig.md)> | | [optional]
|
||||||
|
**args_escaped** | Option<**bool**> | Command is already escaped (Windows only) | [optional][default to false]
|
||||||
|
**volumes** | Option<[**std::collections::HashMap<String, serde_json::Value>**](serde_json::Value.md)> | An object mapping mount point paths inside the container to empty objects. | [optional]
|
||||||
|
**working_dir** | Option<**String**> | The working directory for commands to run in. | [optional]
|
||||||
|
**entrypoint** | Option<**Vec<String>**> | The entry point for the container as a string or an array of strings. If the array consists of exactly one empty string (`[\"\"]`) then the entry point is reset to system default (i.e., the entry point used by docker when there is no `ENTRYPOINT` instruction in the `Dockerfile`). | [optional]
|
||||||
|
**on_build** | Option<**Vec<String>**> | `ONBUILD` metadata that were defined in the image's `Dockerfile`. | [optional]
|
||||||
|
**labels** | Option<**std::collections::HashMap<String, String>**> | User-defined key/value metadata. | [optional]
|
||||||
|
**stop_signal** | Option<**String**> | Signal to stop a container as a string or unsigned integer. | [optional]
|
||||||
|
**shell** | Option<**Vec<String>**> | Shell for when `RUN`, `CMD`, and `ENTRYPOINT` uses a shell. | [optional]
|
||||||
|
|
||||||
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||||
|
|
||||||
|
|
||||||
12
docs/ImageDeleteResponseItem.md
Normal file
12
docs/ImageDeleteResponseItem.md
Normal file
|
|
@ -0,0 +1,12 @@
|
||||||
|
# ImageDeleteResponseItem
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
**untagged** | Option<**String**> | The image ID of an image that was untagged | [optional]
|
||||||
|
**deleted** | Option<**String**> | The image ID of an image that was deleted | [optional]
|
||||||
|
|
||||||
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||||
|
|
||||||
|
|
||||||
11
docs/ImageId.md
Normal file
11
docs/ImageId.md
Normal file
|
|
@ -0,0 +1,11 @@
|
||||||
|
# ImageId
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
**id** | Option<**String**> | | [optional]
|
||||||
|
|
||||||
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||||
|
|
||||||
|
|
||||||
30
docs/ImageInspect.md
Normal file
30
docs/ImageInspect.md
Normal file
|
|
@ -0,0 +1,30 @@
|
||||||
|
# ImageInspect
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
**id** | Option<**String**> | ID is the content-addressable ID of an image. This identifier is a content-addressable digest calculated from the image's configuration (which includes the digests of layers used by the image). Note that this digest differs from the `RepoDigests` below, which holds digests of image manifests that reference the image. | [optional]
|
||||||
|
**descriptor** | Option<[**models::OciDescriptor**](OCIDescriptor.md)> | | [optional]
|
||||||
|
**manifests** | Option<[**Vec<models::ImageManifestSummary>**](ImageManifestSummary.md)> | Manifests is a list of image manifests available in this image. It provides a more detailed view of the platform-specific image manifests or other image-attached data like build attestations. Only available if the daemon provides a multi-platform image store and the `manifests` option is set in the inspect request. WARNING: This is experimental and may change at any time without any backward compatibility. | [optional]
|
||||||
|
**repo_tags** | Option<**Vec<String>**> | List of image names/tags in the local image cache that reference this image. Multiple image tags can refer to the same image, and this list may be empty if no tags reference the image, in which case the image is \"untagged\", in which case it can still be referenced by its ID. | [optional]
|
||||||
|
**repo_digests** | Option<**Vec<String>**> | List of content-addressable digests of locally available image manifests that the image is referenced from. Multiple manifests can refer to the same image. These digests are usually only available if the image was either pulled from a registry, or if the image was pushed to a registry, which is when the manifest is generated and its digest calculated. | [optional]
|
||||||
|
**parent** | Option<**String**> | ID of the parent image. Depending on how the image was created, this field may be empty and is only set for images that were built/created locally. This field is empty if the image was pulled from an image registry. | [optional]
|
||||||
|
**comment** | Option<**String**> | Optional message that was set when committing or importing the image. | [optional]
|
||||||
|
**created** | Option<**String**> | Date and time at which the image was created, formatted in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. This information is only available if present in the image, and omitted otherwise. | [optional]
|
||||||
|
**docker_version** | Option<**String**> | The version of Docker that was used to build the image. Depending on how the image was created, this field may be empty. | [optional]
|
||||||
|
**author** | Option<**String**> | Name of the author that was specified when committing the image, or as specified through MAINTAINER (deprecated) in the Dockerfile. | [optional]
|
||||||
|
**config** | Option<[**models::ImageConfig**](ImageConfig.md)> | | [optional]
|
||||||
|
**architecture** | Option<**String**> | Hardware CPU architecture that the image runs on. | [optional]
|
||||||
|
**variant** | Option<**String**> | CPU architecture variant (presently ARM-only). | [optional]
|
||||||
|
**os** | Option<**String**> | Operating System the image is built to run on. | [optional]
|
||||||
|
**os_version** | Option<**String**> | Operating System version the image is built to run on (especially for Windows). | [optional]
|
||||||
|
**size** | Option<**i64**> | Total size of the image including all layers it is composed of. | [optional]
|
||||||
|
**virtual_size** | Option<**i64**> | Total size of the image including all layers it is composed of. Deprecated: this field is omitted in API v1.44, but kept for backward compatibility. Use Size instead. | [optional]
|
||||||
|
**graph_driver** | Option<[**models::DriverData**](DriverData.md)> | | [optional]
|
||||||
|
**root_fs** | Option<[**models::ImageInspectRootFs**](ImageInspect_RootFS.md)> | | [optional]
|
||||||
|
**metadata** | Option<[**models::ImageInspectMetadata**](ImageInspect_Metadata.md)> | | [optional]
|
||||||
|
|
||||||
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||||
|
|
||||||
|
|
||||||
11
docs/ImageInspectMetadata.md
Normal file
11
docs/ImageInspectMetadata.md
Normal file
|
|
@ -0,0 +1,11 @@
|
||||||
|
# ImageInspectMetadata
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
**last_tag_time** | Option<**String**> | Date and time at which the image was last tagged in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. This information is only available if the image was tagged locally, and omitted otherwise. | [optional]
|
||||||
|
|
||||||
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||||
|
|
||||||
|
|
||||||
12
docs/ImageInspectRootFs.md
Normal file
12
docs/ImageInspectRootFs.md
Normal file
|
|
@ -0,0 +1,12 @@
|
||||||
|
# ImageInspectRootFs
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
**r#type** | **String** | |
|
||||||
|
**layers** | Option<**Vec<String>**> | | [optional]
|
||||||
|
|
||||||
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||||
|
|
||||||
|
|
||||||
17
docs/ImageManifestSummary.md
Normal file
17
docs/ImageManifestSummary.md
Normal file
|
|
@ -0,0 +1,17 @@
|
||||||
|
# ImageManifestSummary
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
**id** | **String** | ID is the content-addressable ID of an image and is the same as the digest of the image manifest. |
|
||||||
|
**descriptor** | [**models::OciDescriptor**](OCIDescriptor.md) | |
|
||||||
|
**available** | **bool** | Indicates whether all the child content (image config, layers) is fully available locally. |
|
||||||
|
**size** | [**models::ImageManifestSummarySize**](ImageManifestSummary_Size.md) | |
|
||||||
|
**kind** | **String** | The kind of the manifest. kind | description -------------|----------------------------------------------------------- image | Image manifest that can be used to start a container. attestation | Attestation manifest produced by the Buildkit builder for a specific image manifest. |
|
||||||
|
**image_data** | Option<[**models::ImageManifestSummaryImageData**](ImageManifestSummary_ImageData.md)> | | [optional]
|
||||||
|
**attestation_data** | Option<[**models::ImageManifestSummaryAttestationData**](ImageManifestSummary_AttestationData.md)> | | [optional]
|
||||||
|
|
||||||
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||||
|
|
||||||
|
|
||||||
11
docs/ImageManifestSummaryAttestationData.md
Normal file
11
docs/ImageManifestSummaryAttestationData.md
Normal file
|
|
@ -0,0 +1,11 @@
|
||||||
|
# ImageManifestSummaryAttestationData
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
**r#for** | **String** | The digest of the image manifest that this attestation is for. |
|
||||||
|
|
||||||
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||||
|
|
||||||
|
|
||||||
13
docs/ImageManifestSummaryImageData.md
Normal file
13
docs/ImageManifestSummaryImageData.md
Normal file
|
|
@ -0,0 +1,13 @@
|
||||||
|
# ImageManifestSummaryImageData
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
**platform** | Option<[**models::OciPlatform**](OCIPlatform.md)> | |
|
||||||
|
**containers** | **Vec<String>** | The IDs of the containers that are using this image. |
|
||||||
|
**size** | [**models::ImageManifestSummaryImageDataSize**](ImageManifestSummary_ImageData_Size.md) | |
|
||||||
|
|
||||||
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||||
|
|
||||||
|
|
||||||
Some files were not shown because too many files have changed in this diff Show more
Loading…
Add table
Add a link
Reference in a new issue