POST Workgroups/{workgroupName}/Assets

Purpose

Creates a new asset in the Workgroup referenced by name.

Required permissions

Asset Management (Read/Write).

URL parameters

workgroupName: Name of the Workgroup.

Request body

Content-Type: application/json

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

Request body details

  • IPAddress: (required) Asset IP address. Max string length is 45.
  • AssetName: (optional) Asset name. If not given, a padded IP address 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.
  • Description: (optional) Asset description. Only updated if version in the URL is 3.1 or greater. Max string length is 255.
  • OperatingSystem: (optional) Asset operating system. Max string length is 255.

Response body

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 codes

201 - Request successful. Asset in response body.

For more information, please see Common response codes.