Tag Management
APIs for managing tags
Add tags in bulk to a set of assets.
api-key
{{api_key}}api-key-id
{{api_key_id}}OK
Bad Request. Got an invalid JSON.
Unauthorized access. An issue occurred during authentication. This can indicate an incorrect key, id, or other invalid authentication parameters.
Unauthorized access. User does not have the required license type to run this API.
Forbidden access. The provided API Key does not have the required RBAC permissions to run this API.
Unprocessable Entity
Internal server error. A unified status for API communication type errors.
POST /public_api/v1/assets/tags/assets_internet_exposure/assign/ HTTP/1.1
Host: api-{{fqdn}}
authorization: {{api_key}}
x-xdr-auth-id: {{api_key_id}}
Content-Type: application/json
Accept: */*
Content-Length: 131
{
"request_data": {
"filters": [
{
"field": "name",
"operator": "in",
"value": "text"
}
],
"tags": [
"text"
]
},
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"reply": {
"assign_tags": "text",
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"ANY_ADDITIONAL_PROPERTY": "anything"
}Add tags in bulk to owned IP ranges.
api-key
{{api_key}}api-key-id
{{api_key_id}}OK
Bad Request. Got an invalid JSON.
Unauthorized access. An issue occurred during authentication. This can indicate an incorrect key, id, or other invalid authentication parameters.
Unauthorized access. User does not have the required license type to run this API.
Forbidden access. The provided API Key does not have the required RBAC permissions to run this API.
Unprocessable Entity
Internal server error. A unified status for API communication type errors.
POST /public_api/v1/assets/tags/external_ip_address_ranges/assign/ HTTP/1.1
Host: api-{{fqdn}}
authorization: {{api_key}}
x-xdr-auth-id: {{api_key_id}}
Content-Type: application/json
Accept: */*
Content-Length: 221
{
"request_data": {
"filters": [
{
"field": "organization_handles",
"operator": "in",
"value": "text",
"ANY_ADDITIONAL_PROPERTY": "anything"
}
],
"tags": [
"text"
],
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"reply": {
"assign_tags": "text",
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"ANY_ADDITIONAL_PROPERTY": "anything"
}Create tag rules that apply tags automatically to assets that match your rule criteria, including any new assets that are attributed to your organization. Tag rules can be defined for IPv4 addresses and IPv4 ranges. These fields can be the same to denote a single IP address. If the list of IP addresses exceeds 100, Expander will create multiple tag rules, each with at most 100 IP addresses per rule. Required License: Cortex Xpanse Expander
api-key
{{api_key}}api-key-id
{{api_key_id}}OK
Bad Request. Got an invalid JSON.
Unauthorized access. An issue occurred during authentication. This can indicate an incorrect key, id, or other invalid authentication parameters.
Unauthorized access. User does not have the required license type to run this API.
Forbidden access. The provided API Key does not have the required RBAC permissions to run this API.
Unprocessable Entity
Internal server error. A unified status for API communication type errors.
POST /public_api/v1/assets/create_asset_tag_rules/ HTTP/1.1
Host: api-{{fqdn}}
authorization: {{api_key}}
x-xdr-auth-id: {{api_key_id}}
Content-Type: application/json
Accept: */*
Content-Length: 235
{
"request_data": {
"ip_ranges": [
{
"from_ip": "text",
"to_ip": "text",
"ANY_ADDITIONAL_PROPERTY": "anything"
}
],
"rule_name": "text",
"description": "text",
"tag_name": "text",
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"reply": "text",
"ANY_ADDITIONAL_PROPERTY": "anything"
}Remove tags in bulk from a set of assets.
api-key
{{api_key}}api-key-id
{{api_key_id}}OK
Bad Request. Got an invalid JSON.
Unauthorized access. An issue occurred during authentication. This can indicate an incorrect key, id, or other invalid authentication parameters.
Unauthorized access. User does not have the required license type to run this API.
Forbidden access. The provided API Key does not have the required RBAC permissions to run this API.
Unprocessable Entity
Internal server error. A unified status for API communication type errors.
POST /public_api/v1/assets/tags/assets_internet_exposure/remove/ HTTP/1.1
Host: api-{{fqdn}}
authorization: {{api_key}}
x-xdr-auth-id: {{api_key_id}}
Content-Type: application/json
Accept: */*
Content-Length: 131
{
"request_data": {
"filters": [
{
"field": "name",
"operator": "in",
"value": "text"
}
],
"tags": [
"text"
]
},
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"reply": {
"remove_tags": "text",
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"ANY_ADDITIONAL_PROPERTY": "anything"
}Remove tags in bulk from a set of IP address ranges.
api-key
{{api_key}}api-key-id
{{api_key_id}}OK
Bad Request. Got an invalid JSON.
Unauthorized access. An issue occurred during authentication. This can indicate an incorrect key, id, or other invalid authentication parameters.
Unauthorized access. User does not have the required license type to run this API.
Forbidden access. The provided API Key does not have the required RBAC permissions to run this API.
Unprocessable Entity
Internal server error. A unified status for API communication type errors.
POST /public_api/v1/assets/tags/external_ip_address_ranges/remove/ HTTP/1.1
Host: api-{{fqdn}}
authorization: {{api_key}}
x-xdr-auth-id: {{api_key_id}}
Content-Type: application/json
Accept: */*
Content-Length: 221
{
"request_data": {
"filters": [
{
"field": "organization_handles",
"operator": "in",
"value": "text",
"ANY_ADDITIONAL_PROPERTY": "anything"
}
],
"tags": [
"text"
],
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"reply": {
"remove_tags": "text",
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"ANY_ADDITIONAL_PROPERTY": "anything"
}Delete unused tags by specifying tag IDs or tag names. You don't have to provide both tag_ids and tag_names, but you can use both to specify different tags.
api-key
{{api-key}}api-key-id
{{api-key-id}}OK
Bad Request. Got an invalid JSON.
Unauthorized access. An issue occurred during authentication. This can indicate an incorrect key, id, or other invalid authentication parameters.
Unauthorized access. User does not have the required license type to run this API.
Forbidden access. The provided API Key does not have the required RBAC permissions to run this API.
Unprocessable Entity
Internal server error. A unified status for API communication type errors.
POST /public_api/v1/assets/delete_unused_tag/ HTTP/1.1
Host: api-{{fqdn}}
authorization: {{api-key}}
x-xdr-auth-id: {{api-key-id}}
Content-Type: application/json
Accept: */*
Content-Length: 93
{
"request_data": {
"tag_family": "ip_ranges",
"tag_ids": [
"IPR:abcd12345"
],
"tag_names": [
"tag-1"
]
}
}{
"reply": "succeeded"
}Last updated
Was this helpful?