DockerEngineAPI.Api.System (elixir_dea v1.45.7)

API calls for all endpoints tagged System.

Summary

Functions

Check auth configuration Validate credentials for a registry and, if available, get an identity token for accessing the registry without password.

system_data_usage(connection, opts \\ [])

Get data usage information

system_events(connection, opts \\ [])

Monitor events Stream real-time events from the server. Various objects within Docker report events when something happens to them. Containers report these events: attach, commit, copy, create, destroy, detach, die, exec_create, exec_detach, exec_start, exec_die, export, health_status, kill, oom, pause, rename, resize, restart, start, stop, top, unpause, update, and prune Images report these events: delete, import, load, pull, push, save, tag, untag, and prune Volumes report these events: create, mount, unmount, destroy, and prune Networks report these events: create, connect, disconnect, destroy, update, remove, and prune The Docker daemon reports these events: reload Services report these events: create, update, and remove Nodes report these events: create, update, and remove Secrets report these events: create, update, and remove Configs report these events: create, update, and remove The Builder reports prune events

system_info(connection, opts \\ [])

Get system information

system_ping(connection, opts \\ [])

Ping This is a dummy endpoint you can use to test if the server is accessible.

system_ping_head(connection, opts \\ [])

Ping This is a dummy endpoint you can use to test if the server is accessible.

system_version(connection, opts \\ [])

Get version Returns the version of Docker that is running and various information about the system that Docker is running on.

Functions

system_auth(connection, opts \\ [])

@spec system_auth(
  Tesla.Env.client(),
  keyword()
) ::
  {:ok, nil}
  | {:ok, DockerEngineAPI.Model.SystemAuthResponse.t()}
  | {:ok, DockerEngineAPI.Model.ErrorResponse.t()}
  | {:error, Tesla.Env.t()}

Check auth configuration Validate credentials for a registry and, if available, get an identity token for accessing the registry without password.

Parameters

connection (DockerEngineAPI.Connection): Connection to server
opts (keyword): Optional parameters
- :body (AuthConfig): Authentication to check

Returns

{:ok, DockerEngineAPI.Model.SystemAuthResponse.t} on success
{:error, Tesla.Env.t} on failure

system_data_usage(connection, opts \\ [])

@spec system_data_usage(
  Tesla.Env.client(),
  keyword()
) ::
  {:ok, DockerEngineAPI.Model.SystemDataUsageResponse.t()}
  | {:ok, DockerEngineAPI.Model.ErrorResponse.t()}
  | {:error, Tesla.Env.t()}

Get data usage information

Parameters

connection (DockerEngineAPI.Connection): Connection to server
opts (keyword): Optional parameters
- :type ([String.t]): Object types, for which to compute and return data.

Returns

{:ok, DockerEngineAPI.Model.SystemDataUsageResponse.t} on success
{:error, Tesla.Env.t} on failure

system_events(connection, opts \\ [])

@spec system_events(
  Tesla.Env.client(),
  keyword()
) ::
  {:ok, DockerEngineAPI.Model.EventMessage.t()}
  | {:ok, DockerEngineAPI.Model.ErrorResponse.t()}
  | {:error, Tesla.Env.t()}

Parameters

connection (DockerEngineAPI.Connection): Connection to server
opts (keyword): Optional parameters
- :since (String.t): Show events created since this timestamp then stream new events.
- :until (String.t): Show events created until this timestamp then stop streaming.
- :filters (String.t): A JSON encoded value of filters (a map[string][]string) to process on the event list. Available filters: - config=<string> config name or ID - container=<string> container name or ID - daemon=<string> daemon name or ID - event=<string> event type - image=<string> image name or ID - label=<string> image or container label - network=<string> network name or ID - node=<string> node ID - plugin=<string> plugin name or ID - scope=<string> local or swarm - secret=<string> secret name or ID - service=<string> service name or ID - type=<string> object to filter by, one of container, image, volume, network, daemon, plugin, node, service, secret or config - volume=<string> volume name

Returns

{:ok, DockerEngineAPI.Model.EventMessage.t} on success
{:error, Tesla.Env.t} on failure

system_info(connection, opts \\ [])

@spec system_info(
  Tesla.Env.client(),
  keyword()
) ::
  {:ok, DockerEngineAPI.Model.SystemInfo.t()}
  | {:ok, DockerEngineAPI.Model.ErrorResponse.t()}
  | {:error, Tesla.Env.t()}

Get system information

Parameters

connection (DockerEngineAPI.Connection): Connection to server
opts (keyword): Optional parameters

Returns

{:ok, DockerEngineAPI.Model.SystemInfo.t} on success
{:error, Tesla.Env.t} on failure

system_ping(connection, opts \\ [])

@spec system_ping(
  Tesla.Env.client(),
  keyword()
) ::
  {:ok, DockerEngineAPI.Model.ErrorResponse.t()}
  | {:ok, String.t()}
  | {:error, Tesla.Env.t()}

Ping This is a dummy endpoint you can use to test if the server is accessible.

Parameters

connection (DockerEngineAPI.Connection): Connection to server
opts (keyword): Optional parameters

Returns

{:ok, String.t} on success
{:error, Tesla.Env.t} on failure

system_ping_head(connection, opts \\ [])

@spec system_ping_head(
  Tesla.Env.client(),
  keyword()
) ::
  {:ok, DockerEngineAPI.Model.ErrorResponse.t()}
  | {:ok, String.t()}
  | {:error, Tesla.Env.t()}

Ping This is a dummy endpoint you can use to test if the server is accessible.

Parameters

connection (DockerEngineAPI.Connection): Connection to server
opts (keyword): Optional parameters

Returns

{:ok, String.t} on success
{:error, Tesla.Env.t} on failure

system_version(connection, opts \\ [])

@spec system_version(
  Tesla.Env.client(),
  keyword()
) ::
  {:ok, DockerEngineAPI.Model.ErrorResponse.t()}
  | {:ok, DockerEngineAPI.Model.SystemVersion.t()}
  | {:error, Tesla.Env.t()}

Get version Returns the version of Docker that is running and various information about the system that Docker is running on.

Parameters

connection (DockerEngineAPI.Connection): Connection to server
opts (keyword): Optional parameters

Returns

{:ok, DockerEngineAPI.Model.SystemVersion.t} on success
{:error, Tesla.Env.t} on failure