Get all criteria

get /public_api/appsec/v1/application/criteria/all

Retrieves a paginated list of all criteria.

Required license:

Cortex XSIAM Premium. In Cortex XSIAM Enterprise and Cortex NG SIEM, requires the Cortex Cloud Posture Management add-on. Not supported in XSIAM Enterprise Plus.

Query parameters

page Double

Current page number in the paginated response.

double

Example: 1.2

pageSize Double

Total number of items in the current page.

double

Example: 1.2

CLIENT REQUEST

          curl -X 'GET'

        -H
        'Accept: application/json'
      
      'https://api-yourfqdn/public_api/appsec/v1/application/criteria/all?page=1.2&pageSize=1.2'

import http.client

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

conn.request("GET", "/public_api/appsec/v1/application/criteria/all?page=SOME_NUMBER_VALUE&pageSize=SOME_NUMBER_VALUE")

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/appsec/v1/application/criteria/all?page=SOME_NUMBER_VALUE&pageSize=SOME_NUMBER_VALUE")

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

request = Net::HTTP::Get.new(url)

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("GET", "https://api-yourfqdn/public_api/appsec/v1/application/criteria/all?page=SOME_NUMBER_VALUE&pageSize=SOME_NUMBER_VALUE");

xhr.send(data);

HttpResponse<String> response = Unirest.get("https://api-yourfqdn/public_api/appsec/v1/application/criteria/all?page=SOME_NUMBER_VALUE&pageSize=SOME_NUMBER_VALUE")
  .asString();

import Foundation

