class Docr::Endpoints::System

Overview

The System class provides methods to interact with system-related endpoints. This class uses the client to send requests to the server and handles the responses.

Defined in:

docr/endpoints/system.cr

Constructors

Instance Method Summary

Constructor Detail

def self.new(client : Docr::Client) #

Initializes a new System instance with the provided client.


[View source]

Instance Method Detail

def auth(auth : Docr::Types::AuthConfig) : Docr::Types::SystemAuthResponse #

Authenticates against a registry, optionally retrieving an identity token for further password-less access.

  • auth: The authentication configuration.

Returns authentication details, including an identity token if available.


[View source]
def client : Docr::Client #

A client instance used for making requests.


[View source]
def events(since : Time | Nil = nil, _until : Time | Nil = nil, filters = Hash(String, Array(String)).new) : IO #

Fetches system events, optionally filtering by time and specific event attributes.

  • since: A timestamp to filter events since. Default is nil.
  • _until: A timestamp to filter events until. Default is nil.
  • filters: Additional filters for event attributes. Default is an empty hash.

Returns an IO object that can be used to read system events.


[View source]
def info #

Fetches system information.

Returns system information as a response object.


[View source]
def ping : String #

Checks the server's accessibility.

Returns a simple response string indicating server accessibility.


[View source]
def version : Docr::Types::SystemVersion #

Retrieves the Docker version and various details about the system Docker runs on.

Returns a structured response with Docker version information.


[View source]