Wiki

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== Docker - Networking - Enable Docker Remote API ======

Docker provides a nice remote REST API.

Edit or create a systemd dropin file under: **/etc/systemd/system/docker.service.d/remote-api.conf**

With the contents:

<file bash /etc/systemd/system/docker.service.d/remote-api.conf>
[Service]
ExecStart=
ExecStart=/usr/bin/dockerd -H tcp://127.0.0.1:1234 -H unix:///var/run/docker.sock
</file>

<WRAP info>
**NOTE:**  The double ExecStart is necessary!

The following can be used instead of the 2nd ExecStart above.  **<nowiki>-H fd://</nowiki>** can also be used to refer to systemd's socket activation feature /lib/systemd/system/docker.socket.

<code bash>
ExecStart=/usr/bin/dockerd -H fd:// -H tcp://127.0.0.1:1234
</code>

It is recommended binding on 127.0.0.1 instead of 0.0.0.0, unless you have a good reason!
</WRAP>

This will have Docker bind to port 1234 which will be used by the Docker Remote API.

One you have saved your changes, you will need to restart the Docker process by running the following command:

<code bash>
sudo systemctl daemon-reload 
sudo systemctl restart docker
</code>

Check that the dockerd process listening on port 1234:

<code bash>
sudo ss -tulpn | grep 1234
tcp6       0      0 :::1234                 :::*                    LISTEN      1836/dockerd   
</code>

To test that the Docker Remote API has been properly enabled, we will list the Images currently in Docker:

<code bash>
sudo docker images
</code>

Test by performing a GET operation on the following URL: http://172.30.0.199:1234/images/json as described in the [[https://docs.docker.com/engine/api/|Docker Remote API]].

You can also easily test this by using CURL on the command-line by running the following command:

<code bash>
curl -X GET http://172.30.0.199:1234/images/json
</code>

----

===== References =====

https://docs.docker.com/engine/api/

https://docs.docker.com/engine/security/

http://www.littlebigextra.com/how-to-enable-remote-rest-api-on-docker-host/