POST
/
interact
/
install
/
{instance_id}
import { Skylight } from "skylight-sdk";

const skylight = new Skylight({
  apikey: process.env["SKYLIGHT_APIKEY"] ?? "",
});

async function run() {
  const result = await skylight.interact.install("<id>", {
    packages: [
      "<value>",
    ],
  });

  // Handle the result
  console.log(result);
}

run();
{
  "status": "<string>"
}

Authorizations

X-API-Key
string
header
required

API key authentication

Path Parameters

instance_id
string
required

Body

application/json
packages
string[]
required

List of Chocolatey package names to install

Response

200
application/json
Packages installation initiated
status
string
required

Status of the operation

Example:

"success"

message
string
required

Human-readable status message

Example:

"Operation completed successfully"

state
string
required

State of the instance (running, pending, hibernated, terminated)

Example:

"running"

livestream_url
string
required

URL to livestream the instance

Example:

"launchskylight.com/embed/i-123456"

command_id
string | null

Command ID for tracking installation progress