SolarWinds Service Desk
56 min
the solarwinds service desk connector allows for seamless integration with swimlane turbine, enabling automated it service management and incident response solarwinds service desk is a comprehensive it service management (itsm) solution that streamlines ticketing, incident management, and problem resolution this connector enables swimlane turbine users to automate itsm workflows, such as creating and updating incidents, managing comments, and handling problem records directly within the swimlane platform by integrating with solarwinds service desk, users can enhance their incident response capabilities, reduce manual efforts, and accelerate resolution times, all while maintaining a centralized view of it service management activities limitations none to date supported versions this connector supports solarwinds service desk api version 1 0 additional docs for more information, please refer to the solarwinds service desk api documentation https //apidoc samanage com/ authenticatio documentation https //apidoc samanage com/#section/general concepts/authentication ensure that your solarwinds service desk account has the necessary permissions to use the connector configuration prerequisites to effectively utilize the solarwinds service desk connector within swimlane turbine, ensure you have the following prerequisites http bearer authentication with the following parameters url the endpoint url for the solarwinds service desk api token a valid bearer token to authenticate api requests authentication methods this connector supports the following authentication methods http bearer authentication setup instructions obtain the url from your solarwinds service desk account obtain the bearer token from your solarwinds service desk account use the bearer token and url in the connector configuration troubleshooting tips ensure that the bearer token has the necessary permissions to access and manage incidents double check that the bearer token is correctly entered capabilities this connector provides the following capabilities create comment create problems delete comment by id delete incident by id get incidents get incidents by id get problem by id get problems update comment update incidents by id create comment additional information description adds a comment to a specific incident parameters provide the incident id and the comment details output returns the updated incident with the new comment solarwinds service desk connector's documentation for this action can be found here https //apidoc samanage com/#tag/comment/operation/createcomment create problem additional information description creates new problem parameters provide the details of the problem to be created output returns the created problem details solarwinds service desk connector's documentation for this action can be found here https //apidoc samanage com/#tag/problem/operation/createproblem delete comment by id additional information description deletes a specific comment by its id parameters provide the comment id to delete output confirms the deletion of the comment solarwinds service desk connector's documentation for this action can be found here https //apidoc samanage com/#tag/comment/operation/deletecommentbyid delete incident by id additional information description deletes a specific incident by its id parameters provide the incident id to delete output confirms the deletion of the incident solarwinds service desk connector's documentation for this action can be found here https //apidoc samanage com/#tag/incident/operation/deleteincidentbyid get incident by id additional information description retrieves details of a specific incident by its id parameters provide the incident id to retrieve output returns the incident details solarwinds service desk connector's documentation for this action can be found here https //apidoc samanage com/#tag/incident/operation/getincidentbyid get incidents additional information description lists all incidents based on specified filters parameters specify filters to list incidents output returns a list of incidents matching the filters solarwinds service desk connector's documentation for this action can be found here https //apidoc samanage com/#tag/incident/operation/getincidents get problem by id additional information description retrieves details of a specific problem by its id parameters provide the problem id to retrieve output returns the problem details solarwinds service desk connector's documentation for this action can be found here https //apidoc samanage com/#tag/problem/operation/getproblembyid get problems additional information description lists all problems based on specified filters parameters specify filters to list problems output returns a list of problems matching the filters solarwinds service desk connector's documentation for this action can be found here https //apidoc samanage com/#tag/problem/operation/getproblems update comment by id additional information description updates a specific comment parameters provide the comment id and the new details output returns the updated comment solarwinds service desk connector's documentation for this action can be found here https //apidoc samanage com/#tag/comment/operation/updatecommentbyid update incident by id additional information description updates an existing incident with specified fields parameters specify the fields to be updated in the incident path parameters provide the incident id to update output returns the updated incident details solarwinds service desk connector's documentation for this action can be found here https //apidoc samanage com/#tag/incident/operation/updateincidentbyid configurations solarwinds service desk http bearer authentication authenticates using bearer token 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 create comment creates a new comment on an object within solarwinds service desk, specified by type and id endpoint url /{{object type}}/{{id}}/comments method post input argument name type required description object type string required source object type id string required numeric id of the object to get or update comment object optional parameter for create comment body string required request body data is private string optional parameter for create comment user id string optional unique identifier output parameter type description status code number http status code of the response reason string response reason phrase comment object output field comment id string unique identifier body string request body data is private string output field is private created at string output field created at updated at string output field updated at user object output field user id string unique identifier account id string unique identifier user id string unique identifier email string output field email name string name of the resource disabled boolean output field disabled avatar object output field avatar type string type of the resource color string output field color initials string output field initials commenter id string unique identifier commenter type string type of the resource example \[ { "status code" 200, "response headers" {}, "reason" "ok", "json body" { "comment" {} } } ] create problem initiates the creation of a new problem record in solarwinds service desk using the provided name endpoint url /problems method post input argument name type required description name string required name of the resource description string optional parameter for create problem site object optional parameter for create problem name string required name of the resource department object optional parameter for create problem name string required name of the resource site id string optional unique identifier department id string optional unique identifier state string optional parameter for create problem requester object optional parameter for create problem email string required parameter for create problem assignee object optional parameter for create problem email string required parameter for create problem priority string optional parameter for create problem root cause string optional parameter for create problem symptoms string optional parameter for create problem workaround string optional parameter for create problem add to tag list string optional parameter for create problem remove from tag list string optional parameter for create problem tag list string optional parameter for create problem custom fields values object optional value for the parameter custom fields value array required value for the parameter name string required name of the resource value string optional value for the parameter user value object optional value for the parameter output parameter type description status code number http status code of the response reason string response reason phrase problem object output field problem id string unique identifier number string output field number name string name of the resource description string output field description state string output field state root cause string output field root cause symptoms string output field symptoms workaround string output field workaround site object output field site id string unique identifier name string name of the resource location string output field location description string output field description time zone string output field time zone department object output field department id string unique identifier name string name of the resource description string output field description default assignee id string unique identifier priority string output field priority created by object output field created by id string unique identifier example \[ { "status code" 200, "response headers" {}, "reason" "ok", "json body" { "problem" {} } } ] delete comment by id removes a specific comment from an item in solarwinds service desk by specifying object type, id, and comment id endpoint url /{{object type}}/{{id}}/comments/{{comment id}} method delete input argument name type required description object type string required source object type id string required numeric id of the object to get or update comment id string required numeric id of the comment output parameter type description status code number http status code of the response reason string response reason phrase messages object response message message string response message example \[ { "status code" 200, "response headers" {}, "reason" "ok", "json body" { "messages" {} } } ] delete incident by id removes a specified incident from solarwinds service desk using the unique identifier provided endpoint url /incidents/{{id}} method delete input argument name type required description id string required numeric id of the object to get or update output parameter type description status code number http status code of the response reason string response reason phrase deleted ids array unique identifier example \[ { "status code" 200, "response headers" {}, "reason" "ok", "json body" { "deleted ids" \[] } } ] get incident by id retrieve detailed information for a specific incident using its id from solarwinds service desk endpoint url /incidents/{{id}} method get input argument name type required description layout string optional this affects the length of the returned records, and is relevant for changes, contracts, hardwares, incidents, other assets, problems, and solutions id string required numeric id of the object to get or update output parameter type description status code number http status code of the response reason string response reason phrase id number unique identifier number number output field number name string name of the resource description string output field description description no html string output field description no html state string output field state priority string output field priority category object output field category id number unique identifier name string name of the resource default tags string output field default tags parent id string unique identifier default assignee id number unique identifier deleted boolean output field deleted subcategory object output field subcategory id number unique identifier name string name of the resource default tags string output field default tags parent id string unique identifier default assignee id number unique identifier deleted boolean output field deleted assignee object output field assignee group id number unique identifier example \[ { "status code" 200, "response headers" { "content type" "application/json", "date" "thu, 01 jan 2024 00 00 00 gmt" }, "reason" "ok", "json body" { "id" 123, "number" 123, "name" "example name", "description" "string", "description no html" "string", "state" "string", "priority" "string", "category" {}, "subcategory" {}, "assignee" {}, "requester" {}, "created at" "string", "updated at" "string", "due at" "string", "sla violations" \[] } } ] get incidents retrieve a detailed list of incidents from solarwinds service desk, including status, assignee, and creation date endpoint url /incidents method get input argument name type required description layout string optional this affects the length of the returned records, and is relevant for changes, contracts, hardwares, incidents, other assets, problems, and solutions updated string optional parameter for get incidents updated custom gte string optional parameter for get incidents updated custom lte string optional parameter for get incidents output parameter type description status code number http status code of the response reason string response reason phrase example \[ { "status code" 200, "response headers" {}, "reason" "ok", "json body" \[ {} ] } ] get problem by id retrieve detailed information for a specific problem in solarwinds service desk using its unique identifier endpoint url /problem/{{id}} method get input argument name type required description layout string optional this affects the length of the returned records, and is relevant for changes, contracts, hardwares, incidents, other assets, problems, and solutions id string required numeric id of the object to get or update output parameter type description status code number http status code of the response reason string response reason phrase problem object output field problem id string unique identifier number string output field number name string name of the resource description string output field description state string output field state root cause string output field root cause symptoms string output field symptoms workaround string output field workaround site object output field site id string unique identifier name string name of the resource location string output field location description string output field description time zone string output field time zone department object output field department id string unique identifier name string name of the resource description string output field description default assignee id string unique identifier priority string output field priority created by object output field created by id string unique identifier example \[ { "status code" 200, "response headers" {}, "reason" "ok", "json body" { "problem" {} } } ] get problems retrieve an overview of ongoing issues by listing problem records from solarwinds service desk endpoint url /problems method get input argument name type required description layout string optional this affects the length of the returned records, and is relevant for changes, contracts, hardwares, incidents, other assets, problems, and solutions output parameter type description status code number http status code of the response reason string response reason phrase example \[ { "status code" 200, "response headers" {}, "reason" "ok", "json body" \[ {} ] } ] update comment by id updates a comment by its id for a given object type in solarwinds service desk, utilizing specified path parameters endpoint url /{{object type}}/{{id}}/comments/{{comment id}} method put input argument name type required description object type string required source object type id string required numeric id of the object to get or update comment id string required numeric id of the comment comment object optional parameter for update comment by id body string optional request body data is private string optional parameter for update comment by id user id string optional unique identifier output parameter type description status code number http status code of the response reason string response reason phrase comment object output field comment id string unique identifier body string request body data is private string output field is private created at string output field created at updated at string output field updated at user object output field user id string unique identifier account id string unique identifier user id string unique identifier email string output field email name string name of the resource disabled boolean output field disabled avatar object output field avatar type string type of the resource color string output field color initials string output field initials commenter id string unique identifier commenter type string type of the resource example \[ { "status code" 200, "response headers" {}, "reason" "ok", "json body" { "comment" {} } } ] update incident by id updates an existing incident in solarwinds service desk with specified id and provided field data endpoint url /incidents/{{id}} method put input argument name type required description id string required unique identifier incident object optional unique identifier name string optional the name property accepts a maximum of 255 chars values exceeding this limit will be truncated with ellipsis site id number optional unique identifier department id number optional unique identifier description string optional parameter for update incident by id state id number optional unique identifier assignee object optional parameter for update incident by id email string required parameter for update incident by id requester object optional parameter for update incident by id email string required parameter for update incident by id priority string optional parameter for update incident by id category object optional parameter for update incident by id name string required name of the resource subcategory object optional parameter for update incident by id name string required name of the resource due at string optional parameter for update incident by id add to tag list string optional parameter for update incident by id remove from tag list string optional parameter for update incident by id tag list string optional parameter for update incident by id custom fields values attributes array optional value for the parameter id number optional unique identifier custom field id number optional unique identifier value string optional value for the parameter custom fields values object optional value for the parameter output parameter type description status code number http status code of the response reason string response reason phrase incident object unique identifier name string name of the resource site id number unique identifier department id number unique identifier description string output field description state id number unique identifier assignee object output field assignee email string output field email requester object output field requester email string output field email priority string output field priority category object output field category name string name of the resource subcategory object output field subcategory name string name of the resource due at string output field due at add to tag list string output field add to tag list remove from tag list string output field remove from tag list tag list string output field tag list custom fields values attributes array value for the parameter id number unique identifier custom field id number unique identifier value string value for the parameter example \[ { "status code" 200, "response headers" {}, "reason" "ok", "json body" { "incident" {} } } ] 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