JUMP TOCTRL-/APIApplication Security APIAPI summaryOpenAPI schemaGet StartedSet up your API tokenAPI conceptsAPI workflowsActivate with invalid hostnamesAdd a new hostname to a configurationAdd a new custom rule to a configurationExport a configuration versionDiff configuration versionsRate limitingEnumeration valuesExport condition type valuesExport match condition type valuesExport header valuesCondition valuesCustomRule condition type valuesDeny name valuesException selector valuesRecommendation selector valuesLogging option values (Beta)Errors400401403404409429Configuration settingsGeneral configuration settingsCreate a configurationpostList configurationsgetGet a security configurationgetRename a security configurationputRemove a configurationdeleteClone a configuration versionpostList configuration versionsgetGet configuration version detailsgetRemove a configuration versiondeleteGet the version notesgetModify version notesputMatch targetsGet the hostname coverage match targetsgetCreate a match targetpostList match targetsgetModify match target orderputGet a match targetgetModify a match targetputRemove a match targetdeletePrefetch requestsGet prefetch requestsgetModify prefetch requestsputShared resources: Rate policiesCreate a rate policypostList rate policiesgetGet a rate policygetModify a rate policyputRemove a rate policydeleteModify a rate policy evaluationputSIEM settingsGet SIEM settingsgetModify SIEM settingsputGet SIEM versionsgetURL protection policiesCreate a URL protection policypostList URL protection policiesgetGet a URL protection policygetModify a URL protection policyputRemove a URL protection policydeleteHostnamesList hostname overlapsgetList selectable hostnamesgetList selected hostnamesgetModify selected hostnamesputShared resources: Malware policiesCreate a malware policypostList malware policiesgetList supported malware policy content typesgetGet a malware policygetModify a malware policyputRemove a malware policydeleteShared resources: Custom rulesCreate a custom rulepostList custom rulesgetGet a custom rulegetModify a custom ruleputRemove a custom ruledeletePII learningGet PII learning settings for a configurationgetEnable PII learning settings for a configurationputShared resources: Custom deny actionsCreate a custom deny actionpostList custom deny actionsgetGet a custom deny actiongetModify a custom deny actionputRemove a custom deny actiondeleteBypass network listsGet bypass network lists settingsgetModify the bypass network lists settingsputFailover hostnamesList failover hostnamesgetShared resources: Reputation profilesCreate a reputation profilepostList reputation profilesgetGet a reputation profilegetModify a reputation profileputRemove a reputation profiledeleteRequest body sizeGet request body size settings for a configurationgetModify request body inspection limit settings for a configurationputCookie SettingsGet cookie settingsgetModify cookie settingsputEvasive path matchGet evasive path match settings for a configurationgetModify evasive path match settings for a configurationputHTTP header logsGet the HTTP header log settings for a configurationgetModify HTTP header log settings for a configurationputAttack payload logsGet the attack payload log settings for a configurationgetModify attack payload log settings for a configurationputPragma settingsGet Pragma settings for a configurationgetModify Pragma settings for a configurationputSecurity policiesGeneral policy settingsClone or create a security policypostList security policiesgetGet a security policygetModify a security policyputRemove a security policydeleteRate policy actionsList rate policy actionsgetModify a rate policy actionputIP/Geo Firewall settingsGet IP/Geo Firewall settingsgetModify IP/Geo Firewall settingsputAttack payload logsGet attack payload logging settings for a policygetModify attack payload logging settings for a policyputHTTP header logsGet HTTP header log settingsgetModify HTTP header log settingsputClient reputationList reputation profile actionsgetGet the action for a reputation profilegetModify the action for a reputation profileputCustom rule actionsList custom rule actionsgetModify a custom rule actionputReputation analysisGet reputation analysis settingsgetModify reputation analysis settingsputURL protection policy actionsList URL protection policy actionsgetModify a URL protection policy actionputPragma settingsGet Pragma settings for a security policygetModify Pragma settings for a security policyputAPI request constraintsList API request constraints and actionsgetModify the request constraint action for all APIsputModify an API request constraint's actionputEvasive path matchGet evasive path match settingsgetModify evasive path match settingsputMalware policy actionsList malware policy actionsgetModify a malware policy actionputRequest body inspection limitsGet request body inspection limit settings for a security policygetModify request body size settings for a security policyputAPI endpointsList API endpointsgetSlow POST protectionsGet slow POST protection settingsgetModify slow POST protection settingsputWAF rules: General settingsList rulesgetUpgrade KRS rulesetputGet adaptive intelligence settingsgetModify adaptive intelligence settingsputGet upgrade detailsgetGet the action for a rulegetModify the action for a ruleputGet the conditions and exceptions of a rulegetModify the conditions and exceptions of a ruleputProtectionsGet protectionsgetModify protectionsputWAF rules: Penalty boxGet the penalty boxgetModify the penalty boxputWAF rules: Penalty box conditionsGet penalty box conditiongetModify the penalty box conditionsputWAF rules: Tuning recommendationsRespond to exception recommendationspostGet tuning recommendations for a policygetList tuning recommendations for an attack groupgetList tuning recommendations for a rulegetWAF rules: Attack groupsList attack groupsgetGet the action for an attack groupgetModify the action for an attack groupputGet the exceptions of an attack groupgetModify the exceptions of an attack groupputWAF rules: Update modeGet the current modegetModify the modeputWAF rules: Rapid rulesList rapid rulesgetGet rapid rules' default actiongetUpdate rapid rules' default actionputGet rapid rules' statusgetUpdate rapid rules' statusputList a rapid rule's conditions and exceptionsgetUpdate a rapid rule's conditions and exceptionsputGet a rapid rule's lock statusgetUpdate a rapid rule's lock statusputGet a rapid rule's actiongetUpdate a rapid rule's actionputBypass network listsGet the bypass network lists settings for a security policygetModify the bypass network lists settings for a security policyputClient-Side Protections & ComplianceGet Client-Side Protection & Compliance settingsgetModify Client-Side Protections & Compliance settingsputHostnamesList selected hostnames for a security policygetModify selected hostnames for a security policyputActivation and exportActivationsActivate a configuration versionpostConfiguration version exportExport a configuration versiongetActivation historyList activation historygetActivation statusGet an activation request statusgetGet activation statusgetConfiguration version diffCompare two versionspostEvaluation modeSecurity policy: Conditions and exceptionsGet the exceptions of an evaluation attack groupgetModify the exceptions of an evaluation attack groupputGet the conditions and exceptions for an evaluation rulegetModify the conditions and exceptions for an evaluation ruleputSecurity policy: Evaluation hostnamesList evaluation hostnames for a security policygetModify evaluation hostnames for a security policyputProtect evaluation hostnames for a security policyputSecurity policy: Evaluation modeSet evaluation modepostSecurity policy: Evaluation penalty boxGet the penalty box for a policy in evaluation modegetModify the evaluation penalty boxputSecurity policy: Evaluation rulesList evaluation rulesgetGet the action of an evaluation rulegetModify the action of an evaluation ruleputSecurity policy: Evaluation attack groupsList evaluation attack groupsgetGet the action for an evaluation attack groupgetModify the action for an evaluation attack groupputWAF rules: Evaluation Penalty box conditionsGet penalty box conditions in evaluation modegetModify the penalty box conditions in evaluation modeputConfiguration: Evaluation hostnamesProtect evaluation hostnamesputList evaluation hostnamesgetModify evaluation hostnamesputUtilities and account dataDiscovered APIsList discovered APIsgetGet a discovered APIgetSubscriptionsSubscribe or unsubscribe to recommendation emailspostList subscribersgetEndpointsModify an API's visibilityputCreate an endpoint or resourcepostList discovered API endpointsgetContracts and groupsList contracts and groupsgetAvailable hostnamesList available hostnames for a new configurationgetHostname coverageGet hostname coveragegetCVE Protections lookupList CVEsgetSubscribe to CVEspostList subscribed CVEsgetUnsubscribe from CVEspostGet a CVEgetGet CVE coveragegetSelf-service onboardingsOnboarding: Creation and settingsCreate an onboardingpostList onboardingsgetGet an onboardinggetDelete an onboardingdeleteList onboarding settingsgetModify onboarding settingsputOnboarding: Activations and statusActivate an onboardingpostOnboarding activation statusgetOnboarding: Post-activation validationGet onboarding certificate challengesgetValidate onboarding certificatepostGet hostname CNAME DNS recordsgetValidate hostname CNAME DNS recordspostGet origin hostnames DNS recordsgetSkip origin hostnames DNS record validationpostValidate origin hostnames DNS recordspostGet PII learning settings for a configurationget https://{hostname}/appsec/v1/configs/{configId}/versions/{versionNumber}/advanced-settings/pii-learningShows whether PII learning is enabled. This operation applies at the security configuration level. Products: Kona Site Defender, App & API Protector with the Advanced Security module.Path ParamsconfigIdint64requiredA unique identifier for each configuration.versionNumberintegerrequiredA unique identifier for each version of a configuration.Query ParamsaccountSwitchKeystringFor 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.Responses 200Successfully retrieved the PII learning settings.Response bodyobjectenablePiiLearningbooleanrequiredEnables PII learning. 400Invalid. Client error, such as invalid or malformed input.Response bodyobjectdetailstringrequiredThe detailed error message.fieldErrorsobjectPointers to fields for which invalid input was provided, whose values are messages detailing the reason this input was invalid for this field.Has additional fieldsinstancestringrequiredThe non-referenceable URI that indicates the error instance.statusintegerrequiredThe HTTP status code.titlestringrequiredThe error title.typestringrequiredThe URL for the error type.View Additional Properties 404Not found. The named security policy doesn't exist, doesn't carry application layer controls, or no rule with this ID is available for use in this policy.Response bodyobjectdetailstringrequiredThe detailed error message.fieldErrorsobjectPointers to fields for which invalid input was provided, whose values are messages detailing the reason this input was invalid for this field.Has additional fieldsinstancestringrequiredThe non-referenceable URI that indicates the error instance.statusintegerrequiredThe HTTP status code.titlestringrequiredThe error title.typestringrequiredThe URL for the error type.View Additional Properties 500Internal server error. Something went wrong on our side. Try again in a few minutes, and contact support if the error persists.Response bodyobjectdetailstringrequiredThe detailed error message.fieldErrorsobjectPointers to fields for which invalid input was provided, whose values are messages detailing the reason this input was invalid for this field.Has additional fieldsinstancestringrequiredThe non-referenceable URI that indicates the error instance.statusintegerrequiredThe HTTP status code.titlestringrequiredThe error title.typestringrequiredThe URL for the error type.View Additional PropertiesUpdated 8 months ago Remove a custom ruleEnable PII learning settings for a configurationDid this page help you?YesNo
