---
title: Solarwinds Service Desk
slug: connectors/solarwinds-service-desk
docTags: 
createdAt: 2026-06-09T16:30:22.671Z
---

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:**

1. Obtain the url from your SolarWinds Service Desk account.
2. Obtain the bearer token from your SolarWinds Service Desk account.
3. 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**                            |
| ----------------------------- | -------- | ------------ | ------------------------------------------ |
| `path_parameters.object_type` | string   | Required     | Source object type.                        |
| `path_parameters.id`          | string   | Required     | Numeric ID of the object to get or update. |
| `comment`                     | object   | Optional     | Parameter for Create Comment               |
| `comment.body`                | string   | Required     | Request body data                          |
| `comment.is_private`          | string   | Optional     | Parameter for Create Comment               |
| `comment.user_id`             | string   | Optional     | Unique identifier                          |

### Input Example

`{"json_body":{"comment":{"body":"Comment body","is_private":"true","user_id":"1"}},"path_parameters":{"object_type":"string","id":"string"}}`

### Output

| **Parameter**                  | **Type** | **Description**                            |
| ------------------------------ | -------- | ------------------------------------------ |
| `status_code`                  | number   | HTTP status code of the response           |
| `reason`                       | string   | Response reason phrase                     |
| `comment`                      | object   | Output field: comment                      |
| `comment.id`                   | string   | Unique identifier                          |
| `comment.body`                 | string   | Request body data                          |
| `comment.is_private`           | string   | Output field: comment.is\_private          |
| `comment.created_at`           | string   | Output field: comment.created\_at          |
| `comment.updated_at`           | string   | Output field: comment.updated\_at          |
| `comment.user`                 | object   | Output field: comment.user                 |
| `comment.user.id`              | string   | Unique identifier                          |
| `comment.user.account_id`      | string   | Unique identifier                          |
| `comment.user.user_id`         | string   | Unique identifier                          |
| `comment.user.email`           | string   | Output field: comment.user.email           |
| `comment.user.name`            | string   | Name of the resource                       |
| `comment.user.disabled`        | boolean  | Output field: comment.user.disabled        |
| `comment.user.avatar`          | object   | Output field: comment.user.avatar          |
| `comment.user.avatar.type`     | string   | Type of the resource                       |
| `comment.user.avatar.color`    | string   | Output field: comment.user.avatar.color    |
| `comment.user.avatar.initials` | string   | Output field: comment.user.avatar.initials |
| `comment.commenter_id`         | string   | Unique identifier                          |
| `comment.commenter_type`       | string   | Type of the resource                       |

### Output Example

`{"status_code":200,"response_headers":{},"reason":"OK","json_body":{"comment":{"id":"1","body":"Comment body","is_private":"true","created_at":"2025-01-01T00:00:00.000+01:00","updated_at":"2025-01-01T00:00:00.000+01:00","user":{},"commenter_id":"1","commenter_type":"Incident"}}}`

