Discovered API

Hide-AppSecDiscoveredAPI

Synopsis

Modify an API's visibility.

Syntax

Hide-AppSecDiscoveredAPI [-Hostname] <String> [-BasePath] <String> [-Reason] <String> [[-EdgeRCFile] <String>]
 [[-Section] <String>] [[-AccountSwitchKey] <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Description

Hides an API. You can include or exclude APIs from the response.

This operation is per-user. It means that if you hide an API from the response, another user can still see that API in their response when they run this operation with their own credentials.

Parameters

-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: 5
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-BasePath

The base64-encoded value of the base path.

Type: String
Parameter Sets: (All)
Aliases: None
Required: True
Position: 1
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: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Hostname

The base64-encoded value of the hostname.

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

-Reason

The reason you've decided to hide the API from the API list.
Use NOT_ELIGIBLE if you want to hide it for now and choose what to do with the API at a later time.
Use FALSE_POSITIVE for APIs you feel are incorrectly included in the data.

Type: String
Parameter Sets: (All)
Aliases:
Accepted values: FALSE_POSITIVE, NOT_ELIGIBLE

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: 4
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