Create a match target

post

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

Kona Site Defender, App & API Protector with the Advanced Security module Creates a new Match Target in the specified Configuration Version.

Path Params

configId

int64

required

A unique identifier for each configuration.

versionNumber

integer

required

A unique identifier for each version of a configuration.

Query Params

accountSwitchKey

string

For customers who manage more than one account, this runs the operation from another account. The Identity and Access Management API provides a list of available account switch keys.

Body Params

Contains information about a match target.

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

bypassNetworkLists

array of objects

The list of network list identifiers and names.

bypassNetworkLists

configId

integer

Uniquely identifies the security configuration.

configVersion

integer

The version of security configuration.

defaultFile

string

enum

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.

Allowed:

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

enum

required

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

Allowed:

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

201Successfully created a match target.

400Bad request. Invalid request body or URL parameter input.

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

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