Endpoint version summary

Get-APIEndpointVersionSummary

Synopsis

Get a version summary.

Syntax

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

Description

Gets a summary for a specific endpoint version. The summary is purely for informational purposes, and you shouldn't use this operation's response in the corresponding Set-APIEndpointVersion function. Instead, use the response object from the Get-APIEndpointVersion operation.

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.

‑VersionNumber
Required

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

Related Links