Skip to main content
POST
/
servers
/
{server_id}
/
out_of_band_connection
Typescript (SDK)
import { Latitudesh } from "latitudesh-typescript-sdk";

const latitudesh = new Latitudesh({
  bearer: process.env["LATITUDESH_BEARER"] ?? "",
});

async function run() {
  const result = await latitudesh.servers.startOutOfBandConnection({
    serverId: "sv_8NkvdyGKDeLpx",
    requestBody: {
      data: {
        type: "out_of_band",
        attributes: {
          sshKeyId: "ssh_3YjJOLMydvZ87",
        },
      },
    },
  });

  console.log(result);
}

run();
{
  "data": {
    "id": "obc_mw49QDB5qagKb",
    "type": "out_of_band",
    "attributes": {
      "ssh_key": {
        "id": "ssh_3YjJOLMydvZ87",
        "description": "wisozk-gislason.example",
        "fingerprint": "14:e2:8e:b3:9e:f5:08:31:b6:c7:43:6d:f5:1e:6d:b2"
      },
      "created_at": "2026-01-14T15:56:58+00:00",
      "username": "server-1",
      "credentials": {
        "user": "donn",
        "password": "398ig362ci"
      },
      "port": "2222",
      "access_ip": "189.1.2.0",
      "server_id": "sv_8NkvdyGKDeLpx",
      "status": "connected"
    }
  },
  "meta": {}
}

Authorizations

Authorization
string
header
required

Path Parameters

server_id
string
required

Body

data
object
required

Response

201 - application/vnd.api+json

Created

data
object