Kaseya VSA

App · 25 actions

Work with Kaseya VSA remote monitoring and management: find agents, assets, organizations and machine groups, read and close alarms, run or schedule agent procedures, check patches and audits, work Service Desk tickets, and start workflows on new alarms, offline or new agents, new or changed tickets and finished agent procedures.

Actions

ActionWhat it does
Add ticket noteAdd a note to a ticket, shown to the submitter or hidden for technicians only.
Close alarmClose an alarm, as a technician does once it's dealt with, with a note saying why.
Create ticketOpen a ticket in a service desk with a summary and description, optionally its priority, status, category and submitter.
Get agentGet one agent: its machine, operating system, network, who is signed in, whether it is online and when it last checked in.
Get alarmGet one alarm: what raised it, its message, the agent it is about, whether it is open and any ticket made from it.
Get assetGet one asset's hardware details: BIOS, processors, memory, drives and network addresses.
Get audit summaryGet an agent's latest audit: make, model and serial number, network, chassis, BIOS and check-in times.
Get current userGet the VSA user the connection signs in as: name, email and when the account was created.
Get patch statusGet an agent's patch status: when it was last scanned, when the next scan and update run, and its reboot settings.
Get ticketGet one Service Desk ticket with its status, priority, assignee, submitter, dates and every note.
List agent procedure historyList when each agent procedure last ran on an agent, how it went (Success or Failed) and who ran it, latest first.
List agent proceduresList the agent procedures (VSA's scripts) the connected user can see, with their folders.
List agentsList agents (managed machines) by organization, machine group, status or name, with their operating system, IP address, current user and last check-in.
List alarmsList alarms, open and closed, newest first, for every agent or one, optionally between two times.
List assetsList assets: machines with agents and devices VSA found on the network, with their alarm and ticket counts.
List machine groupsList machine groups, for every organization or for one.
List missing patchesList the patches an agent's machine is missing, from its latest patch scan, with their KB articles.
List organizationsList the organizations (your customers, and your own) the connected user's scope can see.
List service desksList the Service Desk desks the connected user can see.
List ticketsList a service desk's tickets, newest first, by status, priority, summary or when they were opened or last changed.
List usersList VSA's users (the technicians who sign in to VSA), with their names, emails, roles and scopes.
Run agent procedureRun an agent procedure on one agent's machine now.
Run patch scanScan an agent's machine for missing patches now.
Schedule agent procedureSchedule an agent procedure on one agent's machine, once or repeating, optionally skipping it or waking the machine if it is offline.
Update ticketChange a ticket's status or priority, or assign it to a staff member.

Add ticket note

Add a note to a ticket, shown to the submitter or hidden for technicians only.

Inputs

Ticket IDticket_idtextRequired
The ticket's id (ServiceDeskTicketId), from 'List tickets', a ticket trigger or an earlier step.
NotetexttextRequired
The note's text.
Hiddenhiddentrue/false
Keep the note for technicians only, hidden from the submitter.

Outputs

addedtrue/false
Always true once added
hiddentrue/false
Whether the note is hidden from the submitter
note_idtext
The new note's id, when VSA returns one
ticket_idtext
The ticket
Example output
{
  "added": true,
  "hidden": false,
  "note_id": "281365297027569",
  "ticket_id": "15293212440025500597997781"
}

Close alarm

Close an alarm, as a technician does once it's dealt with, with a note saying why.

Inputs

Alarm IDalarm_idtextRequired
The alarm's id, from 'List alarms', the new alarm trigger or an earlier step.
Reasonnotestext
Why the alarm is closed, kept with it in VSA.

Outputs

alarm_idtext
The alarm closed
closedtrue/false
Always true once closed
notestext
The reason given, empty if none
Example output
{
  "alarm_id": "29170",
  "closed": true,
  "notes": "Disk cleaned up."
}

Create ticket

Open a ticket in a service desk with a summary and description, optionally its priority, status, category and submitter.

Inputs

Service deskservice_desk_idtextRequired
The service desk. Pick one, or give its id.
SummarysummarytextRequired
The ticket's one-line summary.
Descriptiondescriptiontext
The full description of the problem or request.
Priorityprioritytext
The ticket's priority. Leave empty for the desk's default.
Statusstatustext
The ticket's status. Leave empty for the desk's default.
Categorycategorytext
The ticket's category.
Submitter namesubmitter_nametext
Who asked for help.
Submitter emailsubmitter_emailtext
Their email address, for VSA's replies.

Outputs

ticketobject
The new ticket
ticket_idtext
The new ticket's id
Example output
{
  "ticket": {
    "AgentGuid": "568648809224995",
    "Assignee": "Tier1Support",
    "AssigneeEmail": "tier1@msp.example",
    "Category": "Hardware",
    "Closed": "",
    "CreatedDate": "2026-11-17T10:56:27",
    "Due": "2026-11-18T10:56:27",
    "IsArchived": false,
    "IsClosed": false,
    "LastPublicUpdate": "2026-11-17T11:02:17",
    "ModifiedDate": "2026-11-17T11:02:17",
    "Notes": [
      {
        "Hidden": false,
        "NoteId": "281365297027568",
        "SystemFlag": false,
        "Text": "Restarted the print spooler; watching it.",
        "Timestamp": "2026-11-17T11:02:17",
        "User": "kadmin"
      }
    ],
    "Organization": "Acme Corp",
    "Owner": "alice",
    "Priority": "Medium",
    "RelatedTickets": [
      {
        "Status": "Closed",
        "Summary": "Printer jams",
        "TicketRef": "STD000000"
      }
    ],
    "Resolution": "",
    "ResolutionNote": "",
    "ServiceDeskId": "68356648120026516947479448",
    "ServiceDeskTicketId": "15293212440025500597997781",
    "Severity": "",
    "SourceType": "ServiceDesk",
    "Staff": "",
    "Stage": "Identified",
    "Submitter": "alice",
    "SubmitterEmail": "alice@acme.example",
    "Summary": "Printer on the third floor is offline",
    "TicketRef": "STD000001",
    "TicketStatus": "Open",
    "TotalHours": 0.5
  },
  "ticket_id": "15293212440025500597997781"
}

Get agent

Get one agent: its machine, operating system, network, who is signed in, whether it is online and when it last checked in.

Inputs

Agentagent_idtextRequired
The agent (managed machine). Pick one, or give its id from an earlier step.

Outputs

agentobject
The agent
Example output
{
  "agent": {
    "AgentId": "568648809224995",
    "AgentName": "frontdesk-pc.root.acme",
    "AgentVersion": 9050012,
    "ComputerName": "FRONTDESK-PC",
    "ConnectionGatewayIP": "203.0.113.10",
    "Contact": "Jo Smith",
    "Country": "United States",
    "CpuCount": 8,
    "CpuSpeed": 2400,
    "CpuType": "Intel(R) Core(TM) i5-1135G7",
    "CurrentUser": "",
    "DefaultGateway": "192.168.1.1",
    "DomainWorkgroup": "ACME",
    "FirstCheckIn": "2025-03-02T14:20:05",
    "IPAddress": "192.168.1.24",
    "IPv6Address": "",
    "LastCheckInTime": "2026-11-17T09:41:52",
    "LastLoggedInUser": "jsmith",
    "LastRebootTime": "2026-11-15T07:02:11",
    "MachineGroup": "root.acme",
    "MachineGroupId": "38591172334412759034671215",
    "OSInfo": "Professional x64 Edition Build 19045",
    "OSType": "10",
    "OSVersion": "10.0.19045",
    "Online": 1,
    "OperatingSystem": "Windows",
    "OrgId": "71839104423118472934516631",
    "RamMBytes": 16384,
    "TimeZone": "Central Standard Time",
    "is_online": true,
    "status": "Online, nobody signed in"
  }
}

Get alarm

Get one alarm: what raised it, its message, the agent it is about, whether it is open and any ticket made from it.

Inputs

Alarm IDalarm_idtextRequired
The alarm's id, from 'List alarms', the new alarm trigger or an earlier step.

Outputs

alarmobject
The alarm
Example output
{
  "alarm": {
    "AdminName": "kadmin",
    "AgentId": "568648809224995",
    "AlarmEmail": "alerts@msp.example",
    "AlarmId": "29170",
    "AlarmSubject": "Monitoring alarm: Disk space low on C:",
    "AlarmType": "Counter",
    "AlertType": 4,
    "EventTime": "2026-11-17T09:30:12",
    "MachineGroup": "root.acme",
    "Message": "Free space on C: is 4% (under the 10% threshold).",
    "MonitorAlarmStateId": 1,
    "MonitorType": 0,
    "TicketId": "",
    "agentName": "frontdesk-pc.root.acme",
    "state": "Open"
  }
}

Get asset

Get one asset's hardware details: BIOS, processors, memory, drives and network addresses.

Inputs

Asset IDasset_idtextRequired
The asset's id (AssetId), from 'List assets' or an earlier step.

Outputs

assetobject
The asset
Example output
{
  "asset": {
    "AgentId": "568648809224995",
    "AssetId": "45218839210477163829574001",
    "AssetName": "frontdesk-pc",
    "AssetTypeId": "1",
    "DeviceFounds": [
      {
        "DeviceBiosInfo": {
          "BiosReleaseDate": "2024-06-11T00:00:00",
          "BiosVendor": "Dell Inc.",
          "BiosVersion": "1.18.0"
        },
        "DeviceDrives": [
          {
            "DriveManufacturer": "Samsung"
          }
        ],
        "DeviceIPs": [
          {
            "DHCPEnabled": true,
            "IPAddress": "192.168.1.24",
            "MACAddress": "00-1A-2B-3C-4D-5E",
            "SubnetMask": "255.255.255.0"
          }
        ],
        "DeviceId": "882100457",
        "DeviceInfo": {
          "HostName": "FRONTDESK-PC",
          "Manufacturer": "Dell Inc.",
          "OSFamily": "Windows",
          "OSName": "Windows 10",
          "OSType": "Windows",
          "SerialNumber": "5CG1234XYZ",
          "Version": "1.0"
        },
        "DeviceMemories": [
          {
            "MemorySize": 16384
          }
        ],
        "DeviceProcessors": [
          {
            "ProcessorFamily": "Core i5"
          }
        ],
        "FoundOn": "2025-03-02T14:20:05"
      }
    ],
    "DeviceId": "882100457",
    "DeviceName": "FRONTDESK-PC",
    "DeviceTime": "2026-11-17T09:41:52",
    "MachineGroup": "root.acme",
    "MachineGroupId": "38591172334412759034671215",
    "OrgId": "71839104423118472934516631",
    "ServerTime": "2026-11-17T15:41:52"
  }
}

Get audit summary

Get an agent's latest audit: make, model and serial number, network, chassis, BIOS and check-in times.

Inputs

Agentagent_idtextRequired
The agent (managed machine). Pick one, or give its id from an earlier step.

Outputs

agent_idtext
The agent
auditobject
The agent's latest audit
Example output
{
  "agent_id": "568648809224995",
  "audit": {
    "BIOS": {
      "BiosReleaseDate": "2024-06-11T00:00:00",
      "BiosVendor": "Dell Inc.",
      "BiosVersion": "1.18.0"
    },
    "Chassis": {
      "ChassisManufacturer": "Dell Inc.",
      "ChassisSerialNumber": "5CG1234XYZ",
      "ChassisType": "Notebook"
    },
    "LastAudit": "2026-11-16T23:10:00",
    "NetworkInfo": {
      "DefaultGateway": "192.168.1.1",
      "DnsServer": "192.168.1.1",
      "IpAddress": "192.168.1.24",
      "MacAddr": "00-1A-2B-3C-4D-5E",
      "SubnetMask": "255.255.255.0"
    },
    "NextAudit": "2026-11-23T23:10:00",
    "SystemInfo": {
      "Manufacturer": "Dell Inc.",
      "ProductName": "Latitude 5420",
      "SysSerialNumber": "5CG1234XYZ",
      "Version": "1.0"
    },
    "TimeInfo": {
      "AgentTimeZone": "-360",
      "FirstCheckin": "2025-03-02T14:20:05",
      "LastCheckin": "2026-11-17T09:41:52",
      "LastReboot": "2026-11-15T07:02:11"
    }
  }
}

Get current user

Get the VSA user the connection signs in as: name, email and when the account was created.

Inputs

None.

Outputs

userobject
The signed-in user
Example output
{
  "user": {
    "CreationDate": "2024-01-08T16:27:40",
    "Email": "kadmin@msp.example",
    "FirstName": "Kay",
    "LastName": "Admin",
    "UserId": "55957651"
  }
}

Get patch status

Get an agent's patch status: when it was last scanned, when the next scan and update run, and its reboot settings.

Inputs

Agentagent_idtextRequired
The agent (managed machine). Pick one, or give its id from an earlier step.

Outputs

agent_idtext
The agent
patch_statusobject
The agent's patch status
Example output
{
  "agent_id": "568648809224995",
  "patch_status": {
    "ExecScriptTime": "2026-11-16T22:00:00",
    "LastPatchScan": "2026-11-16T22:00:00",
    "NewPatchAlert": 1,
    "NextRunTime": "2026-11-20T02:00:00",
    "PatchFailedAlert": 1,
    "RebootDay": "Sunday",
    "RebootTime": "03:00",
    "ScanNextRunTime": "2026-11-23T22:00:00",
    "ScanResultsPending": "0"
  }
}

Get ticket

Get one Service Desk ticket with its status, priority, assignee, submitter, dates and every note.

Inputs

Ticket IDticket_idtextRequired
The ticket's id (ServiceDeskTicketId), from 'List tickets', a ticket trigger or an earlier step.

Outputs

ticketobject
The ticket, with its notes
Example output
{
  "ticket": {
    "AgentGuid": "568648809224995",
    "Assignee": "Tier1Support",
    "AssigneeEmail": "tier1@msp.example",
    "Category": "Hardware",
    "Closed": "",
    "CreatedDate": "2026-11-17T10:56:27",
    "Due": "2026-11-18T10:56:27",
    "IsArchived": false,
    "IsClosed": false,
    "LastPublicUpdate": "2026-11-17T11:02:17",
    "ModifiedDate": "2026-11-17T11:02:17",
    "Notes": [
      {
        "Hidden": false,
        "NoteId": "281365297027568",
        "SystemFlag": false,
        "Text": "Restarted the print spooler; watching it.",
        "Timestamp": "2026-11-17T11:02:17",
        "User": "kadmin"
      }
    ],
    "Organization": "Acme Corp",
    "Owner": "alice",
    "Priority": "Medium",
    "RelatedTickets": [
      {
        "Status": "Closed",
        "Summary": "Printer jams",
        "TicketRef": "STD000000"
      }
    ],
    "Resolution": "",
    "ResolutionNote": "",
    "ServiceDeskId": "68356648120026516947479448",
    "ServiceDeskTicketId": "15293212440025500597997781",
    "Severity": "",
    "SourceType": "ServiceDesk",
    "Staff": "",
    "Stage": "Identified",
    "Submitter": "alice",
    "SubmitterEmail": "alice@acme.example",
    "Summary": "Printer on the third floor is offline",
    "TicketRef": "STD000001",
    "TicketStatus": "Open",
    "TotalHours": 0.5
  }
}

List agent procedure history

List when each agent procedure last ran on an agent, how it went (Success or Failed) and who ran it, latest first.

Inputs

Agentagent_idtextRequired
The agent (managed machine). Pick one, or give its id from an earlier step.
Page sizelimitnumber
How many to return, 1 to 100. Defaults to 100, VSA's most.From 1 to 100.
Offsetoffsetnumber
How many to skip. Use 'next_offset' from an earlier page to read on.At least 0.

Outputs

agent_idtext
The agent
countnumber
How many are on this page
has_moretrue/false
Whether another page follows
historylist
Each procedure's latest run, latest first
next_offsetnumber
The offset that reads the next page, 0 when none follows
total_recordsnumber
How many match in all, across every page
Example output
{
  "agent_id": "568648809224995",
  "count": 1,
  "has_more": false,
  "history": [
    {
      "Admin": "kadmin",
      "LastExecutionTime": "2026-11-17T08:00:04",
      "ScriptName": "Config Windows Automatic Update",
      "Status": "Success THEN"
    }
  ],
  "next_offset": 0,
  "total_records": 1
}

List agent procedures

List the agent procedures (VSA's scripts) the connected user can see, with their folders.

Inputs

Name containsname_containstext
Only procedures whose name contains this text.
Page sizelimitnumber
How many to return, 1 to 100. Defaults to 100, VSA's most.From 1 to 100.
Offsetoffsetnumber
How many to skip. Use 'next_offset' from an earlier page to read on.At least 0.

Outputs

countnumber
How many are on this page
has_moretrue/false
Whether another page follows
next_offsetnumber
The offset that reads the next page, 0 when none follows
procedureslist
The procedures, by name
total_recordsnumber
How many match in all, across every page
Example output
{
  "count": 1,
  "has_more": false,
  "next_offset": 0,
  "procedures": [
    {
      "AgentProcedureId": "123",
      "AgentProcedureName": "Config Windows Automatic Update",
      "Description": "Turns on automatic updates.",
      "Path": "shared/sampleProc/windows"
    }
  ],
  "total_records": 1
}

List agents

List agents (managed machines) by organization, machine group, status or name, with their operating system, IP address, current user and last check-in.

Inputs

Organizationorg_idtext
Only this organization. Leave empty for every organization.
Machine groupmachine_group_idtext
Only this machine group. Leave empty for every group.
Statusstatustext
Only agents that are online, offline, suspended or have never checked in.One of: online, offline, suspended, never_checked_in (Never checked in).
Name containsname_containstext
Only agents whose name contains this text.
Page sizelimitnumber
How many to return, 1 to 100. Defaults to 100, VSA's most.From 1 to 100.
Offsetoffsetnumber
How many to skip. Use 'next_offset' from an earlier page to read on.At least 0.

Outputs

agentslist
The agents, by name
countnumber
How many are on this page
has_moretrue/false
Whether another page follows
next_offsetnumber
The offset that reads the next page, 0 when none follows
total_recordsnumber
How many match in all, across every page
Example output
{
  "agents": [
    {
      "AgentId": "568648809224995",
      "AgentName": "frontdesk-pc.root.acme",
      "AgentVersion": 9050012,
      "ComputerName": "FRONTDESK-PC",
      "ConnectionGatewayIP": "203.0.113.10",
      "Contact": "Jo Smith",
      "Country": "United States",
      "CpuCount": 8,
      "CpuSpeed": 2400,
      "CpuType": "Intel(R) Core(TM) i5-1135G7",
      "CurrentUser": "",
      "DefaultGateway": "192.168.1.1",
      "DomainWorkgroup": "ACME",
      "FirstCheckIn": "2025-03-02T14:20:05",
      "IPAddress": "192.168.1.24",
      "IPv6Address": "",
      "LastCheckInTime": "2026-11-17T09:41:52",
      "LastLoggedInUser": "jsmith",
      "LastRebootTime": "2026-11-15T07:02:11",
      "MachineGroup": "root.acme",
      "MachineGroupId": "38591172334412759034671215",
      "OSInfo": "Professional x64 Edition Build 19045",
      "OSType": "10",
      "OSVersion": "10.0.19045",
      "Online": 1,
      "OperatingSystem": "Windows",
      "OrgId": "71839104423118472934516631",
      "RamMBytes": 16384,
      "TimeZone": "Central Standard Time",
      "is_online": true,
      "status": "Online, nobody signed in"
    }
  ],
  "count": 1,
  "has_more": false,
  "next_offset": 0,
  "total_records": 1
}

List alarms

List alarms, open and closed, newest first, for every agent or one, optionally between two times.

Inputs

Agentagent_idtext
Only this agent's alarms. Leave empty for every agent.
Raised on or aftersincedate and time
Only alarms raised at or after this time.
Raised on or beforeuntildate and time
Only alarms raised at or before this time.
Page sizelimitnumber
How many to return, 1 to 100. Defaults to 100, VSA's most.From 1 to 100.
Offsetoffsetnumber
How many to skip. Use 'next_offset' from an earlier page to read on.At least 0.

Outputs

alarmslist
The alarms, newest first; state is Open or Closed
countnumber
How many are on this page
has_moretrue/false
Whether another page follows
next_offsetnumber
The offset that reads the next page, 0 when none follows
total_recordsnumber
How many match in all, across every page
Example output
{
  "alarms": [
    {
      "AgentId": "568648809224995",
      "AlarmId": "29170",
      "AlarmSubject": "Monitoring alarm: Disk space low on C:",
      "AlertType": 4,
      "EventTime": "2026-11-17T09:30:12",
      "MachineGroup": "root.acme",
      "MonitorAlarmStateId": 1,
      "agentName": "frontdesk-pc.root.acme",
      "state": "Open"
    }
  ],
  "count": 1,
  "has_more": false,
  "next_offset": 0,
  "total_records": 1
}

List assets

List assets: machines with agents and devices VSA found on the network, with their alarm and ticket counts.

Inputs

Organizationorg_idtext
Only this organization. Leave empty for every organization.
Machine groupmachine_group_idtext
Only this machine group. Leave empty for every group.
Name containsname_containstext
Only assets whose name contains this text.
Page sizelimitnumber
How many to return, 1 to 100. Defaults to 100, VSA's most.From 1 to 100.
Offsetoffsetnumber
How many to skip. Use 'next_offset' from an earlier page to read on.At least 0.

Outputs

assetslist
The assets, by name
countnumber
How many are on this page
has_moretrue/false
Whether another page follows
next_offsetnumber
The offset that reads the next page, 0 when none follows
total_recordsnumber
How many match in all, across every page
Example output
{
  "assets": [
    {
      "AgentId": "568648809224995",
      "AlarmCount": 2,
      "AssetId": "45218839210477163829574001",
      "AssetName": "frontdesk-pc",
      "AssetTypeId": "1",
      "DeviceManufacturer": "Dell Inc.",
      "DisplayName": "frontdesk-pc.root.acme",
      "HostName": "FRONTDESK-PC",
      "IsComputerAgent": true,
      "IsMobileAgent": false,
      "LastSeenDate": "2026-11-17T09:41:52",
      "MachineGroup": "root.acme",
      "MachineGroupId": "38591172334412759034671215",
      "OSFamily": "Windows",
      "OSName": "Windows 10",
      "OSType": "Windows",
      "OrgId": "71839104423118472934516631",
      "SysSerialNum": "5CG1234XYZ",
      "TicketCount": 1
    }
  ],
  "count": 1,
  "has_more": false,
  "next_offset": 0,
  "total_records": 1
}

List machine groups

List machine groups, for every organization or for one.

Inputs

Organizationorg_idtext
Only this organization. Leave empty for every organization.
Name containsname_containstext
Only machine groups whose name contains this text.
Page sizelimitnumber
How many to return, 1 to 100. Defaults to 100, VSA's most.From 1 to 100.
Offsetoffsetnumber
How many to skip. Use 'next_offset' from an earlier page to read on.At least 0.

Outputs

countnumber
How many are on this page
has_moretrue/false
Whether another page follows
machine_groupslist
The machine groups
next_offsetnumber
The offset that reads the next page, 0 when none follows
total_recordsnumber
How many match in all, across every page
Example output
{
  "count": 1,
  "has_more": false,
  "machine_groups": [
    {
      "MachineGroupId": "38591172334412759034671215",
      "MachineGroupName": "root",
      "OrgId": "71839104423118472934516631",
      "ParentMachineGroupId": ""
    }
  ],
  "next_offset": 0,
  "total_records": 1
}

List missing patches

List the patches an agent's machine is missing, from its latest patch scan, with their KB articles.

Inputs

Agentagent_idtextRequired
The agent (managed machine). Pick one, or give its id from an earlier step.
Include denied patchesinclude_deniedtrue/false
Also list patches denied by patch policy.
Page sizelimitnumber
How many to return, 1 to 100. Defaults to 100, VSA's most.From 1 to 100.
Offsetoffsetnumber
How many to skip. Use 'next_offset' from an earlier page to read on.At least 0.

Outputs

agent_idtext
The agent
countnumber
How many are on this page
has_moretrue/false
Whether another page follows
next_offsetnumber
The offset that reads the next page, 0 when none follows
patcheslist
The missing patches
total_recordsnumber
How many match in all, across every page
Example output
{
  "agent_id": "568648809224995",
  "count": 1,
  "has_more": false,
  "next_offset": 0,
  "patches": [
    {
      "Description": "2026-11 Cumulative Update for Windows 10 Version 22H2",
      "Ignore": 0,
      "IsSuperseded": false,
      "KBArticle": "KB5046613",
      "PatchDataId": "51332",
      "PatchState": 0,
      "Product": "Windows 10",
      "ReleaseDate": "2026-11-11T00:00:00",
      "SecurityBulletinLink": "https://support.microsoft.com/help/5046613",
      "Status": 0,
      "UpdateClassification": 100
    }
  ],
  "total_records": 1
}

List organizations

List the organizations (your customers, and your own) the connected user's scope can see.

Inputs

Name containsname_containstext
Only organizations whose name contains this text.
Page sizelimitnumber
How many to return, 1 to 100. Defaults to 100, VSA's most.From 1 to 100.
Offsetoffsetnumber
How many to skip. Use 'next_offset' from an earlier page to read on.At least 0.

Outputs

countnumber
How many are on this page
has_moretrue/false
Whether another page follows
next_offsetnumber
The offset that reads the next page, 0 when none follows
organizationslist
The organizations
total_recordsnumber
How many match in all, across every page
Example output
{
  "count": 1,
  "has_more": false,
  "next_offset": 0,
  "organizations": [
    {
      "AnnualRevenue": 0,
      "ContactInfo": {
        "City": "Springfield",
        "Country": "United States",
        "PreferredContactMethod": "Email",
        "PrimaryEmail": "it@acme.example",
        "PrimaryFax": "",
        "PrimaryPhone": "+1 555 0100",
        "PrimaryTextMessagePhone": "",
        "State": "IL",
        "Street": "1 Main Street",
        "ZipCode": "62701"
      },
      "CustomFields": [
        {
          "FieldName": "Contract",
          "FieldValue": "Gold"
        }
      ],
      "DefaultDepartmentName": "root",
      "DefaultMachineGroupName": "root",
      "NoOfEmployees": 120,
      "OrgId": "71839104423118472934516631",
      "OrgName": "Acme Corp",
      "OrgRef": "acme",
      "OrgType": "Customer",
      "ParentOrgId": "",
      "Website": "https://acme.example"
    }
  ],
  "total_records": 1
}

List service desks

List the Service Desk desks the connected user can see.

Inputs

None.

Outputs

countnumber
How many
service_deskslist
The service desks
Example output
{
  "count": 1,
  "service_desks": [
    {
      "DefaultPolicy": "",
      "Description": "Support requests from customers",
      "DeskAdministrator": "kadmin",
      "Prefix": "STD",
      "ServiceDeskId": "68356648120026516947479448",
      "ServiceDeskName": "Standard"
    }
  ]
}

List tickets

List a service desk's tickets, newest first, by status, priority, summary or when they were opened or last changed.

Inputs

Service deskservice_desk_idtextRequired
The service desk. Pick one, or give its id.
Statusstatustext
Only tickets with this status. Leave empty for every status.
Priorityprioritytext
Only tickets with this priority. Leave empty for every priority.
Summary containssummary_containstext
Only tickets whose summary contains this text.
Opened on or aftercreated_sincedate and time
Only tickets opened at or after this time.
Changed on or afterchanged_sincedate and time
Only tickets changed at or after this time.
Orderordertext
Newest first, oldest first, or most recently changed first.One of: newest (Newest first (default)), oldest (Oldest first), recently_changed (Most recently changed first). Default: newest.
Page sizelimitnumber
How many to return, 1 to 100. Defaults to 100, VSA's most.From 1 to 100.
Offsetoffsetnumber
How many to skip. Use 'next_offset' from an earlier page to read on.At least 0.

Outputs

countnumber
How many are on this page
has_moretrue/false
Whether another page follows
next_offsetnumber
The offset that reads the next page, 0 when none follows
ticketslist
The tickets
total_recordsnumber
How many match in all, across every page
Example output
{
  "count": 1,
  "has_more": false,
  "next_offset": 0,
  "tickets": [
    {
      "AgentGuid": "568648809224995",
      "Assignee": "Tier1Support",
      "Category": "Hardware",
      "Closed": "",
      "CreatedDate": "2026-11-17T10:56:27",
      "Due": "2026-11-18T10:56:27",
      "LastPublicUpdate": "2026-11-17T11:02:17",
      "ModifiedDate": "2026-11-17T11:02:17",
      "Organization": "Acme Corp",
      "Owner": "alice",
      "Priority": "Medium",
      "Resolution": "",
      "ServiceDeskId": "68356648120026516947479448",
      "ServiceDeskTicketId": "15293212440025500597997781",
      "Severity": "",
      "SourceType": "ServiceDesk",
      "Staff": "",
      "Stage": "Identified",
      "Submitter": "alice",
      "SubmitterEmail": "alice@acme.example",
      "Summary": "Printer on the third floor is offline",
      "TicketRef": "STD000001",
      "TicketStatus": "Open"
    }
  ],
  "total_records": 1
}

List users

List VSA's users (the technicians who sign in to VSA), with their names, emails, roles and scopes.

Inputs

Name containsname_containstext
Only users whose name contains this text.
Page sizelimitnumber
How many to return, 1 to 100. Defaults to 100, VSA's most.From 1 to 100.
Offsetoffsetnumber
How many to skip. Use 'next_offset' from an earlier page to read on.At least 0.

Outputs

countnumber
How many are on this page
has_moretrue/false
Whether another page follows
next_offsetnumber
The offset that reads the next page, 0 when none follows
total_recordsnumber
How many match in all, across every page
userslist
The users, by user name
Example output
{
  "count": 1,
  "has_more": false,
  "next_offset": 0,
  "total_records": 1,
  "users": [
    {
      "AdminName": "kadmin",
      "AdminRoleIds": [
        "2"
      ],
      "AdminScopeIds": [
        "2"
      ],
      "Admintype": 2,
      "CreationDate": "2024-01-08T16:27:40",
      "DefaultStaffDepartmentId": "",
      "DefaultStaffOrgId": "71839104423118472934516631",
      "DisableUntil": "",
      "Email": "kadmin@msp.example",
      "FirstName": "Kay",
      "LastName": "Admin",
      "UserId": "55957651"
    }
  ]
}

Run agent procedure

Run an agent procedure on one agent's machine now. Use 'List agent procedure history' to see how it went.

Inputs

Agentagent_idtextRequired
The agent (managed machine). Pick one, or give its id from an earlier step.
Agent procedureprocedure_idtextRequired
The agent procedure. Pick one, or give its id.

Outputs

agent_idtext
The agent it runs on
procedure_idtext
The procedure run
startedtrue/false
Always true once VSA accepts it
Example output
{
  "agent_id": "568648809224995",
  "procedure_id": "123",
  "started": true
}

Run patch scan

Scan an agent's machine for missing patches now. 'List missing patches' shows what it found once it finishes.

Inputs

Agentagent_idtextRequired
The agent (managed machine). Pick one, or give its id from an earlier step.

Outputs

agent_idtext
The agent scanned
startedtrue/false
Always true once VSA accepts it
Example output
{
  "agent_id": "568648809224995",
  "started": true
}

Schedule agent procedure

Schedule an agent procedure on one agent's machine, once or repeating, optionally skipping it or waking the machine if it is offline.

Inputs

Agentagent_idtextRequired
The agent (managed machine). Pick one, or give its id from an earlier step.
Agent procedureprocedure_idtextRequired
The agent procedure. Pick one, or give its id.
Startstart_atdate and timeRequired
When it first runs.
Repeatrepeattext
Run once, or again every few minutes, hours, days, weeks or months.One of: Never (Once (default)), Minutes (Every few minutes), Hours (Every few hours), Days (Every few days), Weeks (Every few weeks), Months (Every few months). Default: Never.
Everyeverynumber
How many of those units between runs, such as 2 for every 2 days. Defaults to 1.From 1 to 1000.
Skip if offlineskip_if_offlinetrue/false
Skip a run when the machine is offline at that time.
Wake if offlinepower_up_if_offlinetrue/false
Try to wake the machine (Wake on LAN) when it is offline at that time.

Outputs

agent_idtext
The agent it runs on
everynumber
Units between runs, 0 if once
procedure_idtext
The procedure scheduled
repeattext
Never, Minutes, Hours, Days, Weeks or Months
scheduledtrue/false
Always true once VSA accepts it
start_attext
When it first runs, in UTC
Example output
{
  "agent_id": "568648809224995",
  "every": 1,
  "procedure_id": "123",
  "repeat": "Weeks",
  "scheduled": true,
  "start_at": "2026-11-18T02:00:00Z"
}

Update ticket

Change a ticket's status or priority, or assign it to a staff member. What you leave empty stays as it is.

Inputs

Service deskservice_desk_idtextRequired
The service desk. Pick one, or give its id.
Ticket IDticket_idtextRequired
The ticket's id (ServiceDeskTicketId), from 'List tickets', a ticket trigger or an earlier step.
Statusstatustext
The ticket's new status.
Priorityprioritytext
The ticket's new priority.
Assign tostaff_idtext
The staff member to assign it to.

Outputs

changedlist
What changed: status, priority and assignee
ticketobject
The ticket, as it is now
Example output
{
  "changed": [
    "status"
  ],
  "ticket": {
    "AgentGuid": "568648809224995",
    "Assignee": "Tier1Support",
    "AssigneeEmail": "tier1@msp.example",
    "Category": "Hardware",
    "Closed": "",
    "CreatedDate": "2026-11-17T10:56:27",
    "Due": "2026-11-18T10:56:27",
    "IsArchived": false,
    "IsClosed": false,
    "LastPublicUpdate": "2026-11-17T11:02:17",
    "ModifiedDate": "2026-11-17T11:02:17",
    "Notes": [
      {
        "Hidden": false,
        "NoteId": "281365297027568",
        "SystemFlag": false,
        "Text": "Restarted the print spooler; watching it.",
        "Timestamp": "2026-11-17T11:02:17",
        "User": "kadmin"
      }
    ],
    "Organization": "Acme Corp",
    "Owner": "alice",
    "Priority": "Medium",
    "RelatedTickets": [
      {
        "Status": "Closed",
        "Summary": "Printer jams",
        "TicketRef": "STD000000"
      }
    ],
    "Resolution": "",
    "ResolutionNote": "",
    "ServiceDeskId": "68356648120026516947479448",
    "ServiceDeskTicketId": "15293212440025500597997781",
    "Severity": "",
    "SourceType": "ServiceDesk",
    "Staff": "",
    "Stage": "Identified",
    "Submitter": "alice",
    "SubmitterEmail": "alice@acme.example",
    "Summary": "Printer on the third floor is offline",
    "TicketRef": "STD000001",
    "TicketStatus": "Open",
    "TotalHours": 0.5
  }
}

On this page