Guide

Discovered API

Get-AppSecDiscoveredAPI

Suggest Edits

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
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.
‑BasePath
Conditionally required
String Parameter sets: single Pipeline input: False

The base64-encoded value of the base path.
‑EdgeRCFile
String Pipeline input: False

Your EdgeGrid resource file to authenticate your command. Defaults to ~/.edgerc.
‑Hostname
Conditionally required
String Parameter sets: single Pipeline input: False

The base64-encoded value of the hostname.
‑IncludeHidden
Switch Parameter sets: all, single Pipeline input: False

If present, the function returns all discovered APIs including ones you have hidden. If absent, returns only the visible APIs.
‑Search
String Parameter sets: all, single Pipeline input: False

Filter results by name, description, or ID. You can match on substrings.
‑Section
String Pipeline input: False

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

Related Links

Updated 3 days ago