OPopenai
vms

Execute a command inside a VM using WebSocket protocol

Changed on
get/vms/{name}/exec

Request

  • The document declares no server URL.
  • Auth
    none declared. Required headers: Connection, Upgrade

Query parameters

commandstring required

Command to execute.

interactiveboolean

Whether to allocate an interactive standard input for the command

When enabled, make sure to close the standard input by sending a ExecClientFrameStdin frame with an empty data. Otherwise the command might never terminate waiting for the standard input to end.

stdinboolean

Deprecated alias for interactive.

If both interactive and stdin are provided, their values must match.

ttyboolean

Whether to allocate a pseudo-terminal for the command

rowsinteger

Initial terminal row count when tty=true

colsinteger

Initial terminal column count when tty=true

envobject

Environment variables to expose to the command.

Use deep object query syntax, for example env[FOO]=bar&env[BAZ]=qux.

workdirstring

Working directory to switch to before starting the command

waitinteger

Duration in seconds for the VM to become available if it's not available already

Headers

Connectionstring required

WebSocket protocol required header

Upgradestring required

WebSocket protocol required header

Changes

  • 27ee74d1b0caRevision changes
    • breaking

      the query request parameter command became required

    • warning

      deleted the query request parameter cmux_session_id

    • warning

      deleted the query request parameter session

    • warning

      removed the optional property //////// from the response with the status

    • warning

      removed the optional property //////// from the response with the status

    • warning

      removed the optional property //////// from the response with the status

    • warning

      removed the optional property //////// from the response with the status

    • info

      removed the non-success response with the status

    • info

      removed history ack detach close discriminator mapping keys from the /// response property for the response status

    • info

      removed no_more_history discriminator mapping keys from the /// response property for the response status

    • info

      removed from the /// response property oneOf list for the response status

    • info

      removed from the /// response property oneOf list for the response status

  • 4dc9d4b10d02Revision changes
    • breaking

      added to the /// response property oneOf list for the response status

    • info

      added the new optional query request parameter cols

    • info

      added the new optional query request parameter env

    • info

      added the new optional query request parameter interactive

    • info

      added the new optional query request parameter rows

    • info

      added the new optional query request parameter tty

    • info

      added the new optional query request parameter workdir

    • info

      query request parameter stdin was deprecated

    • info

      added resize discriminator mapping keys to the /// response property for the response status