Retrieve endpoint administration cleanup settings

post /public_api/v1/configurations/agent/endpoint_administration_cleanup

Returns the current endpoint administration cleanup configuration, including whether periodic duplicate cleanup is enabled, the matching criteria used to identify duplicates (hostname, IP address, MAC address), and the cleanup frequency. Periodic duplicate cleanup removes redundant endpoint entries from the endpoint administration table, retaining only the most recent record for each endpoint. This is useful when endpoints re-register after hardware changes, preventing stale or conflicting records in the management console.

Authentication: api-key-header-x-xdr-auth-id Api Key "x-xdr-auth-id"

Authentication: api-key-header-authorization Api Key "Authorization"

CLIENT REQUEST

          curl -X 'POST'

         -H "x-xdr-auth-id: [[apiKey]]"
        
         \
      
         -H "Authorization: [[apiKey]]"
        
         \
      
        -H
        'Accept: application/json'
      
      'https://api-yourfqdn/public_api/v1/configurations/agent/endpoint_administration_cleanup'

import http.client

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

headers = { 'x-xdr-auth-id': "REPLACE_KEY_VALUE" }

conn.request("POST", "/public_api/v1/configurations/agent/endpoint_administration_cleanup", headers=headers)

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

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

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

url = URI("https://api-yourfqdn/public_api/v1/configurations/agent/endpoint_administration_cleanup")

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["x-xdr-auth-id"] = 'REPLACE_KEY_VALUE'

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

const data = null;

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-yourfqdn/public_api/v1/configurations/agent/endpoint_administration_cleanup");
xhr.setRequestHeader("x-xdr-auth-id", "REPLACE_KEY_VALUE");

xhr.send(data);

HttpResponse<String> response = Unirest.post("https://api-yourfqdn/public_api/v1/configurations/agent/endpoint_administration_cleanup")
  .header("x-xdr-auth-id", "REPLACE_KEY_VALUE")
  .asString();

import Foundation

let headers = ["x-xdr-auth-id": "REPLACE_KEY_VALUE"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api-yourfqdn/public_api/v1/configurations/agent/endpoint_administration_cleanup")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers

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-yourfqdn/public_api/v1/configurations/agent/endpoint_administration_cleanup",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "x-xdr-auth-id: REPLACE_KEY_VALUE"
  ],
]);

$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-yourfqdn/public_api/v1/configurations/agent/endpoint_administration_cleanup");

struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "x-xdr-auth-id: REPLACE_KEY_VALUE");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

CURLcode ret = curl_easy_perform(hnd);

var client = new RestClient("https://api-yourfqdn/public_api/v1/configurations/agent/endpoint_administration_cleanup");
var request = new RestRequest(Method.POST);
request.AddHeader("x-xdr-auth-id", "REPLACE_KEY_VALUE");
IRestResponse response = client.Execute(request);

Responses

Successful response containing the current cleanup configuration.

Body

application/json

Current endpoint administration cleanup configuration.

replyobject

periodic_duplicate_cleanupboolean

Indicates whether periodic cleanup of duplicate endpoints is currently enabled.

Example:true

host_nameboolean

Indicates whether hostname is currently used as a criterion for identifying duplicate endpoints. Null when periodic cleanup is disabled.

Example:true

ipboolean

Indicates whether IP address is currently used as a criterion for identifying duplicate endpoints. Null when periodic cleanup is disabled.

Example:true

macboolean

Indicates whether MAC address is currently used as a criterion for identifying duplicate endpoints. Null when periodic cleanup is disabled.

time_interval_hoursinteger (Enum)

The current time interval in hours between cleanup runs. Null when periodic cleanup is disabled. Valid values: 1 (hourly), 6 (every 6 hours), 24 (daily), 168 (weekly).

Example:24

Allowed values:1624168

RESPONSE
{
  "reply": {
    "periodic_duplicate_cleanup": true,
    "host_name": true,
    "ip": true,
    "mac": false,
    "time_interval_hours": 24
  }
}

Bad request. The request was malformed or contained invalid parameters.

Body

application/json

Standard error response returned when a request fails.

replyobject

Error details container.

err_codeinteger

Numeric error code identifying the type of error.

err_msgstring

Human-readable error message describing what went wrong.

err_extrastring

Additional context about the error, if available.

RESPONSEbadrequest
{
  "reply": {
    "err_code": 400,
    "err_msg": "Bad request. Got an invalid JSON.",
    "err_extra": "Additional error context"
  }
}

Unauthorized. Authentication credentials are missing or invalid.

Body

application/json

Standard error response returned when a request fails.

replyobject

Error details container.

err_codeinteger

Numeric error code identifying the type of error.

err_msgstring

Human-readable error message describing what went wrong.

err_extrastring

Additional context about the error, if available.

RESPONSEunauthorized
{
  "reply": {
    "err_code": 401,
    "err_msg": "Public API request unauthorized",
    "err_extra": "Additional error context"
  }
}

Forbidden. The API key does not have the required permissions.

Body

application/json

Standard error response returned when a request fails.

replyobject

Error details container.

err_codeinteger

Numeric error code identifying the type of error.

err_msgstring

Human-readable error message describing what went wrong.

err_extrastring

Additional context about the error, if available.

RESPONSEforbidden
{
  "reply": {
    "err_code": 403,
    "err_msg": "Forbidden. Access was denied to this resource.",
    "err_extra": "Insufficient permissions for api key"
  }
}

Internal server error.

Body

application/json

Standard error response returned when a request fails.

replyobject

Error details container.

err_codeinteger

Numeric error code identifying the type of error.

err_msgstring

Human-readable error message describing what went wrong.

err_extrastring

Additional context about the error, if available.

RESPONSEInternalServerError
{
  "reply": {
    "err_code": 500,
    "err_msg": "Internal server error",
    "err_extra": "Additional error context"
  }
}