Update Asset Annotation

Cortex Xpanse REST API

post /public_api/v1/assets/assets_internet_exposure/annotation/

Required License: **Cortex Xpanse Expander**

Adds an annotation (also called a note) to an asset or IP range. If an asset or IP range has an existing annotation, you can append a new annotation to the existing annotation or replace the existing annotation with a new one.

CURL
curl -X POST \ \ -H "Accept: application/json" \ -H "Content-Type: application/json" -H "authorization: authorization_example" -H "x-xdr-auth-id: xXdrAuthId_example" \ "https://api-yourfqdn/public_api/v1/assets/assets_internet_exposure/annotation/" \ -d '{ "request_data" : { "assets" : [ { "annotation" : "annotation", "entity_type" : "asset", "entity_id" : "entity_id" }, { "annotation" : "annotation", "entity_type" : "asset", "entity_id" : "entity_id" } ], "should_append" : true } }'
Authentication: api_key Api Key "apiKey"
Request headers
authorization
required
String
api-key
Example: authorization_example
x-xdr-auth-id
required
String
api-key-id
Example: xXdrAuthId_example
Request
Body
optional
request_data
required
A dictionary containing the API request fields.
assets
required
Array
List of dictionaries that refer to assets.
entity_id
optional
String
<asm_asset_id>
entity_type
optional
String (Enum)
Values are asset or ip_range.
Allowed values:
asset
ip_range
annotation
optional
String
Annotation text.
should_append
optional
Boolean
True append the annotation to the existing annotation. False replaces the existing annotation.
The default is true.
Responses

OK

Body
reply
optional
String
Reply indicates succeeded if the annotation was updated.