Endpoint version error response type

Get-APIEndpointVersionErrorResponseType

Synopsis

Get an error response.

Syntax

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

Description

Returns a customizable error response of the selected type.

Parameters

‑APIEndpointID
Conditionally required

The endpoint's ID.

‑APIEndpointName
Conditionally required

The endpoint's name.

‑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.

‑EdgeRCFile

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

‑Section

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

‑Type
Required

The customizable error response type.

‑VersionNumber
Required

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

Related Links