Fork me on GitHub
API V1 RESOURCES LINKS

One-off Containers

When you request to one-off container, you will receive a attach_url. This page explains how to use this endpoint.

Access your container

CONNECT [:attach_url]

To use this endpoint you have to hijack the HTTP connection. It’s pretty simple actually, when you’re doing a HTTP request, a TCP connection is created. HTTP hijacking consist in turning this connection into a full bidirectional connection.

You can find an example of implementation in this project.

For your information there is an example of server also.

HTTP is used to handle the routing and the headers, then the connection is used rawly to exchange data.

Update your container

PUT [:attach_url]

Send information to the container to update its state. As containers are interactive and that most software you may be using are using libreadline, your should notify the container when the size of the terminal is changed for instance.

Parameters

  • width: Width for the remote terminal
  • height: Height for the remote terminal

Example request:

curl -H 'Content-Type: application/json' -H 'Accept: application/json' \
  -X PUT [:attach_url] -d \
  '{
    "width": 80,
    "height": 25
  }'

Upload a file to your container

POST [:attach_url]/files

It may happen that you require a file to be present in your temporary container, for a batch or anything else, the transfer is done via a multipart form.

The Content-Type of this request is not application/json, it should be multipart/form-data; boundary=[:boundary]

It has to be done before attaching to the container. Files can be found in the directory /tmp/uploads

Form parameters:

  • file: contain the name of the file and its content.

Example request:

curl --form file=@mysql_dump.tar.gz [:attach_url]/files

Returns 200 OK Without content