v15

latestOpenAPI 3.1.02026-07-1295183803.5 KB
Tracking_Asset

Update an Asset

put/skynet/asset/{id}

Path parameters

idstring required

ID of the asset to be updated. This is the same ID that was generated/provided at the time of creating the asset.

Query parameters

keystring 32 character alphanumeric string required
Example:key=API_KEY

A key is a unique identifier that is required to authenticate a request to the API.

Request body

descriptionstring

Use this param to update the description of an asset.

meta_dataMetaData

Any valid json object data. Can be used to save customized data. Max size is 65kb.

namestring

Use this param to update the name of an asset. Users can assign meaningful custom names to their assets.

tagsstring[]

This parameter will be deprecated soon! Please use the attributes parameter to add labels or markers for the asset.

Use this param to update the tags of an asset. tags can be used to filter asset in Get Asset List, Search and Monitor queries.

attributesobject

Use this param to update the attributes of an asset in key:value format. Users can maintain any useful information or context about the assets by utilising this parameter.

Please be careful when using this parameter while updating an asset as the new attributes object provided will completely overwrite the old attributes object. Use the Update Asset Attributes method to add new or modify existing attributes.

Another point to note is that the overall size of the attributes object cannot exceed 65kb and the maximum number of key:value pairs that can be added to this object is 100.

Response

OK

messagestring

Displays the error message in case of a failed request. If the request is successful, this field is not present in the response.

statusstring

A string indicating the state of the response. On successful responses, the value will be Ok. Indicative error messages are returned for different errors. See the API Error Codes section below for more information.