Guide

Endpoint version

Get-APIEndpointVersion

Suggest Edits

Synopsis

Gets one or all versions.

Syntax

Get-APIEndpointVersion -APIEndpointName <String> [-Page <Int32>] [-PageSize <Int32>] [-Show <String>] [-SortBy <String>] [-SortOrder <String>] [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

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

Get-APIEndpointVersion -APIEndpointID <Int32> [-Page <Int32>] [-PageSize <Int32>] [-Show <String>] [-SortBy <String>] [-SortOrder <String>] [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

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

Description

Gets all versions of an API endpoint or returns a specific endpoint version by its name or ID and version number. The -VersionNumber parameter is either an integer or the word latest.

Parameters

‑APIEndpointID
Conditionally required
Int Parameter sets: id-all, id-version Pipeline input: False

The endpoint's ID.
‑APIEndpointName
Conditionally required
String Parameter sets: name-all, name-version 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.
‑Page
Int Parameter sets: id-all, name-all Pipeline input: False

The page number index, starting at the default value of 1.
‑PageSize
Int Parameter sets: id-all, name-all Pipeline input: False

The number of endpoints on each page of results, 25 by default.
‑Section
String Pipeline input: False

The section name in your EdgeGrid resource file to retrieve authentication credentials from. Defaults to default.
‑Show
String Accepted values: ONLY_VISIBLE, ONLY_HIDDEN, ALL Parameter sets: id-all, name-all Pipeline input: False

The type of endpoints to return based on their visibility status. By default the API returns ALL endpoints. You can instead decide to return ONLY endpoints, or ONLYHIDDEN endpoints.
‑SortBy
String Accepted values: updateDate, updatedBy, description, versionNumber, basedOn, stagingStatus, productionStatus Parameter sets: id-all, name-all Pipeline input: False

The field to sort endpoints by, either the API name (corresponding to the apiEndPointName member) or updateDate.
‑SortOrder
String Accepted values: asc, desc Parameter sets: id-all, name-all Pipeline input: False

The sort order, either desc for descending or the default asc for ascending.
‑VersionNumber
Conditionally required
String Parameter sets: id-version, name-version Pipeline input: False

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

Related Links

Updated 4 months ago