Get remote-control session URL

Generates a remote-control URL for the device using the protocol given by the type query param. Enterprise Edition feature — on Community Edition this returns null.

RBAC · asset

Path parameters

idstring <uuid>Required

Asset UUID from assets.asset_id.

Query parameters

typestringOptional

Remote-control protocol (default splashtop).

Response body

Success response 200 · schema AssetRemoteControlResponse

urlstring

typestring

Response codes

200

Remote-control URL (null on CE).

401

x-api-key missing/invalid.

403

Caller lacks the required asset permission.

404

Asset not found.

500

Unexpected error.

GET /api/v1/assets/{id}/rmm/remote-control

cURL

curl -X GET "https://algapsa.com/api/v1/assets/{id}/rmm/remote-control?type=splashtop" \
  -H "X-API-Key: $ALGA_API_KEY"

TypeScript

const response = await fetch("https://algapsa.com/api/v1/assets/{id}/rmm/remote-control?type=splashtop", {
  method: "GET",
  headers: {
    "X-API-Key": "$ALGA_API_KEY",
  }
});
const data = await response.json();

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Get, "https://algapsa.com/api/v1/assets/{id}/rmm/remote-control?type=splashtop");
request.Headers.TryAddWithoutValidation("X-API-Key", "$ALGA_API_KEY");
var response = await client.SendAsync(request);
var body = await response.Content.ReadAsStringAsync();

200 OK·application/json

{
  "url": "string",
  "type": "string"
}