Connect to the Instance Console

The instance console pipeline is a websocket connection that broadcasts the events of an instance's PID 1 as a raw data stream.

Authenticating

Connecting to the console websocket is a two step process.

You authenticate against the following endpoint:

/v1/containers/CONTAINER_ID/instances/ID/console

This returns a URL and a token you can use to create a websocket connection to the console.

If you're using the TypeScript client this is automatically handled for you. The function call is shown in the example area. If you're not using the TypeScript client and want to pass credentials to your websocket client of choice, you can use cURL to authenticate and pass the credentials to your client.

The return from the authentication request will be a token, and the token will need to be appended to the URL as a parameter to complete the websocket connection.

https://api.cycle.io/v1/containers/CONTAINER_ID/instances/ID/console?token=5d71fa31db2ab0000167b87e

Auth Only

Example Request
$ curl https://api.cycle.io/v1/containers/5d71fa31db2ab0000167b87e/instances/5d71fa31db2ab0000167b87e/console \
-H
"Authorization: Bearer API_KEY"
\
-H
"X-HUB-ID: HUB_ID"