Get control failed results

post /public_api/v1/compliance/get_control_failed_results

Get the failed findings and issues for a specific compliance control.

Required license: Cortex Cloud Runtime Security or Cortex Cloud Posture Management

Authentication: XDRAuthToken Api Key "Authorization"

Authentication: XDRAuth Api Key "x-xdr-auth-id"

CLIENT REQUEST

          curl -X 'POST'

         -H "Authorization: [[apiKey]]"
        
         \
      
         -H "x-xdr-auth-id: [[apiKey]]"
        
         \
      
        -H
        'Accept: application/json'
      
        -H
        'Content-Type: application/json'
      
      'https://api-yourfqdn/public_api/v1/compliance/get_control_failed_results'
    
      -d
      ''

import http.client

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

payload = "{\"request_data\":{\"control_revision\":\"string\",\"assessment_profile_revision\":\"string\",\"last_evaluation_time\":0}}"

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

conn.request("POST", "/public_api/v1/compliance/get_control_failed_results", payload, 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/compliance/get_control_failed_results")

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'
request["content-type"] = 'application/json'
request.body = "{\"request_data\":{\"control_revision\":\"string\",\"assessment_profile_revision\":\"string\",\"last_evaluation_time\":0}}"

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

const data = JSON.stringify({
  "request_data": {
    "control_revision": "string",
    "assessment_profile_revision": "string",
    "last_evaluation_time": 0
  }
});

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/compliance/get_control_failed_results");
xhr.setRequestHeader("x-xdr-auth-id", "REPLACE_KEY_VALUE");
xhr.setRequestHeader("content-type", "application/json");

xhr.send(data);

HttpResponse<String> response = Unirest.post("https://api-yourfqdn/public_api/v1/compliance/get_control_failed_results")
  .header("x-xdr-auth-id", "REPLACE_KEY_VALUE")
  .header("content-type", "application/json")
  .body("{\"request_data\":{\"control_revision\":\"string\",\"assessment_profile_revision\":\"string\",\"last_evaluation_time\":0}}")
  .asString();

import Foundation

let headers = [
  "x-xdr-auth-id": "REPLACE_KEY_VALUE",
  "content-type": "application/json"
]
let parameters = ["request_data": [
    "control_revision": "string",
    "assessment_profile_revision": "string",
    "last_evaluation_time": 0
  ]] as [String : Any]

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

let request = NSMutableURLRequest(url: NSURL(string: "https://api-yourfqdn/public_api/v1/compliance/get_control_failed_results")! 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-yourfqdn/public_api/v1/compliance/get_control_failed_results",
  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\":{\"control_revision\":\"string\",\"assessment_profile_revision\":\"string\",\"last_evaluation_time\":0}}",
  CURLOPT_HTTPHEADER => [
    "content-type: application/json",
    "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/compliance/get_control_failed_results");

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

curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\"request_data\":{\"control_revision\":\"string\",\"assessment_profile_revision\":\"string\",\"last_evaluation_time\":0}}");

CURLcode ret = curl_easy_perform(hnd);

var client = new RestClient("https://api-yourfqdn/public_api/v1/compliance/get_control_failed_results");
var request = new RestRequest(Method.POST);
request.AddHeader("x-xdr-auth-id", "REPLACE_KEY_VALUE");
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\"request_data\":{\"control_revision\":\"string\",\"assessment_profile_revision\":\"string\",\"last_evaluation_time\":0}}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

Body parameters

required

application/json

request_dataobject

control_revisionstringrequired

Compliance control revision ID

assessment_profile_revisionstringrequired

Assessment profile revision ID

last_evaluation_timeintegerrequiredint64

Last evaluation timestamp (epoch time in milliseconds)

REQUEST
{
  "request_data": {
    "control_revision": "example",
    "assessment_profile_revision": "example",
    "last_evaluation_time": 0
  }
}

Responses

Successfully retrieved failed results

Body

application/json

replyobject

dataobject

findingsarray

[

idsarray[string]

]

issuesarray

[

namestring

Severity name

pretty_namestring

valueinteger

The number of issues with this level of severity

idsarray[string]

List of issue IDs with this level of severity

]

RESPONSEExample 1
{
  "reply": {
    "data": {
      "findings": {
        "ids": [
          "45667890n85678908765456789bkk"
        ],
        "value": 1
      },
      "issues": [
        {
          "name": "SEV_020_LOW",
          "pretty_name": "Low",
          "value": 0,
          "ids": []
        },
        {
          "name": "SEV_030_MEDIUM",
          "pretty_name": "Medium",
          "value": 0,
          "ids": []
        },
        {
          "name": "SEV_040_HIGH",
          "pretty_name": "High",
          "value": 1,
          "ids": [
            "4537893ijnmskiu2y6t5rxt7y789ok"
          ]
        },
        {
          "name": "SEV_050_CRITICAL",
          "pretty_name": "Critical",
          "value": 0,
          "ids": []
        }
      ]
    }
  }
}

Bad request - invalid input parameters

Body

application/json

replyobject

err_codeinteger

Error code

err_msgstring

Error message

err_extraobject

Additional error details

RESPONSE

{
  "reply": {
    "err_code": 400,
    "err_msg": "Invalid filter field. Allowed fields: name, category, subcategory, is_custom, creation_time, created_by, modified_by, modification_time, id, description",
    "err_extra": {}
  }
}

{
  "reply": {
    "err_code": 400,
    "err_msg": "Invalid operator 'range' for field 'name'. Allowed operators: eq, neq, contains, not_contains",
    "err_extra": {}
  }
}

{
  "reply": {
    "err_code": 400,
    "err_msg": "Missing required parameter: control_name",
    "err_extra": {}
  }
}

{
  "reply": {
    "err_code": 400,
    "err_msg": "Invalid value for is_custom field. Allowed values: yes, no",
    "err_extra": {}
  }
}

Internal server error

Body

application/json

replyobject

err_codeinteger

Error code

err_msgstring

Error message

err_extraobject

Additional error details

RESPONSE
{
  "reply": {
    "err_code": 500,
    "err_msg": "Failed to retrieve controls",
    "err_extra": {}
  }
}