Search or ask Docker

SystemVersion

SystemVersion schema in Docker Engine API 1.57.

View Markdown

Schema

Type: object

Response of Engine API: GET "/version"
ApiVersion

Type: string

The default (and highest) API version that is supported by the daemon
All schema constraints and annotations
{
  "description": "The default (and highest) API version that is supported by the daemon\n",
  "example": "1.47",
  "type": "string"
}
Arch

Type: string

Architecture of the daemon, as returned by the Go runtime (GOARCH).

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

All schema constraints and annotations
{
  "description": "Architecture of the daemon, as returned by the Go runtime (`GOARCH`).\n\nA full list of possible values can be found in the [Go documentation](https://go.dev/doc/install/source#environment).\n",
  "example": "amd64",
  "type": "string"
}
BuildTime

Type: string

The date and time that the daemon was compiled.
All schema constraints and annotations
{
  "description": "The date and time that the daemon was compiled.\n",
  "example": "2020-06-22T15:49:27.000000000+00:00",
  "type": "string"
}
Components

Type: array

Information about system components
Array item

Type: object

Details

Type: object

Key/value pairs of strings with additional information about the component. These values are intended for informational purposes only, and their content is not defined, and not part of the API specification.

These messages can be printed by the client as information to the user.

All schema constraints and annotations
{
  "description": "Key/value pairs of strings with additional information about the\ncomponent. These values are intended for informational purposes\nonly, and their content is not defined, and not part of the API\nspecification.\n\nThese messages can be printed by the client as information to the user.\n",
  "type": "object",
  "x-nullable": true
}
Name · required

Type: string

Name of the component
All schema constraints and annotations
{
  "description": "Name of the component\n",
  "example": "Engine",
  "type": "string"
}
Version · required

Type: string

Version of the component
All schema constraints and annotations
{
  "description": "Version of the component\n",
  "example": "27.0.1",
  "type": "string",
  "x-nullable": false
}
All schema constraints and annotations
{
  "properties": {
    "Details": {
      "description": "Key/value pairs of strings with additional information about the\ncomponent. These values are intended for informational purposes\nonly, and their content is not defined, and not part of the API\nspecification.\n\nThese messages can be printed by the client as information to the user.\n",
      "type": "object",
      "x-nullable": true
    },
    "Name": {
      "description": "Name of the component\n",
      "example": "Engine",
      "type": "string"
    },
    "Version": {
      "description": "Version of the component\n",
      "example": "27.0.1",
      "type": "string",
      "x-nullable": false
    }
  },
  "required": [
    "Name",
    "Version"
  ],
  "type": "object",
  "x-go-name": "ComponentVersion"
}
All schema constraints and annotations
{
  "description": "Information about system components\n",
  "items": {
    "properties": {
      "Details": {
        "description": "Key/value pairs of strings with additional information about the\ncomponent. These values are intended for informational purposes\nonly, and their content is not defined, and not part of the API\nspecification.\n\nThese messages can be printed by the client as information to the user.\n",
        "type": "object",
        "x-nullable": true
      },
      "Name": {
        "description": "Name of the component\n",
        "example": "Engine",
        "type": "string"
      },
      "Version": {
        "description": "Version of the component\n",
        "example": "27.0.1",
        "type": "string",
        "x-nullable": false
      }
    },
    "required": [
      "Name",
      "Version"
    ],
    "type": "object",
    "x-go-name": "ComponentVersion"
  },
  "type": "array"
}
Experimental

Type: boolean

Indicates if the daemon is started with experimental features enabled.

This field is omitted when empty / false.

All schema constraints and annotations
{
  "description": "Indicates if the daemon is started with experimental features enabled.\n\nThis field is omitted when empty / false.\n",
  "example": true,
  "type": "boolean"
}
GitCommit

Type: string

The Git commit of the source code that was used to build the daemon
All schema constraints and annotations
{
  "description": "The Git commit of the source code that was used to build the daemon\n",
  "example": "48a66213fe",
  "type": "string"
}
GoVersion

Type: string

The version Go used to compile the daemon, and the version of the Go runtime in use.
All schema constraints and annotations
{
  "description": "The version Go used to compile the daemon, and the version of the Go\nruntime in use.\n",
  "example": "go1.22.7",
  "type": "string"
}
KernelVersion

