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

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.

‑BasePath
Required

The base64-encoded value of the base path.

‑EdgeRCFile

Your EdgeGrid resource file to authenticate your command. Defaults to ~/.edgerc.

‑Hostname
Required

The base64-encoded value of the hostname.

‑Reason
Required

The reason you've decided to hide the API from the API list.

- Use NOT if you want to hide it for now and decide what to do with the API at a later time.

- Use FALSEPOSITIVE for APIs you feel are incorrectly included in the data.

‑Section

The section name in your EdgeGrid resource file to retrieve authentication credentials from. Defaults to default.

Related Links