Kaseya Virtual System Administrator

this connector integrates kaseya virtual system administrator with swimlane capabilities this connector provides the following capabilities add organization get agent procedures get agent settings get agent get agents get asset types get asset get assets get organization get organizations get scheduled agent procedure run agent procedure schedule agent procedure update organization asset setup this connector supports the token based authentication all applications follow a basic pattern when accessing a vsa api using oauth 2 0 at a high level, you follow five steps obtain oauth 2 0 credentials from the vsa server by registering your application authenticate to the vsa to obtain a temporary authorization code exchange the authorization code for an access token send the access token to the vsa api when needed refresh your access token, if necessary for more details on the authentication, please refer to kaseya vsa link https //help kaseya com/webhelp/en/restapi/9050000/usingoauth2 0toaccessvsaapis pdf#zoom=70\&navpanes=0 configurations http bearer authentication authenticates using bearer token such as a jwt, etc configuration parameters parameter description type required url a url to the target host string required token the api key, token, etc string required verify ssl verify ssl certificate boolean optional http proxy a proxy to route requests through string optional actions add organization this action adds a single organization record endpoint url /system/orgs method post input argument name type required description orgid number optional unique identifier orgname string optional name of the resource orgref string optional parameter for add organization orgtype string optional type of the resource defaultdepartmentname string optional name of the resource defaultmachinegroupname string optional name of the resource parentorgid number optional unique identifier website string optional parameter for add organization noofemployees number optional parameter for add organization annualrevenue number optional parameter for add organization contactinfo object optional parameter for add organization preferredcontactmethod string optional http method to use primaryphone string optional parameter for add organization primaryfax string optional parameter for add organization primaryemail string optional parameter for add organization country string optional parameter for add organization street string optional parameter for add organization city string optional parameter for add organization state string optional parameter for add organization zipcode string optional parameter for add organization primarytextmessagephone string optional response message customfields array optional parameter for add organization fieldname string optional name of the resource fieldvalue string optional value for the parameter attributes object optional parameter for add organization output parameter type description status code number http status code of the response reason string response reason phrase responsecode number output field responsecode status string status value error string error message if any example \[ { "status code" 200, "response headers" {}, "reason" "ok", "json body" { "responsecode" 200, "status" "ok", "error" "none" } } ] get agent this action returns a single agent record endpoint url /assetmgmt/agents/{{agentid}} method get input argument name type required description agentid number required unique identifier output parameter type description status code number http status code of the response reason string response reason phrase result object result of the operation agentid number unique identifier agentname string name of the resource online number output field online ostype string type of the resource osinfo string output field osinfo orgid number unique identifier machinegroupid number unique identifier machinegroup string output field machinegroup computername string name of the resource ipv6address string output field ipv6address ipaddress string output field ipaddress operatingsystem string output field operatingsystem osversion string output field osversion lastloggedinuser string output field lastloggedinuser lastreboottime string time value lastcheckintime string time value country string output field country currentuser string output field currentuser contact string output field contact timezone string output field timezone rammbytes number output field rammbytes cpucount number count value example \[ { "status code" 200, "response headers" {}, "reason" "ok", "json body" { "result" {}, "responsecode" 0, "status" "string", "error" "string" } } ] get agent procedures this action returns an array of agent procedures endpoint url /automation/agentprocs method get input argument name type required description filter string optional parameter for get agent procedures orderby string optional parameter for get agent procedures output parameter type description status code number http status code of the response reason string response reason phrase totalrecords number output field totalrecords result array result of the operation agentprocedureid number unique identifier agentprocedurename string name of the resource path string output field path description string output field description attributes object output field attributes responsecode number output field responsecode status string status value error string error message if any example \[ { "status code" 200, "response headers" {}, "reason" "ok", "json body" { "totalrecords" 0, "result" \[], "responsecode" 0, "status" "string", "error" "string" } } ] get agent settings this action returns an array of settings for an agent endpoint url /assetmgmt/agent/{{agentid}}/settings method get input argument name type required description agentid number required unique identifier filter string optional parameter for get agent settings orderby string optional parameter for get agent settings output parameter type description status code number http status code of the response reason string response reason phrase result object result of the operation agentversion number output field agentversion currentuser string output field currentuser lastcheckin string output field lastcheckin firstcheckin string output field firstcheckin lastreboot string output field lastreboot tempdirectory string output field tempdirectory checkincontrol object output field checkincontrol primarykserver string output field primarykserver primarykserverport number output field primarykserverport secondarykserver string output field secondarykserver secondarykserverport number output field secondarykserverport quickcheckintimeinseconds number output field quickcheckintimeinseconds bandwidththrottle number unique identifier attributes object output field attributes userprofile object output field userprofile adminemail string output field adminemail username string name of the resource useremail string output field useremail userphone string output field userphone notes string output field notes showtooltip number output field showtooltip autoassigntickets boolean output field autoassigntickets example \[ { "status code" 200, "response headers" {}, "reason" "ok", "json body" { "result" {}, "responsecode" 0, "status" "string", "error" "string" } } ] get agents this action returns an array of agent records endpoint url /assetmgmt/agents method get input argument name type required description filter string optional parameter for get agents orderby string optional parameter for get agents output parameter type description status code number http status code of the response reason string response reason phrase totalrecords number output field totalrecords result array result of the operation agentid number unique identifier agentname string name of the resource online number output field online ostype string type of the resource osinfo string output field osinfo orgid number unique identifier machinegroupid number unique identifier machinegroup string output field machinegroup computername string name of the resource ipv6address string output field ipv6address ipaddress string output field ipaddress operatingsystem string output field operatingsystem osversion string output field osversion lastloggedinuser string output field lastloggedinuser lastreboottime string time value lastcheckintime string time value country string output field country currentuser string output field currentuser contact string output field contact timezone string output field timezone rammbytes number output field rammbytes example \[ { "status code" 200, "response headers" {}, "reason" "ok", "json body" { "totalrecords" 0, "result" \[], "responsecode" 0, "status" "string", "error" "string" } } ] get asset this action returns a single detailed asset record endpoint url /assetmgmt/assets/{{assetid}} method get input argument name type required description assetid number required unique identifier output parameter type description status code number http status code of the response reason string response reason phrase assetid number unique identifier assetname string name of the resource assettypeid number unique identifier machinegroupid number unique identifier machinegroup string output field machinegroup orgid number unique identifier agentid number unique identifier deviceid number unique identifier devicename string name of the resource devicetype number type of the resource devicetime string time value servertime string time value devicefounds array output field devicefounds deviceid number unique identifier foundon string output field foundon foundby object output field foundby probeid number unique identifier probetypeid number unique identifier probename string name of the resource probeagentid number unique identifier probetype object type of the resource probetypeid number unique identifier probetypename string name of the resource example \[ { "status code" 200, "response headers" {}, "reason" "ok", "json body" { "assetid" 0, "assetname" "string", "assettypeid" 0, "machinegroupid" 0, "machinegroup" "string", "orgid" 0, "agentid" 0, "deviceid" 0, "devicename" "string", "devicetype" 0, "devicetime" "2016 02 02t22 50 04 298z", "servertime" "2016 02 02t22 50 04 298z", "devicefounds" \[], "attributes" {} } } ] get asset types this action returns an array of asset type records endpoint url /assetmgmt/assettypes method get input argument name type required description filter string optional parameter for get asset types orderby string optional parameter for get asset types output parameter type description status code number http status code of the response reason string response reason phrase totalrecords number output field totalrecords result array result of the operation assettypeid number unique identifier assettypename string name of the resource parentassettypeid number unique identifier attributes object output field attributes responsecode number output field responsecode status string status value error string error message if any example \[ { "status code" 200, "response headers" {}, "reason" "ok", "json body" { "totalrecords" 0, "result" \[], "responsecode" 0, "status" "string", "error" "string" } } ] get assets this action returns an array of summary asset records endpoint url /assetmgmt/assets method get input argument name type required description filter string optional parameter for get assets orderby string optional parameter for get assets output parameter type description status code number http status code of the response reason string response reason phrase totalrecords number output field totalrecords result array result of the operation assetid number unique identifier assetname string name of the resource assettypeid number unique identifier probeid number unique identifier machinegroupid number unique identifier machinegroup string output field machinegroup orgid number unique identifier iscomputeragent boolean output field iscomputeragent ismobileagent boolean output field ismobileagent ismonitoring string output field ismonitoring ispatching string output field ispatching isauditing string output field isauditing isbackingup string output field isbackingup issecurity string output field issecurity ticketcount number count value alarmcount number count value issnmpactive boolean output field issnmpactive isvproactive boolean output field isvproactive networkinfo number output field networkinfo agentid number unique identifier displayname string name of the resource example \[ { "status code" 200, "response headers" {}, "reason" "ok", "json body" { "totalrecords" 1 8, "result" \[], "responsecode" 0, "status" "string", "error" "string" } } ] get organization this action returns a single organization record endpoint url /system/orgs/{{orgid}} method get input argument name type required description orgid number required unique identifier output parameter type description status code number http status code of the response reason string response reason phrase orgid number unique identifier orgname string name of the resource orgref string output field orgref orgtype string type of the resource defaultdepartmentname string name of the resource defaultmachinegroupname string name of the resource parentorgid number unique identifier website string output field website noofemployees number output field noofemployees annualrevenue number output field annualrevenue contactinfo object output field contactinfo preferredcontactmethod string http method to use primaryphone string output field primaryphone primaryfax string output field primaryfax primaryemail string output field primaryemail country string output field country street string output field street city string output field city state string output field state zipcode string output field zipcode primarytextmessagephone string response message customfields array output field customfields fieldname string name of the resource example \[ { "status code" 200, "response headers" {}, "reason" "ok", "json body" { "orgid" 0, "orgname" "string", "orgref" "string", "orgtype" "string", "defaultdepartmentname" "string", "defaultmachinegroupname" "string", "parentorgid" 0, "website" "string", "noofemployees" 0, "annualrevenue" 0, "contactinfo" {}, "customfields" \[], "attributes" {} } } ] get organizations this action returns an array of organization records endpoint url /system/orgs method get input argument name type required description filter string optional parameter for get organizations orderby string optional parameter for get organizations output parameter type description status code number http status code of the response reason string response reason phrase totalrecords number output field totalrecords result array result of the operation orgid number unique identifier orgname string name of the resource orgref string output field orgref orgtype string type of the resource defaultdepartmentname string name of the resource defaultmachinegroupname string name of the resource parentorgid number unique identifier website string output field website noofemployees number output field noofemployees annualrevenue number output field annualrevenue contactinfo object output field contactinfo preferredcontactmethod string http method to use primaryphone string output field primaryphone primaryfax string output field primaryfax primaryemail string output field primaryemail country string output field country street string output field street city string output field city state string output field state zipcode string output field zipcode primarytextmessagephone string response message example \[ { "status code" 200, "response headers" {}, "reason" "ok", "json body" { "totalrecords" 0, "result" \[], "responsecode" 0, "status" "string", "error" "string" } } ] get scheduled agent procedures this action returns an array of agent procedure schedule records for a specified agent endpoint url /automation/agentprocs/{{agentid}}/scheduledprocs method get input argument name type required description agentid number required unique identifier filter string optional parameter for get scheduled agent procedures orderby string optional parameter for get scheduled agent procedures output parameter type description status code number http status code of the response reason string response reason phrase totalrecords number output field totalrecords result array result of the operation agentprocedureid number unique identifier agentprocedurename string name of the resource nextexectime string time value status string status value admin string output field admin recurrence string output field recurrence attributes object output field attributes agentid number unique identifier servertimezone boolean output field servertimezone skipifoffline boolean output field skipifoffline powerupifoffline boolean output field powerupifoffline scriptprompts object output field scriptprompts caption string output field caption name string name of the resource value string value for the parameter distribution object output field distribution interval string output field interval magnitude number output field magnitude start object output field start starton string output field starton startat string output field startat example \[ { "status code" 200, "response headers" {}, "reason" "ok", "json body" { "totalrecords" 10, "result" \[], "responsecode" 0, "status" "ok", "error" "none" } } ] run agent procedure this action runs an agent procedure immediately for a single agent endpoint url /automation/agentprocs/{{agentid}}/{{agentprocid}}/runnow method put input argument name type required description agentid number required unique identifier agentprocid number required unique identifier output parameter type description status code number http status code of the response reason string response reason phrase result boolean result of the operation responsecode number output field responsecode status string status value error string error message if any example \[ { "status code" 200, "response headers" {}, "reason" "ok", "json body" { "result" true, "responsecode" 0, "status" "string", "error" "string" } } ] schedule agent procedure this action schedules an agent procedure for a single agent endpoint url /automation/agentprocs/{{agentid}}/{{agentprocid}}/schedule method put input argument name type required description agentid number required unique identifier agentprocid number required unique identifier output parameter type description status code number http status code of the response reason string response reason phrase agentid number unique identifier agentprocid number unique identifier servertimezone boolean output field servertimezone skipifoffline boolean output field skipifoffline powerupifoffline boolean output field powerupifoffline scriptprompts array output field scriptprompts caption string output field caption name string name of the resource value string value for the parameter recurrence object output field recurrence repeat string output field repeat times number output field times daysofweek string output field daysofweek dayofmonth string output field dayofmonth specificdayofmonth number output field specificdayofmonth monthofyear string output field monthofyear endat string output field endat endon string output field endon endafterintervaltimes number output field endafterintervaltimes distribution object output field distribution interval string output field interval magnitude number output field magnitude start object output field start example \[ { "status code" 200, "response headers" {}, "reason" "ok", "json body" { "agentid" 0, "agentprocid" 1, "servertimezone" true, "skipifoffline" true, "powerupifoffline" true, "scriptprompts" \[], "recurrence" {}, "distribution" {}, "start" {}, "exclusion" {}, "attributes" {} } } ] update organization this action updates a single organization record endpoint url /system/orgs/{{orgid}} method put input argument name type required description orgid number required unique identifier orgid number optional unique identifier orgname string optional name of the resource orgref string optional parameter for update organization orgtype string optional type of the resource defaultdepartmentname string optional name of the resource defaultmachinegroupname string optional name of the resource parentorgid number optional unique identifier website string optional parameter for update organization noofemployees number optional parameter for update organization annualrevenue number optional parameter for update organization contactinfo object optional parameter for update organization preferredcontactmethod string optional http method to use primaryphone string optional parameter for update organization primaryfax string optional parameter for update organization primaryemail string optional parameter for update organization country string optional parameter for update organization street string optional parameter for update organization city string optional parameter for update organization state string optional parameter for update organization zipcode string optional parameter for update organization primarytextmessagephone string optional response message customfields array optional parameter for update organization fieldname string optional name of the resource fieldvalue string optional value for the parameter output parameter type description status code number http status code of the response reason string response reason phrase responsecode number output field responsecode status string status value error string error message if any example \[ { "status code" 200, "response headers" {}, "reason" "ok", "json body" { "responsecode" 200, "status" "ok", "error" "none" } } ] notes for further details, please refer to api documentation https //help kaseya com/webhelp/en/restapi/9050000/#home htm