v1

latestSwagger 2.02026-07-175684145.0 KB

Get System information

get/info

Response

no error

IDstring

Unique identifier of the daemon.

Note: The format of the ID itself is not part of the API, and should not be considered stable.

Containersinteger

Total number of containers on the host.

ContainersRunninginteger

Number of containers with status "running".

ContainersPausedinteger

Number of containers with status "paused".

ContainersStoppedinteger

Number of containers with status "stopped".

Imagesinteger

Total number of images on the host.

Both tagged and untagged (dangling) images are counted.

Driverstring

Name of the storage driver in use.

PouchRootDirstring

Root directory of persistent Pouch state.

Defaults to /var/lib/pouch on Linux.

Debugboolean

Indicates if the daemon is running in debug-mode / with debug-level logging enabled.

LoggingDriverstring

The logging driver to use as a default for new containers.

VolumeDriversstring[]

The list of volume drivers which the pouchd supports

CgroupDriver'cgroupfs' | 'systemd'

The driver to use for managing cgroups.

KernelVersionstring

Kernel version of the host. On Linux, this information obtained from uname.

OperatingSystemstring

Name of the host's operating system, for example: "Ubuntu 16.04.2 LTS".

OSTypestring

Generic type of the operating system of the host, as returned by the Go runtime (GOOS).

Currently returned value is "linux". A full list of possible values can be found in the Go documentation.

Architecturestring

Hardware architecture of the host, as returned by the Go runtime (GOARCH).

A full list of possible values can be found in the Go documentation.

NCPUinteger

The number of logical CPUs usable by the daemon.

The number of available CPUs is checked by querying the operating system when the daemon starts. Changes to operating system CPU allocation after the daemon is started are not reflected.

MemTotalinteger

Total amount of physical memory available on the host, in kilobytes (kB).

IndexServerAddressstring

Address / URL of the index server that is used for image search, and as a default for user authentication.

DefaultRegistrystring

default registry can be defined by user.

HttpProxystring

HTTP-proxy configured for the daemon. This value is obtained from the HTTP_PROXY environment variable.

Containers do not automatically inherit this configuration.

HttpsProxystring

HTTPS-proxy configured for the daemon. This value is obtained from the HTTPS_PROXY environment variable.

Containers do not automatically inherit this configuration.

Namestring

Hostname of the host.

Labelsstring[]

User-defined labels (key/value metadata) as set on the daemon.

ExperimentalBuildboolean

Indicates if experimental features are enabled on the daemon.

ServerVersionstring

Version string of the daemon.

Runtimesobject

List of OCI compliant runtimes configured on the daemon. Keys hold the "name" used to reference the runtime.

The Pouch daemon relies on an OCI compliant runtime (invoked via the containerd daemon) as its interface to the Linux kernel namespaces, cgroups, and SELinux.

The default runtime is runc, and automatically configured. Additional runtimes can be configured by the user and will be listed here.

DefaultRuntimestring

Name of the default OCI runtime that is used when starting containers. The default can be overridden per-container at create time.

LiveRestoreEnabledboolean

Indicates if live restore is enabled. If enabled, containers are kept running when the daemon is shutdown or upon daemon start if running containers are detected.

LxcfsEnabledboolean

Indicates if lxcfs is enabled.

CriEnabledboolean

Indicates if pouchd has accepted flag --enable-cri and enables cri part.

SecurityOptionsstring[]

List of security features that are enabled on the daemon, such as apparmor, seccomp, SELinux, and user-namespaces (userns).

Additional configuration options for each security feature may be present, and are included as a comma-separated list of key/value pairs.

ListenAddressesstring[]

List of addresses the pouchd listens on

Example response

{
  "ID": "7TRN:IPZB:QYBB:VPBQ:UMPP:KARE:6ZNR:XE6T:7EWV:PKF4:ZOJD:TPYS",
  "Containers": 14,
  "ContainersRunning": 3,
  "ContainersPaused": 1,
  "ContainersStopped": 10,
  "Images": 508,
  "Driver": "overlay2",
  "DriverStatus": [
    [
      "Backing Filesystem",
      "extfs"
    ],
    [
      "Supports d_type",
      "true"
    ],
    [
      "Native Overlay Diff",
      "true"
    ]
  ],
  "PouchRootDir": "/var/lib/pouch",
  "Debug": true,
  "VolumeDrivers": [
    "local",
    "tmpfs"
  ],
  "CgroupDriver": "cgroupfs",
  "OperatingSystem": "Alpine Linux v3.5",
  "OSType": "linux",
  "Architecture": "x86_64",
  "NCPU": 4,
  "MemTotal": 2095882240,
  "RegistryConfig": {
    "AllowNondistributableArtifactsCIDRs": [
      "::1/128",
      "127.0.0.0/8"
    ],
    "AllowNondistributableArtifactsHostnames": [
      "registry.internal.corp.example.com:3000",
      "[2001:db8:a0b:12f0::1]:443"
    ],
    "InsecureRegistryCIDRs": [
      "::1/128",
      "127.0.0.0/8"
    ],
    "IndexConfigs": {
      "127.0.0.1:5000": {
        "Name": "127.0.0.1:5000",
        "Mirrors": [],
        "Secure": false,
        "Official": false
      },
      "[2001:db8:a0b:12f0::1]:80": {
        "Name": "[2001:db8:a0b:12f0::1]:80",
        "Mirrors": [],
        "Secure": false,
        "Official": false
      },
      "registry.internal.corp.example.com:3000": {
        "Name": "registry.internal.corp.example.com:3000",
        "Mirrors": [],
        "Secure": false,
        "Official": false
      }
    },
    "Mirrors": [
      "https://hub-mirror.corp.example.com:5000/",
      "https://[2001:db8:a0b:12f0::1]/"
    ]
  },
  "HttpProxy": "http://user:pass@proxy.corp.example.com:8080",
  "HttpsProxy": "https://user:pass@proxy.corp.example.com:4443",
  "Name": "node5.corp.example.com",
  "Labels": [
    "storage=ssd",
    "production"
  ],
  "ExperimentalBuild": true,
  "ServerVersion": "17.06.0-ce",
  "Runtimes": {
    "runc": {
      "path": "pouch-runc"
    },
    "runc-master": {
      "path": "/go/bin/runc"
    },
    "custom": {
      "path": "/usr/local/bin/my-oci-runtime",
      "runtimeArgs": [
        "--debug",
        "--systemd-cgroup=false"
      ]
    }
  },
  "DefaultRuntime": "runc",
  "ContainerdCommit": {
    "ID": "cfb82a876ecc11b5ca0977d1733adbe58599088a",
    "Expected": "2d41c047c83e09a6d61d464906feb2a2f3c52aa4"
  },
  "RuncCommit": {
    "ID": "cfb82a876ecc11b5ca0977d1733adbe58599088a",
    "Expected": "2d41c047c83e09a6d61d464906feb2a2f3c52aa4"
  },
  "SecurityOptions": [
    "name=apparmor",
    "name=seccomp,profile=default",
    "name=selinux",
    "name=userns"
  ],
  "ListenAddresses": [
    [
      "unix:///var/run/pouchd.sock",
      "tcp://0.0.0.0:4243"
    ]
  ]
}