MobyEndpoints.ts overview

Moby endpoints.

Since v1.0.0

Exports Grouped by Category

Errors
Layers
- Configs
- ConfigsLayer
- Containers
- ContainersLayer
- Distributions
- DistributionsLayer
- Execs
- ExecsLayer
- Images
- ImagesLayer
- Networks
- NetworksLayer
- Nodes
- NodesLayer
- Plugins
- PluginsLayer
- Secrets
- SecretsLayer
- Services
- ServicesLayer
- Sessions
- SessionsLayer
- Swarm
- SwarmLayer
- Systems
- SystemsLayer
- Tasks
- TasksLayer
- Volumes
- VolumesLayer

Errors

ConfigsError

Signature

declare const ConfigsError: typeof ConfigsError

Source

Since v1.0.0

ContainersError

Signature

declare const ContainersError: typeof ContainersError

Source

Since v1.0.0

DistributionsError

Signature

declare const DistributionsError: typeof DistributionsError

Source

Since v1.0.0

ExecsError

Signature

declare const ExecsError: typeof ExecsError

Source

Since v1.0.0

ImagesError

Signature

declare const ImagesError: typeof ImagesError

Source

Since v1.0.0

NetworksError

Signature

declare const NetworksError: typeof NetworksError

Source

Since v1.0.0

NodesError

Signature

declare const NodesError: typeof NodesError

Source

Since v1.0.0

PluginsError

Signature

declare const PluginsError: typeof PluginsError

Source

Since v1.0.0

SecretsError

Signature

declare const SecretsError: typeof SecretsError

Source

Since v1.0.0

ServicesError

Signature

declare const ServicesError: typeof ServicesError

Source

Since v1.0.0

SessionsError

Signature

declare const SessionsError: typeof SessionsError

Source

Since v1.0.0

SwarmsError

Signature

declare const SwarmsError: typeof SwarmsError

Source

Since v1.0.0

SystemsError

Signature

declare const SystemsError: typeof SystemsError

Source

Since v1.0.0

TasksError

Signature

declare const TasksError: typeof TasksError

Source

Since v1.0.0

VolumesError

Signature

declare const VolumesError: typeof VolumesError

Source

Since v1.0.0

isConfigsError

Signature

declare const isConfigsError: (u: unknown) => u is ConfigsError

Source

Since v1.0.0

isContainersError

Signature

declare const isContainersError: (u: unknown) => u is ContainersError

Source

Since v1.0.0

isDistributionsError

Signature

declare const isDistributionsError: (u: unknown) => u is DistributionsError

Source

Since v1.0.0

isExecsError

Signature

declare const isExecsError: (u: unknown) => u is ExecsError

Source

Since v1.0.0

isImagesError

Signature

declare const isImagesError: (u: unknown) => u is ImagesError

Source

Since v1.0.0

isNetworksError

Signature

declare const isNetworksError: (u: unknown) => u is NetworksError

Source

Since v1.0.0

isNodesError

Signature

declare const isNodesError: (u: unknown) => u is NodesError

Source

Since v1.0.0

isPluginsError

Signature

declare const isPluginsError: (u: unknown) => u is PluginsError

Source

Since v1.0.0

isSecretsError

Signature

declare const isSecretsError: (u: unknown) => u is SecretsError

Source

Since v1.0.0

isServicesError

Signature

declare const isServicesError: (u: unknown) => u is ServicesError

Source

Since v1.0.0

isSessionsError

Signature

declare const isSessionsError: (u: unknown) => u is SessionsError

Source

Since v1.0.0

isSwarmsError

Signature

declare const isSwarmsError: (u: unknown) => u is SwarmsError

Source

Since v1.0.0

isSystemsError

Signature

declare const isSystemsError: (u: unknown) => u is SystemsError

Source

Since v1.0.0

isTasksError

Signature

declare const isTasksError: (u: unknown) => u is TasksError

Source

Since v1.0.0

isVolumesError

Signature

declare const isVolumesError: (u: unknown) => u is VolumesError

Source

Since v1.0.0

Layers

Configs

Configs are application configurations that can be used by services. Swarm mode must be enabled for these endpoints to work.

See

https://docs.docker.com/reference/api/engine/latest/#tag/Config

Signature

declare const Configs: typeof Configs

Source

Since v1.0.0

ConfigsLayer

Configs are application configurations that can be used by services. Swarm mode must be enabled for these endpoints to work.

See

https://docs.docker.com/reference/api/engine/latest/#tag/Config

Signature

declare const ConfigsLayer: Layer<Configs, never, HttpClient>

Source

Since v1.0.0

Containers

See

https://docs.docker.com/reference/api/engine/latest/#tag/Container

Signature

declare const Containers: typeof Containers

Source

Since v1.0.0

ContainersLayer

See

https://docs.docker.com/reference/api/engine/latest/#tag/Container

Signature

declare const ContainersLayer: Layer<Containers, never, HttpClient | WebSocketConstructor>

Source

Since v1.0.0

Distributions

See

https://docs.docker.com/engine/api/v1.45/#tag/Distribution

Signature

declare const Distributions: typeof Distributions

Source

Since v1.0.0

DistributionsLayer

See

https://docs.docker.com/engine/api/v1.45/#tag/Distribution

Signature

declare const DistributionsLayer: Layer<Distributions, never, HttpClient>

