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.
Required License: Cortex Xpanse Expander
authorization
String
required
{{api_key}}
x-xdr-auth-id
String
required
{{api_key_id}}
request_dataObject
A dictionary containing the API request fields.
assetsArray
List of dictionaries that refer to assets.
entity_idString
entity_typeString (Enum)
Values are asset or ip_range.
annotationString
Annotation text.
should_appendBoolean
True append the annotation to the existing annotation.
False replaces the existing annotation.
The default is true.
{
"request_data": {
"assets": [
{
"annotation": "annotation",
"entity_type": "asset",
"entity_id": "entity_id"
},
{
"annotation": "annotation",
"entity_type": "asset",
"entity_id": "entity_id"
}
],
"should_append": true
}
}
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
}
}'
OK
replyString
Reply indicates succeeded if the annotation was updated.
{
"reply": "reply_example"
}Bad Request. Got an invalid JSON.
replyObject
The query results upon error.
{
"reply": {}
}Unauthorized access. An issue occurred during authentication. This can indicate an incorrect key, id, or other invalid authentication parameters.
replyObject
The query results upon error.
{
"reply": {}
}Unauthorized access. User does not have the required license type to run this API.
replyObject
The query results upon error.
{
"reply": {}
}Forbidden access. The provided API Key does not have the required RBAC permissions to run this API.
replyObject
The query results upon error.
{
"reply": {}
}Unprocessable Entity
codeInteger
Error code
statusString
Error name
messageString
Error message
errorsObject
Errors
{
"code": 0,
"status": "status_example",
"message": "message_example",
"errors": {}
}Internal server error. A unified status for API communication type errors.
replyObject
The query results upon error.
{
"reply": {}
}