Main Navigation Guide API Reference

Appearance

Sidebar Navigation

config

Functions

setContext

withContext

headers

Functions

xRegistryAuth

xRegistryConfig

Type Aliases

RegistryConfig

v1.47

Functions

Config

configCreate

configDelete

configInspect

configList

configUpdate

Container

containerArchive

containerArchiveInfo

containerAttach

containerAttachWebsocket

containerChanges

containerCreate

containerDelete

containerExport

containerInspect

containerKill

containerList

containerLogs

containerPause

containerPrune

containerRename

containerResize

containerRestart

containerStart

containerStats

containerStop

containerTop

containerUnpause

containerUpdate

containerWait

putContainerArchive

Distribution

distributionInspect

Exec

containerExec

execInspect

execResize

execStart

Image

buildPrune

imageBuild

imageCommit

imageCreate

imageDelete

imageGet

imageGetAll

imageHistory

imageInspect

imageList

imageLoad

imagePrune

imagePush

imageSearch

imageTag

Network

networkConnect

networkCreate

networkDelete

networkDisconnect

networkInspect

networkList

networkPrune

Node

nodeDelete

nodeInspect

nodeList

nodeUpdate

Plugin

getPluginPrivileges

pluginCreate

pluginDelete

pluginDisable

pluginEnable

pluginInspect

pluginList

pluginPull

pluginPush

pluginSet

pluginUpgrade

Secret

secretCreate

secretDelete

secretInspect

secretList

secretUpdate

Service

serviceCreate

serviceDelete

serviceInspect

serviceList

serviceLogs

serviceUpdate

Swarm

swarmInit

swarmInspect

swarmJoin

swarmLeave

swarmUnlock

swarmUnlockkey

swarmUpdate

System

systemAuth

systemDataUsage

systemEvents

systemInfo

systemVersion

Task

taskInspect

taskList

taskLogs

Volume

volumeCreate

volumeDelete

volumeInspect

volumeList

volumePrune

volumeUpdate

Variables

logger

Type Aliases

Address

AuthConfig

BuildCache

BuildInfo

BuildPruneData

BuildPruneError

BuildPruneResponse

CallbackFn

ChangeType

ClusterInfo

ClusterVolume

ClusterVolumeSpec

Commit

Config

ConfigCreateData

ConfigCreateError

ConfigCreateResponse

ConfigDeleteData

ConfigDeleteError

ConfigDeleteResponse

ConfigInspectData

ConfigInspectError

ConfigInspectResponse

ConfigListData

ConfigListError

ConfigListResponse

ConfigReference

ConfigSpec

ConfigUpdateData

ConfigUpdateError

ConfigUpdateResponse

ContainerArchiveData

ContainerArchiveError

ContainerArchiveInfoData

ContainerArchiveInfoError

ContainerArchiveInfoResponse

ContainerArchiveResponse

ContainerAttachData

ContainerAttachError

ContainerAttachResponse

ContainerAttachWebsocketData

ContainerAttachWebsocketError

ContainerAttachWebsocketResponse

ContainerChangesData

ContainerChangesError

ContainerChangesResponse

ContainerConfig

ContainerCreateData

ContainerCreateError

ContainerCreateResponse

ContainerCreateResponse2

ContainerDeleteData

ContainerDeleteError

ContainerDeleteResponse

ContainerdInfo

ContainerExecData

ContainerExecError

ContainerExecResponse

ContainerExportData

ContainerExportError

ContainerExportResponse

ContainerInspectData

ContainerInspectError

ContainerInspectResponse

ContainerKillData

ContainerKillError

ContainerKillResponse

ContainerListData

ContainerListError

ContainerListResponse

ContainerLogsData

ContainerLogsError

ContainerLogsResponse

ContainerPauseData

ContainerPauseError

ContainerPauseResponse

ContainerPruneData

ContainerPruneError

ContainerPruneResponse

ContainerRenameData

ContainerRenameError

