Remove Tags
Remove tags from your endpoints.
Synopsis
URI | public_api/v1/tags/agents/remove |
HTTP Method | POST |
Required License | Cortex XDR Prevent,
Cortex XDR Pro per Endpoint, or Cortex XDR Pro per TB |
Description
Remove one or more tags from
one or more endpoints.
Request Fields
The body of this request
contains a JSON object with the following fields:
Field | Description |
|---|---|
context | ( Required ) A dictionary containing
the tenant ID. |
lcaas_id | The tenant ID of the endpoint(s) for which
you want to remove the tag. |
request_data | ( Required ) A dictionary containing
the following API request fields. |
filters | Provides an array of filtered fields. Each
JSON object must contain the following keyword:
|
tag | The tag name(s) you want to remove. |
Request Example
curl -X POST https://api-{fqdn}/public_api/v1/tags/agents/remove/ \ -H "x-xdr-auth-id:{API_KEY_ID}" \ -H "Authorization:{API_KEY}" \ -H "Content-Type:application/json" \ -d '{ "context": { "lcaas_id": "<tenant_id>" }, "request_data":{ "filters":[ {"field":"endpoint_id_list", "operator":"in", "value":[ "<distribution_id" ] } ], "tag": "<tag_name>" } }'
Success Response
Upon success,
the HTTP response code is 200 and the API returns a reply of true.
Field | Description |
|---|---|
true | The tag name removed successfully. |
Error Response
Upon error,
the reply includes an HTTP response code, an error message, and additional
information describing the error. The HTTP response code is one
of the following:
Field | Description |
|---|---|
400 | Bad Request. Got an invalid JSON. |
401 | Unauthorized access. An issue occurred during authentication.
This can indicate an incorrect key, id, or other invalid authentication
parameters. |
402 | Unauthorized access. User does not have the
required license type to run this API. |
403 | Forbidden access. The provided API Key does
not have the required RBAC permissions to run this API. |
500 | Internal server error. A unified status for
API communication type errors. For example, test@test.com is not a valid Cortex XDR email address. |
Error Response Format
{"reply": {"err_code": STATUS_CODE, "err_msg": GENERAL_MESSAGE, "err_extra": EXTRA_DATA}}
Most Popular
Recommended For You
Recommended Videos
Recommended videos not found.
