Initialize interactive session Run in API Explorer

POST /session

Start a new interactive session with a server. Session allows server to call back to the client for advanced capabilities.

Hijacking

This endpoint hijacks the HTTP connection to HTTP2 transport that allows the client to expose gPRC services on that connection.

For example, the client sends this request to upgrade the connection:

POST /session HTTP/1.1
Upgrade: h2c
Connection: Upgrade

The Docker daemon responds with a 101 UPGRADED response follow with the raw stream:

HTTP/1.1 101 UPGRADED
Connection: Upgrade
Upgrade: h2c

Responses

  • 101

    no error, hijacking successful

  • 400 application/vnd.docker.raw-stream

    bad parameter

    Hide response attribute Show response attribute object
    • message string Required

      The error message.

  • 500 application/vnd.docker.raw-stream

    server error

    Hide response attribute Show response attribute object
    • message string Required

      The error message.

POST /session
curl \
 --request POST 'http://api.example.com/v1.49/session'
Response examples (400)
{
  "message": "Something went wrong."
}
Response examples (500)
{
  "message": "Something went wrong."
}