DocumentationAPI ReferenceRelease Notes
API Reference

Update asset

Updates an existing asset by ID.

Required Permission(s)

  • Asset Management (Full control)

Notes

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

Request body

  • AssetName, DnsName, DomainName and IPAddress are all required, and IPAddress must be a valid IP address. Omitting any of them fails with 400
  • AssetName has no fallback on update. The padded-IP default described on that property applies when creating an Asset, not when updating one
  • WorkgroupID is required, and it is applied - supplying a different Workgroup moves the Asset to it. It must be a Workgroup you have access to, otherwise the request fails with 404
  • Description is only applied from version 3.1. On version 3.0 it is ignored without error

API Versions

  • Version 3.1 - Adds Description
  • Version 3.0 - Base properties
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
int32
required

The unique identifier of the asset to update

Query Params
string
Defaults to 3.0

API version for asset model compatibility

Body Params

Updated asset configuration including modified properties

string | null

Asset name. If not given, a padded IP address is used

string | null

Asset type

string | null

Asset description. Only updated if version in the URL is 3.1 or greater

This property is ignored in Search requests

string | null

Asset DNS name

string | null

Asset domain name

string | null

Asset IP address

string | null

Asset operating system

This property is ignored in Search requests

int32
Headers
string
enum
Defaults to application/*+json

Generated from available request content types

Allowed:
Responses

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

©2003-2026 BeyondTrust Corporation. All Rights Reserved. Other trademarks identified on this page are owned by their respective owners. BeyondTrust is not a chartered bank or trust company, or depository institution. It is not authorized to accept deposits or trust accounts and is not licensed or regulated by any state or federal banking authority.