ContainerRenameResponse

ContainerResizeData

ContainerResizeError

ContainerResizeResponse

ContainerRestartData

ContainerRestartError

ContainerRestartResponse

ContainerStartData

ContainerStartError

ContainerStartResponse

ContainerState

ContainerStatsData

ContainerStatsError

ContainerStatsResponse

ContainerStatus

ContainerStopData

ContainerStopError

ContainerStopResponse

ContainerSummary

ContainerTopData

ContainerTopError

ContainerTopResponse

ContainerUnpauseData

ContainerUnpauseError

ContainerUnpauseResponse

ContainerUpdateData

ContainerUpdateError

ContainerUpdateResponse

ContainerWaitData

ContainerWaitError

ContainerWaitExitError

ContainerWaitResponse

ContainerWaitResponse2

CreateImageInfo

DeviceMapping

DeviceRequest

DistributionInspect

DistributionInspectData

DistributionInspectError

DistributionInspectResponse

Driver

DriverData

EndpointIPAMConfig

EndpointPortConfig

EndpointSettings

EndpointSpec

EngineDescription

ErrorDetail

ErrorResponse

EventActor

EventMessage

ExecInspectData

ExecInspectError

ExecInspectResponse

ExecResizeData

ExecResizeError

ExecResizeResponse

ExecStartData

ExecStartError

ExecStartResponse

ExtendedOptions

ExtendedOptionsWithBody

FilesystemChange

GenericResources

GetPluginPrivilegesData

GetPluginPrivilegesError

GetPluginPrivilegesResponse

Health

HealthcheckResult

HealthConfig

HostConfig

IdResponse

ImageBuildBody

ImageBuildData

ImageBuildError

ImageBuildResponse

ImageCommitData

ImageCommitError

ImageCommitResponse

ImageConfig

ImageCreateData

ImageCreateError

ImageCreateResponse

ImageDeleteData

ImageDeleteError

ImageDeleteResponse

ImageDeleteResponseItem

ImageGetAllData

ImageGetAllError

ImageGetAllResponse

ImageGetData

ImageGetError

ImageGetResponse

ImageHistoryData

ImageHistoryError

ImageHistoryResponse

ImageID

ImageInspect

ImageInspectData

ImageInspectError

ImageInspectResponse

ImageListData

ImageListError

ImageListResponse

ImageLoadData

ImageLoadError

ImageLoadResponse

ImageManifestSummary

ImagePruneData

ImagePruneError

ImagePruneResponse

ImagePushData

ImagePushError

ImagePushResponse

ImageSearchData

ImageSearchError

ImageSearchResponse

ImageSummary

ImageTagData

ImageTagError

ImageTagResponse

IndexInfo

IPAM

IPAMConfig

JoinTokens

Limit

LocalNodeState

ManagerStatus

Mount

MountPoint

Network

NetworkAttachmentConfig

NetworkConnectData

NetworkConnectError

NetworkConnectResponse

NetworkContainer

NetworkCreateData

NetworkCreateError

NetworkCreateResponse

NetworkCreateResponse2

NetworkDeleteData

NetworkDeleteError

NetworkDeleteResponse

NetworkDisconnectData

NetworkDisconnectError

NetworkDisconnectResponse

NetworkingConfig

NetworkInspectData

NetworkInspectError

NetworkInspectResponse

NetworkListData

NetworkListError

NetworkListResponse

NetworkPruneData

NetworkPruneError

NetworkPruneResponse

NetworkSettings

Node

NodeDeleteData

NodeDeleteError

NodeDeleteResponse

NodeDescription

NodeInspectData

NodeInspectError

NodeInspectResponse

NodeListData

NodeListError

NodeListResponse

NodeSpec

NodeState

NodeStatus

NodeUpdateData

NodeUpdateError

NodeUpdateResponse

ObjectVersion

OCIDescriptor

OCIPlatform

Options

PeerInfo

PeerNode

Platform

Plugin

