Guide

Policy API request constraints

Set-AppSecPolicyAPIRequestConstraints

Suggest Edits

Synopsis

Modify an API request constraint's action.

Syntax

Set-AppSecPolicyAPIRequestConstraints [-ConfigName] <String> [-VersionNumber] <String> [-PolicyName] <String> [-APIID <String>] -Action <String> [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Set-AppSecPolicyAPIRequestConstraints [-ConfigName] <String> [-VersionNumber] <String> -PolicyID <String> [-APIID <String>] -Action <String> [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Set-AppSecPolicyAPIRequestConstraints -ConfigID <Int32> [-VersionNumber] <String> -PolicyID <String> [-APIID <String>] -Action <String> [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Set-AppSecPolicyAPIRequestConstraints -ConfigID <Int32> [-VersionNumber] <String> [-PolicyName] <String> [-APIID <String>] -Action <String> [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Description

Updates what action to take when the API request constraint triggers. This operation modifies an individual API constraint action.

To use this operation, run the Get-AppSecPolicyAPIRequestConstraints operation and select an API from the response list. Use alert to record the trigger of the event, deny to block the request, or none to take no action.

When making a request, you can specify a configuration with the -ConfigName or -ConfigID parameter. The -VersionNumber parameter is an integer or the word latest. To specify a policy, use the -PolicyName or -PolicyID parameter.

Parameters

‑APIID
String Pipeline input: False

Your API's ID.
‑AccountSwitchKey
String Pipeline input: False

An account credential key that lets you move between accounts when using an API client enabled for multiple accounts. To find account switch keys, use Get-AccountSwitchKey.
‑Action
Required
String Accepted values: alert, deny, none Pipeline input: False

Specifies the action that the rule should trigger. Either alert, deny, deny, or none.

Use deny to apply a custom action instead of Akamai's default. If the action is none, it isn't associated with the policy.
‑ConfigID
Conditionally required
Int Parameter sets: configid-policyid, configid-policyname Pipeline input: False

Your configuration's ID.
‑ConfigName
Conditionally required
String Parameter sets: configname-policyid, configname-policyname Pipeline input: False

The name of your security configuration.
‑EdgeRCFile
String Pipeline input: False

Your EdgeGrid resource file to authenticate your command. Defaults to ~/.edgerc.
‑PolicyID
Conditionally required
String Parameter sets: configid-policyid, configname-policyid Pipeline input: False

Your security policy's ID.
‑PolicyName
Conditionally required
String Parameter sets: configid-policyname, configname-policyname Pipeline input: False

The name of your security policy.
‑Section
String Pipeline input: False

The section name in your EdgeGrid resource file to retrieve authentication credentials from. Defaults to default.
‑VersionNumber
Required
String Pipeline input: False

A configuration's version. Can be an integer or the word latest.

Related Links

Updated 4 months ago