POST Assets/Search

Purpose

Returns a list of assets that match the given search criteria.

Required Permissions

Asset Management (Read).

Query Parameters (Optional)

• limit: (default: 100000) Number of records to return.
• offset: (default: 0) Number of records to skip before returning <limit> records (can only be used in conjunction with limit).

Request Body

Content-Type: application/json

{
    AssetName: string,
    DnsName: string,
    DomainName: string,
    IPAddress: string,
    MacAddress: string,
    AssetType: string,
}

Request Body Details

At least one request body property should be provided; any property not provided is ignored. All search criteria is case insensitive and is an exact match (equality), except for IPAddress.

IPAddress can be a single IP address (10.0.0.1), a comma-delimited list of IPs (10.0.0.1,10.0.0.2,10.0.0.3), an IP range (10.0.0.1-10.0.0.25), or CIDR notation (10.0.0.0/24).

Response Body (when limit is not given)

Content-Type: application/json

[
    {
        WorkgroupID: int,
        AssetID: int,
        AssetName: string,
        DnsName: string,
        DomainName: string,
        IPAddress: string,
        MacAddress: string,
        AssetType: string,
        OperatingSystem: string,
        CreateDate: datetime,
        LastUpdateDate: datetime
    },
    …
]

Response Body (when limit is given)

Content-Type: application/json

{
    TotalCount : int,
    Data :
    [
        {
            WorkgroupID: int,
            AssetID: int,
            AssetName: string,
            DnsName: string,
            DomainName: string,
            IPAddress: string,
            MacAddress: string,
            AssetType: string,
            OperatingSystem: string,
            CreateDate: datetime,
            LastUpdateDate: datetime
        },
        …
    ]
}

Response Codes

200 - Request successful. Assets in response body.

For more information, please see Common Response Codes.