PUT Assets/{id}

Purpose

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.

Required permissions

Asset Management (Read/Write).

URL parameters

id: ID of the asset.

Request body

Content-Type: application/json

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

Request body details

  • 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 clears any existing value.
  • AssetType: (required) Asset type. An empty value is accepted and clears any existing value.
  • Description: (optional) Asset description. Only updated if version in the URL is 3.1 or greater. Max string length is 255.
  • OperatingSystem: (required) Asset operating system. An empty value is accepted and clears any existing value.

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

200 - Request successful. Asset in response body.

For more information, please see Common response codes.