Importing assets
Details on identifying, creating, and updating assets
Assets are imported according to the asset data merging rules.
POST /api/v1/assets/import
Bulk creation or update of assets.
Access: administrator and analyst.
Request body
Format: JSON
|
Request mandatory fields
Name | Data type | Mandatory | Description | Value example |
TenantID | string | Yes | Tenant ID | 00000000-0000-0000-0000-000000000000 |
assets | []Asset | Yes | Array of imported assets |
|
Asset mandatory fields
Name | Data type | Mandatory | Description | Value example |
fqdn | string | If the ipAddresses array is not specified | Asset FQDN. It is recommended that you specify the FQDN and not just the host name. Priority indicator for asset identification. | my-asset-1.example.com my-asset-1 |
ipAddresses | []string | If FQDN is not specified | Array of IP addresses for the asset. IPv4 or IPv6. The first element of the array is used as a secondary indicator for asset identification. | ["192.168.1.1", "192.168.2.2"] ["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 import assets into the shared tenant | import into shared tenant not allowed |
|
400 | Not a single asset was specified in the request body | at least one asset required |
|
400 | None of the mandatory fields is specified | one of fields required | asset[<index>]: fqdn, ipAddresses |
400 | Invalid FQDN | invalid value | asset[<index>].fqdn |
400 | Invalid IP address | invalid value | asset[<index>].ipAddresses[<index>] |
400 | IP address is repeated | duplicated value | asset[<index>].ipAddresses |
400 | Invalid MAC address | invalid value | asset[<index>].macAddresses[<index>] |
400 | MAC address is repeated | duplicated value | asset[<index>].macAddresses |
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 |