Type: string

The kernel version (uname -r) that the daemon is running on.

This field is omitted when empty.

All schema constraints and annotations
{
  "description": "The kernel version (`uname -r`) that the daemon is running on.\n\nThis field is omitted when empty.\n",
  "example": "6.8.0-31-generic",
  "type": "string"
}
MinAPIVersion

Type: string

The minimum API version that is supported by the daemon
All schema constraints and annotations
{
  "description": "The minimum API version that is supported by the daemon\n",
  "example": "1.24",
  "type": "string"
}
Os

Type: string

The operating system that the daemon is running on ("linux" or "windows")
All schema constraints and annotations
{
  "description": "The operating system that the daemon is running on (\"linux\" or \"windows\")\n",
  "example": "linux",
  "type": "string"
}
Platform

Type: object

Name · required

Type: string

All schema constraints and annotations
{
  "type": "string"
}
All schema constraints and annotations
{
  "properties": {
    "Name": {
      "type": "string"
    }
  },
  "required": [
    "Name"
  ],
  "type": "object"
}
Version

Type: string

The version of the daemon
All schema constraints and annotations
{
  "description": "The version of the daemon",
  "example": "27.0.1",
  "type": "string"
}
All schema constraints and annotations
{
  "description": "Response of Engine API: GET \"/version\"\n",
  "properties": {
    "ApiVersion": {
      "description": "The default (and highest) API version that is supported by the daemon\n",
      "example": "1.47",
      "type": "string"
    },
    "Arch": {
      "description": "Architecture of the daemon, as returned by the Go runtime (`GOARCH`).\n\nA full list of possible values can be found in the [Go documentation](https://go.dev/doc/install/source#environment).\n",
      "example": "amd64",
      "type": "string"
    },
    "BuildTime": {
      "description": "The date and time that the daemon was compiled.\n",
      "example": "2020-06-22T15:49:27.000000000+00:00",
      "type": "string"
    },
    "Components": {
      "description": "Information about system components\n",
      "items": {
        "properties": {
          "Details": {
            "description": "Key/value pairs of strings with additional information about the\ncomponent. These values are intended for informational purposes\nonly, and their content is not defined, and not part of the API\nspecification.\n\nThese messages can be printed by the client as information to the user.\n",
            "type": "object",
            "x-nullable": true
          },
          "Name": {
            "description": "Name of the component\n",
            "example": "Engine",
            "type": "string"
          },
          "Version": {
            "description": "Version of the component\n",
            "example": "27.0.1",
            "type": "string",
            "x-nullable": false
          }
        },
        "required": [
          "Name",
          "Version"
        ],
        "type": "object",
        "x-go-name": "ComponentVersion"
      },
      "type": "array"
    },
    "Experimental": {
      "description": "Indicates if the daemon is started with experimental features enabled.\n\nThis field is omitted when empty / false.\n",
      "example": true,
      "type": "boolean"
    },
    "GitCommit": {
      "description": "The Git commit of the source code that was used to build the daemon\n",
      "example": "48a66213fe",
      "type": "string"
    },
    "GoVersion": {
      "description": "The version Go used to compile the daemon, and the version of the Go\nruntime in use.\n",
      "example": "go1.22.7",
      "type": "string"
    },
    "KernelVersion": {
      "description": "The kernel version (`uname -r`) that the daemon is running on.\n\nThis field is omitted when empty.\n",
      "example": "6.8.0-31-generic",
      "type": "string"
    },
    "MinAPIVersion": {
      "description": "The minimum API version that is supported by the daemon\n",
      "example": "1.24",
      "type": "string"
    },
    "Os": {
      "description": "The operating system that the daemon is running on (\"linux\" or \"windows\")\n",
      "example": "linux",
      "type": "string"
    },
    "Platform": {
      "properties": {
        "Name": {
          "type": "string"
        }
      },
      "required": [
        "Name"
      ],
      "type": "object"
    },
    "Version": {
      "description": "The version of the daemon",
      "example": "27.0.1",
      "type": "string"
    }
  },
  "type": "object"
}