Guide

Endpoint version error response type

Get-APIEndpointVersionErrorResponseType

Suggest Edits

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
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.
‑Type
Required
String Accepted values: API_KEY_INVALID, API_KEY_FORBIDDEN, QUOTA_EXCEEDED, JWT_SIGNATURE_INVALID, JWT_CLAIM_VALUE_INVALID Pipeline input: False

The customizable error response type.
‑VersionNumber
Required
String Pipeline input: False

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

Related Links

Updated about 1 month ago