Run a script via RMM

Runs the script identified by scriptId on the RMM-managed device. Enterprise Edition feature — on Community Edition this returns { success:false } with an EE-required message.

RBAC · asset

Path parameters

idstring <uuid>Required

Asset UUID from assets.asset_id.

Request body

Content type: application/json · schema AssetRmmScriptBody

scriptIdstringRequired

Provider script identifier to run on the device.

Response body

Success response 200 · schema AssetRmmActionResponse

successbooleanRequired

messagestringRequired

jobIdstring

Provider job id when the action was queued (EE).

Response codes

200

Script run result.

401

x-api-key missing/invalid.

403

Caller lacks the required asset permission.

404

Asset not found.

500

Unexpected error.

POST /api/v1/assets/{id}/rmm/script

cURL

curl -X POST "https://algapsa.com/api/v1/assets/{id}/rmm/script" \
  -H "X-API-Key: $ALGA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "scriptId": "string"
}'

TypeScript

const response = await fetch("https://algapsa.com/api/v1/assets/{id}/rmm/script", {
  method: "POST",
  headers: {
    "X-API-Key": "$ALGA_API_KEY",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "scriptId": "string"
  })
});
const data = await response.json();

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Post, "https://algapsa.com/api/v1/assets/{id}/rmm/script");
request.Headers.TryAddWithoutValidation("X-API-Key", "$ALGA_API_KEY");
request.Headers.TryAddWithoutValidation("Content-Type", "application/json");
request.Content = new StringContent(@"{
  ""scriptId"": ""string""
}", Encoding.UTF8, "application/json");
var response = await client.SendAsync(request);
var body = await response.Content.ReadAsStringAsync();

200 OK·application/json

{
  "success": false,
  "message": "string",
  "jobId": "string"
}