Delete Unused Tags

post /public_api/v1/assets/delete_unused_tag/

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.

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

request_dataObject

A dictionary containing the API request fields.

An empty dictionary returns all results.

tag_familyObject (Enum)

Allowed values:"assets""ip_ranges"

tag_idsArray[string]

IDs of tags to be deleted.

tag_namesArray[string]

Names of tags to be deleted.

REQUEST BODY


    {"request_data":{"tag_family":"ip_ranges","tag_ids":["IPR:abcd12345"],"tag_names":["tag-1"]}}

CLIENT REQUEST

          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/delete_unused_tag/'
    
      -d
      ''

import http.client

conn = http.client.HTTPSConnection("api-")

payload = "{\"request_data\":{\"tag_family\":\"assets\",\"tag_ids\":[\"string\"],\"tag_names\":[\"string\"]}}"

headers = {
    'authorization': "{{api-key}}",
    'x-xdr-auth-id': "{{api-key-id}}",
    'content-type': "application/json"
    }

conn.request("POST", "%7B%7Bfqdn%7D%7D/public_api/v1/assets/delete_unused_tag/", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

require 'uri'
require 'net/http'
require 'openssl'

url = URI("https://api-/%7B%7Bfqdn%7D%7D/public_api/v1/assets/delete_unused_tag/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE

request = Net::HTTP::Post.new(url)
request["authorization"] = '{{api-key}}'
request["x-xdr-auth-id"] = '{{api-key-id}}'
request["content-type"] = 'application/json'
request.body = "{\"request_data\":{\"tag_family\":\"assets\",\"tag_ids\":[\"string\"],\"tag_names\":[\"string\"]}}"

response = http.request(request)
puts response.read_body

const data = JSON.stringify({
  "request_data": {
    "tag_family": "assets",
    "tag_ids": [
      "string"
    ],
    "tag_names": [
      "string"
    ]
  }
});

const xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api-/%7B%7Bfqdn%7D%7D/public_api/v1/assets/delete_unused_tag/");
xhr.setRequestHeader("authorization", "{{api-key}}");
xhr.setRequestHeader("x-xdr-auth-id", "{{api-key-id}}");
xhr.setRequestHeader("content-type", "application/json");

xhr.send(data);

HttpResponse<String> response = Unirest.post("https://api-/%7B%7Bfqdn%7D%7D/public_api/v1/assets/delete_unused_tag/")
  .header("authorization", "{{api-key}}")
  .header("x-xdr-auth-id", "{{api-key-id}}")
  .header("content-type", "application/json")
  .body("{\"request_data\":{\"tag_family\":\"assets\",\"tag_ids\":[\"string\"],\"tag_names\":[\"string\"]}}")
  .asString();

import Foundation

let headers = [
  "authorization": "{{api-key}}",
  "x-xdr-auth-id": "{{api-key-id}}",
  "content-type": "application/json"
]
let parameters = ["request_data": [
    "tag_family": "assets",
    "tag_ids": ["string"],
    "tag_names": ["string"]
  ]] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api-/%7B%7Bfqdn%7D%7D/public_api/v1/assets/delete_unused_tag/")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api-/%7B%7Bfqdn%7D%7D/public_api/v1/assets/delete_unused_tag/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "{\"request_data\":{\"tag_family\":\"assets\",\"tag_ids\":[\"string\"],\"tag_names\":[\"string\"]}}",
  CURLOPT_HTTPHEADER => [
    "authorization: {{api-key}}",
    "content-type: application/json",
    "x-xdr-auth-id: {{api-key-id}}"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

CURL *hnd = curl_easy_init();

curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "https://api-/%7B%7Bfqdn%7D%7D/public_api/v1/assets/delete_unused_tag/");

struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "authorization: {{api-key}}");
headers = curl_slist_append(headers, "x-xdr-auth-id: {{api-key-id}}");
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\"request_data\":{\"tag_family\":\"assets\",\"tag_ids\":[\"string\"],\"tag_names\":[\"string\"]}}");

CURLcode ret = curl_easy_perform(hnd);

var client = new RestClient("https://api-/%7B%7Bfqdn%7D%7D/public_api/v1/assets/delete_unused_tag/");
var request = new RestRequest(Method.POST);
request.AddHeader("authorization", "{{api-key}}");
request.AddHeader("x-xdr-auth-id", "{{api-key-id}}");
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\"request_data\":{\"tag_family\":\"assets\",\"tag_ids\":[\"string\"],\"tag_names\":[\"string\"]}}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

Responses

Body

replyString

RESPONSE

{
  "reply": "succeeded"
}

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": {}
}