PluginCreateData

PluginCreateError

PluginCreateResponse

PluginDeleteData

PluginDeleteError

PluginDeleteResponse

PluginDevice

PluginDisableData

PluginDisableError

PluginDisableResponse

PluginEnableData

PluginEnableError

PluginEnableResponse

PluginEnv

PluginInspectData

PluginInspectError

PluginInspectResponse

PluginInterfaceType

PluginListData

PluginListError

PluginListResponse

PluginMount

PluginPrivilege

PluginPullData

PluginPullError

PluginPullResponse

PluginPushData

PluginPushError

PluginPushResponse

PluginSetData

PluginSetError

PluginSetResponse

PluginsInfo

PluginUpgradeData

PluginUpgradeError

PluginUpgradeResponse

Port

PortBinding

PortMap

PortStatus

ProcessConfig

ProgressDetail

PushImageInfo

PutContainerArchiveBody

PutContainerArchiveData

PutContainerArchiveError

PutContainerArchiveResponse

Reachability

RegistryServiceConfig

ResourceObject

Resources

RestartPolicy

Runtime

Secret

SecretCreateData

SecretCreateError

SecretCreateResponse

SecretDeleteData

SecretDeleteError

SecretDeleteResponse

SecretInspectData

SecretInspectError

SecretInspectResponse

SecretListData

SecretListError

SecretListResponse

SecretSpec

SecretUpdateData

SecretUpdateError

SecretUpdateResponse

Service

ServiceCreateData

ServiceCreateError

ServiceCreateResponse

ServiceCreateResponse2

ServiceDeleteData

ServiceDeleteError

ServiceDeleteResponse

ServiceInspectData

ServiceInspectError

ServiceInspectResponse

ServiceListData

ServiceListError

ServiceListResponse

ServiceLogsData

ServiceLogsError

ServiceLogsResponse

ServiceSpec

ServiceUpdateData

ServiceUpdateError

ServiceUpdateResponse

ServiceUpdateResponse2

StreamCallbackFn

Swarm

SwarmInfo

SwarmInitData

SwarmInitError

SwarmInitResponse

SwarmInspectError

SwarmInspectResponse

SwarmJoinData

SwarmJoinError

SwarmJoinResponse

SwarmLeaveData

SwarmLeaveError

SwarmLeaveResponse

SwarmSpec

SwarmUnlockData

SwarmUnlockError

SwarmUnlockkeyError

SwarmUnlockkeyResponse

SwarmUnlockResponse

SwarmUpdateData

SwarmUpdateError

SwarmUpdateResponse

SystemAuthData

SystemAuthError

SystemAuthResponse

SystemDataUsageData

SystemDataUsageError

SystemDataUsageResponse

SystemEventsData

SystemEventsError

SystemEventsResponse

SystemInfo

SystemInfoError

SystemInfoResponse

SystemPingError

SystemPingHeadError

SystemPingHeadResponse

SystemPingResponse

SystemVersion

SystemVersionError

SystemVersionResponse

Task

TaskInspectData

TaskInspectError

TaskInspectResponse

TaskListData

TaskListError

TaskListResponse

TaskLogsData

TaskLogsError

TaskLogsResponse

TaskSpec

TaskState

TaskStatus

ThrottleDevice

TLSInfo

Topology

UnlockKey

Volume

VolumeCreateData

VolumeCreateError

VolumeCreateOptions

VolumeCreateResponse

VolumeDeleteData

VolumeDeleteError

VolumeDeleteResponse

VolumeInspectData

VolumeInspectError

VolumeInspectResponse

VolumeListData

VolumeListError

VolumeListResponse

VolumeListResponse2

VolumePruneData

VolumePruneError

VolumePruneResponse

VolumeUpdateData

VolumeUpdateError

VolumeUpdateResponse

On this page

dsdk

Modules

config
headers
v1.47

Pager

Next pageconfig

dsdk ​

Modules ​

dsdk

Modules