---
description: This is the API Documentation for the /api/assets/software route.
---

# Software

## Get ALL Assets

<mark style="color:blue;">`GET`</mark> `/api/assets/software/view-all`

{% tabs %}
{% tab title="200: OK SoftwareAsset[]" %}
The response is an Array of [hardware-asset](../types/hardware-asset "mention").
{% endtab %}
{% endtabs %}

## Get ALL Assets by Supervising Employee

<mark style="color:blue;">`GET`</mark> `/api/assets/software/view-all/:id`

#### Path Parameters

| Name                                 | Type   | Description |
| ------------------------------------ | ------ | ----------- |
| id<mark style="color:red;">\*</mark> | String | Employee ID |

{% tabs %}
{% tab title="200: OK SoftwareAsset[]" %}
The response is an array of [hardware-asset](../types/hardware-asset "mention") objects.
{% endtab %}

{% tab title="404: Not Found " %}

{% endtab %}
{% endtabs %}

## Get Asset

<mark style="color:blue;">`GET`</mark> `/api/assets/software/:id`

#### Path Parameters

| Name                                 | Type   | Description         |
| ------------------------------------ | ------ | ------------------- |
| id<mark style="color:red;">\*</mark> | String | The ID of the Asset |

{% tabs %}
{% tab title="200: OK SoftwareAsset" %}
The response is a [hardware-asset](../types/hardware-asset "mention") object.
{% endtab %}

{% tab title="404: Not Found " %}

{% endtab %}
{% endtabs %}

## Perform Vulnerability Scan

<mark style="color:blue;">`GET`</mark> `/api/assets/software/:id/scan`

#### Path Parameters

| Name                                 | Type   | Description         |
| ------------------------------------ | ------ | ------------------- |
| id<mark style="color:red;">\*</mark> | String | The ID of the Asset |

{% tabs %}
{% tab title="200: OK VulnerabilityScan" %}

{% endtab %}

{% tab title="400: Bad Request " %}

{% endtab %}
{% endtabs %}

## Insert Asset

<mark style="color:green;">`POST`</mark> `/api/assets/software/`

#### Request Body

| Name                                           | Type   | Description                   |
| ---------------------------------------------- | ------ | ----------------------------- |
| name<mark style="color:red;">\*</mark>         | String | The Name of the Asset         |
| manufacturer<mark style="color:red;">\*</mark> | String | The Manufacturer of the Asset |
| risk\_level                                    | String | The Risk Level of the Asset   |
| version<mark style="color:red;">\*</mark>      | String | The Version of the Asset      |

{% tabs %}
{% tab title="200: OK { status: true, id: ObjectId }" %}

{% endtab %}

{% tab title="400: Bad Request " %}

{% endtab %}
{% endtabs %}

## Delete Asset

<mark style="color:red;">`DELETE`</mark> `/api/assets/software/:id`

#### Path Parameters

| Name                                 | Type   | Description                  |
| ------------------------------------ | ------ | ---------------------------- |
| id<mark style="color:red;">\*</mark> | String | The ID of the Software Asset |

{% tabs %}
{% tab title="200: OK " %}

{% endtab %}
{% endtabs %}

## Delete ALL Assets

<mark style="color:red;">`DELETE`</mark> `/api/assets/software/`

{% tabs %}
{% tab title="200: OK " %}

{% endtab %}
{% endtabs %}



## Edit Asset

<mark style="color:purple;">`PATCH`</mark> `/api/assets/software/:id`

#### Path Parameters

| Name                                 | Type   | Description                  |
| ------------------------------------ | ------ | ---------------------------- |
| id<mark style="color:red;">\*</mark> | String | The ID of the Software Asset |

#### Request Body

| Name                                           | Type   | Description                   |
| ---------------------------------------------- | ------ | ----------------------------- |
| name<mark style="color:red;">\*</mark>         | String | The Name of the Asset         |
| risk\_level                                    | String | The Risk Level of the Asset   |
| version<mark style="color:red;">\*</mark>      | String | The Version of the Asset      |
| manufacturer<mark style="color:red;">\*</mark> | String | The Manufacturer of the Asset |

{% tabs %}
{% tab title="200: OK { status: true }" %}

{% endtab %}

{% tab title="400: Bad Request " %}

{% endtab %}
{% endtabs %}

