Discovered API

Get-AppSecDiscoveredAPI

Synopsis

Get a discovered API.

Syntax

Get-AppSecDiscoveredAPI [-IncludeHidden] [-Search <String>] [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
Get-AppSecDiscoveredAPI -Hostname <String> -BasePath <String> [-IncludeHidden] [-Search <String>] [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Description

Gets all APIs discovered in the account's traffic or retrieves a specific API by its hostname and base path.

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
Conditionally required

The base64-encoded value of the base path.

‑EdgeRCFile

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

‑Hostname
Conditionally required

The base64-encoded value of the hostname.

‑IncludeHidden

If present, the function returns all discovered APIs including ones you have hidden. If absent, returns only the visible APIs.

‑Search

Filter results by name, description, or ID. You can match on substrings.

‑Section

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

Related Links