Deleting assets
POST /api/v1/assets/delete
Access: General administrator, Tenant administrator, Tier 2 analyst, Tier 1 analyst.
Request body
Format: JSON
Name | Data type | Mandatory | Description | Value example |
TenantID | string | Yes | Tenant ID | 00000000-0000-0000-0000-000000000000 |
ids | []string | If neither the ipAddresses array nor the FQDNs are specified | List of asset IDs | ["00000000-0000-0000-0000-000000000000"] |
fqdns | []string | If neither the ipAddresses array nor the IDs are specified | Array of asset FQDNs | ["my-asset-1.example.com", "my-asset-1"] |
ipAddresses | []string | If neither the IDs nor FQDNs are specified | Array of main IP addresses of the asset. | ["192.168.1.1", "2001:0db8:85a3:0000:0000:8a2e:0370:7334"] |
Response
HTTP code: 200
Format: JSON
|
Possible errors
HTTP code | Description | message field value | details field value |
400 | Tenant ID is not specified | tenantID required |
|
400 | Attempt to delete an asset from the shared tenant | delete from shared tenant not allowed |
|
400 | None of the mandatory fields is specified | one of fields required | ids, fqdns, ipAddresses |
400 | Invalid FQDN specified | invalid value | fqdns[<index>] |
400 | Invalid IP address specified | invalid value | ipAddresses[<index>] |
403 | The user does not have the required role in the specified tenant | access denied |
|
404 | The specified tenant was not found | tenant not found |
|
406 | The specified tenant was disabled | tenant disabled |
|
500 | Any other internal errors | variable | variable |