Assets

Quick Navigation

For more information on related topics, please see:

GET Assets/{id}

Returns an Asset by ID.

Asset Management (Read)

id: ID of the asset.

None

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
}

200 - Request successful. Asset in response body.

For more information, please see Common Response Codes.

GET Workgroups/{workgroupID}/Assets

Returns a list of Assets by Workgroup ID.

Asset Management (Read)

workgroupID: ID of the Workgroup.

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

None

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
    },
    …
]

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
        },
        …
    ]
}

200 - Request successful. Assets in response body.

For more information, please see Common Response Codes.

GET Workgroups/{workgroupName}/Assets

Returns a list of Assets by Work Group Name.

Asset Management (Read)

workgroupName: Name of the Workgroup.

  • 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).

None

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
    },
    …
]

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
        },
        …
    ]
}

200 - Request successful. Assets in response body.

For more information, please see Common Response Codes.

GET Workgroups/{workgroupName}/Assets?name={name}

Returns an Asset by Workgroup Name and Asset Name.

Asset Management (Read)

workgroupName: Name of the workgroup.

name: Name of the asset.

None

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
}

200 - Request successful. Asset in response body.

For more information, please see Common Response Codes.

POST Workgroups/{workgroupID}/Assets

Creates a new asset in the workgroup, referenced by ID.

Asset Management (Read/Write)

workgroupID: ID of the workgroup.

Content-Type: application/json

{
    IPAddress: string,
    AssetName: string,
    DnsName: string,
    DomainName: string,
    MacAddress: string,
    AssetType: string,
    OperatingSystem: string
}
  • IPAddress: (required) Asset IP address. Max string length is 45.
  • AssetName: (optional) Asset name. If not given, a padded IPAddress is used. Max string length is 128.
  • DnsName: (optional) Asset DNS name. Max string length is 255.
  • DomainName: (optional) Asset domain name. Max string length is 64.
  • MacAddress: (optional) Asset MAC address. Max string length is 128.
  • AssetType: (optional) Asset type. Max string length is 64.
  • OperatingSystem: (optional) Asset operating system. Max string length is 255.

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
}

201 - Request successful. Asset in response body.

For more information, please see Common Response Codes.

POST Workgroups/{workgroupName}/Assets

Creates a new asset in the workgroup referenced by name.

Asset Management (Read/Write)

workgroupName: Name of the Workgroup.

Content-Type: application/json

{
    IPAddress: string,
    AssetName: string,
    DnsName: string,
    DomainName: string,
    MacAddress: string,
    AssetType: string,
    OperatingSystem: string
}
  • IPAddress: (required) Asset IP address. Max string length is 45.
  • AssetName: (optional) Asset name. If not given, a padded IPAddress is used. Max string length is 128.
  • DnsName: (optional) Asset DNS name. Max string length is 255.
  • DomainName: (optional) Asset domain name. Max string length is 64.
  • MacAddress: (optional) Asset MAC address. Max string length is 128.
  • AssetType: (optional) Asset type. Max string length is 64.
  • OperatingSystem: (optional) Asset operating system. Max string length is 255.

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
}

201 - Request successful. Asset in response body.

For more information, please see Common Response Codes.

PUT Assets/{id}

Updates an existing asset by ID.

Call GET Assets/{id} (or equivalent) first to get the current state of the Asset before calling PUT Assets/{id} to update it with new values.

Asset Management (Read/Write)

id: ID of the asset.

Content-Type: application/json

{
    WorkgroupID: int,
    AssetName: string,
    DnsName: string,
    DomainName: string,
    IPAddress: string,
    MacAddress: string,
    AssetType: string,
    OperatingSystem: string,
}
  • WorkgroupID: (required) ID of the Workgroup to which the asset belongs.
  • AssetName: (required) Asset name.
  • DnsName: (required) Asset DNS name.
  • DomainName: (required) Asset domain name.
  • IPAddress: (required) Asset IP address.
  • MacAddress: (required) Asset MAC address. An empty value is accepted and will clear any existing value.
  • AssetType: (required) Asset type. An empty value is accepted and will clear any existing value.
  • OperatingSystem: (required) Asset operating system. An empty value is accepted and will clear any existing value.

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
}

200 - Request successful. Asset in response body.

For more information, please see Common Response Codes.

POST Assets/Search

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

Asset Management (Read)

  • 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).

Content-Type: application/json

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

At least one request body property should be provided; any property not provided will be 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).

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
    },
    …
]

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
        },
        …
    ]
}

200 - Request successful. Assets in response body.

For more information, please see Common Response Codes.

DELETE Assets/{id}

Deletes an Asset by ID.

Asset Management (Read/Write)

id: ID of the asset.

None

None

200 - Request successful.

For more information, please see Common Response Codes.

DELETE Workgroups/{workgroupName}/Assets?name={name}

Deletes an Asset by Workgroup Name and Asset Name.

Asset Management (Read/Write)

workgroupName: Name of the Workgroup.

name: Name of the asset.

None

None

200 - Request successful.

For more information, please see Common Response Codes.

Smart Rule Assets

GET SmartRules/{id}/Assets

Returns a list of Assets by Smart Rule ID.

Read access to the Smart Rule referenced by ID.

id: ID of the Smart Rule.

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

None

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
    },
    …
]

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
        },
        …
    ]
}

200 - Request successful. Assets in response body.

For more information, please see Common Response Codes.