Endpoint version
Get-APIEndpointVersion
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 |
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 |
‑Page |
The page number index, starting at the default value of |
‑PageSize |
The number of endpoints on each page of results, |
‑Section |
The section name in your EdgeGrid resource file to retrieve authentication credentials from. Defaults to |
‑Show |
The type of endpoints to return based on their visibility status. By default the API returns |
‑SortBy |
The field to sort endpoints by, either the API |
‑SortOrder |
The sort order, either |
‑VersionNumber Conditionally required |
The endpoint version's number. Can be an integer or 'latest'. |
Related Links
Updated 17 days ago