let request = NSMutableURLRequest(url: NSURL(string: "https://api-yourfqdn/public_api/appsec/v1/application/criteria/all?page=SOME_NUMBER_VALUE&pageSize=SOME_NUMBER_VALUE")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"

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/appsec/v1/application/criteria/all?page=SOME_NUMBER_VALUE&pageSize=SOME_NUMBER_VALUE",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$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, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "https://api-yourfqdn/public_api/appsec/v1/application/criteria/all?page=SOME_NUMBER_VALUE&pageSize=SOME_NUMBER_VALUE");

CURLcode ret = curl_easy_perform(hnd);

var client = new RestClient("https://api-yourfqdn/public_api/appsec/v1/application/criteria/all?page=SOME_NUMBER_VALUE&pageSize=SOME_NUMBER_VALUE");
var request = new RestRequest(Method.GET);
IRestResponse response = client.Execute(request);

Responses

Body

application/json

itemsarrayrequired

[

Any of

idstringrequired

Unique Id of the criteria.

namestringrequired

Unique name of the criteria.

descriptionstring

Criteria description.

creationMethodstring (Enum)required

Creation method for the criteria. Possible values: -manual: For the criteria created manually. -automatic: Criteria that are automatically created.

Allowed values:"manual""automatic"

createdBystringrequired

Owner of the criteria.

createdAtstringrequireddate-time

Timestamp when the criteria was created.

lastUpdatedstringdate-time

Timestamp when the criteria was updated.

deletedAtstringdate-time

Timestamp when the criteria was deleted.

metadataobject

Additional metadata for the criteria.

applicationCountnumberdouble

The number of associated applications.

assetCountnumberdouble

The number of associated assets.

refreshStatusstring (Enum)

The current refresh status.

Allowed values:"in_progress""done"

deletedFromUaiboolean

Indicates whether the resource has been deleted from UAI.

typestring (Enum)required

Criteria Type.

Allowed values:"code"

configobject

unifyWithinProviderboolean

Repositories with the same name at the selected group-by level (org, project, or repository) are consolidated into a single application within the selected provider.

unifyAcrossProvidersboolean

If multiple applications share the same name at the chosen group-by level (org, project, or repository), they are merged across providers to form a single unified application.

criteriaDefinitionsarrayrequired

[

typestring (Enum)required

Allowed values:"tags""organization""project""repository"

providerobjectrequired

Any of

string (Enum)

Source code management (SCM) or code hosting provider. Allowed values: GITLAB, GITHUB, BITBUCKET, AZURE_REPOS, AWS_CODE_COMMIT

Allowed values:"GITLAB""GITHUB""BITBUCKET""AZURE_REPOS""AWS_CODE_COMMIT"

string (Enum)

Runtime or execution environment provider for the application or asset. Allowed Values: GCP, AWS, AZURE

Allowed values:"GCP""AWS""AZURE"

filtersarray

Optional. A list of filters to apply. If you choose to include the filters array, all fields within each filter object are required. Each filter object contains the following fields:

[

typeobject (Enum)required

The filter operation.

Allowed values:"equal""notEqual""contains""notContains"

fieldobject (Enum)required

The field to filter on.

Allowed values:"repositoryName""organizationName""projectName"

valuesarray[string]required

The values to match for the filter.

]

tagKeysarray[string]

The tag keys to include.

]

criteriaPrettyNamestring

A human-readable name for the criteria.

criteriaPrettyNameTagsarray[string]

Tags associated with the criteria name.

applicationMetaDataobject

businessOwnerstring (Enum)required

The metadata of the business owner.

Allowed values:"none""organizationOwner""projectOwner""repositoryOwner"

businessCriticalitystring (Enum)required

The operational importance of the asset.

Allowed values:"Critical""High""Medium""Low"

exposedToInternetOverridebooleanrequired

Whether the asset is exposed to the internet.

idstringrequired

Unique Id of the criteria.

namestringrequired

Unique name of the criteria.

descriptionstring

Criteria description.

creationMethodstring (Enum)required

Creation method for the criteria. Possible values: -manual: For the criteria created manually. -automatic: Criteria that are automatically created.

Allowed values:"manual""automatic"

createdBystringrequired

Owner of the criteria.

createdAtstringrequireddate-time

Timestamp when the criteria was created.

lastUpdatedstringdate-time

Timestamp when the criteria was updated.

deletedAtstringdate-time

Timestamp when the criteria was deleted.

metadataobject

Additional metadata for the criteria.

applicationCountnumberdouble

The number of associated applications.

assetCountnumberdouble

The number of associated assets.

refreshStatusstring (Enum)

The current refresh status.

Allowed values:"in_progress""done"

deletedFromUaiboolean

Indicates whether the resource has been deleted from UAI.

typestring (Enum)required

Criteria Type. Allowed values - cloud.

Allowed values:"cloud"

configobject

unifyWithinProviderboolean

Repositories with the same name at the selected group-by level (org, project, or repository) are consolidated into a single application within the selected provider.

unifyAcrossProvidersboolean

If multiple applications share the same name at the chosen group-by level (org, project, or repository), they are merged across providers to form a single unified application.

criteriaDefinitionsarrayrequired

[

typestring (Enum)required

Allowed values:"tags""organization""project""repository"

providerobjectrequired

Any of

string (Enum)

Source code management (SCM) or code hosting provider. Allowed values: GITLAB, GITHUB, BITBUCKET, AZURE_REPOS, AWS_CODE_COMMIT

Allowed values:"GITLAB""GITHUB""BITBUCKET""AZURE_REPOS""AWS_CODE_COMMIT"

string (Enum)

Runtime or execution environment provider for the application or asset. Allowed Values: GCP, AWS, AZURE

Allowed values:"GCP""AWS""AZURE"

filtersarray

Optional. A list of filters to apply. If you choose to include the filters array, all fields within each filter object are required. Each filter object contains the following fields:

[

typeobject (Enum)required

The filter operation.

Allowed values:"equal""notEqual""contains""notContains"

fieldobject (Enum)required

The field to filter on.

Allowed values:"repositoryName""organizationName""projectName"

valuesarray[string]required

The values to match for the filter.

]

tagKeysarray[string]

The tag keys to include.

]

criteriaPrettyNamestring

A human-readable name for the criteria.

criteriaPrettyNameTagsarray

Tags associated with the criteria name.

[

]

applicationMetaDataobjectrequired

applicationNameSourceTagsstring

Identifies the application name. If multiple values are found, the three most frequent ones are concatenated (for example, infra_bank_pay). If matching tag is not found, the application name is automatically generated by the system.

businessCriticalitySourceTagsstring

Maps the business criticality level (Critical, High, Medium, or Low). If multiple values are present, the highest severity level is applied. The default value is Medium.

businessOwnerSourceTagsarray[string]

businessUnitSourceTagsstring

Maps the tag key to the Business Unit. If multiple values are available, a comma-separated string containing the top five most frequent values is shown.

]

currentPagenumberrequireddouble

Current page number in the paginated response.

totalPagesnumberdouble

Total number of pages for the paginated response.

pageSizenumberrequireddouble

Number of entries in each page.

totalItemsnumberrequireddouble

Total number of items in the response.

RESPONSE
{
  "items": [
    {
      "id": "example",
      "name": "example",
      "description": "example",
      "creationMethod": "manual",
      "createdBy": "example",
      "createdAt": "2020-01-01T12:00:00Z",
      "lastUpdated": "2020-01-01T12:00:00Z",
      "deletedAt": "2020-01-01T12:00:00Z",
      "metadata": {
        "applicationCount": 0.1,
        "assetCount": 0.1,
        "refreshStatus": "in_progress",
        "deletedFromUai": false
      },
      "type": "cloud",
      "config": {
        "unifyWithinProvider": false,
        "unifyAcrossProviders": false,
        "criteriaDefinitions": [
          [
            {
              "type": "tags",
              "provider": "GCP",
              "filters": [
                {
                  "type": "equal",
                  "field": "repositoryName",
                  "values": [
                    "example"
                  ]
                }
              ],
              "tagKeys": [
                "example"
              ]
            }
          ]
        ],
        "criteriaPrettyName": "example",
        "criteriaPrettyNameTags": [
          {}
        ],
        "applicationMetaData": {
          "applicationNameSourceTags": "example",
          "businessCriticalitySourceTags": "example",
          "businessOwnerSourceTags": [
            "example"
          ],
          "businessUnitSourceTags": "example"
        }
      }
    }
  ],
  "currentPage": 0.1,
  "totalPages": 0.1,
  "pageSize": 0.1,
  "totalItems": 0.1
}