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 https //help kaseya com/webhelp/en/restapi/9050000/usingoauth2 0toaccessvsaapis pdf#zoom=70\&navpanes=0 notes for further details, please refer to https //help kaseya com/webhelp/en/restapi/9050000/#home htm 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 contactinfo preferredcontactmethod string optional http method to use contactinfo primaryphone string optional parameter for add organization contactinfo primaryfax string optional parameter for add organization contactinfo primaryemail string optional parameter for add organization contactinfo country string optional parameter for add organization contactinfo street string optional parameter for add organization contactinfo city string optional parameter for add organization contactinfo state string optional parameter for add organization contactinfo zipcode string optional parameter for add organization contactinfo primarytextmessagephone string optional response message customfields array optional parameter for add organization customfields fieldname string optional name of the resource customfields fieldvalue string optional value for the parameter attributes object optional parameter for add organization input example {"json body" {"orgid" 0,"orgname" "string","orgref" "string","orgtype" "string","defaultdepartmentname" "string","defaultmachinegroupname" "string","parentorgid" 0,"website" "string","noofemployees" 0,"annualrevenue" 0,"contactinfo" {"preferredcontactmethod" "string","primaryphone" "string","primaryfax" "string","primaryemail" "string","country" "string","street" "string","city" "string","state" "string","zipcode" "string","primarytextmessagephone" "string"},"customfields" \[{"fieldname" "string","fieldvalue" "string"}],"attributes" {}}} 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 output 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 path parameters agentid number required parameters for the get agent action input example {"path parameters" {"agentid" 0}} output parameter type description status code number http status code of the response reason string response reason phrase result object result of the operation result agentid number unique identifier result agentname string name of the resource result online number result of the operation result ostype string type of the resource result osinfo string result of the operation result orgid number unique identifier result machinegroupid number unique identifier result machinegroup string result of the operation result computername string name of the resource result ipv6address string result of the operation result ipaddress string result of the operation result operatingsystem string result of the operation result osversion string result of the operation result lastloggedinuser string result of the operation result lastreboottime string result of the operation result lastcheckintime string result of the operation result country string result of the operation result currentuser string result of the operation result contact string result of the operation result timezone string result of the operation result rammbytes number result of the operation result cpucount number result of the operation output example {"status code" 200,"response headers" {},"reason" "ok","json body" {"result" {"agentid" 0,"agentname" "string","online" 0,"ostype" "string","osinfo" "string","orgid" 0,"machinegroupid" 0,"machinegroup" "string","computername" "string","ipv6address" "string","ipaddress" "string","operatingsystem" "string","osversion" "string","lastloggedinuser" "string","lastreboottime" "2016 02 02t17 55 17 030z"},"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 parameters filter string optional parameters for the get agent procedures action parameters orderby string optional parameters for the get agent procedures action input example {"parameters" {"filter" "substringof('cab', orgname)","orderby" "priority"}} 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 result agentprocedureid number unique identifier result agentprocedurename string name of the resource result path string result of the operation result description string result of the operation result attributes object result of the operation responsecode number output field responsecode status string status value error string error message if any output 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 path parameters agentid number required parameters for the get agent settings action parameters filter string optional parameters for the get agent settings action parameters orderby string optional parameters for the get agent settings action input example {"parameters" {"filter" "substringof('cab', orgname)","orderby" "priority"},"path parameters" {"agentid" 0}} output parameter type description status code number http status code of the response reason string response reason phrase result object result of the operation result agentversion number result of the operation result currentuser string result of the operation result lastcheckin string result of the operation result firstcheckin string result of the operation result lastreboot string result of the operation result tempdirectory string result of the operation result checkincontrol object result of the operation result checkincontrol primarykserver string result of the operation result checkincontrol primarykserverport number result of the operation result checkincontrol secondarykserver string result of the operation result checkincontrol secondarykserverport number result of the operation result checkincontrol quickcheckintimeinseconds number result of the operation result checkincontrol bandwidththrottle number unique identifier result checkincontrol attributes object result of the operation result userprofile object result of the operation result userprofile adminemail string result of the operation result userprofile username string name of the resource result userprofile useremail string result of the operation result userprofile userphone string result of the operation result userprofile notes string result of the operation result userprofile showtooltip number result of the operation result userprofile autoassigntickets boolean result of the operation output example {"status code" 200,"response headers" {},"reason" "ok","json body" {"result" {"agentversion" 0,"currentuser" "string","lastcheckin" "2016 03 16t16 13 52 579z","firstcheckin" "2016 03 16t16 13 52 579z","lastreboot" "2016 03 16t16 13 52 579z","tempdirectory" "string","checkincontrol" {},"userprofile" {},"patchpolicymembership" \[],"viewdefinitioncollections" \[],"attributes" {}},"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 parameters filter string optional parameters for the get agents action parameters orderby string optional parameters for the get agents action input example {"parameters" {"filter" "substringof('cab', orgname)","orderby" "priority"}} 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 result agentid number unique identifier result agentname string name of the resource result online number result of the operation result ostype string type of the resource result osinfo string result of the operation result orgid number unique identifier result machinegroupid number unique identifier result machinegroup string result of the operation result computername string name of the resource result ipv6address string result of the operation result ipaddress string result of the operation result operatingsystem string result of the operation result osversion string result of the operation result lastloggedinuser string result of the operation result lastreboottime string result of the operation result lastcheckintime string result of the operation result country string result of the operation result currentuser string result of the operation result contact string result of the operation result timezone string result of the operation result rammbytes number result of the operation output 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 path parameters assetid number required parameters for the get asset action input example {"path parameters" {"assetid" 0}} 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 devicefounds deviceid number unique identifier devicefounds foundon string output field devicefounds foundon devicefounds foundby object output field devicefounds foundby devicefounds foundby probeid number unique identifier devicefounds foundby probetypeid number unique identifier devicefounds foundby probename string name of the resource devicefounds foundby probeagentid number unique identifier devicefounds foundby probetype object type of the resource devicefounds foundby probetype probetypeid number unique identifier devicefounds foundby probetype probetypename string name of the resource output 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 parameters filter string optional parameters for the get asset types action parameters orderby string optional parameters for the get asset types action input example {"parameters" {"filter" "substringof('cab', orgname)","orderby" "priority"}} 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 result assettypeid number unique identifier result assettypename string name of the resource result parentassettypeid number unique identifier result attributes object result of the operation responsecode number output field responsecode status string status value error string error message if any output 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 parameters filter string optional parameters for the get assets action parameters orderby string optional parameters for the get assets action input example {"parameters" {"filter" "substringof('cab', orgname)","orderby" "priority"}} 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 result assetid number unique identifier result assetname string name of the resource result assettypeid number unique identifier result probeid number unique identifier result machinegroupid number unique identifier result machinegroup string result of the operation result orgid number unique identifier result iscomputeragent boolean result of the operation result ismobileagent boolean result of the operation result ismonitoring string result of the operation result ispatching string result of the operation result isauditing string result of the operation result isbackingup string result of the operation result issecurity string result of the operation result ticketcount number result of the operation result alarmcount number result of the operation result issnmpactive boolean result of the operation result isvproactive boolean result of the operation result networkinfo number result of the operation result agentid number unique identifier result displayname string name of the resource output 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 path parameters orgid number required parameters for the get organization action input example {"path parameters" {"orgid" 0}} 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 contactinfo preferredcontactmethod string http method to use contactinfo primaryphone string output field contactinfo primaryphone contactinfo primaryfax string output field contactinfo primaryfax contactinfo primaryemail string output field contactinfo primaryemail contactinfo country string output field contactinfo country contactinfo street string output field contactinfo street contactinfo city string output field contactinfo city contactinfo state string output field contactinfo state contactinfo zipcode string output field contactinfo zipcode contactinfo primarytextmessagephone string response message customfields array output field customfields customfields fieldname string name of the resource output 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" {"preferredcontactmethod" "string","primaryphone" "string","primaryfax" "string","primaryemail" "string","country" "string","street" "string","city" "string","state" "string","zipcode" "string","primarytextmessage get organizations this action returns an array of organization records endpoint url /system/orgs method get input argument name type required description parameters filter string optional parameters for the get organizations action parameters orderby string optional parameters for the get organizations action input example {"parameters" {"filter" "substringof('cab', orgname)","orderby" "priority"}} 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 result orgid number unique identifier result orgname string name of the resource result orgref string result of the operation result orgtype string type of the resource result defaultdepartmentname string name of the resource result defaultmachinegroupname string name of the resource result parentorgid number unique identifier result website string result of the operation result noofemployees number result of the operation result annualrevenue number result of the operation result contactinfo object result of the operation result contactinfo preferredcontactmethod string http method to use result contactinfo primaryphone string result of the operation result contactinfo primaryfax string result of the operation result contactinfo primaryemail string result of the operation result contactinfo country string result of the operation result contactinfo street string result of the operation result contactinfo city string result of the operation result contactinfo state string result of the operation result contactinfo zipcode string result of the operation result contactinfo primarytextmessagephone string result of the operation output 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 path parameters agentid number required parameters for the get scheduled agent procedures action parameters filter string optional parameters for the get scheduled agent procedures action parameters orderby string optional parameters for the get scheduled agent procedures action input example {"parameters" {"filter" "substringof('cab', orgname)","orderby" "priority"},"path parameters" {"agentid" 0}} 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 result agentprocedureid number unique identifier result agentprocedurename string name of the resource result nextexectime string result of the operation result status string status value result admin string result of the operation result recurrence string result of the operation result attributes object result of the operation result agentid number unique identifier result servertimezone boolean result of the operation result skipifoffline boolean result of the operation result powerupifoffline boolean result of the operation result scriptprompts object result of the operation result scriptprompts caption string result of the operation result scriptprompts name string name of the resource result scriptprompts value string value for the parameter result distribution object result of the operation result distribution interval string result of the operation result distribution magnitude number result of the operation result start object result of the operation result start starton string result of the operation result start startat string result of the operation output 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 path parameters agentid number required parameters for the run agent procedure action path parameters agentprocid number required parameters for the run agent procedure action input example {"path parameters" {"agentid" 0,"agentprocid" 1}} 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 output 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 path parameters agentid number required parameters for the schedule agent procedure action path parameters agentprocid number required parameters for the schedule agent procedure action input example {"path parameters" {"agentid" 0,"agentprocid" 1}} 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 scriptprompts caption string output field scriptprompts caption scriptprompts name string name of the resource scriptprompts value string value for the parameter recurrence object output field recurrence recurrence repeat string output field recurrence repeat recurrence times number output field recurrence times recurrence daysofweek string output field recurrence daysofweek recurrence dayofmonth string output field recurrence dayofmonth recurrence specificdayofmonth number output field recurrence specificdayofmonth recurrence monthofyear string output field recurrence monthofyear recurrence endat string output field recurrence endat recurrence endon string output field recurrence endon recurrence endafterintervaltimes number output field recurrence endafterintervaltimes distribution object output field distribution distribution interval string output field distribution interval distribution magnitude number output field distribution magnitude start object output field start output example {"status code" 200,"response headers" {},"reason" "ok","json body" {"agentid" 0,"agentprocid" 1,"servertimezone"\ true,"skipifoffline"\ true,"powerupifoffline"\ true,"scriptprompts" \[{}],"recurrence" {"repeat" "never","times" 0,"daysofweek" "string","dayofmonth" "firstsunday","specificdayofmonth" 0,"monthofyear" "january","endat" "t0000","endon" "2016 02 05t21 02 56 650z","endafterintervaltimes" 0},"distribution" {"interval" "minutes","magnitude" 0},"start" {"starton" "2016 02 05t21 02 56 650z","st update organization this action updates a single organization record endpoint url /system/orgs/{{orgid}} method put input argument name type required description path parameters orgid number required parameters for the update organization action 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 contactinfo preferredcontactmethod string optional http method to use contactinfo primaryphone string optional parameter for update organization contactinfo primaryfax string optional parameter for update organization contactinfo primaryemail string optional parameter for update organization contactinfo country string optional parameter for update organization contactinfo street string optional parameter for update organization contactinfo city string optional parameter for update organization contactinfo state string optional parameter for update organization contactinfo zipcode string optional parameter for update organization contactinfo primarytextmessagephone string optional response message customfields array optional parameter for update organization customfields fieldname string optional name of the resource customfields fieldvalue string optional value for the parameter input example {"json body" {"orgid" 0,"orgname" "string","orgref" "string","orgtype" "string","defaultdepartmentname" "string","defaultmachinegroupname" "string","parentorgid" 0,"website" "string","noofemployees" 0,"annualrevenue" 0,"contactinfo" {"preferredcontactmethod" "string","primaryphone" "string","primaryfax" "string","primaryemail" "string","country" "string","street" "string","city" "string","state" "string","zipcode" "string","primarytextmessagephone" "string"},"customfields" \[{"fieldname" "string","fieldvalue" "string"}],"attributes" {}},"path parameters" {"orgid" 0}} 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 output example {"status code" 200,"response headers" {},"reason" "ok","json body" {"responsecode" 200,"status" "ok","error" "none"}} response headers header description example content type the media type of the resource application/json date the date and time at which the message was originated thu, 01 jan 2024 00 00 00 gmt