mirror of https://github.com/docker/docs.git
2404 lines
90 KiB
HTML
2404 lines
90 KiB
HTML
<!DOCTYPE html>
|
||
<html lang="en">
|
||
<head>
|
||
<meta charset="utf-8">
|
||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||
<meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=no">
|
||
|
||
<meta name="docker_version" content="1.4.1">
|
||
<meta name="docker_git_branch" content="master">
|
||
<meta name="docker_git_commit" content="3c097c2">
|
||
<meta name="docker_build_date" content="Wed Jan 28 04:30:29 UTC 2015">
|
||
|
||
<meta name="description" content="API Documentation for Docker">
|
||
<meta name="keywords" content="API, Docker, rcli, REST, documentation">
|
||
|
||
<link rel="canonical" href="/reference/api/docker_remote_api_v1.16/">
|
||
<link href="/css/bootstrap-custom.css" rel="stylesheet">
|
||
<link href="/css/main.css" rel="stylesheet">
|
||
<link href="/css/prettify-1.0.css" rel="stylesheet">
|
||
<link rel="stylesheet" type="text/css" href="/css/dockerfile_tutorial.css">
|
||
<link href="/tipuesearch/tipuesearch.css" rel="stylesheet">
|
||
<link href="/css/docs.css" rel="stylesheet">
|
||
<link rel="shortcut icon" href="/img/favicon.png">
|
||
<title>Docker Remote API v1.16 - Docker Documentation</title>
|
||
<!-- HTML5 shim and Respond.js IE8 support of HTML5 elements and media queries -->
|
||
<!--[if lt IE 9]>
|
||
<script src="https://oss.maxcdn.com/libs/html5shiv/3.7.0/html5shiv.js"></script>
|
||
<script src="https://oss.maxcdn.com/libs/respond.js/1.3.0/respond.min.js"></script>
|
||
<![endif]-->
|
||
|
||
<script type="text/javascript">
|
||
!function(){var analytics=window.analytics=window.analytics||[];if(!analytics.initialize)if(analytics.invoked)window.console&&console.error&&console.error("Segment snippet included twice.");else{analytics.invoked=!0;analytics.methods=["trackSubmit","trackClick","trackLink","trackForm","pageview","identify","reset","group","track","ready","alias","debug","page","once","off","on"];analytics.factory=function(t){return function(){var e=Array.prototype.slice.call(arguments);e.unshift(t);analytics.push(e);return analytics}};for(var t=0;t<analytics.methods.length;t++){var e=analytics.methods[t];analytics[e]=analytics.factory(e)}analytics.load=function(t){var e=document.createElement("script");e.type="text/javascript";e.async=!0;e.src=("https:"===document.location.protocol?"https://":"http://")+"cdn.segment.com/analytics.js/v1/"+t+"/analytics.min.js";var n=document.getElementsByTagName("script")[0];n.parentNode.insertBefore(e,n)};analytics.SNIPPET_VERSION="4.0.0";
|
||
analytics.load("IWj9D0UpZHZdZUZX9jl98PcpBFWBnBMy");
|
||
analytics.page();
|
||
}}();
|
||
</script>
|
||
|
||
</head>
|
||
<body>
|
||
|
||
<div id="topmostnav" class="topmostnav_loggedout navbar navbar-static-top public">
|
||
<div class="container">
|
||
<a href="http://www.docker.com/" title="Homepage">
|
||
<div class="brand logo"><img src="/img/nav/docker-logo-loggedout.png"> </div>
|
||
</a>
|
||
<ul class="nav">
|
||
<li class=""><a href="http://www.docker.com/whatisdocker/" title="What is Docker">What is Docker?</a></li>
|
||
<li class=""><a href="http://www.docker.com/resources/usecases/" title="Use Cases">Use Cases</a></li>
|
||
<li class=""><a href="http://www.docker.com/tryit/" title="Try It!">Try It!</a></li>
|
||
<li class="active"><a href="https://docs.docker.com" title="Install & Docs">Install & Docs</a></li>
|
||
<li><a href="https://registry.hub.docker.com" title="Browse">Browse</a></li>
|
||
</ul>
|
||
<div id="usernav" class="pull-right">
|
||
<a href="https://hub.docker.com/account/login" class="btn nav-button2" title="Lg In">Log In</a>
|
||
<a href="https://hub.docker.com/account/signup" class="btn nav-button1" title="Sign Up">Sign Up</a>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="topmostnav" class="topmostnav_loggedin navbar navbar-static-top">
|
||
<div class="container">
|
||
<a href="http://www.docker.com/" title="Docker Docs Home"><div class="brand logo"><img src="/img/nav/docker-logo-loggedin.png"> </div></a>
|
||
<form id="search_box_header" class="navbar-index-search pull-right" action="https://registry.hub.docker.com/search">
|
||
<span role="status" aria-live="polite" class="ui-helper-hidden-accessible"></span><input type="text" class="search-query ui-autocomplete-input" placeholder="Search..." name="q" value="" autocomplete="off">
|
||
</form>
|
||
<ul class="nav">
|
||
<li><a href="https://registry.hub.docker.com" title="Browse Repos">Browse Repos</a></li>
|
||
<li class="active"><a href="http://docs.docker.com" title="Documentation">Documentation</a></li>
|
||
<li><a href="http://www.docker.com/community/participate/" title="Community">Community</a></li>
|
||
<li><a href="http://www.docker.com/resources/help/" title="Help">Help</a></li>
|
||
</ul>
|
||
<div id="usernav" class="pull-right">
|
||
<ul class="nav user">
|
||
<li class="dropdown">
|
||
<a id="logged-in-header-username" class="dropdown-toggle" data-toggle="dropdown" href="#">
|
||
<img class="profile" src="" alt="profile picture">
|
||
</a>
|
||
<ul class="dropdown-menu pull-right">
|
||
<li><a href="https://hub.docker.com/">View Profile</a></li>
|
||
<li><a href="https://hub.docker.com/account/settings/">Settings</a></li>
|
||
<li><a href="https://hub.docker.com/repos/">My Repositories</a></li>
|
||
<li><a href="https://hub.docker.com/plans/billing-info">Billing</a></li>
|
||
<li><a href="https://hub.docker.com/account/logout/?next=/">Log out</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
<div id="wrap">
|
||
<nav id="nav_menu" class="clearfix navbar navbar-default navbar-static-top affix" role="navigation">
|
||
<div id="docsnav">
|
||
<ul id="main-nav" class="pull-left">
|
||
|
||
|
||
<li class="dd_menu pull-left">
|
||
|
||
<a href="/">About</a>
|
||
|
||
<ul class="dd_submenu" style="max-height: 75px;">
|
||
|
||
<li >
|
||
<a href="/">Docker</a>
|
||
</li>
|
||
|
||
<li >
|
||
<a href="/release-notes/">Release Notes</a>
|
||
</li>
|
||
|
||
<li >
|
||
<a href="/introduction/understanding-docker/">Understanding Docker</a>
|
||
</li>
|
||
|
||
</ul>
|
||
</li>
|
||
|
||
|
||
|
||
<li class="dd_menu pull-left">
|
||
|
||
<a href="/installation/mac/">Installation</a>
|
||
|
||
<ul class="dd_submenu" style="max-height: 75px;">
|
||
|
||
<li >
|
||
<a href="/installation/mac/">Mac OS X</a>
|
||
</li>
|
||
|
||
<li >
|
||
<a href="/installation/ubuntulinux/">Ubuntu</a>
|
||
</li>
|
||
|
||
<li >
|
||
<a href="/installation/rhel/">Red Hat Enterprise Linux</a>
|
||
</li>
|
||
|
||
<li >
|
||
<a href="/installation/oracle/">Oracle Linux</a>
|
||
</li>
|
||
|
||
<li >
|
||
<a href="/installation/centos/">CentOS</a>
|
||
</li>
|
||
|
||
<li >
|
||
<a href="/installation/debian/">Debian</a>
|
||
</li>
|
||
|
||
<li >
|
||
<a href="/installation/gentoolinux/">Gentoo</a>
|
||
</li>
|
||
|
||
<li >
|
||
<a href="/installation/google/">Google Cloud Platform</a>
|
||
</li>
|
||
|
||
<li >
|
||
<a href="/installation/rackspace/">Rackspace Cloud</a>
|
||
</li>
|
||
|
||
<li >
|
||
<a href="/installation/amazon/">Amazon EC2</a>
|
||
</li>
|
||
|
||
<li >
|
||
<a href="/installation/softlayer/">IBM Softlayer</a>
|
||
</li>
|
||
|
||
<li >
|
||
<a href="/installation/archlinux/">Arch Linux</a>
|
||
</li>
|
||
|
||
<li >
|
||
<a href="/installation/frugalware/">FrugalWare</a>
|
||
</li>
|
||
|
||
<li >
|
||
<a href="/installation/fedora/">Fedora</a>
|
||
</li>
|
||
|
||
<li >
|
||
<a href="/installation/SUSE/">SUSE</a>
|
||
</li>
|
||
|
||
<li >
|
||
<a href="/installation/cruxlinux/">CRUX Linux</a>
|
||
</li>
|
||
|
||
<li >
|
||
<a href="/installation/windows/">Microsoft Windows</a>
|
||
</li>
|
||
|
||
<li >
|
||
<a href="/installation/binaries/">Binaries</a>
|
||
</li>
|
||
|
||
</ul>
|
||
</li>
|
||
|
||
|
||
|
||
<li class="dd_menu pull-left">
|
||
|
||
<a href="/userguide/">User Guide</a>
|
||
|
||
<ul class="dd_submenu" style="max-height: 75px;">
|
||
|
||
<li >
|
||
<a href="/userguide/">The Docker User Guide</a>
|
||
</li>
|
||
|
||
<li >
|
||
<a href="/userguide/dockerhub/">Getting Started with Docker Hub</a>
|
||
</li>
|
||
|
||
<li >
|
||
<a href="/userguide/dockerizing/">Dockerizing Applications</a>
|
||
</li>
|
||
|
||
<li >
|
||
<a href="/userguide/usingdocker/">Working with Containers</a>
|
||
</li>
|
||
|
||
<li >
|
||
<a href="/userguide/dockerimages/">Working with Docker Images</a>
|
||
</li>
|
||
|
||
<li >
|
||
<a href="/userguide/dockerlinks/">Linking containers together</a>
|
||
</li>
|
||
|
||
<li >
|
||
<a href="/userguide/dockervolumes/">Managing data in containers</a>
|
||
</li>
|
||
|
||
<li >
|
||
<a href="/userguide/dockerrepos/">Working with Docker Hub</a>
|
||
</li>
|
||
|
||
</ul>
|
||
</li>
|
||
|
||
|
||
|
||
<li class="dd_menu pull-left">
|
||
|
||
<a href="/docker-hub/">Docker Hub</a>
|
||
|
||
<ul class="dd_submenu" style="max-height: 75px;">
|
||
|
||
<li >
|
||
<a href="/docker-hub/">Docker Hub</a>
|
||
</li>
|
||
|
||
<li >
|
||
<a href="/docker-hub/accounts/">Accounts</a>
|
||
</li>
|
||
|
||
<li >
|
||
<a href="/docker-hub/repos/">Repositories</a>
|
||
</li>
|
||
|
||
<li >
|
||
<a href="/docker-hub/builds/">Automated Builds</a>
|
||
</li>
|
||
|
||
<li >
|
||
<a href="/docker-hub/official_repos/">Official Repo Guidelines</a>
|
||
</li>
|
||
|
||
</ul>
|
||
</li>
|
||
|
||
|
||
|
||
<li class="dd_menu pull-left">
|
||
|
||
<a href="/examples/nodejs_web_app/">Examples</a>
|
||
|
||
<ul class="dd_submenu" style="max-height: 75px;">
|
||
|
||
<li >
|
||
<a href="/examples/nodejs_web_app/">Dockerizing a Node.js web application</a>
|
||
</li>
|
||
|
||
<li >
|
||
<a href="/examples/mongodb/">Dockerizing MongoDB</a>
|
||
</li>
|
||
|
||
<li >
|
||
<a href="/examples/running_redis_service/">Dockerizing a Redis service</a>
|
||
</li>
|
||
|
||
<li >
|
||
<a href="/examples/postgresql_service/">Dockerizing a PostgreSQL service</a>
|
||
</li>
|
||
|
||
<li >
|
||
<a href="/examples/running_riak_service/">Dockerizing a Riak service</a>
|
||
</li>
|
||
|
||
<li >
|
||
<a href="/examples/running_ssh_service/">Dockerizing an SSH service</a>
|
||
</li>
|
||
|
||
<li >
|
||
<a href="/examples/couchdb_data_volumes/">Dockerizing a CouchDB service</a>
|
||
</li>
|
||
|
||
<li >
|
||
<a href="/examples/apt-cacher-ng/">Dockerizing an Apt-Cacher-ng service</a>
|
||
</li>
|
||
|
||
</ul>
|
||
</li>
|
||
|
||
|
||
|
||
<li class="dd_menu pull-left">
|
||
|
||
<a href="/articles/basics/">Articles</a>
|
||
|
||
<ul class="dd_submenu" style="max-height: 75px;">
|
||
|
||
<li >
|
||
<a href="/articles/basics/">Docker basics</a>
|
||
</li>
|
||
|
||
<li >
|
||
<a href="/articles/networking/">Advanced networking</a>
|
||
</li>
|
||
|
||
<li >
|
||
<a href="/articles/security/">Security</a>
|
||
</li>
|
||
|
||
<li >
|
||
<a href="/articles/https/">Running Docker with HTTPS</a>
|
||
</li>
|
||
|
||
<li >
|
||
<a href="/articles/registry_mirror/">Run a local registry mirror</a>
|
||
</li>
|
||
|
||
<li >
|
||
<a href="/articles/host_integration/">Automatically starting containers</a>
|
||
</li>
|
||
|
||
<li >
|
||
<a href="/articles/baseimages/">Creating a base image</a>
|
||
</li>
|
||
|
||
<li >
|
||
<a href="/articles/dockerfile_best-practices/">Best practices for writing Dockerfiles</a>
|
||
</li>
|
||
|
||
<li >
|
||
<a href="/articles/certificates/">Using certificates for repository client verification</a>
|
||
</li>
|
||
|
||
<li >
|
||
<a href="/articles/using_supervisord/">Using Supervisor</a>
|
||
</li>
|
||
|
||
<li >
|
||
<a href="/articles/cfengine_process_management/">Process management with CFEngine</a>
|
||
</li>
|
||
|
||
<li >
|
||
<a href="/articles/puppet/">Using Puppet</a>
|
||
</li>
|
||
|
||
<li >
|
||
<a href="/articles/chef/">Using Chef</a>
|
||
</li>
|
||
|
||
<li >
|
||
<a href="/articles/dsc/">Using PowerShell DSC</a>
|
||
</li>
|
||
|
||
<li >
|
||
<a href="/articles/ambassador_pattern_linking/">Cross-Host linking using ambassador containers</a>
|
||
</li>
|
||
|
||
<li >
|
||
<a href="/articles/runmetrics/">Runtime metrics</a>
|
||
</li>
|
||
|
||
<li >
|
||
<a href="/articles/b2d_volume_resize/">Increasing a Boot2Docker volume</a>
|
||
</li>
|
||
|
||
<li >
|
||
<a href="/articles/systemd/">Controlling and configuring Docker using Systemd</a>
|
||
</li>
|
||
|
||
</ul>
|
||
</li>
|
||
|
||
|
||
|
||
<li class="dd_menu pull-left active">
|
||
|
||
<a href="/reference/commandline/cli/">Reference</a>
|
||
|
||
<ul class="dd_submenu" style="max-height: 75px;">
|
||
|
||
<li >
|
||
<a href="/reference/commandline/cli/">Command line</a>
|
||
</li>
|
||
|
||
<li >
|
||
<a href="/reference/builder/">Dockerfile</a>
|
||
</li>
|
||
|
||
<li >
|
||
<a href="/faq/">FAQ</a>
|
||
</li>
|
||
|
||
<li >
|
||
<a href="/reference/run/">Run Reference</a>
|
||
</li>
|
||
|
||
<li >
|
||
<a href="/reference/api/docker-io_api/">Docker Hub API</a>
|
||
</li>
|
||
|
||
<li >
|
||
<a href="/reference/api/registry_api/">Docker Registry API</a>
|
||
</li>
|
||
|
||
<li >
|
||
<a href="/reference/api/registry_api_client_libraries/">Docker Registry API Client Libraries</a>
|
||
</li>
|
||
|
||
<li >
|
||
<a href="/reference/api/hub_registry_spec/">Docker Hub and Registry Spec</a>
|
||
</li>
|
||
|
||
<li >
|
||
<a href="/reference/api/docker_remote_api/">Docker Remote API</a>
|
||
</li>
|
||
|
||
<li class="active">
|
||
<a href="/reference/api/docker_remote_api_v1.16/">Docker Remote API v1.16</a>
|
||
</li>
|
||
|
||
<li >
|
||
<a href="/reference/api/docker_remote_api_v1.15/">Docker Remote API v1.15</a>
|
||
</li>
|
||
|
||
<li >
|
||
<a href="/reference/api/docker_remote_api_v1.14/">Docker Remote API v1.14</a>
|
||
</li>
|
||
|
||
<li >
|
||
<a href="/reference/api/docker_remote_api_v1.13/">Docker Remote API v1.13</a>
|
||
</li>
|
||
|
||
<li >
|
||
<a href="/reference/api/docker_remote_api_v1.12/">Docker Remote API v1.12</a>
|
||
</li>
|
||
|
||
<li >
|
||
<a href="/reference/api/docker_remote_api_v1.11/">Docker Remote API v1.11</a>
|
||
</li>
|
||
|
||
<li >
|
||
<a href="/reference/api/remote_api_client_libraries/">Docker Remote API Client Libraries</a>
|
||
</li>
|
||
|
||
<li >
|
||
<a href="/reference/api/docker_io_accounts_api/">Docker Hub Accounts API</a>
|
||
</li>
|
||
|
||
</ul>
|
||
</li>
|
||
|
||
|
||
|
||
<li class="dd_menu pull-left">
|
||
|
||
<a href="/contributing/contributing/">Contribute</a>
|
||
|
||
<ul class="dd_submenu" style="max-height: 75px;">
|
||
|
||
<li >
|
||
<a href="/contributing/contributing/">Contributing</a>
|
||
</li>
|
||
|
||
<li >
|
||
<a href="/contributing/devenvironment/">Development environment</a>
|
||
</li>
|
||
|
||
<li >
|
||
<a href="/contributing/docs_style-guide/">Documentation style guide</a>
|
||
</li>
|
||
|
||
</ul>
|
||
</li>
|
||
|
||
|
||
</ul>
|
||
<form id="nav_search" class="pull-right" action="/jsearch/">
|
||
<span role="status" aria-live="polite" class="ui-helper-hidden-accessible"></span>
|
||
<input name="q" id="tipue_search_input" type="text" class="search_input search-query ui-autocomplete-input" placeholder="Search the Docs" autocomplete="off">
|
||
</form>
|
||
</div>
|
||
</nav>
|
||
<div id="content" class="container">
|
||
<div class="row">
|
||
|
||
<div class="span3" id="leftnav">
|
||
<div id="toc_table">
|
||
<ul class="nav nav-tabs nav-stacked">
|
||
|
||
|
||
<li class=""><a href="#1-brief-introduction">1. Brief introduction</a></li>
|
||
|
||
|
||
|
||
|
||
<li class=""><a href="#21-containers">2.1 Containers</a></li>
|
||
|
||
<h3><a href="#list-containers">List containers</a></h3>
|
||
|
||
<h3><a href="#create-a-container">Create a container</a></h3>
|
||
|
||
<h3><a href="#inspect-a-container">Inspect a container</a></h3>
|
||
|
||
<h3><a href="#list-processes-running-inside-a-container">List processes running inside a container</a></h3>
|
||
|
||
<h3><a href="#get-container-logs">Get container logs</a></h3>
|
||
|
||
<h3><a href="#inspect-changes-on-a-containers-filesystem">Inspect changes on a container's filesystem</a></h3>
|
||
|
||
<h3><a href="#export-a-container">Export a container</a></h3>
|
||
|
||
<h3><a href="#resize-a-container-tty">Resize a container TTY</a></h3>
|
||
|
||
<h3><a href="#start-a-container">Start a container</a></h3>
|
||
|
||
<h3><a href="#stop-a-container">Stop a container</a></h3>
|
||
|
||
<h3><a href="#restart-a-container">Restart a container</a></h3>
|
||
|
||
<h3><a href="#kill-a-container">Kill a container</a></h3>
|
||
|
||
<h3><a href="#pause-a-container">Pause a container</a></h3>
|
||
|
||
<h3><a href="#unpause-a-container">Unpause a container</a></h3>
|
||
|
||
<h3><a href="#attach-to-a-container">Attach to a container</a></h3>
|
||
|
||
<h3><a href="#attach-to-a-container-websocket">Attach to a container (websocket)</a></h3>
|
||
|
||
<h3><a href="#wait-a-container">Wait a container</a></h3>
|
||
|
||
<h3><a href="#remove-a-container">Remove a container</a></h3>
|
||
|
||
<h3><a href="#copy-files-or-folders-from-a-container">Copy files or folders from a container</a></h3>
|
||
|
||
|
||
<li class=""><a href="#22-images">2.2 Images</a></li>
|
||
|
||
<h3><a href="#list-images">List Images</a></h3>
|
||
|
||
<h3><a href="#create-an-image">Create an image</a></h3>
|
||
|
||
<h3><a href="#inspect-an-image">Inspect an image</a></h3>
|
||
|
||
<h3><a href="#get-the-history-of-an-image">Get the history of an image</a></h3>
|
||
|
||
<h3><a href="#push-an-image-on-the-registry">Push an image on the registry</a></h3>
|
||
|
||
<h3><a href="#tag-an-image-into-a-repository">Tag an image into a repository</a></h3>
|
||
|
||
<h3><a href="#remove-an-image">Remove an image</a></h3>
|
||
|
||
<h3><a href="#search-images">Search images</a></h3>
|
||
|
||
|
||
<li class=""><a href="#23-misc">2.3 Misc</a></li>
|
||
|
||
<h3><a href="#build-an-image-from-dockerfile-via-stdin">Build an image from Dockerfile via stdin</a></h3>
|
||
|
||
<h3><a href="#check-auth-configuration">Check auth configuration</a></h3>
|
||
|
||
<h3><a href="#display-system-wide-information">Display system-wide information</a></h3>
|
||
|
||
<h3><a href="#show-the-docker-version-information">Show the docker version information</a></h3>
|
||
|
||
<h3><a href="#ping-the-docker-server">Ping the docker server</a></h3>
|
||
|
||
<h3><a href="#create-a-new-image-from-a-containers-changes">Create a new image from a container's changes</a></h3>
|
||
|
||
<h3><a href="#monitor-dockers-events">Monitor Docker's events</a></h3>
|
||
|
||
<h3><a href="#get-a-tarball-containing-all-images-in-a-repository">Get a tarball containing all images in a repository</a></h3>
|
||
|
||
<h3><a href="#get-a-tarball-containing-all-images">Get a tarball containing all images.</a></h3>
|
||
|
||
<h3><a href="#load-a-tarball-with-a-set-of-images-and-tags-into-docker">Load a tarball with a set of images and tags into docker</a></h3>
|
||
|
||
<h3><a href="#image-tarball-format">Image tarball format</a></h3>
|
||
|
||
<h3><a href="#exec-create">Exec Create</a></h3>
|
||
|
||
<h3><a href="#exec-start">Exec Start</a></h3>
|
||
|
||
<h3><a href="#exec-resize">Exec Resize</a></h3>
|
||
|
||
<h3><a href="#exec-inspect">Exec Inspect</a></h3>
|
||
|
||
|
||
|
||
|
||
<li class=""><a href="#31-inside-docker-run">3.1 Inside docker run</a></li>
|
||
|
||
|
||
<li class=""><a href="#32-hijacking">3.2 Hijacking</a></li>
|
||
|
||
|
||
<li class=""><a href="#33-cors-requests">3.3 CORS Requests</a></li>
|
||
|
||
|
||
|
||
</ul>
|
||
</div>
|
||
</div>
|
||
<div class="span9 content-body">
|
||
|
||
|
||
|
||
<div id="versionnav" class="span3 pull-right invisible">
|
||
<ul class="nav version pull-right">
|
||
<li class="dropdown">
|
||
<a id="document-version-number" class="dropdown-toggle" data-toggle="dropdown" href="#">
|
||
Version v1.4
|
||
</a>
|
||
<ul id="documentation-version-list" class="dropdown-menu pull-right">
|
||
|
||
<li role="presentation" class="divider"></li>
|
||
<li> <a class="home-link3 tertiary-nav" href="https://github.com/docker/docker/blob/master/docs/sources/reference/api/docker_remote_api_v1.16.md" >Edit on GitHub</a></li>
|
||
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</div>
|
||
|
||
<h1 id="docker-remote-api-v116">Docker Remote API v1.16</h1>
|
||
<h2 id="1-brief-introduction">1. Brief introduction</h2>
|
||
<ul>
|
||
<li>The Remote API has replaced <code>rcli</code>.</li>
|
||
<li>The daemon listens on <code>unix:///var/run/docker.sock</code> but you can
|
||
<a href="/articles/basics/#bind-docker-to-another-hostport-or-a-unix-socket">Bind Docker to another host/port or a Unix socket</a>.</li>
|
||
<li>The API tends to be REST, but for some complex commands, like <code>attach</code>
|
||
or <code>pull</code>, the HTTP connection is hijacked to transport <code>STDOUT</code>,
|
||
<code>STDIN</code> and <code>STDERR</code>.</li>
|
||
</ul>
|
||
<h1 id="2-endpoints">2. Endpoints</h1>
|
||
<h2 id="21-containers">2.1 Containers</h2>
|
||
<h3 id="list-containers">List containers</h3>
|
||
<p><code>GET /containers/json</code></p>
|
||
<p>List containers</p>
|
||
<p><strong>Example request</strong>:</p>
|
||
<pre class="prettyprint well"><code> GET /containers/json?all=1&before=8dfafdbc3a40&size=1 HTTP/1.1
|
||
</code></pre>
|
||
<p><strong>Example response</strong>:</p>
|
||
<pre class="prettyprint well"><code> HTTP/1.1 200 OK
|
||
Content-Type: application/json
|
||
|
||
[
|
||
{
|
||
"Id": "8dfafdbc3a40",
|
||
"Image": "base:latest",
|
||
"Command": "echo 1",
|
||
"Created": 1367854155,
|
||
"Status": "Exit 0",
|
||
"Ports": [{"PrivatePort": 2222, "PublicPort": 3333, "Type": "tcp"}],
|
||
"SizeRw": 12288,
|
||
"SizeRootFs": 0
|
||
},
|
||
{
|
||
"Id": "9cd87474be90",
|
||
"Image": "base:latest",
|
||
"Command": "echo 222222",
|
||
"Created": 1367854155,
|
||
"Status": "Exit 0",
|
||
"Ports": [],
|
||
"SizeRw": 12288,
|
||
"SizeRootFs": 0
|
||
},
|
||
{
|
||
"Id": "3176a2479c92",
|
||
"Image": "base:latest",
|
||
"Command": "echo 3333333333333333",
|
||
"Created": 1367854154,
|
||
"Status": "Exit 0",
|
||
"Ports":[],
|
||
"SizeRw":12288,
|
||
"SizeRootFs":0
|
||
},
|
||
{
|
||
"Id": "4cb07b47f9fb",
|
||
"Image": "base:latest",
|
||
"Command": "echo 444444444444444444444444444444444",
|
||
"Created": 1367854152,
|
||
"Status": "Exit 0",
|
||
"Ports": [],
|
||
"SizeRw": 12288,
|
||
"SizeRootFs": 0
|
||
}
|
||
]
|
||
</code></pre>
|
||
<p>Query Parameters:</p>
|
||
<ul>
|
||
<li><strong>all</strong> – 1/True/true or 0/False/false, Show all containers.
|
||
Only running containers are shown by default (i.e., this defaults to false)</li>
|
||
<li><strong>limit</strong> – Show <code>limit</code> last created
|
||
containers, include non-running ones.</li>
|
||
<li><strong>since</strong> – Show only containers created since Id, include
|
||
non-running ones.</li>
|
||
<li><strong>before</strong> – Show only containers created before Id, include
|
||
non-running ones.</li>
|
||
<li><strong>size</strong> – 1/True/true or 0/False/false, Show the containers
|
||
sizes</li>
|
||
<li><strong>filters</strong> - a json encoded value of the filters (a map[string][]string) to process on the containers list. Available filters:</li>
|
||
<li>exited=<int> -- containers with exit code of <int></li>
|
||
<li>status=(restarting|running|paused|exited)</li>
|
||
</ul>
|
||
<p>Status Codes:</p>
|
||
<ul>
|
||
<li><strong>200</strong> – no error</li>
|
||
<li><strong>400</strong> – bad parameter</li>
|
||
<li><strong>500</strong> – server error</li>
|
||
</ul>
|
||
<h3 id="create-a-container">Create a container</h3>
|
||
<p><code>POST /containers/create</code></p>
|
||
<p>Create a container</p>
|
||
<p><strong>Example request</strong>:</p>
|
||
<pre class="prettyprint well"><code> POST /containers/create HTTP/1.1
|
||
Content-Type: application/json
|
||
|
||
{
|
||
"Hostname": "",
|
||
"Domainname": "",
|
||
"User": "",
|
||
"Memory": 0,
|
||
"MemorySwap": 0,
|
||
"CpuShares": 512,
|
||
"Cpuset": "0,1",
|
||
"AttachStdin": false,
|
||
"AttachStdout": true,
|
||
"AttachStderr": true,
|
||
"Tty": false,
|
||
"OpenStdin": false,
|
||
"StdinOnce": false,
|
||
"Env": null,
|
||
"Cmd": [
|
||
"date"
|
||
],
|
||
"Entrypoint": "",
|
||
"Image": "base",
|
||
"Volumes": {
|
||
"/tmp": {}
|
||
},
|
||
"WorkingDir": "",
|
||
"NetworkDisabled": false,
|
||
"MacAddress": "12:34:56:78:9a:bc",
|
||
"ExposedPorts": {
|
||
"22/tcp": {}
|
||
},
|
||
"SecurityOpts": [""],
|
||
"HostConfig": {
|
||
"Binds": ["/tmp:/tmp"],
|
||
"Links": ["redis3:redis"],
|
||
"LxcConf": {"lxc.utsname":"docker"},
|
||
"PortBindings": { "22/tcp": [{ "HostPort": "11022" }] },
|
||
"PublishAllPorts": false,
|
||
"Privileged": false,
|
||
"Dns": ["8.8.8.8"],
|
||
"DnsSearch": [""],
|
||
"ExtraHosts": null,
|
||
"VolumesFrom": ["parent", "other:ro"],
|
||
"CapAdd": ["NET_ADMIN"],
|
||
"CapDrop": ["MKNOD"],
|
||
"RestartPolicy": { "Name": "", "MaximumRetryCount": 0 },
|
||
"NetworkMode": "bridge",
|
||
"Devices": []
|
||
}
|
||
}
|
||
</code></pre>
|
||
<p><strong>Example response</strong>:</p>
|
||
<pre class="prettyprint well"><code> HTTP/1.1 201 Created
|
||
Content-Type: application/json
|
||
|
||
{
|
||
"Id":"e90e34656806"
|
||
"Warnings":[]
|
||
}
|
||
</code></pre>
|
||
<p>Json Parameters:</p>
|
||
<ul>
|
||
<li><strong>Hostname</strong> - A string value containing the desired hostname to use for the
|
||
container.</li>
|
||
<li><strong>Domainname</strong> - A string value containing the desired domain name to use
|
||
for the container.</li>
|
||
<li><strong>User</strong> - A string value containg the user to use inside the container.</li>
|
||
<li><strong>Memory</strong> - Memory limit in bytes.</li>
|
||
<li><strong>MemorySwap</strong>- Total memory usage (memory + swap); set <code>-1</code> to disable swap.</li>
|
||
<li><strong>CpuShares</strong> - An integer value containing the CPU Shares for container
|
||
(ie. the relative weight vs othercontainers).
|
||
<strong>CpuSet</strong> - String value containg the cgroups Cpuset to use.</li>
|
||
<li><strong>AttachStdin</strong> - Boolean value, attaches to stdin.</li>
|
||
<li><strong>AttachStdout</strong> - Boolean value, attaches to stdout.</li>
|
||
<li><strong>AttachStderr</strong> - Boolean value, attaches to stderr.</li>
|
||
<li><strong>Tty</strong> - Boolean value, Attach standard streams to a tty, including stdin if it is not closed.</li>
|
||
<li><strong>OpenStdin</strong> - Boolean value, opens stdin,</li>
|
||
<li><strong>StdinOnce</strong> - Boolean value, close stdin after the 1 attached client disconnects.</li>
|
||
<li><strong>Env</strong> - A list of environment variables in the form of <code>VAR=value</code></li>
|
||
<li><strong>Cmd</strong> - Command to run specified as a string or an array of strings.</li>
|
||
<li><strong>Entrypoint</strong> - Set the entrypoint for the container a a string or an array
|
||
of strings</li>
|
||
<li><strong>Image</strong> - String value containing the image name to use for the container</li>
|
||
<li><strong>Volumes</strong> – An object mapping mountpoint paths (strings) inside the
|
||
container to empty objects.</li>
|
||
<li><strong>WorkingDir</strong> - A string value containing the working dir for commands to
|
||
run in.</li>
|
||
<li><strong>NetworkDisabled</strong> - Boolean value, when true disables neworking for the
|
||
container</li>
|
||
<li><strong>ExposedPorts</strong> - An object mapping ports to an empty object in the form of:
|
||
<code>"ExposedPorts": { "<port>/<tcp|udp>: {}" }</code></li>
|
||
<li><strong>SecurityOpts</strong>: A list of string values to customize labels for MLS
|
||
systems, such as SELinux.</li>
|
||
<li><strong>HostConfig</strong></li>
|
||
<li><strong>Binds</strong> – A list of volume bindings for this container. Each volume
|
||
binding is a string of the form <code>container_path</code> (to create a new
|
||
volume for the container), <code>host_path:container_path</code> (to bind-mount
|
||
a host path into the container), or <code>host_path:container_path:ro</code>
|
||
(to make the bind-mount read-only inside the container).</li>
|
||
<li><strong>Links</strong> - A list of links for the container. Each link entry should be of
|
||
of the form "container_name:alias".</li>
|
||
<li><strong>LxcConf</strong> - LXC specific configurations. These configurations will only
|
||
work when using the <code>lxc</code> execution driver.</li>
|
||
<li><strong>PortBindings</strong> - A map of exposed container ports and the host port they
|
||
should map to. It should be specified in the form
|
||
<code>{ <port>/<protocol>: [{ "HostPort": "<port>" }] }</code>
|
||
Take note that <code>port</code> is specified as a string and not an integer value.</li>
|
||
<li><strong>PublishAllPorts</strong> - Allocates a random host port for all of a container's
|
||
exposed ports. Specified as a boolean value.</li>
|
||
<li><strong>Privileged</strong> - Gives the container full access to the host. Specified as
|
||
a boolean value.</li>
|
||
<li><strong>Dns</strong> - A list of dns servers for the container to use.</li>
|
||
<li><strong>DnsSearch</strong> - A list of DNS search domains</li>
|
||
<li><strong>ExtraHosts</strong> - A list of hostnames/IP mappings to be added to the
|
||
container's <code>/etc/hosts</code> file. Specified in the form <code>["hostname:IP"]</code>.</li>
|
||
<li><strong>VolumesFrom</strong> - A list of volumes to inherit from another container.
|
||
Specified in the form <code><container name>[:<ro|rw>]</code></li>
|
||
<li><strong>CapAdd</strong> - A list of kernel capabilties to add to the container.</li>
|
||
<li><strong>Capdrop</strong> - A list of kernel capabilties to drop from the container.</li>
|
||
<li><strong>RestartPolicy</strong> – The behavior to apply when the container exits. The
|
||
value is an object with a <code>Name</code> property of either <code>"always"</code> to
|
||
always restart or <code>"on-failure"</code> to restart only when the container
|
||
exit code is non-zero. If <code>on-failure</code> is used, <code>MaximumRetryCount</code>
|
||
controls the number of times to retry before giving up.
|
||
The default is not to restart. (optional)
|
||
An ever increasing delay (double the previous delay, starting at 100mS)
|
||
is added before each restart to prevent flooding the server.</li>
|
||
<li><strong>NetworkMode</strong> - Sets the networking mode for the container. Supported
|
||
values are: <code>bridge</code>, <code>host</code>, and <code>container:<name|id></code></li>
|
||
<li><strong>Devices</strong> - A list of devices to add to the container specified in the
|
||
form
|
||
<code>{ "PathOnHost": "/dev/deviceName", "PathInContainer": "/dev/deviceName", "CgroupPermissions": "mrw"}</code></li>
|
||
</ul>
|
||
<p>Query Parameters:</p>
|
||
<ul>
|
||
<li><strong>name</strong> – Assign the specified name to the container. Must
|
||
match <code>/?[a-zA-Z0-9_-]+</code>.</li>
|
||
</ul>
|
||
<p>Status Codes:</p>
|
||
<ul>
|
||
<li><strong>201</strong> – no error</li>
|
||
<li><strong>404</strong> – no such container</li>
|
||
<li><strong>406</strong> – impossible to attach (container not running)</li>
|
||
<li><strong>500</strong> – server error</li>
|
||
</ul>
|
||
<h3 id="inspect-a-container">Inspect a container</h3>
|
||
<p><code>GET /containers/(id)/json</code></p>
|
||
<p>Return low-level information on the container <code>id</code></p>
|
||
<p><strong>Example request</strong>:</p>
|
||
<pre class="prettyprint well"><code> GET /containers/4fa6e0f0c678/json HTTP/1.1
|
||
</code></pre>
|
||
<p><strong>Example response</strong>:</p>
|
||
<pre class="prettyprint well"><code> HTTP/1.1 200 OK
|
||
Content-Type: application/json
|
||
|
||
{
|
||
"Id": "4fa6e0f0c6786287e131c3852c58a2e01cc697a68231826813597e4994f1d6e2",
|
||
"Created": "2013-05-07T14:51:42.041847+02:00",
|
||
"Path": "date",
|
||
"Args": [],
|
||
"Config": {
|
||
"Hostname": "4fa6e0f0c678",
|
||
"User": "",
|
||
"Memory": 0,
|
||
"MemorySwap": 0,
|
||
"AttachStdin": false,
|
||
"AttachStdout": true,
|
||
"AttachStderr": true,
|
||
"PortSpecs": null,
|
||
"Tty": false,
|
||
"OpenStdin": false,
|
||
"StdinOnce": false,
|
||
"Env": null,
|
||
"Cmd": [
|
||
"date"
|
||
],
|
||
"Dns": null,
|
||
"Image": "base",
|
||
"Volumes": {},
|
||
"VolumesFrom": "",
|
||
"WorkingDir": ""
|
||
},
|
||
"State": {
|
||
"Running": false,
|
||
"Pid": 0,
|
||
"ExitCode": 0,
|
||
"StartedAt": "2013-05-07T14:51:42.087658+02:01360",
|
||
"Ghost": false
|
||
},
|
||
"Image": "b750fe79269d2ec9a3c593ef05b4332b1d1a02a62b4accb2c21d589ff2f5f2dc",
|
||
"NetworkSettings": {
|
||
"IpAddress": "",
|
||
"IpPrefixLen": 0,
|
||
"Gateway": "",
|
||
"Bridge": "",
|
||
"PortMapping": null
|
||
},
|
||
"SysInitPath": "/home/kitty/go/src/github.com/docker/docker/bin/docker",
|
||
"ResolvConfPath": "/etc/resolv.conf",
|
||
"Volumes": {},
|
||
"HostConfig": {
|
||
"Binds": null,
|
||
"ContainerIDFile": "",
|
||
"LxcConf": [],
|
||
"Privileged": false,
|
||
"PortBindings": {
|
||
"80/tcp": [
|
||
{
|
||
"HostIp": "0.0.0.0",
|
||
"HostPort": "49153"
|
||
}
|
||
]
|
||
},
|
||
"Links": ["/name:alias"],
|
||
"PublishAllPorts": false,
|
||
"CapAdd": ["NET_ADMIN"],
|
||
"CapDrop": ["MKNOD"]
|
||
}
|
||
}
|
||
</code></pre>
|
||
<p>Status Codes:</p>
|
||
<ul>
|
||
<li><strong>200</strong> – no error</li>
|
||
<li><strong>404</strong> – no such container</li>
|
||
<li><strong>500</strong> – server error</li>
|
||
</ul>
|
||
<h3 id="list-processes-running-inside-a-container">List processes running inside a container</h3>
|
||
<p><code>GET /containers/(id)/top</code></p>
|
||
<p>List processes running inside the container <code>id</code></p>
|
||
<p><strong>Example request</strong>:</p>
|
||
<pre class="prettyprint well"><code> GET /containers/4fa6e0f0c678/top HTTP/1.1
|
||
</code></pre>
|
||
<p><strong>Example response</strong>:</p>
|
||
<pre class="prettyprint well"><code> HTTP/1.1 200 OK
|
||
Content-Type: application/json
|
||
|
||
{
|
||
"Titles": [
|
||
"USER",
|
||
"PID",
|
||
"%CPU",
|
||
"%MEM",
|
||
"VSZ",
|
||
"RSS",
|
||
"TTY",
|
||
"STAT",
|
||
"START",
|
||
"TIME",
|
||
"COMMAND"
|
||
],
|
||
"Processes": [
|
||
["root","20147","0.0","0.1","18060","1864","pts/4","S","10:06","0:00","bash"],
|
||
["root","20271","0.0","0.0","4312","352","pts/4","S+","10:07","0:00","sleep","10"]
|
||
]
|
||
}
|
||
</code></pre>
|
||
<p>Query Parameters:</p>
|
||
<ul>
|
||
<li><strong>ps_args</strong> – ps arguments to use (e.g., aux)</li>
|
||
</ul>
|
||
<p>Status Codes:</p>
|
||
<ul>
|
||
<li><strong>200</strong> – no error</li>
|
||
<li><strong>404</strong> – no such container</li>
|
||
<li><strong>500</strong> – server error</li>
|
||
</ul>
|
||
<h3 id="get-container-logs">Get container logs</h3>
|
||
<p><code>GET /containers/(id)/logs</code></p>
|
||
<p>Get stdout and stderr logs from the container <code>id</code></p>
|
||
<p><strong>Example request</strong>:</p>
|
||
<pre class="prettyprint well"><code> GET /containers/4fa6e0f0c678/logs?stderr=1&stdout=1&timestamps=1&follow=1&tail=10 HTTP/1.1
|
||
</code></pre>
|
||
<p><strong>Example response</strong>:</p>
|
||
<pre class="prettyprint well"><code> HTTP/1.1 200 OK
|
||
Content-Type: application/vnd.docker.raw-stream
|
||
|
||
{{ STREAM }}
|
||
</code></pre>
|
||
<p>Query Parameters:</p>
|
||
<ul>
|
||
<li><strong>follow</strong> – 1/True/true or 0/False/false, return stream. Default false</li>
|
||
<li><strong>stdout</strong> – 1/True/true or 0/False/false, show stdout log. Default false</li>
|
||
<li><strong>stderr</strong> – 1/True/true or 0/False/false, show stderr log. Default false</li>
|
||
<li><strong>timestamps</strong> – 1/True/true or 0/False/false, print timestamps for
|
||
every log line. Default false</li>
|
||
<li><strong>tail</strong> – Output specified number of lines at the end of logs: <code>all</code> or <code><number></code>. Default all</li>
|
||
</ul>
|
||
<p>Status Codes:</p>
|
||
<ul>
|
||
<li><strong>200</strong> – no error</li>
|
||
<li><strong>404</strong> – no such container</li>
|
||
<li><strong>500</strong> – server error</li>
|
||
</ul>
|
||
<h3 id="inspect-changes-on-a-containers-filesystem">Inspect changes on a container's filesystem</h3>
|
||
<p><code>GET /containers/(id)/changes</code></p>
|
||
<p>Inspect changes on container <code>id</code>'s filesystem</p>
|
||
<p><strong>Example request</strong>:</p>
|
||
<pre class="prettyprint well"><code> GET /containers/4fa6e0f0c678/changes HTTP/1.1
|
||
</code></pre>
|
||
<p><strong>Example response</strong>:</p>
|
||
<pre class="prettyprint well"><code> HTTP/1.1 200 OK
|
||
Content-Type: application/json
|
||
|
||
[
|
||
{
|
||
"Path": "/dev",
|
||
"Kind": 0
|
||
},
|
||
{
|
||
"Path": "/dev/kmsg",
|
||
"Kind": 1
|
||
},
|
||
{
|
||
"Path": "/test",
|
||
"Kind": 1
|
||
}
|
||
]
|
||
</code></pre>
|
||
<p>Status Codes:</p>
|
||
<ul>
|
||
<li><strong>200</strong> – no error</li>
|
||
<li><strong>404</strong> – no such container</li>
|
||
<li><strong>500</strong> – server error</li>
|
||
</ul>
|
||
<h3 id="export-a-container">Export a container</h3>
|
||
<p><code>GET /containers/(id)/export</code></p>
|
||
<p>Export the contents of container <code>id</code></p>
|
||
<p><strong>Example request</strong>:</p>
|
||
<pre class="prettyprint well"><code> GET /containers/4fa6e0f0c678/export HTTP/1.1
|
||
</code></pre>
|
||
<p><strong>Example response</strong>:</p>
|
||
<pre class="prettyprint well"><code> HTTP/1.1 200 OK
|
||
Content-Type: application/octet-stream
|
||
|
||
{{ TAR STREAM }}
|
||
</code></pre>
|
||
<p>Status Codes:</p>
|
||
<ul>
|
||
<li><strong>200</strong> – no error</li>
|
||
<li><strong>404</strong> – no such container</li>
|
||
<li><strong>500</strong> – server error</li>
|
||
</ul>
|
||
<h3 id="resize-a-container-tty">Resize a container TTY</h3>
|
||
<p><code>POST /containers/(id)/resize?h=<height>&w=<width></code></p>
|
||
<p>Resize the TTY for container with <code>id</code>. The container must be restarted for the resize to take effect.</p>
|
||
<p><strong>Example request</strong>:</p>
|
||
<pre class="prettyprint well"><code> POST /containers/4fa6e0f0c678/resize?h=40&w=80 HTTP/1.1
|
||
</code></pre>
|
||
<p><strong>Example response</strong>:</p>
|
||
<pre class="prettyprint well"><code> HTTP/1.1 200 OK
|
||
Content-Length: 0
|
||
Content-Type: text/plain; charset=utf-8
|
||
</code></pre>
|
||
<p>Status Codes:</p>
|
||
<ul>
|
||
<li><strong>200</strong> – no error</li>
|
||
<li><strong>404</strong> – No such container</li>
|
||
<li><strong>500</strong> – Cannot resize container</li>
|
||
</ul>
|
||
<h3 id="start-a-container">Start a container</h3>
|
||
<p><code>POST /containers/(id)/start</code></p>
|
||
<p>Start the container <code>id</code></p>
|
||
<p><strong>Example request</strong>:</p>
|
||
<pre class="prettyprint well"><code> POST /containers/(id)/start HTTP/1.1
|
||
Content-Type: application/json
|
||
</code></pre>
|
||
<p><strong>Example response</strong>:</p>
|
||
<pre class="prettyprint well"><code> HTTP/1.1 204 No Content
|
||
</code></pre>
|
||
<p>Json Parameters:</p>
|
||
<p>Status Codes:</p>
|
||
<ul>
|
||
<li><strong>204</strong> – no error</li>
|
||
<li><strong>304</strong> – container already started</li>
|
||
<li><strong>404</strong> – no such container</li>
|
||
<li><strong>500</strong> – server error</li>
|
||
</ul>
|
||
<h3 id="stop-a-container">Stop a container</h3>
|
||
<p><code>POST /containers/(id)/stop</code></p>
|
||
<p>Stop the container <code>id</code></p>
|
||
<p><strong>Example request</strong>:</p>
|
||
<pre class="prettyprint well"><code> POST /containers/e90e34656806/stop?t=5 HTTP/1.1
|
||
</code></pre>
|
||
<p><strong>Example response</strong>:</p>
|
||
<pre class="prettyprint well"><code> HTTP/1.1 204 No Content
|
||
</code></pre>
|
||
<p>Query Parameters:</p>
|
||
<ul>
|
||
<li><strong>t</strong> – number of seconds to wait before killing the container</li>
|
||
</ul>
|
||
<p>Status Codes:</p>
|
||
<ul>
|
||
<li><strong>204</strong> – no error</li>
|
||
<li><strong>304</strong> – container already stopped</li>
|
||
<li><strong>404</strong> – no such container</li>
|
||
<li><strong>500</strong> – server error</li>
|
||
</ul>
|
||
<h3 id="restart-a-container">Restart a container</h3>
|
||
<p><code>POST /containers/(id)/restart</code></p>
|
||
<p>Restart the container <code>id</code></p>
|
||
<p><strong>Example request</strong>:</p>
|
||
<pre class="prettyprint well"><code> POST /containers/e90e34656806/restart?t=5 HTTP/1.1
|
||
</code></pre>
|
||
<p><strong>Example response</strong>:</p>
|
||
<pre class="prettyprint well"><code> HTTP/1.1 204 No Content
|
||
</code></pre>
|
||
<p>Query Parameters:</p>
|
||
<ul>
|
||
<li><strong>t</strong> – number of seconds to wait before killing the container</li>
|
||
</ul>
|
||
<p>Status Codes:</p>
|
||
<ul>
|
||
<li><strong>204</strong> – no error</li>
|
||
<li><strong>404</strong> – no such container</li>
|
||
<li><strong>500</strong> – server error</li>
|
||
</ul>
|
||
<h3 id="kill-a-container">Kill a container</h3>
|
||
<p><code>POST /containers/(id)/kill</code></p>
|
||
<p>Kill the container <code>id</code></p>
|
||
<p><strong>Example request</strong>:</p>
|
||
<pre class="prettyprint well"><code> POST /containers/e90e34656806/kill HTTP/1.1
|
||
</code></pre>
|
||
<p><strong>Example response</strong>:</p>
|
||
<pre class="prettyprint well"><code> HTTP/1.1 204 No Content
|
||
</code></pre>
|
||
<p>Query Parameters</p>
|
||
<ul>
|
||
<li><strong>signal</strong> - Signal to send to the container: integer or string like "SIGINT".
|
||
When not set, SIGKILL is assumed and the call will waits for the container to exit.</li>
|
||
</ul>
|
||
<p>Status Codes:</p>
|
||
<ul>
|
||
<li><strong>204</strong> – no error</li>
|
||
<li><strong>404</strong> – no such container</li>
|
||
<li><strong>500</strong> – server error</li>
|
||
</ul>
|
||
<h3 id="pause-a-container">Pause a container</h3>
|
||
<p><code>POST /containers/(id)/pause</code></p>
|
||
<p>Pause the container <code>id</code></p>
|
||
<p><strong>Example request</strong>:</p>
|
||
<pre class="prettyprint well"><code> POST /containers/e90e34656806/pause HTTP/1.1
|
||
</code></pre>
|
||
<p><strong>Example response</strong>:</p>
|
||
<pre class="prettyprint well"><code> HTTP/1.1 204 No Content
|
||
</code></pre>
|
||
<p>Status Codes:</p>
|
||
<ul>
|
||
<li><strong>204</strong> – no error</li>
|
||
<li><strong>404</strong> – no such container</li>
|
||
<li><strong>500</strong> – server error</li>
|
||
</ul>
|
||
<h3 id="unpause-a-container">Unpause a container</h3>
|
||
<p><code>POST /containers/(id)/unpause</code></p>
|
||
<p>Unpause the container <code>id</code></p>
|
||
<p><strong>Example request</strong>:</p>
|
||
<pre class="prettyprint well"><code> POST /containers/e90e34656806/unpause HTTP/1.1
|
||
</code></pre>
|
||
<p><strong>Example response</strong>:</p>
|
||
<pre class="prettyprint well"><code> HTTP/1.1 204 No Content
|
||
</code></pre>
|
||
<p>Status Codes:</p>
|
||
<ul>
|
||
<li><strong>204</strong> – no error</li>
|
||
<li><strong>404</strong> – no such container</li>
|
||
<li><strong>500</strong> – server error</li>
|
||
</ul>
|
||
<h3 id="attach-to-a-container">Attach to a container</h3>
|
||
<p><code>POST /containers/(id)/attach</code></p>
|
||
<p>Attach to the container <code>id</code></p>
|
||
<p><strong>Example request</strong>:</p>
|
||
<pre class="prettyprint well"><code> POST /containers/16253994b7c4/attach?logs=1&stream=0&stdout=1 HTTP/1.1
|
||
</code></pre>
|
||
<p><strong>Example response</strong>:</p>
|
||
<pre class="prettyprint well"><code> HTTP/1.1 200 OK
|
||
Content-Type: application/vnd.docker.raw-stream
|
||
|
||
{{ STREAM }}
|
||
</code></pre>
|
||
<p>Query Parameters:</p>
|
||
<ul>
|
||
<li><strong>logs</strong> – 1/True/true or 0/False/false, return logs. Default false</li>
|
||
<li><strong>stream</strong> – 1/True/true or 0/False/false, return stream.
|
||
Default false</li>
|
||
<li><strong>stdin</strong> – 1/True/true or 0/False/false, if stream=true, attach
|
||
to stdin. Default false</li>
|
||
<li><strong>stdout</strong> – 1/True/true or 0/False/false, if logs=true, return
|
||
stdout log, if stream=true, attach to stdout. Default false</li>
|
||
<li><strong>stderr</strong> – 1/True/true or 0/False/false, if logs=true, return
|
||
stderr log, if stream=true, attach to stderr. Default false</li>
|
||
</ul>
|
||
<p>Status Codes:</p>
|
||
<ul>
|
||
<li><strong>200</strong> – no error</li>
|
||
<li><strong>400</strong> – bad parameter</li>
|
||
<li><strong>404</strong> – no such container</li>
|
||
<li>
|
||
<p><strong>500</strong> – server error</p>
|
||
<p><strong>Stream details</strong>:</p>
|
||
<p>When using the TTY setting is enabled in
|
||
<a href="/reference/api/docker_remote_api_v1.9/#create-a-container" title="POST /containers/create"><code>POST /containers/create</code>
|
||
</a>,
|
||
the stream is the raw data from the process PTY and client's stdin.
|
||
When the TTY is disabled, then the stream is multiplexed to separate
|
||
stdout and stderr.</p>
|
||
<p>The format is a <strong>Header</strong> and a <strong>Payload</strong> (frame).</p>
|
||
<p><strong>HEADER</strong></p>
|
||
<p>The header will contain the information on which stream write the
|
||
stream (stdout or stderr). It also contain the size of the
|
||
associated frame encoded on the last 4 bytes (uint32).</p>
|
||
<p>It is encoded on the first 8 bytes like this:</p>
|
||
<pre class="prettyprint well"><code>header := [8]byte{STREAM_TYPE, 0, 0, 0, SIZE1, SIZE2, SIZE3, SIZE4}
|
||
</code></pre>
|
||
<p><code>STREAM_TYPE</code> can be:</p>
|
||
</li>
|
||
<li>
|
||
<p>0: stdin (will be written on stdout)</p>
|
||
</li>
|
||
<li>1: stdout</li>
|
||
<li>
|
||
<p>2: stderr</p>
|
||
<p><code>SIZE1, SIZE2, SIZE3, SIZE4</code> are the 4 bytes of
|
||
the uint32 size encoded as big endian.</p>
|
||
<p><strong>PAYLOAD</strong></p>
|
||
<p>The payload is the raw stream.</p>
|
||
<p><strong>IMPLEMENTATION</strong></p>
|
||
<p>The simplest way to implement the Attach protocol is the following:</p>
|
||
<ol>
|
||
<li>Read 8 bytes</li>
|
||
<li>chose stdout or stderr depending on the first byte</li>
|
||
<li>Extract the frame size from the last 4 byets</li>
|
||
<li>Read the extracted size and output it on the correct output</li>
|
||
<li>Goto 1</li>
|
||
</ol>
|
||
</li>
|
||
</ul>
|
||
<h3 id="attach-to-a-container-websocket">Attach to a container (websocket)</h3>
|
||
<p><code>GET /containers/(id)/attach/ws</code></p>
|
||
<p>Attach to the container <code>id</code> via websocket</p>
|
||
<p>Implements websocket protocol handshake according to <a href="http://tools.ietf.org/html/rfc6455">RFC 6455</a></p>
|
||
<p><strong>Example request</strong></p>
|
||
<pre class="prettyprint well"><code> GET /containers/e90e34656806/attach/ws?logs=0&stream=1&stdin=1&stdout=1&stderr=1 HTTP/1.1
|
||
</code></pre>
|
||
<p><strong>Example response</strong></p>
|
||
<pre class="prettyprint well"><code> {{ STREAM }}
|
||
</code></pre>
|
||
<p>Query Parameters:</p>
|
||
<ul>
|
||
<li><strong>logs</strong> – 1/True/true or 0/False/false, return logs. Default false</li>
|
||
<li><strong>stream</strong> – 1/True/true or 0/False/false, return stream.
|
||
Default false</li>
|
||
<li><strong>stdin</strong> – 1/True/true or 0/False/false, if stream=true, attach
|
||
to stdin. Default false</li>
|
||
<li><strong>stdout</strong> – 1/True/true or 0/False/false, if logs=true, return
|
||
stdout log, if stream=true, attach to stdout. Default false</li>
|
||
<li><strong>stderr</strong> – 1/True/true or 0/False/false, if logs=true, return
|
||
stderr log, if stream=true, attach to stderr. Default false</li>
|
||
</ul>
|
||
<p>Status Codes:</p>
|
||
<ul>
|
||
<li><strong>200</strong> – no error</li>
|
||
<li><strong>400</strong> – bad parameter</li>
|
||
<li><strong>404</strong> – no such container</li>
|
||
<li><strong>500</strong> – server error</li>
|
||
</ul>
|
||
<h3 id="wait-a-container">Wait a container</h3>
|
||
<p><code>POST /containers/(id)/wait</code></p>
|
||
<p>Block until container <code>id</code> stops, then returns the exit code</p>
|
||
<p><strong>Example request</strong>:</p>
|
||
<pre class="prettyprint well"><code> POST /containers/16253994b7c4/wait HTTP/1.1
|
||
</code></pre>
|
||
<p><strong>Example response</strong>:</p>
|
||
<pre class="prettyprint well"><code> HTTP/1.1 200 OK
|
||
Content-Type: application/json
|
||
|
||
{"StatusCode": 0}
|
||
</code></pre>
|
||
<p>Status Codes:</p>
|
||
<ul>
|
||
<li><strong>200</strong> – no error</li>
|
||
<li><strong>404</strong> – no such container</li>
|
||
<li><strong>500</strong> – server error</li>
|
||
</ul>
|
||
<h3 id="remove-a-container">Remove a container</h3>
|
||
<p><code>DELETE /containers/(id)</code></p>
|
||
<p>Remove the container <code>id</code> from the filesystem</p>
|
||
<p><strong>Example request</strong>:</p>
|
||
<pre class="prettyprint well"><code> DELETE /containers/16253994b7c4?v=1 HTTP/1.1
|
||
</code></pre>
|
||
<p><strong>Example response</strong>:</p>
|
||
<pre class="prettyprint well"><code> HTTP/1.1 204 No Content
|
||
</code></pre>
|
||
<p>Query Parameters:</p>
|
||
<ul>
|
||
<li><strong>v</strong> – 1/True/true or 0/False/false, Remove the volumes
|
||
associated to the container. Default false</li>
|
||
<li><strong>force</strong> - 1/True/true or 0/False/false, Kill then remove the container.
|
||
Default false</li>
|
||
</ul>
|
||
<p>Status Codes:</p>
|
||
<ul>
|
||
<li><strong>204</strong> – no error</li>
|
||
<li><strong>400</strong> – bad parameter</li>
|
||
<li><strong>404</strong> – no such container</li>
|
||
<li><strong>500</strong> – server error</li>
|
||
</ul>
|
||
<h3 id="copy-files-or-folders-from-a-container">Copy files or folders from a container</h3>
|
||
<p><code>POST /containers/(id)/copy</code></p>
|
||
<p>Copy files or folders of container <code>id</code></p>
|
||
<p><strong>Example request</strong>:</p>
|
||
<pre class="prettyprint well"><code> POST /containers/4fa6e0f0c678/copy HTTP/1.1
|
||
Content-Type: application/json
|
||
|
||
{
|
||
"Resource": "test.txt"
|
||
}
|
||
</code></pre>
|
||
<p><strong>Example response</strong>:</p>
|
||
<pre class="prettyprint well"><code> HTTP/1.1 200 OK
|
||
Content-Type: application/x-tar
|
||
|
||
{{ TAR STREAM }}
|
||
</code></pre>
|
||
<p>Status Codes:</p>
|
||
<ul>
|
||
<li><strong>200</strong> – no error</li>
|
||
<li><strong>404</strong> – no such container</li>
|
||
<li><strong>500</strong> – server error</li>
|
||
</ul>
|
||
<h2 id="22-images">2.2 Images</h2>
|
||
<h3 id="list-images">List Images</h3>
|
||
<p><code>GET /images/json</code></p>
|
||
<p><strong>Example request</strong>:</p>
|
||
<pre class="prettyprint well"><code> GET /images/json?all=0 HTTP/1.1
|
||
</code></pre>
|
||
<p><strong>Example response</strong>:</p>
|
||
<pre class="prettyprint well"><code> HTTP/1.1 200 OK
|
||
Content-Type: application/json
|
||
|
||
[
|
||
{
|
||
"RepoTags": [
|
||
"ubuntu:12.04",
|
||
"ubuntu:precise",
|
||
"ubuntu:latest"
|
||
],
|
||
"Id": "8dbd9e392a964056420e5d58ca5cc376ef18e2de93b5cc90e868a1bbc8318c1c",
|
||
"Created": 1365714795,
|
||
"Size": 131506275,
|
||
"VirtualSize": 131506275
|
||
},
|
||
{
|
||
"RepoTags": [
|
||
"ubuntu:12.10",
|
||
"ubuntu:quantal"
|
||
],
|
||
"ParentId": "27cf784147099545",
|
||
"Id": "b750fe79269d2ec9a3c593ef05b4332b1d1a02a62b4accb2c21d589ff2f5f2dc",
|
||
"Created": 1364102658,
|
||
"Size": 24653,
|
||
"VirtualSize": 180116135
|
||
}
|
||
]
|
||
</code></pre>
|
||
<p>Query Parameters:</p>
|
||
<ul>
|
||
<li><strong>all</strong> – 1/True/true or 0/False/false, default false</li>
|
||
<li><strong>filters</strong> – a json encoded value of the filters (a map[string][]string) to process on the images list. Available filters:</li>
|
||
<li>dangling=true</li>
|
||
</ul>
|
||
<h3 id="create-an-image">Create an image</h3>
|
||
<p><code>POST /images/create</code></p>
|
||
<p>Create an image, either by pulling it from the registry or by importing it</p>
|
||
<p><strong>Example request</strong>:</p>
|
||
<pre class="prettyprint well"><code> POST /images/create?fromImage=base HTTP/1.1
|
||
</code></pre>
|
||
<p><strong>Example response</strong>:</p>
|
||
<pre class="prettyprint well"><code> HTTP/1.1 200 OK
|
||
Content-Type: application/json
|
||
|
||
{"status": "Pulling..."}
|
||
{"status": "Pulling", "progress": "1 B/ 100 B", "progressDetail": {"current": 1, "total": 100}}
|
||
{"error": "Invalid..."}
|
||
...
|
||
|
||
When using this endpoint to pull an image from the registry, the
|
||
`X-Registry-Auth` header can be used to include
|
||
a base64-encoded AuthConfig object.
|
||
</code></pre>
|
||
<p>Query Parameters:</p>
|
||
<ul>
|
||
<li><strong>fromImage</strong> – name of the image to pull</li>
|
||
<li><strong>fromSrc</strong> – source to import. The value may be a URL from which the image
|
||
can be retrieved or <code>-</code> to read the image from the request body.</li>
|
||
<li><strong>repo</strong> – repository</li>
|
||
<li><strong>tag</strong> – tag</li>
|
||
<li>
|
||
<p><strong>registry</strong> – the registry to pull from</p>
|
||
<p>Request Headers:</p>
|
||
</li>
|
||
<li>
|
||
<p><strong>X-Registry-Auth</strong> – base64-encoded AuthConfig object</p>
|
||
</li>
|
||
</ul>
|
||
<p>Status Codes:</p>
|
||
<ul>
|
||
<li><strong>200</strong> – no error</li>
|
||
<li><strong>500</strong> – server error</li>
|
||
</ul>
|
||
<h3 id="inspect-an-image">Inspect an image</h3>
|
||
<p><code>GET /images/(name)/json</code></p>
|
||
<p>Return low-level information on the image <code>name</code></p>
|
||
<p><strong>Example request</strong>:</p>
|
||
<pre class="prettyprint well"><code> GET /images/base/json HTTP/1.1
|
||
</code></pre>
|
||
<p><strong>Example response</strong>:</p>
|
||
<pre class="prettyprint well"><code> HTTP/1.1 200 OK
|
||
Content-Type: application/json
|
||
|
||
{
|
||
"Created": "2013-03-23T22:24:18.818426-07:00",
|
||
"Container": "3d67245a8d72ecf13f33dffac9f79dcdf70f75acb84d308770391510e0c23ad0",
|
||
"ContainerConfig":
|
||
{
|
||
"Hostname": "",
|
||
"User": "",
|
||
"Memory": 0,
|
||
"MemorySwap": 0,
|
||
"AttachStdin": false,
|
||
"AttachStdout": false,
|
||
"AttachStderr": false,
|
||
"PortSpecs": null,
|
||
"Tty": true,
|
||
"OpenStdin": true,
|
||
"StdinOnce": false,
|
||
"Env": null,
|
||
"Cmd": ["/bin/bash"],
|
||
"Dns": null,
|
||
"Image": "base",
|
||
"Volumes": null,
|
||
"VolumesFrom": "",
|
||
"WorkingDir": ""
|
||
},
|
||
"Id": "b750fe79269d2ec9a3c593ef05b4332b1d1a02a62b4accb2c21d589ff2f5f2dc",
|
||
"Parent": "27cf784147099545",
|
||
"Size": 6824592
|
||
}
|
||
</code></pre>
|
||
<p>Status Codes:</p>
|
||
<ul>
|
||
<li><strong>200</strong> – no error</li>
|
||
<li><strong>404</strong> – no such image</li>
|
||
<li><strong>500</strong> – server error</li>
|
||
</ul>
|
||
<h3 id="get-the-history-of-an-image">Get the history of an image</h3>
|
||
<p><code>GET /images/(name)/history</code></p>
|
||
<p>Return the history of the image <code>name</code></p>
|
||
<p><strong>Example request</strong>:</p>
|
||
<pre class="prettyprint well"><code> GET /images/base/history HTTP/1.1
|
||
</code></pre>
|
||
<p><strong>Example response</strong>:</p>
|
||
<pre class="prettyprint well"><code> HTTP/1.1 200 OK
|
||
Content-Type: application/json
|
||
|
||
[
|
||
{
|
||
"Id": "b750fe79269d",
|
||
"Created": 1364102658,
|
||
"CreatedBy": "/bin/bash"
|
||
},
|
||
{
|
||
"Id": "27cf78414709",
|
||
"Created": 1364068391,
|
||
"CreatedBy": ""
|
||
}
|
||
]
|
||
</code></pre>
|
||
<p>Status Codes:</p>
|
||
<ul>
|
||
<li><strong>200</strong> – no error</li>
|
||
<li><strong>404</strong> – no such image</li>
|
||
<li><strong>500</strong> – server error</li>
|
||
</ul>
|
||
<h3 id="push-an-image-on-the-registry">Push an image on the registry</h3>
|
||
<p><code>POST /images/(name)/push</code></p>
|
||
<p>Push the image <code>name</code> on the registry</p>
|
||
<p><strong>Example request</strong>:</p>
|
||
<pre class="prettyprint well"><code> POST /images/test/push HTTP/1.1
|
||
</code></pre>
|
||
<p><strong>Example response</strong>:</p>
|
||
<pre class="prettyprint well"><code> HTTP/1.1 200 OK
|
||
Content-Type: application/json
|
||
|
||
{"status": "Pushing..."}
|
||
{"status": "Pushing", "progress": "1/? (n/a)", "progressDetail": {"current": 1}}}
|
||
{"error": "Invalid..."}
|
||
...
|
||
|
||
If you wish to push an image on to a private registry, that image must already have been tagged
|
||
into a repository which references that registry host name and port. This repository name should
|
||
then be used in the URL. This mirrors the flow of the CLI.
|
||
</code></pre>
|
||
<p><strong>Example request</strong>:</p>
|
||
<pre class="prettyprint well"><code> POST /images/registry.acme.com:5000/test/push HTTP/1.1
|
||
</code></pre>
|
||
<p>Query Parameters:</p>
|
||
<ul>
|
||
<li><strong>tag</strong> – the tag to associate with the image on the registry, optional</li>
|
||
</ul>
|
||
<p>Request Headers:</p>
|
||
<ul>
|
||
<li><strong>X-Registry-Auth</strong> – include a base64-encoded AuthConfig
|
||
object.</li>
|
||
</ul>
|
||
<p>Status Codes:</p>
|
||
<ul>
|
||
<li><strong>200</strong> – no error</li>
|
||
<li><strong>404</strong> – no such image</li>
|
||
<li><strong>500</strong> – server error</li>
|
||
</ul>
|
||
<h3 id="tag-an-image-into-a-repository">Tag an image into a repository</h3>
|
||
<p><code>POST /images/(name)/tag</code></p>
|
||
<p>Tag the image <code>name</code> into a repository</p>
|
||
<p><strong>Example request</strong>:</p>
|
||
<pre class="prettyprint well"><code> POST /images/test/tag?repo=myrepo&force=0&tag=v42 HTTP/1.1
|
||
</code></pre>
|
||
<p><strong>Example response</strong>:</p>
|
||
<pre class="prettyprint well"><code> HTTP/1.1 201 OK
|
||
</code></pre>
|
||
<p>Query Parameters:</p>
|
||
<ul>
|
||
<li><strong>repo</strong> – The repository to tag in</li>
|
||
<li><strong>force</strong> – 1/True/true or 0/False/false, default false</li>
|
||
<li><strong>tag</strong> - The new tag name</li>
|
||
</ul>
|
||
<p>Status Codes:</p>
|
||
<ul>
|
||
<li><strong>201</strong> – no error</li>
|
||
<li><strong>400</strong> – bad parameter</li>
|
||
<li><strong>404</strong> – no such image</li>
|
||
<li><strong>409</strong> – conflict</li>
|
||
<li><strong>500</strong> – server error</li>
|
||
</ul>
|
||
<h3 id="remove-an-image">Remove an image</h3>
|
||
<p><code>DELETE /images/(name)</code></p>
|
||
<p>Remove the image <code>name</code> from the filesystem</p>
|
||
<p><strong>Example request</strong>:</p>
|
||
<pre class="prettyprint well"><code> DELETE /images/test HTTP/1.1
|
||
</code></pre>
|
||
<p><strong>Example response</strong>:</p>
|
||
<pre class="prettyprint well"><code> HTTP/1.1 200 OK
|
||
Content-type: application/json
|
||
|
||
[
|
||
{"Untagged": "3e2f21a89f"},
|
||
{"Deleted": "3e2f21a89f"},
|
||
{"Deleted": "53b4f83ac9"}
|
||
]
|
||
</code></pre>
|
||
<p>Query Parameters:</p>
|
||
<ul>
|
||
<li><strong>force</strong> – 1/True/true or 0/False/false, default false</li>
|
||
<li><strong>noprune</strong> – 1/True/true or 0/False/false, default false</li>
|
||
</ul>
|
||
<p>Status Codes:</p>
|
||
<ul>
|
||
<li><strong>200</strong> – no error</li>
|
||
<li><strong>404</strong> – no such image</li>
|
||
<li><strong>409</strong> – conflict</li>
|
||
<li><strong>500</strong> – server error</li>
|
||
</ul>
|
||
<h3 id="search-images">Search images</h3>
|
||
<p><code>GET /images/search</code></p>
|
||
<p>Search for an image on <a href="https://hub.docker.com">Docker Hub</a>.</p>
|
||
<blockquote>
|
||
<p><strong>Note</strong>:
|
||
The response keys have changed from API v1.6 to reflect the JSON
|
||
sent by the registry server to the docker daemon's request.</p>
|
||
</blockquote>
|
||
<p><strong>Example request</strong>:</p>
|
||
<pre class="prettyprint well"><code> GET /images/search?term=sshd HTTP/1.1
|
||
</code></pre>
|
||
<p><strong>Example response</strong>:</p>
|
||
<pre class="prettyprint well"><code> HTTP/1.1 200 OK
|
||
Content-Type: application/json
|
||
|
||
[
|
||
{
|
||
"description": "",
|
||
"is_official": false,
|
||
"is_automated": false,
|
||
"name": "wma55/u1210sshd",
|
||
"star_count": 0
|
||
},
|
||
{
|
||
"description": "",
|
||
"is_official": false,
|
||
"is_automated": false,
|
||
"name": "jdswinbank/sshd",
|
||
"star_count": 0
|
||
},
|
||
{
|
||
"description": "",
|
||
"is_official": false,
|
||
"is_automated": false,
|
||
"name": "vgauthier/sshd",
|
||
"star_count": 0
|
||
}
|
||
...
|
||
]
|
||
</code></pre>
|
||
<p>Query Parameters:</p>
|
||
<ul>
|
||
<li><strong>term</strong> – term to search</li>
|
||
</ul>
|
||
<p>Status Codes:</p>
|
||
<ul>
|
||
<li><strong>200</strong> – no error</li>
|
||
<li><strong>500</strong> – server error</li>
|
||
</ul>
|
||
<h2 id="23-misc">2.3 Misc</h2>
|
||
<h3 id="build-an-image-from-dockerfile-via-stdin">Build an image from Dockerfile via stdin</h3>
|
||
<p><code>POST /build</code></p>
|
||
<p>Build an image from Dockerfile via stdin</p>
|
||
<p><strong>Example request</strong>:</p>
|
||
<pre class="prettyprint well"><code> POST /build HTTP/1.1
|
||
|
||
{{ TAR STREAM }}
|
||
</code></pre>
|
||
<p><strong>Example response</strong>:</p>
|
||
<pre class="prettyprint well"><code> HTTP/1.1 200 OK
|
||
Content-Type: application/json
|
||
|
||
{"stream": "Step 1..."}
|
||
{"stream": "..."}
|
||
{"error": "Error...", "errorDetail": {"code": 123, "message": "Error..."}}
|
||
|
||
The stream must be a tar archive compressed with one of the
|
||
following algorithms: identity (no compression), gzip, bzip2, xz.
|
||
|
||
The archive must include a file called `Dockerfile`
|
||
at its root. It may include any number of other files,
|
||
which will be accessible in the build context (See the [*ADD build
|
||
command*](/reference/builder/#dockerbuilder)).
|
||
</code></pre>
|
||
<p>Query Parameters:</p>
|
||
<ul>
|
||
<li><strong>t</strong> – repository name (and optionally a tag) to be applied to
|
||
the resulting image in case of success</li>
|
||
<li><strong>q</strong> – suppress verbose build output</li>
|
||
<li><strong>nocache</strong> – do not use the cache when building the image</li>
|
||
<li><strong>pull</strong> - attempt to pull the image even if an older image exists locally</li>
|
||
<li><strong>rm</strong> - remove intermediate containers after a successful build (default behavior)</li>
|
||
<li>
|
||
<p><strong>forcerm</strong> - always remove intermediate containers (includes rm)</p>
|
||
<p>Request Headers:</p>
|
||
</li>
|
||
<li>
|
||
<p><strong>Content-type</strong> – should be set to <code>"application/tar"</code>.</p>
|
||
</li>
|
||
<li><strong>X-Registry-Config</strong> – base64-encoded ConfigFile objec</li>
|
||
</ul>
|
||
<p>Status Codes:</p>
|
||
<ul>
|
||
<li><strong>200</strong> – no error</li>
|
||
<li><strong>500</strong> – server error</li>
|
||
</ul>
|
||
<h3 id="check-auth-configuration">Check auth configuration</h3>
|
||
<p><code>POST /auth</code></p>
|
||
<p>Get the default username and email</p>
|
||
<p><strong>Example request</strong>:</p>
|
||
<pre class="prettyprint well"><code> POST /auth HTTP/1.1
|
||
Content-Type: application/json
|
||
|
||
{
|
||
"username":" hannibal",
|
||
"password: "xxxx",
|
||
"email": "hannibal@a-team.com",
|
||
"serveraddress": "https://index.docker.io/v1/"
|
||
}
|
||
</code></pre>
|
||
<p><strong>Example response</strong>:</p>
|
||
<pre class="prettyprint well"><code> HTTP/1.1 200 OK
|
||
</code></pre>
|
||
<p>Status Codes:</p>
|
||
<ul>
|
||
<li><strong>200</strong> – no error</li>
|
||
<li><strong>204</strong> – no error</li>
|
||
<li><strong>500</strong> – server error</li>
|
||
</ul>
|
||
<h3 id="display-system-wide-information">Display system-wide information</h3>
|
||
<p><code>GET /info</code></p>
|
||
<p>Display system-wide information</p>
|
||
<p><strong>Example request</strong>:</p>
|
||
<pre class="prettyprint well"><code> GET /info HTTP/1.1
|
||
</code></pre>
|
||
<p><strong>Example response</strong>:</p>
|
||
<pre class="prettyprint well"><code> HTTP/1.1 200 OK
|
||
Content-Type: application/json
|
||
|
||
{
|
||
"Containers":11,
|
||
"Images":16,
|
||
"Driver":"btrfs",
|
||
"DriverStatus": [[""]],
|
||
"ExecutionDriver":"native-0.1",
|
||
"KernelVersion":"3.12.0-1-amd64"
|
||
"NCPU":1,
|
||
"MemTotal":2099236864,
|
||
"Name":"prod-server-42",
|
||
"ID":"7TRN:IPZB:QYBB:VPBQ:UMPP:KARE:6ZNR:XE6T:7EWV:PKF4:ZOJD:TPYS",
|
||
"Debug":false,
|
||
"NFd": 11,
|
||
"NGoroutines":21,
|
||
"NEventsListener":0,
|
||
"InitPath":"/usr/bin/docker",
|
||
"InitSha1":"",
|
||
"IndexServerAddress":["https://index.docker.io/v1/"],
|
||
"MemoryLimit":true,
|
||
"SwapLimit":false,
|
||
"IPv4Forwarding":true,
|
||
"Labels":["storage=ssd"],
|
||
"DockerRootDir": "/var/lib/docker",
|
||
"OperatingSystem": "Boot2Docker",
|
||
}
|
||
</code></pre>
|
||
<p>Status Codes:</p>
|
||
<ul>
|
||
<li><strong>200</strong> – no error</li>
|
||
<li><strong>500</strong> – server error</li>
|
||
</ul>
|
||
<h3 id="show-the-docker-version-information">Show the docker version information</h3>
|
||
<p><code>GET /version</code></p>
|
||
<p>Show the docker version information</p>
|
||
<p><strong>Example request</strong>:</p>
|
||
<pre class="prettyprint well"><code> GET /version HTTP/1.1
|
||
</code></pre>
|
||
<p><strong>Example response</strong>:</p>
|
||
<pre class="prettyprint well"><code> HTTP/1.1 200 OK
|
||
Content-Type: application/json
|
||
|
||
{
|
||
"ApiVersion": "1.12",
|
||
"Version": "0.2.2",
|
||
"GitCommit": "5a2a5cc+CHANGES",
|
||
"GoVersion": "go1.0.3"
|
||
}
|
||
</code></pre>
|
||
<p>Status Codes:</p>
|
||
<ul>
|
||
<li><strong>200</strong> – no error</li>
|
||
<li><strong>500</strong> – server error</li>
|
||
</ul>
|
||
<h3 id="ping-the-docker-server">Ping the docker server</h3>
|
||
<p><code>GET /_ping</code></p>
|
||
<p>Ping the docker server</p>
|
||
<p><strong>Example request</strong>:</p>
|
||
<pre class="prettyprint well"><code> GET /_ping HTTP/1.1
|
||
</code></pre>
|
||
<p><strong>Example response</strong>:</p>
|
||
<pre class="prettyprint well"><code> HTTP/1.1 200 OK
|
||
Content-Type: text/plain
|
||
|
||
OK
|
||
</code></pre>
|
||
<p>Status Codes:</p>
|
||
<ul>
|
||
<li><strong>200</strong> - no error</li>
|
||
<li><strong>500</strong> - server error</li>
|
||
</ul>
|
||
<h3 id="create-a-new-image-from-a-containers-changes">Create a new image from a container's changes</h3>
|
||
<p><code>POST /commit</code></p>
|
||
<p>Create a new image from a container's changes</p>
|
||
<p><strong>Example request</strong>:</p>
|
||
<pre class="prettyprint well"><code> POST /commit?container=44c004db4b17&comment=message&repo=myrepo HTTP/1.1
|
||
Content-Type: application/json
|
||
|
||
{
|
||
"Hostname": "",
|
||
"Domainname": "",
|
||
"User": "",
|
||
"Memory": 0,
|
||
"MemorySwap": 0,
|
||
"CpuShares": 512,
|
||
"Cpuset": "0,1",
|
||
"AttachStdin": false,
|
||
"AttachStdout": true,
|
||
"AttachStderr": true,
|
||
"PortSpecs": null,
|
||
"Tty": false,
|
||
"OpenStdin": false,
|
||
"StdinOnce": false,
|
||
"Env": null,
|
||
"Cmd": [
|
||
"date"
|
||
],
|
||
"Volumes": {
|
||
"/tmp": {}
|
||
},
|
||
"WorkingDir": "",
|
||
"NetworkDisabled": false,
|
||
"ExposedPorts": {
|
||
"22/tcp": {}
|
||
}
|
||
}
|
||
</code></pre>
|
||
<p><strong>Example response</strong>:</p>
|
||
<pre class="prettyprint well"><code> HTTP/1.1 201 Created
|
||
Content-Type: application/vnd.docker.raw-stream
|
||
|
||
{"Id": "596069db4bf5"}
|
||
</code></pre>
|
||
<p>Json Parameters:</p>
|
||
<ul>
|
||
<li><strong>config</strong> - the container's configuration</li>
|
||
</ul>
|
||
<p>Query Parameters:</p>
|
||
<ul>
|
||
<li><strong>container</strong> – source container</li>
|
||
<li><strong>repo</strong> – repository</li>
|
||
<li><strong>tag</strong> – tag</li>
|
||
<li><strong>comment</strong> – commit message</li>
|
||
<li><strong>author</strong> – author (e.g., "John Hannibal Smith
|
||
<<a href="mailto:hannibal%40a-team.com">hannibal@a-team.com</a>>")</li>
|
||
</ul>
|
||
<p>Status Codes:</p>
|
||
<ul>
|
||
<li><strong>201</strong> – no error</li>
|
||
<li><strong>404</strong> – no such container</li>
|
||
<li><strong>500</strong> – server error</li>
|
||
</ul>
|
||
<h3 id="monitor-dockers-events">Monitor Docker's events</h3>
|
||
<p><code>GET /events</code></p>
|
||
<p>Get container events from docker, either in real time via streaming, or via
|
||
polling (using since).</p>
|
||
<p>Docker containers will report the following events:</p>
|
||
<pre class="prettyprint well"><code>create, destroy, die, export, kill, pause, restart, start, stop, unpause
|
||
</code></pre>
|
||
<p>and Docker images will report:</p>
|
||
<pre class="prettyprint well"><code>untag, delete
|
||
</code></pre>
|
||
<p><strong>Example request</strong>:</p>
|
||
<pre class="prettyprint well"><code> GET /events?since=1374067924
|
||
</code></pre>
|
||
<p><strong>Example response</strong>:</p>
|
||
<pre class="prettyprint well"><code> HTTP/1.1 200 OK
|
||
Content-Type: application/json
|
||
|
||
{"status": "create", "id": "dfdf82bd3881","from": "base:latest", "time":1374067924}
|
||
{"status": "start", "id": "dfdf82bd3881","from": "base:latest", "time":1374067924}
|
||
{"status": "stop", "id": "dfdf82bd3881","from": "base:latest", "time":1374067966}
|
||
{"status": "destroy", "id": "dfdf82bd3881","from": "base:latest", "time":1374067970}
|
||
</code></pre>
|
||
<p>Query Parameters:</p>
|
||
<ul>
|
||
<li><strong>since</strong> – timestamp used for polling</li>
|
||
<li><strong>until</strong> – timestamp used for polling</li>
|
||
<li><strong>filters</strong> – a json encoded value of the filters (a map[string][]string) to process on the event list. Available filters:</li>
|
||
<li>event=<string> -- event to filter</li>
|
||
<li>image=<string> -- image to filter</li>
|
||
<li>container=<string> -- container to filter</li>
|
||
</ul>
|
||
<p>Status Codes:</p>
|
||
<ul>
|
||
<li><strong>200</strong> – no error</li>
|
||
<li><strong>500</strong> – server error</li>
|
||
</ul>
|
||
<h3 id="get-a-tarball-containing-all-images-in-a-repository">Get a tarball containing all images in a repository</h3>
|
||
<p><code>GET /images/(name)/get</code></p>
|
||
<p>Get a tarball containing all images and metadata for the repository specified
|
||
by <code>name</code>.</p>
|
||
<p>If <code>name</code> is a specific name and tag (e.g. ubuntu:latest), then only that image
|
||
(and its parents) are returned. If <code>name</code> is an image ID, similarly only tha
|
||
image (and its parents) are returned, but with the exclusion of the
|
||
'repositories' file in the tarball, as there were no image names referenced.</p>
|
||
<p>See the <a href="#image-tarball-format">image tarball format</a> for more details.</p>
|
||
<p><strong>Example request</strong></p>
|
||
<pre class="prettyprint well"><code> GET /images/ubuntu/get
|
||
</code></pre>
|
||
<p><strong>Example response</strong>:</p>
|
||
<pre class="prettyprint well"><code> HTTP/1.1 200 OK
|
||
Content-Type: application/x-tar
|
||
|
||
Binary data stream
|
||
</code></pre>
|
||
<p>Status Codes:</p>
|
||
<ul>
|
||
<li><strong>200</strong> – no error</li>
|
||
<li><strong>500</strong> – server error</li>
|
||
</ul>
|
||
<h3 id="get-a-tarball-containing-all-images">Get a tarball containing all images.</h3>
|
||
<p><code>GET /images/get</code></p>
|
||
<p>Get a tarball containing all images and metadata for one or more repositories.</p>
|
||
<p>For each value of the <code>names</code> parameter: if it is a specific name and tag (e.g.
|
||
ubuntu:latest), then only that image (and its parents) are returned; if it is
|
||
an image ID, similarly only that image (and its parents) are returned and there
|
||
would be no names referenced in the 'repositories' file for this image ID.</p>
|
||
<p>See the <a href="#image-tarball-format">image tarball format</a> for more details.</p>
|
||
<p><strong>Example request</strong></p>
|
||
<pre class="prettyprint well"><code> GET /images/get?names=myname%2Fmyapp%3Alatest&names=busybox
|
||
</code></pre>
|
||
<p><strong>Example response</strong>:</p>
|
||
<pre class="prettyprint well"><code> HTTP/1.1 200 OK
|
||
Content-Type: application/x-tar
|
||
|
||
Binary data stream
|
||
</code></pre>
|
||
<p>Status Codes:</p>
|
||
<ul>
|
||
<li><strong>200</strong> – no error</li>
|
||
<li><strong>500</strong> – server error</li>
|
||
</ul>
|
||
<h3 id="load-a-tarball-with-a-set-of-images-and-tags-into-docker">Load a tarball with a set of images and tags into docker</h3>
|
||
<p><code>POST /images/load</code></p>
|
||
<p>Load a set of images and tags into the docker repository.
|
||
See the <a href="#image-tarball-format">image tarball format</a> for more details.</p>
|
||
<p><strong>Example request</strong></p>
|
||
<pre class="prettyprint well"><code> POST /images/load
|
||
|
||
Tarball in body
|
||
</code></pre>
|
||
<p><strong>Example response</strong>:</p>
|
||
<pre class="prettyprint well"><code> HTTP/1.1 200 OK
|
||
</code></pre>
|
||
<p>Status Codes:</p>
|
||
<ul>
|
||
<li><strong>200</strong> – no error</li>
|
||
<li><strong>500</strong> – server error</li>
|
||
</ul>
|
||
<h3 id="image-tarball-format">Image tarball format</h3>
|
||
<p>An image tarball contains one directory per image layer (named using its long ID),
|
||
each containing three files:</p>
|
||
<ol>
|
||
<li><code>VERSION</code>: currently <code>1.0</code> - the file format version</li>
|
||
<li><code>json</code>: detailed layer information, similar to <code>docker inspect layer_id</code></li>
|
||
<li><code>layer.tar</code>: A tarfile containing the filesystem changes in this layer</li>
|
||
</ol>
|
||
<p>The <code>layer.tar</code> file will contain <code>aufs</code> style <code>.wh..wh.aufs</code> files and directories
|
||
for storing attribute changes and deletions.</p>
|
||
<p>If the tarball defines a repository, there will also be a <code>repositories</code> file at
|
||
the root that contains a list of repository and tag names mapped to layer IDs.</p>
|
||
<pre class="prettyprint well"><code>{"hello-world":
|
||
{"latest": "565a9d68a73f6706862bfe8409a7f659776d4d60a8d096eb4a3cbce6999cc2a1"}
|
||
}
|
||
</code></pre>
|
||
|
||
<h3 id="exec-create">Exec Create</h3>
|
||
<p><code>POST /containers/(id)/exec</code></p>
|
||
<p>Sets up an exec instance in a running container <code>id</code></p>
|
||
<p><strong>Example request</strong>:</p>
|
||
<pre class="prettyprint well"><code> POST /containers/e90e34656806/exec HTTP/1.1
|
||
Content-Type: application/json
|
||
|
||
{
|
||
"AttachStdin": false,
|
||
"AttachStdout": true,
|
||
"AttachStderr": true,
|
||
"Tty": false,
|
||
"Cmd": [
|
||
"date"
|
||
],
|
||
}
|
||
</code></pre>
|
||
<p><strong>Example response</strong>:</p>
|
||
<pre class="prettyprint well"><code> HTTP/1.1 201 OK
|
||
Content-Type: application/json
|
||
|
||
{
|
||
"Id": "f90e34656806"
|
||
}
|
||
</code></pre>
|
||
<p>Json Parameters:</p>
|
||
<ul>
|
||
<li><strong>AttachStdin</strong> - Boolean value, attaches to stdin of the exec command.</li>
|
||
<li><strong>AttachStdout</strong> - Boolean value, attaches to stdout of the exec command.</li>
|
||
<li><strong>AttachStderr</strong> - Boolean value, attaches to stderr of the exec command.</li>
|
||
<li><strong>Tty</strong> - Boolean value to allocate a pseudo-TTY</li>
|
||
<li><strong>Cmd</strong> - Command to run specified as a string or an array of strings.</li>
|
||
</ul>
|
||
<p>Status Codes:</p>
|
||
<ul>
|
||
<li><strong>201</strong> – no error</li>
|
||
<li><strong>404</strong> – no such container</li>
|
||
</ul>
|
||
<h3 id="exec-start">Exec Start</h3>
|
||
<p><code>POST /exec/(id)/start</code></p>
|
||
<p>Starts a previously set up exec instance <code>id</code>. If <code>detach</code> is true, this API
|
||
returns after starting the <code>exec</code> command. Otherwise, this API sets up an
|
||
interactive session with the <code>exec</code> command.</p>
|
||
<p><strong>Example request</strong>:</p>
|
||
<pre class="prettyprint well"><code> POST /exec/e90e34656806/start HTTP/1.1
|
||
Content-Type: application/json
|
||
|
||
{
|
||
"Detach": false,
|
||
"Tty": false,
|
||
}
|
||
</code></pre>
|
||
<p><strong>Example response</strong>:</p>
|
||
<pre class="prettyprint well"><code> HTTP/1.1 201 OK
|
||
Content-Type: application/json
|
||
|
||
{{ STREAM }}
|
||
</code></pre>
|
||
<p>Json Parameters:</p>
|
||
<ul>
|
||
<li><strong>Detach</strong> - Detach from the exec command</li>
|
||
<li><strong>Tty</strong> - Boolean value to allocate a pseudo-TTY</li>
|
||
</ul>
|
||
<p>Status Codes:</p>
|
||
<ul>
|
||
<li><strong>201</strong> – no error</li>
|
||
<li>
|
||
<p><strong>404</strong> – no such exec instance</p>
|
||
<p><strong>Stream details</strong>:
|
||
Similar to the stream behavior of <code>POST /container/(id)/attach</code> API</p>
|
||
</li>
|
||
</ul>
|
||
<h3 id="exec-resize">Exec Resize</h3>
|
||
<p><code>POST /exec/(id)/resize</code></p>
|
||
<p>Resizes the tty session used by the exec command <code>id</code>.
|
||
This API is valid only if <code>tty</code> was specified as part of creating and starting the exec command.</p>
|
||
<p><strong>Example request</strong>:</p>
|
||
<pre class="prettyprint well"><code> POST /exec/e90e34656806/resize HTTP/1.1
|
||
Content-Type: plain/text
|
||
</code></pre>
|
||
<p><strong>Example response</strong>:</p>
|
||
<pre class="prettyprint well"><code> HTTP/1.1 201 OK
|
||
Content-Type: plain/text
|
||
</code></pre>
|
||
<p>Query Parameters:</p>
|
||
<ul>
|
||
<li><strong>h</strong> – height of tty session</li>
|
||
<li><strong>w</strong> – width</li>
|
||
</ul>
|
||
<p>Status Codes:</p>
|
||
<ul>
|
||
<li><strong>201</strong> – no error</li>
|
||
<li><strong>404</strong> – no such exec instance</li>
|
||
</ul>
|
||
<h3 id="exec-inspect">Exec Inspect</h3>
|
||
<p><code>GET /exec/(id)/json</code></p>
|
||
<p>Return low-level information about the exec command <code>id</code>.</p>
|
||
<p><strong>Example request</strong>:</p>
|
||
<pre class="prettyprint well"><code> GET /exec/11fb006128e8ceb3942e7c58d77750f24210e35f879dd204ac975c184b820b39/json HTTP/1.1
|
||
</code></pre>
|
||
<p><strong>Example response</strong>:</p>
|
||
<pre class="prettyprint well"><code> HTTP/1.1 200 OK
|
||
Content-Type: plain/text
|
||
|
||
{
|
||
"ID" : "11fb006128e8ceb3942e7c58d77750f24210e35f879dd204ac975c184b820b39",
|
||
"Running" : false,
|
||
"ExitCode" : 2,
|
||
"ProcessConfig" : {
|
||
"privileged" : false,
|
||
"user" : "",
|
||
"tty" : false,
|
||
"entrypoint" : "sh",
|
||
"arguments" : [
|
||
"-c",
|
||
"exit 2"
|
||
]
|
||
},
|
||
"OpenStdin" : false,
|
||
"OpenStderr" : false,
|
||
"OpenStdout" : false,
|
||
"Container" : {
|
||
"State" : {
|
||
"Running" : true,
|
||
"Paused" : false,
|
||
"Restarting" : false,
|
||
"OOMKilled" : false,
|
||
"Pid" : 3650,
|
||
"ExitCode" : 0,
|
||
"Error" : "",
|
||
"StartedAt" : "2014-11-17T22:26:03.717657531Z",
|
||
"FinishedAt" : "0001-01-01T00:00:00Z"
|
||
},
|
||
"ID" : "8f177a186b977fb451136e0fdf182abff5599a08b3c7f6ef0d36a55aaf89634c",
|
||
"Created" : "2014-11-17T22:26:03.626304998Z",
|
||
"Path" : "date",
|
||
"Args" : [],
|
||
"Config" : {
|
||
"Hostname" : "8f177a186b97",
|
||
"Domainname" : "",
|
||
"User" : "",
|
||
"Memory" : 0,
|
||
"MemorySwap" : 0,
|
||
"CpuShares" : 0,
|
||
"Cpuset" : "",
|
||
"AttachStdin" : false,
|
||
"AttachStdout" : false,
|
||
"AttachStderr" : false,
|
||
"PortSpecs" : null,
|
||
"ExposedPorts" : null,
|
||
"Tty" : false,
|
||
"OpenStdin" : false,
|
||
"StdinOnce" : false,
|
||
"Env" : [ "PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin" ],
|
||
"Cmd" : [
|
||
"date"
|
||
],
|
||
"Image" : "ubuntu",
|
||
"Volumes" : null,
|
||
"WorkingDir" : "",
|
||
"Entrypoint" : null,
|
||
"NetworkDisabled" : false,
|
||
"MacAddress" : "",
|
||
"OnBuild" : null,
|
||
"SecurityOpt" : null
|
||
},
|
||
"Image" : "5506de2b643be1e6febbf3b8a240760c6843244c41e12aa2f60ccbb7153d17f5",
|
||
"NetworkSettings" : {
|
||
"IPAddress" : "172.17.0.2",
|
||
"IPPrefixLen" : 16,
|
||
"MacAddress" : "02:42:ac:11:00:02",
|
||
"Gateway" : "172.17.42.1",
|
||
"Bridge" : "docker0",
|
||
"PortMapping" : null,
|
||
"Ports" : {}
|
||
},
|
||
"ResolvConfPath" : "/var/lib/docker/containers/8f177a186b977fb451136e0fdf182abff5599a08b3c7f6ef0d36a55aaf89634c/resolv.conf",
|
||
"HostnamePath" : "/var/lib/docker/containers/8f177a186b977fb451136e0fdf182abff5599a08b3c7f6ef0d36a55aaf89634c/hostname",
|
||
"HostsPath" : "/var/lib/docker/containers/8f177a186b977fb451136e0fdf182abff5599a08b3c7f6ef0d36a55aaf89634c/hosts",
|
||
"Name" : "/test",
|
||
"Driver" : "aufs",
|
||
"ExecDriver" : "native-0.2",
|
||
"MountLabel" : "",
|
||
"ProcessLabel" : "",
|
||
"AppArmorProfile" : "",
|
||
"RestartCount" : 0,
|
||
"Volumes" : {},
|
||
"VolumesRW" : {}
|
||
}
|
||
}
|
||
</code></pre>
|
||
<p>Status Codes:</p>
|
||
<ul>
|
||
<li><strong>200</strong> – no error</li>
|
||
<li><strong>404</strong> – no such exec instance</li>
|
||
<li><strong>500</strong> - server error</li>
|
||
</ul>
|
||
<h1 id="3-going-further">3. Going further</h1>
|
||
<h2 id="31-inside-docker-run">3.1 Inside <code>docker run</code></h2>
|
||
<p>As an example, the <code>docker run</code> command line makes the following API calls:</p>
|
||
<ul>
|
||
<li>
|
||
<p>Create the container</p>
|
||
</li>
|
||
<li>
|
||
<p>If the status code is 404, it means the image doesn't exist:</p>
|
||
<ul>
|
||
<li>Try to pull it</li>
|
||
<li>Then retry to create the container</li>
|
||
</ul>
|
||
</li>
|
||
<li>
|
||
<p>Start the container</p>
|
||
</li>
|
||
<li>
|
||
<p>If you are not in detached mode:</p>
|
||
</li>
|
||
<li>
|
||
<p>Attach to the container, using logs=1 (to have stdout and
|
||
stderr from the container's start) and stream=1</p>
|
||
</li>
|
||
<li>
|
||
<p>If in detached mode or only stdin is attached:</p>
|
||
</li>
|
||
<li>Display the container's id</li>
|
||
</ul>
|
||
<h2 id="32-hijacking">3.2 Hijacking</h2>
|
||
<p>In this version of the API, /attach, uses hijacking to transport stdin,
|
||
stdout and stderr on the same socket. This might change in the future.</p>
|
||
<h2 id="33-cors-requests">3.3 CORS Requests</h2>
|
||
<p>To enable cross origin requests to the remote api add the flag
|
||
"--api-enable-cors" when running docker in daemon mode.</p>
|
||
<pre class="prettyprint well"><code>$ docker -d -H="192.168.1.9:2375" --api-enable-cors
|
||
</code></pre>
|
||
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
<div id="push-footer"></div>
|
||
|
||
</div>
|
||
|
||
|
||
|
||
<div id="footer-container" class="container">
|
||
<div id="footer" class="grey-body">
|
||
<div class="row">
|
||
<div class="span2">
|
||
<span class="footer-title">Community</span>
|
||
<ul class="unstyled">
|
||
<li><a class="primary-button" href="https://www.docker.com/community/events/">Events</a></li>
|
||
<li><a class="primary-button" href="http://posts.docker.com">Friends' Posts</a></li>
|
||
<li><a class="primary-button" href="https://www.docker.com/community/meetups/">Meetups</a></li>
|
||
<li><a class="primary-button" href="https://www.docker.com/community/governance/">Governance</a></li>
|
||
<li><a class="primary-button" href="http://forums.docker.com">Forums</a></li>
|
||
<li><a class="primary-button" href="http://botbot.me/freenode/docker">IRC</a></li>
|
||
<li><a class="primary-button" href="https://github.com/docker/docker">GitHub</a></li>
|
||
<li><a class="primary-button" href="http://stackoverflow.com/search?q=docker">Stackoverflow</a></li>
|
||
<li><a class="primary-button" href="http://www.cafepress.com/docker">Swag</a></li>
|
||
</ul>
|
||
</div>
|
||
<div class="span2">
|
||
<span class="footer-title">Enterprise</span>
|
||
<ul class="unstyled">
|
||
<li><a class="primary-button" href="https://www.docker.com/enterprise/support/">Support</a></li>
|
||
<li><a class="primary-button" href="https://www.docker.com/enterprise/education/">Education</a></li>
|
||
<li><a class="primary-button" href="https://www.docker.com/enterprise/services/">Services</a></li>
|
||
</ul>
|
||
<span class="footer-title">Partner Solutions</span>
|
||
<ul class="unstyled">
|
||
<li><a class="primary-button" href="https://www.docker.com/partners/find/">Find a Partner</a></li>
|
||
<li><a class="primary-button" href="https://www.docker.com/partners/program/">Partner Program</a></li>
|
||
<li><a class="primary-button" href="https://www.docker.com/partners/learn/">Learn More</a></li>
|
||
</ul>
|
||
</div>
|
||
<div class="span2">
|
||
<span class="footer-title">Resources</span>
|
||
<ul class="unstyled">
|
||
<li><a class="primary-button" href="https://docs.docker.com">Documentation</a></li>
|
||
<li><a class="primary-button" href="https://www.docker.com/resources/help/">Help</a></li>
|
||
<li><a class="primary-button" href="https://www.docker.com/resources/usecases/">Use Cases</a></li>
|
||
<li><a class="primary-button" href="http://www.docker.com/tryit/">Online Tutorial</a></li>
|
||
<li><a class="primary-button" href="https://www.docker.com/resources/howtobuy/">How To Buy</a></li>
|
||
<li><a class="primary-button" href="http://status.docker.com">Status</a></li>
|
||
<li><a class="primary-button" href="https://www.docker.com/resources/security/">Security</a></li>
|
||
</ul>
|
||
</div>
|
||
<div class="span2">
|
||
<span class="footer-title">Company</span>
|
||
<ul class="unstyled">
|
||
<li><a class="primary-button" href="https://www.docker.com/company/aboutus/">About Us</a></li>
|
||
<li><a class="primary-button" href="https://www.docker.com/company/team/">Team</a></li>
|
||
<li><a class="primary-button" href="https://www.docker.com/company/news/">News</a></li>
|
||
<li><a class="primary-button" href="https://www.docker.com/company/press/">Press</a></li>
|
||
<li><a class="primary-button" href="https://www.docker.com/company/careers/">Careers</a></li>
|
||
<li><a class="primary-button" href="https://www.docker.com/company/contact/">Contact</a></li>
|
||
</ul>
|
||
</div>
|
||
<div class="span3">
|
||
<span class="footer-title">Connect</span>
|
||
<div class="search">
|
||
<span>Subscribe to our newsletter</span>
|
||
<form action="https://www.docker.com/subscribe_newsletter/" method="post">
|
||
<input type='hidden' name='csrfmiddlewaretoken' value='aWL78QXQkY8DSKNYh6cl08p5eTLl7sOa' />
|
||
<tr><th><label for="id_email">Email:</label></th><td><input class="form-control" id="id_email" name="email" placeholder="Enter your email" type="text" /></td></tr>
|
||
|
||
<button type="submit"><i class="icon-arrow-right"></i> </button>
|
||
</form>
|
||
</div>
|
||
<ul class="unstyled social">
|
||
<li><a title="Docker on Twitter" class="primary-button blog" href="http://blog.docker.com">Blog</a></li>
|
||
<li><a title="Docker on Twitter" class="primary-button twitter" href="http://twitter.com/docker">Twitter</a></li>
|
||
<li><a title="Docker on Google+" class="primary-button googleplus" href="https://plus.google.com/u/0/communities/108146856671494713993">Google+</a></li>
|
||
<li><a title="Docker on Facebook" class="primary-button facebook" href="https://www.facebook.com/docker.run">Facebook</a></li>
|
||
<li><a title="Docker on Youtube" class="primary-button youtube" href="http://www.youtube.com/user/dockerrun">YouTube</a></li>
|
||
</ul>
|
||
<ul class="unstyled social">
|
||
<li><a title="Docker on SlideShare" class="primary-button slideshare" href="http://www.slideshare.net/Docker">Slideshare</a></li>
|
||
<li>
|
||
<a title="Docker on LinkedIn" class="primary-button" href="https://www.linkedin.com/company/docker">
|
||
<span class="linkedin"></span>
|
||
LinkedIn
|
||
</a>
|
||
</li>
|
||
<li>
|
||
<a title="Docker on GitHub" class="primary-button" href="https://github.com/docker/">
|
||
<span class="github"></span>
|
||
GitHub
|
||
</a>
|
||
</li>
|
||
<li>
|
||
<a title="Docker on Reddit" class="primary-button" href="http://www.reddit.com/r/docker">
|
||
<span class="reddit"></span>
|
||
Reddit
|
||
</a>
|
||
</li>
|
||
<li>
|
||
<a title="Docker on AngelList" class="primary-button" href="https://angel.co/docker-inc-1">
|
||
<span class="angellist"></span>
|
||
AngelList
|
||
</a>
|
||
</li>
|
||
</ul>
|
||
</div>
|
||
</div>
|
||
<div class="row clearfix">
|
||
<div class="span6 pagination-right copyright">
|
||
<span>© 2014-2015 Docker, Inc.</span>
|
||
</div>
|
||
<div class="span6 pagination-left copyright">
|
||
<a href="http://www.docker.com/legal/terms_of_service">Terms</a> ·
|
||
<a href="http://www.docker.com/legal/privacy_policy">Privacy</a> ·
|
||
<a href="http://www.docker.com/legal/trademark_guidelines">Trademarks</a>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
<script src="/js/jquery-1.10.2.min.js"></script>
|
||
<script src="/js/jquery.cookie.js" ></script>
|
||
<script src="/js/jquery-scrolltofixed-min.js"></script>
|
||
<script src="/js/bootstrap-3.0.3.min.js"></script>
|
||
<script src="/js/prettify-1.0.min.js"></script>
|
||
<script src="/js/dockerfile_tutorial.js"></script>
|
||
<script src="/js/dockerfile_tutorial_level.js"></script>
|
||
<script src="/js/base.js"></script>
|
||
<script src="/tipuesearch/tipuesearch_set.js"></script>
|
||
<script src="/tipuesearch/tipuesearch.min.js"></script>
|
||
<script type="text/javascript">
|
||
piAId = '45082';
|
||
piCId = '1482';
|
||
|
||
(function() {
|
||
function async_load(){
|
||
var s = document.createElement('script'); s.type = 'text/javascript';
|
||
s.src = ('https:' == document.location.protocol ? 'https://pi' : 'http://cdn') + '.pardot.com/pd.js';
|
||
var c = document.getElementsByTagName('script')[0]; c.parentNode.insertBefore(s, c);
|
||
}
|
||
if(window.attachEvent) { window.attachEvent('onload', async_load); }
|
||
else { window.addEventListener('load', async_load, false); }
|
||
})();
|
||
</script>
|
||
<script type="text/javascript">
|
||
$(document).ready(function() {
|
||
$('#content').css("min-height", $(window).height() - 553 );
|
||
// if the URL contains a version string, update the version picker to reflect that
|
||
version = document.location.pathname.match(/^\/(v\d\.\d)\/.*/)
|
||
if (version && version[1]) {
|
||
$('#document-version-number')[0].text = 'Version '+version[1];
|
||
} else {
|
||
$('#document-version-number')[0].text = $('#document-version-number')[0].text + " (Latest)"
|
||
}
|
||
// load the complete versions list
|
||
$.get("/versions.html_fragment", function( data ) {
|
||
$('#documentation-version-list').prepend(data);
|
||
//remove any "/v1.1/" bits from front, so we can add the path to the version selection dropdown.
|
||
path = document.location.pathname.replace(/^\/v\d\.\d/, "");
|
||
$('#documentation-version-list a.version').each(function(i, e) {
|
||
e.href = e.href+path;
|
||
$(e).removeClass()
|
||
});
|
||
});
|
||
|
||
})
|
||
var userName = getCookie('docker_sso_username');
|
||
if (userName) {
|
||
$('.topmostnav_loggedout').hide();
|
||
$('.topmostnav_loggedin').show();
|
||
$('#logged-in-header-username').text(userName);
|
||
} else {
|
||
$('.topmostnav_loggedout').show();
|
||
$('.topmostnav_loggedin').hide();
|
||
}
|
||
</script>
|
||
</body>
|
||
</html> |