## 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   | Optional     | Name of the resource         |
| `description`                                         | string   | Optional     | Parameter for Create Problem |
| `site`                                                | object   | Optional     | Parameter for Create Problem |
| `site.name`                                           | string   | Required     | Name of the resource         |
| `department`                                          | object   | Optional     | Parameter for Create Problem |
| `department.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 |
| `requester.email`                                     | string   | Required     | Parameter for Create Problem |
| `assignee`                                            | object   | Optional     | Parameter for Create Problem |
| `assignee.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_values.custom_fields_value`            | array    | Required     | Value for the parameter      |
| `custom_fields_values.custom_fields_value.name`       | string   | Required     | Name of the resource         |
| `custom_fields_values.custom_fields_value.value`      | string   | Optional     | Value for the parameter      |
| `custom_fields_values.custom_fields_value.user_value` | object   | Optional     | Value for the parameter      |

### Input Example

`{"json_body":{"name":"Example Problem","description":"This is an example description.","site":{"id":"123","name":"Example Site"},"department":{"id":"456","name":"Example Department"},"site_id":"123","department_id":"456","state":"open","requester":{"id":"789","name":"Example Requester","email":"requester@example.com"},"assignee":{"id":"101","name":"Example Assignee","email":"assignee@example.com"},"priority":"high","root_cause":"Example root cause","symptoms":"Example symptoms","workaround":"Example workaround","add_to_tag_list":"example_tag","remove_from_tag_list":"old_tag","tag_list":"example_tag,another_tag","custom_fields_values":{"name":"value1","value":"value2","user_value":"user_value"},"custom_fields_values_attributes":[{"id":"1","custom_field_id":"cf1","value":"attribute_value1"},{"id":"2","custom_field_id":"cf2","value":"attribute_value2"}],"incident_ids":["1","2","3"],"itsm_change_ids":["4","5","6"],"configuration_item_ids":["7","8","9"]}}`

### Output

| **Parameter**                            | **Type** | **Description**                              |
| ---------------------------------------- | -------- | -------------------------------------------- |
| `status_code`                            | number   | HTTP status code of the response             |
| `reason`                                 | string   | Response reason phrase                       |
| `problem`                                | object   | Output field: problem                        |
| `problem.id`                             | string   | Unique identifier                            |
| `problem.number`                         | string   | Output field: problem.number                 |
| `problem.name`                           | string   | Name of the resource                         |
| `problem.description`                    | string   | Output field: problem.description            |
| `problem.state`                          | string   | Output field: problem.state                  |
| `problem.root_cause`                     | string   | Output field: problem.root\_cause            |
| `problem.symptoms`                       | string   | Output field: problem.symptoms               |
| `problem.workaround`                     | string   | Output field: problem.workaround             |
| `problem.site`                           | object   | Output field: problem.site                   |
| `problem.site.id`                        | string   | Unique identifier                            |
| `problem.site.name`                      | string   | Name of the resource                         |
| `problem.site.location`                  | string   | Output field: problem.site.location          |
| `problem.site.description`               | string   | Output field: problem.site.description       |
| `problem.site.time_zone`                 | string   | Output field: problem.site.time\_zone        |
| `problem.department`                     | object   | Output field: problem.department             |
| `problem.department.id`                  | string   | Unique identifier                            |
| `problem.department.name`                | string   | Name of the resource                         |
| `problem.department.description`         | string   | Output field: problem.department.description |
| `problem.department.default_assignee_id` | string   | Unique identifier                            |
| `problem.priority`                       | string   | Output field: problem.priority               |
| `problem.created_by`                     | object   | Output field: problem.created\_by            |
| `problem.created_by.id`                  | string   | Unique identifier                            |

### Output Example

`{"status_code":200,"response_headers":{},"reason":"OK","json_body":{"problem":{"id":"10000","number":"1000","name":"Problem Name","description":"description","state":"New","root_cause":"Root cause description","symptoms":"Symptoms description","workaround":"workaround description","site":{},"department":{},"priority":"High","created_by":{},"assignee":{},"requester":{},"custom_fields_values":[]}}}`

## 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**                            |
| ----------------------------- | -------- | ------------ | ------------------------------------------ |
| `path_parameters.object_type` | string   | Required     | Source object type.                        |
| `path_parameters.id`          | string   | Required     | Numeric ID of the object to get or update. |
| `path_parameters.comment_id`  | string   | Required     | Numeric ID of the comment.                 |

### Input Example

`{"path_parameters":{"object_type":"incidents","id":"1","comment_id":"22"}}`

### Output

| **Parameter**      | **Type** | **Description**                  |
| ------------------ | -------- | -------------------------------- |
| `status_code`      | number   | HTTP status code of the response |
| `reason`           | string   | Response reason phrase           |
| `messages`         | object   | Response message                 |
| `messages.message` | string   | Response message                 |

### Output Example

`{"status_code":200,"response_headers":{},"reason":"OK","json_body":{"messages":{"message":"Deleted comment"}}}`

## 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**                            |
| -------------------- | -------- | ------------ | ------------------------------------------ |
| `path_parameters.id` | string   | Required     | Numeric ID of the object to get or update. |

### Input Example

`{"path_parameters":{"id":"1"}}`

### Output

| **Parameter** | **Type** | **Description**                  |
| ------------- | -------- | -------------------------------- |
| `status_code` | number   | HTTP status code of the response |
| `reason`      | string   | Response reason phrase           |
| `deleted_ids` | array    | Unique identifier                |

### Output Example

`{"status_code":200,"response_headers":{},"reason":"OK","json_body":{"deleted_ids":["1"]}}`

## 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**                                                                                                                                       |
| -------------------- | -------- | ------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------- |
| `parameters.layout`  | string   | Optional     | This affects the length of the returned records, and is relevant for changes, contracts, hardwares, incidents, other assets, problems, and solutions. |
| `path_parameters.id` | string   | Required     | Numeric ID of the object to get or update.                                                                                                            |

### Input Example

`{"parameters":{"layout":"short"},"path_parameters":{"id":"10000"}}`

### 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                  |
| `category.id`                     | number   | Unique identifier                       |
| `category.name`                   | string   | Name of the resource                    |
| `category.default_tags`           | string   | Output field: category.default\_tags    |
| `category.parent_id`              | string   | Unique identifier                       |
| `category.default_assignee_id`    | number   | Unique identifier                       |
| `category.deleted`                | boolean  | Output field: category.deleted          |
| `subcategory`                     | object   | Output field: subcategory               |
| `subcategory.id`                  | number   | Unique identifier                       |
| `subcategory.name`                | string   | Name of the resource                    |
| `subcategory.default_tags`        | string   | Output field: subcategory.default\_tags |
| `subcategory.parent_id`           | string   | Unique identifier                       |
| `subcategory.default_assignee_id` | number   | Unique identifier                       |
| `subcategory.deleted`             | boolean  | Output field: subcategory.deleted       |
| `assignee`                        | object   | Output field: assignee                  |
| `assignee.group_id`               | number   | Unique identifier                       |

### Output Example

`{"id":123,"number":123,"name":"Example Name","description":"string","description_no_html":"string","state":"string","priority":"string","category":{"id":123,"name":"Example Name","default_tags":"string","parent_id":"string","default_assignee_id":123,"deleted":true},"subcategory":{"id":123,"name":"Example Name","default_tags":"string","parent_id":"string","default_assignee_id":123,"deleted":true},"assignee":{"group_id":123,"is_user":"string","id":123,"name":"Example Name","email":"user@example.co...`

## 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**                                                                                                                                       |
| ------------------------------- | -------- | ------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------- |
| `parameters.layout`             | string   | Optional     | This affects the length of the returned records, and is relevant for changes, contracts, hardwares, incidents, other assets, problems, and solutions. |
| `parameters.updated`            | string   | Optional     | Parameters for the Get Incidents action                                                                                                               |
| `parameters.updated_custom_gte` | string   | Optional     | Parameters for the Get Incidents action                                                                                                               |
| `parameters.updated_custom_lte` | string   | Optional     | Parameters for the Get Incidents action                                                                                                               |

### Input Example

`{"parameters":{"layout":"short","updated":"30","updated_custom_gte":"Mar 2 2023","updated_custom_lte":"Apr 2 2024"}}`

### Output

| **Parameter** | **Type** | **Description**                  |
| ------------- | -------- | -------------------------------- |
| `status_code` | number   | HTTP status code of the response |
| `reason`      | string   | Response reason phrase           |

### Output Example

`{"status_code":200,"response_headers":{},"reason":"OK","json_body":[{"id":10000,"number":1000,"name":"Incident Name","description":"<p>description</p>","description_no_html":"description","state":"New","priority":"High","category":{},"subcategory":{},"assignee":{},"requester":{},"created_at":"2024-01-01T00:00:00.000+01:00","updated_at":"2024-01-01T00:00:00.000+01:00","due_at":"2025-01-01T00:00:00.000+01:00","sla_violations":[]}]}`

## 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**                                                                                                                                       |
| -------------------- | -------- | ------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------- |
| `parameters.layout`  | string   | Optional     | This affects the length of the returned records, and is relevant for changes, contracts, hardwares, incidents, other assets, problems, and solutions. |
| `path_parameters.id` | string   | Required     | Numeric ID of the object to get or update.                                                                                                            |

### Input Example

`{"parameters":{"layout":"short"},"path_parameters":{"id":"1"}}`

### Output

| **Parameter**                            | **Type** | **Description**                              |
| ---------------------------------------- | -------- | -------------------------------------------- |
| `status_code`                            | number   | HTTP status code of the response             |
| `reason`                                 | string   | Response reason phrase                       |
| `problem`                                | object   | Output field: problem                        |
| `problem.id`                             | string   | Unique identifier                            |
| `problem.number`                         | string   | Output field: problem.number                 |
| `problem.name`                           | string   | Name of the resource                         |
| `problem.description`                    | string   | Output field: problem.description            |
| `problem.state`                          | string   | Output field: problem.state                  |
| `problem.root_cause`                     | string   | Output field: problem.root\_cause            |
| `problem.symptoms`                       | string   | Output field: problem.symptoms               |
| `problem.workaround`                     | string   | Output field: problem.workaround             |
| `problem.site`                           | object   | Output field: problem.site                   |
| `problem.site.id`                        | string   | Unique identifier                            |
| `problem.site.name`                      | string   | Name of the resource                         |
| `problem.site.location`                  | string   | Output field: problem.site.location          |
| `problem.site.description`               | string   | Output field: problem.site.description       |
| `problem.site.time_zone`                 | string   | Output field: problem.site.time\_zone        |
| `problem.department`                     | object   | Output field: problem.department             |
| `problem.department.id`                  | string   | Unique identifier                            |
| `problem.department.name`                | string   | Name of the resource                         |
| `problem.department.description`         | string   | Output field: problem.department.description |
| `problem.department.default_assignee_id` | string   | Unique identifier                            |
| `problem.priority`                       | string   | Output field: problem.priority               |
| `problem.created_by`                     | object   | Output field: problem.created\_by            |
| `problem.created_by.id`                  | string   | Unique identifier                            |

### Output Example

`{"status_code":200,"response_headers":{},"reason":"OK","json_body":{"problem":{"id":"10000","number":"1000","name":"Problem Name","description":"description","state":"New","root_cause":"Root cause description","symptoms":"Symptoms description","workaround":"workaround description","site":{},"department":{},"priority":"High","created_by":{},"assignee":{},"requester":{},"custom_fields_values":[]}}}`

## 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**                                                                                                                                       |
| ------------------- | -------- | ------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------- |
| `parameters.layout` | string   | Optional     | This affects the length of the returned records, and is relevant for changes, contracts, hardwares, incidents, other assets, problems, and solutions. |

### Input Example

`{"parameters":{"layout":"long"}}`

### Output

| **Parameter** | **Type** | **Description**                  |
| ------------- | -------- | -------------------------------- |
| `status_code` | number   | HTTP status code of the response |
| `reason`      | string   | Response reason phrase           |

### Output Example

`{"status_code":200,"response_headers":{},"reason":"OK","json_body":[{"problem":{}}]}`

## 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**                            |
| ----------------------------- | -------- | ------------ | ------------------------------------------ |
| `path_parameters.object_type` | string   | Required     | Source object type.                        |
| `path_parameters.id`          | string   | Required     | Numeric ID of the object to get or update. |
| `path_parameters.comment_id`  | string   | Required     | Numeric ID of the comment.                 |
| `comment`                     | object   | Optional     | Parameter for Update Comment By ID         |
| `comment.body`                | string   | Optional     | Request body data                          |
| `comment.is_private`          | string   | Optional     | Parameter for Update Comment By ID         |
| `comment.user_id`             | string   | Optional     | Unique identifier                          |

### Input Example

`{"json_body":{"comment":{"body":"Comment body","is_private":"true","user_id":"1"}},"path_parameters":{"object_type":"string","id":"string","comment_id":"string"}}`

### Output

| **Parameter**                  | **Type** | **Description**                            |
| ------------------------------ | -------- | ------------------------------------------ |
| `status_code`                  | number   | HTTP status code of the response           |
| `reason`                       | string   | Response reason phrase                     |
| `comment`                      | object   | Output field: comment                      |
| `comment.id`                   | string   | Unique identifier                          |
| `comment.body`                 | string   | Request body data                          |
| `comment.is_private`           | string   | Output field: comment.is\_private          |
| `comment.created_at`           | string   | Output field: comment.created\_at          |
| `comment.updated_at`           | string   | Output field: comment.updated\_at          |
| `comment.user`                 | object   | Output field: comment.user                 |
| `comment.user.id`              | string   | Unique identifier                          |
| `comment.user.account_id`      | string   | Unique identifier                          |
| `comment.user.user_id`         | string   | Unique identifier                          |
| `comment.user.email`           | string   | Output field: comment.user.email           |
| `comment.user.name`            | string   | Name of the resource                       |
| `comment.user.disabled`        | boolean  | Output field: comment.user.disabled        |
| `comment.user.avatar`          | object   | Output field: comment.user.avatar          |
| `comment.user.avatar.type`     | string   | Type of the resource                       |
| `comment.user.avatar.color`    | string   | Output field: comment.user.avatar.color    |
| `comment.user.avatar.initials` | string   | Output field: comment.user.avatar.initials |
| `comment.commenter_id`         | string   | Unique identifier                          |
| `comment.commenter_type`       | string   | Type of the resource                       |

### Output Example

`{"status_code":200,"response_headers":{},"reason":"OK","json_body":{"comment":{"id":"1","body":"Comment body","is_private":"true","created_at":"2025-01-01T00:00:00.000+01:00","updated_at":"2025-01-01T00:00:00.000+01:00","user":{},"commenter_id":"1","commenter_type":"Incident"}}}`

## 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**                                                                                                |
| ---------------------------------------------------------- | -------- | ------------ | -------------------------------------------------------------------------------------------------------------- |
| `path_parameters.id`                                       | string   | Required     | Parameters for the Update Incident By ID action                                                                |
| `incident`                                                 | object   | Optional     | Unique identifier                                                                                              |
| `incident.name`                                            | string   | Optional     | The name property accepts a maximum of 255 chars. values exceeding this limit will be truncated with ellipsis. |
| `incident.site_id`                                         | number   | Optional     | Unique identifier                                                                                              |
| `incident.department_id`                                   | number   | Optional     | Unique identifier                                                                                              |
| `incident.description`                                     | string   | Optional     | Unique identifier                                                                                              |
| `incident.state_id`                                        | number   | Optional     | Unique identifier                                                                                              |
| `incident.assignee`                                        | object   | Optional     | Unique identifier                                                                                              |
| `incident.assignee.email`                                  | string   | Required     | Unique identifier                                                                                              |
| `incident.requester`                                       | object   | Optional     | Unique identifier                                                                                              |
| `incident.requester.email`                                 | string   | Required     | Unique identifier                                                                                              |
| `incident.priority`                                        | string   | Optional     | Unique identifier                                                                                              |
| `incident.category`                                        | object   | Optional     | Unique identifier                                                                                              |
| `incident.category.name`                                   | string   | Required     | Unique identifier                                                                                              |
| `incident.subcategory`                                     | object   | Optional     | Unique identifier                                                                                              |
| `incident.subcategory.name`                                | string   | Required     | Unique identifier                                                                                              |
| `incident.due_at`                                          | string   | Optional     | Unique identifier                                                                                              |
| `incident.add_to_tag_list`                                 | string   | Optional     | Unique identifier                                                                                              |
| `incident.remove_from_tag_list`                            | string   | Optional     | Unique identifier                                                                                              |
| `incident.tag_list`                                        | string   | Optional     | Unique identifier                                                                                              |
| `incident.custom_fields_values_attributes`                 | array    | Optional     | Unique identifier                                                                                              |
| `incident.custom_fields_values_attributes.id`              | number   | Optional     | Unique identifier                                                                                              |
| `incident.custom_fields_values_attributes.custom_field_id` | number   | Optional     | Unique identifier                                                                                              |
| `incident.custom_fields_values_attributes.value`           | string   | Optional     | Unique identifier                                                                                              |
| `incident.custom_fields_values`                            | object   | Optional     | Unique identifier                                                                                              |

### Input Example

`{"json_body":{"incident":{"name":"Incident Name","site_id":1,"department_id":1,"description":"description","state_id":1,"assignee":{"email":"john.doe@email.com"},"requester":{"email":"john.doe@email.com"},"priority":"High","category":{"name":"Facilities"},"subcategory":{"name":"Equipment"},"due_at":"Jan 01,2025","add_to_tag_list":"tag1, tag2","remove_from_tag_list":"tag3","tag_list":"tag1, tag2","custom_fields_values_attributes":[{"id":10,"custom_field_id":1,"value":"content"},{"id":100,"custom_field_id":2,"value":"1"}],"custom_fields_values":{"custom_fields_value":[{"name":"Text custom field","value":"content"},{"name":"User custom field","user_value":{"email":"john.doe@email.com"}}]},"incidents":[{"number":100}],"problems":[{"number":100}],"changes":[{"number":100}],"solutions":[{"number":100}],"releases":[{"number":100}],"purchase_orders":[{"number":100}],"configuration_items":[{"name":"Item name"}],"configuration_item_ids":[100],"cc":["jane.doe@email.com"]}},"path_parameters":{"id":"1"}}`

### Output

| **Parameter**                                              | **Type** | **Description**                  |
| ---------------------------------------------------------- | -------- | -------------------------------- |
| `status_code`                                              | number   | HTTP status code of the response |
| `reason`                                                   | string   | Response reason phrase           |
| `incident`                                                 | object   | Unique identifier                |
| `incident.name`                                            | string   | Unique identifier                |
| `incident.site_id`                                         | number   | Unique identifier                |
| `incident.department_id`                                   | number   | Unique identifier                |
| `incident.description`                                     | string   | Unique identifier                |
| `incident.state_id`                                        | number   | Unique identifier                |
| `incident.assignee`                                        | object   | Unique identifier                |
| `incident.assignee.email`                                  | string   | Unique identifier                |
| `incident.requester`                                       | object   | Unique identifier                |
| `incident.requester.email`                                 | string   | Unique identifier                |
| `incident.priority`                                        | string   | Unique identifier                |
| `incident.category`                                        | object   | Unique identifier                |
| `incident.category.name`                                   | string   | Unique identifier                |
| `incident.subcategory`                                     | object   | Unique identifier                |
| `incident.subcategory.name`                                | string   | Unique identifier                |
| `incident.due_at`                                          | string   | Unique identifier                |
| `incident.add_to_tag_list`                                 | string   | Unique identifier                |
| `incident.remove_from_tag_list`                            | string   | Unique identifier                |
| `incident.tag_list`                                        | string   | Unique identifier                |
| `incident.custom_fields_values_attributes`                 | array    | Unique identifier                |
| `incident.custom_fields_values_attributes.id`              | number   | Unique identifier                |
| `incident.custom_fields_values_attributes.custom_field_id` | number   | Unique identifier                |
| `incident.custom_fields_values_attributes.value`           | string   | Unique identifier                |

### Output Example

`{"status_code":200,"response_headers":{},"reason":"OK","json_body":{"incident":{"name":"Incident Name","site_id":1,"department_id":1,"description":"description","state_id":1,"assignee":{},"requester":{},"priority":"High","category":{},"subcategory":{},"due_at":"Jan 01,2025","add_to_tag_list":"tag1, tag2","remove_from_tag_list":"tag3","tag_list":"tag1, tag2","custom_fields_values_attributes":[]}}}`

# 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 |