Developer reference
+Docker APIs
++ Build with Docker, from your local daemon to hosted services. +
++ Choose an API to find connection guidance, operations, and data models. +
+{{ .title }}
+API {{ .version }} · {{ len .operations }} operations
+ Explore reference → + {{ end }} + {{ range $data.legacyAPIs }} + + {{ if eq .connection "unix" }} + Your daemon + {{ else }} + Hosted service + {{ end }} +{{ .title }}
+{{ .description }}
+ Explore reference → + + {{ end }} ++ {{ if eq $api.connection "unix" }} + User-operated API + {{ else }} + Hosted API + {{ end }} +
+{{ $api.title }} API
++ API {{ $api.version }} · {{ len $api.operations }} operations · + {{ len $api.schemas }} named schemas +
+Overview
++ {{ if eq $api.connection "unix" }} + Connecting to + {{ $api.title }} + {{ else }} + Connecting to the {{ $api.title }} API + {{ end }} +
+ {{ range $name, $scheme := $api.securitySchemes }} + {{ with $scheme.description }} +{{ index $scheme "x-displayName" | default $name }}
+curl --unix-socket /var/run/docker.sock http://localhost/v{{ $api.version }}/version{{ .url }}{{ end }}
+ {{ end }}{{ range $api.guides }}
+ {{ $guide := site.GetPage (index (split . "#") 0) }}
+
+ {{ end }}
+ {{ .summary }}
+Operations
+ +{{ partial "api-reference/path.html" .path }}{{ .summary }}
+ {{ end }}
+ Schemas
+-
+ {{ range $api.schemas }}
+
-
+
{{ .name }}+
+ {{ end }}
+
{{ .summary }}
+{{ partial "api-reference/path.html" .path }}{{ if .deprecated }}
+ Deprecated
+ {{ end }}
+ Connection and access
++ API connection and authentication guidance +
+ {{ if and (eq $api.product "engine") (where .parameters "name" "X-Registry-Auth") }} +
+ X-Registry-Auth delegates registry credentials
+ and does not authenticate the daemon caller.
+
+ {{ .url }}{{ with .description }}
+ —
+ {{ . }}
+ {{ end }}
+
+ No HTTP authentication requirement is declared for this + operation. Transport access controls can still apply. +
+ {{ else }} ++ Use one of these alternatives. Requirements within an + alternative apply together. +
+-
+ {{ range .security }}
+
-
+ {{ $first := true }}{{ range $name, $scopes := . }}
+ {{ if not $first }}
+ AND
+ {{ end }}{{ $first = false }}
{{ $name }}{{ with $scopes }} + ({{ delimit . ", " }}) + {{ end }} + {{ end }}{{ if $first }}Anonymous access{{ end }} +
+ {{ end }}
+
Parameters
+ {{ if not .parameters }} +No parameters are declared.
+ {{ end }} + {{ range .parameters }} +
+ {{ .name }}
+ {{ .in }}
+ {{ if .required }}
+ Required
+ {{ end }}
+
+ {{ . | jsonify (dict "indent" " ") }}Serialization: {{ . }}
Request and responses
+ + {{ range $i, $v := .variants }} +
+ {{ $v.direction | humanize }}
+ {{ with $v.status }}
+ {{ . }}
+ {{ end }}
+
+ {{ $v.media }}
No response content is declared.
+ {{ end }} + {{ with $v.headers }} +Headers
+ {{ range $name,$header := . }} +{{ $name }}
+ {{ $header.description }}
+{{ $header | jsonify (dict "indent" " ") }}Stream item
+ {{ partial "api-reference/schema.html" (dict "schema" $v.itemSchema "api" $api "depth" 0) }} + {{ end }} + {{ if $v.examples }} +{{ $ex.name }}
+{{ $ex.text }}Referenced schemas
+ {{ range .references }} + {{ if .url }} + + {{ end }} + {{ end }} +Complete operation contract
+{{ .raw | jsonify (dict "indent" " ") }}Schema
+