List match targets

get https://{hostname}/appsec/v1/configs/{configId}/versions/{versionNumber}/match-targets

Kona Site Defender, App & API Protector with the Advanced Security module Returns match targets defined in the specified security configuration version.

Responses

Response body

object

matchTargets

object

required

Match target settings.

apiTargets

array of objects

required

The api match targets.

apiTargets*

object

apis

array of objects

Contains a list of objects containing an API endpoint ID and name. This field applies only to API match targets.

apis

object

integer

required

Uniquely identifies the API endpoint.

name

string

The API endpoint name.

bypassNetworkLists

array of objects

The list of network list identifiers and names.

bypassNetworkLists

object

string

required

Uniquely identifies the network list.

name

string

The name of the network list.

configId

integer

Uniquely identifies the security configuration.

configVersion

integer

The version of security configuration.

defaultFile

string

Defaults to NO_MATCH

Describes the rule to match on paths. Either NO_MATCH to not match on the default file, BASE_MATCH to match only requests for top-level hostnames ending in a trailing slash, or RECURSIVE_MATCH to match all requests for paths that end in a trailing slash.

NO_MATCH BASE_MATCH RECURSIVE_MATCH

effectiveSecurityControls

object

Read-only Defines the security controls to apply. For a security control to be effectively turned on, it has to be enabled in both the match target and the security policy.

fileExtensions

array of strings

Contains a list of file extensions.

fileExtensions

filePaths

array of strings

Contains a list of file paths.

filePaths

hostnames

array of strings

Contains a list of hostnames to protect.

hostnames

isNegativeFileExtensionMatch

boolean

Describes whether the match target applies when a match is found in the specified fileExtensions or when a match isn't found.

isNegativePathMatch

boolean

Describes whether the match target applies when a match is found in the specified paths or when a match isn't found.

securityPolicy

object

required

The security policy associated with the match target.

sequence

integer

The position in the sequence of match targets.

targetId

integer

Uniquely identifies the match target.

type

string

required

Describes the type of match target, either website or api.

website api

validations

object

Read-only Describes warnings, errors, or notices determined by a validation of this resource.

websiteTargets

array of objects

required

The website match targets.

websiteTargets*

object

apis

array of objects

Contains a list of objects containing an API endpoint ID and name. This field applies only to API match targets.

apis

object

integer

required

Uniquely identifies the API endpoint.

name

string

The API endpoint name.

bypassNetworkLists

array of objects

The list of network list identifiers and names.

bypassNetworkLists

object

string

required

Uniquely identifies the network list.

name

string

The name of the network list.

configId

integer

Uniquely identifies the security configuration.

configVersion

integer

The version of security configuration.

defaultFile

string

Defaults to NO_MATCH

NO_MATCH BASE_MATCH RECURSIVE_MATCH

effectiveSecurityControls

object

Read-only Defines the security controls to apply. For a security control to be effectively turned on, it has to be enabled in both the match target and the security policy.

fileExtensions

array of strings

Contains a list of file extensions.

fileExtensions

filePaths

array of strings

Contains a list of file paths.

filePaths

hostnames

array of strings

Contains a list of hostnames to protect.

hostnames

isNegativeFileExtensionMatch

boolean

Describes whether the match target applies when a match is found in the specified fileExtensions or when a match isn't found.

isNegativePathMatch

boolean

Describes whether the match target applies when a match is found in the specified paths or when a match isn't found.

securityPolicy

object

required

The security policy associated with the match target.

sequence

integer

The position in the sequence of match targets.

targetId

integer

Uniquely identifies the match target.

type

string

required

Describes the type of match target, either website or api.

website api

validations

object

Read-only Describes warnings, errors, or notices determined by a validation of this resource.

Language

Authentication

Remember to add your authentication credentials to run this code.

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url https://hostname/appsec/v1/configs/configId/versions/versionNumber/match-targets \
3
     --header 'accept: application/json'


xxxxxxxxxx
115
}
1
{
2
  "matchTargets": {
3
    "apiTargets": [
4
      {
5
        "apis": [
6
          {
7
            "id": 1111,
8
            "name": "API Endpoint 1"
9
          },
10
          {
11
            "id": 2222,
12
            "name": "API Endpoint 2"
13
          }
14
        ],
15
        "bypassNetworkLists": [
16
          {
17
            "id": "522825_CCCBYPASSLIST",
18
            "name": "Example network list 11"
19
          },
20
          {
21
            "id": "1622566_XXAABYPASSL",
22
            "name": "Example network list 12"
23
          }
24
        ],
25
        "configId": 77653,

200Successfully returned match targets.

403Forbidden. You don't have access to match targets in this security configuration.

404Not found. Security configuration version wasn't found.