Policy API request constraints

Set-AppSecPolicyAPIRequestConstraints

Synopsis

Modify an API request constraint's action.

Syntax

configname-policyname (Default)

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

configname-policyid

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

configid-policyid

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

configid-policyname

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

An ID for each API.

Type: String
Parameter Sets: (All)
Aliases: None
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-AccountSwitchKey

Account switch key, for use when you have access to multiple accounts and need to specify which one to use. Account switch keys can be found using Get-AccountSwitchKey.

Type: String
Parameter Sets: (All)
Aliases: None
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Action

Specifies the action that the rule should trigger. Either alert, deny, deny_custom_{custom_deny_id}, or none. If the action is none, it isn't associated with the policy.

Use deny_custom_{custom_deny_id} to apply a custom action instead of Akamai's default.

Type: String
Parameter Sets: (All)
Aliases:
Accepted values: alert, deny, none

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ConfigID

An ID for each configuration.

Type: Int32
Parameter Sets: configid-policyid, configid-policyname
Aliases: None
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ConfigName

The name of the security configuration.

Type: String
Parameter Sets: configname-policyname, configname-policyid
Aliases: None
Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-EdgeRCFile

EdgeRC file to authenticate your command. Defaults to ~/.edgerc.

Type: String
Parameter Sets: (All)
Aliases: None
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-PolicyID

An ID for a security policy.

Type: String
Parameter Sets: configname-policyid, configid-policyid
Aliases: None
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-PolicyName

The name of the security policy.

Type: String
Parameter Sets: configname-policyname, configid-policyname
Aliases: None
Required: True
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Section

EdgeRC section to retrieve authentication credentials from. Defaults to default.

Type: String
Parameter Sets: (All)
Aliases: None
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-VersionNumber

An ID for each version of a configuration. Can be an integer or the word latest.

Type: String
Parameter Sets: (All)
Aliases: None
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

None

Outputs

System.Object