Remove Tags from Assets

post /public_api/v1/assets/tags/assets_internet_exposure/remove/

Remove tags in bulk from a set of assets.

Request headers

authorization

String

required

api-key

Example: {{api_key}}

x-xdr-auth-id

String

required

api-key-id

Example: {{api_key_id}}

Body parameters

required

request_dataObject

A dictionary containing the API request fields. An empty dictionary returns all results.

filtersArray

[

fieldString (Enum)

Indicates that the list of assets will be an "asm_id_list".

Allowed values:"name""has_xdr_agent""ip_address""externally_detected_providers""type""has_active_external_services""mac_addresses""externally_inferred_cves""aws_cloud_tags""gcp_cloud_tags""azure_cloud_tags""tags""business_units_list""ipv6_address""has_bu_overrides""asm_id_list"

operatorString (Enum)

Allowed values:"in""contains""neq""eq""not_contains"

valueObject

List of strings, the asset IDs that should be removed from the tag

Free-Form object

]

tagsArray[string]

List of tag names to remove from the assets. These do not need to include the tag family.

Free-Form object

REQUEST BODY

{
  "request_data": {
    "filters": [
      {
        "field": "name",
        "value": "AssignOrRemoveTagsFromAsmAssetsRequestFilter_value",
        "operator": "in"
      },
      {
        "field": "name",
        "value": "AssignOrRemoveTagsFromAsmAssetsRequestFilter_value",
        "operator": "in"
      }
    ],
    "tags": [
      "tags",
      "tags"
    ]
  }
}

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/tags/assets_internet_exposure/remove/'
    

      -d
      '{
  "request_data" : {
    "filters" : [ {
      "field" : "name",
      "value" : "AssignOrRemoveTagsFromAsmAssetsRequestFilter_value",
      "operator" : "in"
    }, {
      "field" : "name",
      "value" : "AssignOrRemoveTagsFromAsmAssetsRequestFilter_value",
      "operator" : "in"
    } ],
    "tags" : [ "tags", "tags" ]
  }
}'
    

  

Responses

Body

replyObjectrequired

remove_tagsString

succeeded if request was successful

Free-Form object

RESPONSE

{
  "reply": {
    "remove_tags": "remove_tags_example"
  }
}

Bad Request. Got an invalid JSON.

Body

replyObject

The query results upon error.

Free-Form object

RESPONSE

{
  "reply": {}
}

Unauthorized access. An issue occurred during authentication. This can indicate an incorrect key, id, or other invalid authentication parameters.

Body

replyObject

The query results upon error.

Free-Form object

RESPONSE

{
  "reply": {}
}

Unauthorized access. User does not have the required license type to run this API.

Body

replyObject

The query results upon error.

Free-Form object

RESPONSE

{
  "reply": {}
}

Forbidden access. The provided API Key does not have the required RBAC permissions to run this API.

Body

replyObject

The query results upon error.

Free-Form object

RESPONSE

{
  "reply": {}
}

Unprocessable Entity

Body

codeInteger

Error code

statusString

Error name

messageString

Error message

errorsObject

Errors

RESPONSE

{
  "code": 0,
  "status": "status_example",
  "message": "message_example",
  "errors": {}
}

Internal server error. A unified status for API communication type errors.

Body

replyObject

The query results upon error.

Free-Form object

RESPONSE

{
  "reply": {}
}