Guide

Endpoint version PII params

Get-APIEndpointVersionPIIParams

Suggest Edits

Synopsis

Get parameters with PII for an endpoint version.

Syntax

Get-APIEndpointVersionPIIParams -APIEndpointName <String> -VersionNumber <String> [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Get-APIEndpointVersionPIIParams -APIEndpointID <Int32> -VersionNumber <String> [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Description

Returns all PII objects for an endpoint version. This includes parameters with PII already in your API definition, as well as parameters with PII the network discovers on your behalf.

You can return this information for both active and inactive endpoint versions. All operations for PII are per endpoint version. The -VersionNumber parameter is either an integer or the word latest.

Run Set-AppSecPIISettings from the Akamai.AppSec module to use this feature.

Parameters

‑APIEndpointID
Conditionally required
Int Parameter sets: id Pipeline input: False

The endpoint's ID.
‑APIEndpointName
Conditionally required
String Parameter sets: name Pipeline input: False

The endpoint's name.
‑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.
‑EdgeRCFile
String Pipeline input: False

Your EdgeGrid resource file to authenticate your command. Defaults to ~/.edgerc.
‑Section
String Pipeline input: False

The section name in your EdgeGrid resource file to retrieve authentication credentials from. Defaults to default.
‑VersionNumber
Required
String Pipeline input: False

The endpoint version's number. Can be an integer or 'latest'.

Related Links

Updated 4 months ago