Source

Since v1.0.0

Execs

See

https://docs.docker.com/reference/api/engine/latest/#tag/Exec

Signature

declare const Execs: typeof Execs

Source

Since v1.0.0

ExecsLayer

See

https://docs.docker.com/reference/api/engine/latest/#tag/Exec

Signature

declare const ExecsLayer: Layer<Execs, never, HttpClient>

Source

Since v1.0.0

Images

See

https://docs.docker.com/reference/api/engine/latest/#tag/Image

Signature

declare const Images: typeof Images

Source

Since v1.0.0

ImagesLayer

See

https://docs.docker.com/reference/api/engine/latest/#tag/Image

Signature

declare const ImagesLayer: Layer<Images, never, HttpClient>

Source

Since v1.0.0

Networks

See

https://docs.docker.com/reference/api/engine/latest/#tag/Network

Signature

declare const Networks: typeof Networks

Source

Since v1.0.0

NetworksLayer

See

https://docs.docker.com/reference/api/engine/latest/#tag/Network

Signature

declare const NetworksLayer: Layer<Networks, never, HttpClient>

Source

Since v1.0.0

Nodes

See

https://docs.docker.com/engine/api/v1.45/#tag/Node

Signature

declare const Nodes: typeof Nodes

Source

Since v1.0.0

NodesLayer

See

https://docs.docker.com/engine/api/v1.45/#tag/Node

Signature

declare const NodesLayer: Layer<Nodes, never, HttpClient>

Source

Since v1.0.0

Plugins

See

https://docs.docker.com/engine/api/v1.45/#tag/Plugin

Signature

declare const Plugins: typeof Plugins

Source

Since v1.0.0

PluginsLayer

See

https://docs.docker.com/engine/api/v1.45/#tag/Plugin

Signature

declare const PluginsLayer: Layer<Plugins, never, HttpClient>

Source

Since v1.0.0

Secrets

Secrets are sensitive data that can be used by services. Swarm mode must be enabled for these endpoints to work.

See

https://docs.docker.com/reference/api/engine/latest/#tag/Secret

Signature

declare const Secrets: typeof Secrets

Source

Since v1.0.0

SecretsLayer

Secrets are sensitive data that can be used by services. Swarm mode must be enabled for these endpoints to work.

See

https://docs.docker.com/reference/api/engine/latest/#tag/Secret

Signature

declare const SecretsLayer: Layer<Secrets, never, HttpClient>

Source

Since v1.0.0

Services

Services are the definitions of tasks to run on a swarm. Swarm mode must be enabled for these endpoints to work.

See

https://docs.docker.com/reference/api/engine/latest/#tag/Service

Signature

declare const Services: typeof Services

Source

Since v1.0.0

ServicesLayer

Services are the definitions of tasks to run on a swarm. Swarm mode must be enabled for these endpoints to work.

See

https://docs.docker.com/reference/api/engine/latest/#tag/Service

Signature

declare const ServicesLayer: Layer<Services, never, HttpClient>

Source

Since v1.0.0

Sessions

See

https://docs.docker.com/reference/api/engine/latest/#tag/Session

Signature

declare const Sessions: typeof Sessions

Source

Since v1.0.0

SessionsLayer

See

https://docs.docker.com/reference/api/engine/latest/#tag/Session

Signature

declare const SessionsLayer: Layer<Sessions, never, HttpClient>

Source

Since v1.0.0

Swarm

Engines can be clustered together in a swarm. Refer to the swarm mode documentation for more information.

See

https://docs.docker.com/reference/api/engine/latest/#tag/Swarm

Signature

declare const Swarm: typeof Swarm

Source

Since v1.0.0

SwarmLayer

Engines can be clustered together in a swarm. Refer to the swarm mode documentation for more information.

See

https://docs.docker.com/reference/api/engine/latest/#tag/Swarm

Signature

declare const SwarmLayer: Layer<Swarm, never, HttpClient>

Source

Since v1.0.0

Systems

See

https://docs.docker.com/reference/api/engine/latest/#tag/System

Signature

declare const Systems: typeof Systems

Source

Since v1.0.0

SystemsLayer

See

https://docs.docker.com/reference/api/engine/latest/#tag/System

Signature

declare const SystemsLayer: Layer<Systems, never, HttpClient>

Source

Since v1.0.0

Tasks

A task is a container running on a swarm. It is the atomic scheduling unit of swarm. Swarm mode must be enabled for these endpoints to work.

See

https://docs.docker.com/reference/api/engine/latest/#tag/Task

Signature

declare const Tasks: typeof Tasks

Source

Since v1.0.0

TasksLayer

A task is a container running on a swarm. It is the atomic scheduling unit of swarm. Swarm mode must be enabled for these endpoints to work.

See

https://docs.docker.com/reference/api/engine/latest/#tag/Task

Signature

declare const TasksLayer: Layer<Tasks, never, HttpClient>

Source

Since v1.0.0

Volumes

See

https://docs.docker.com/reference/api/engine/latest/#tag/Volume

Signature

declare const Volumes: typeof Volumes

Source

Since v1.0.0

VolumesLayer

See

https://docs.docker.com/reference/api/engine/latest/#tag/Volume

Signature

declare const VolumesLayer: Layer<Volumes, never, HttpClient>

Source

Since v1.0.0