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: {{api_key}}" -H "x-xdr-auth-id: {{api_key_id}}" \
"https://api-}/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
}
}'
Request headers
authorization
required
String
api-key
Example:
{{api_key}}
x-xdr-auth-id
required
String
api-key-id
Example:
{{api_key_id}}
Request
Body
required
request_data
required
Object
A dictionary containing the API request fields.
assets
optional
Array
of objects
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