Endpoint version

Synopsis

Get 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	Int32Parameter sets: `All by ID`, `Version by ID`Pipeline input: ByPropertyName, ByValue The endpoint's ID.
`‑APIEndpointName` Conditionally required	StringParameter sets: `All by name`, `Version by name`Pipeline input: False The endpoint's name.
`‑AccountSwitchKey`	StringPipeline 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`	StringPipeline input: False Your EdgeGrid resource file to authenticate your command. Defaults to `~/.edgerc`.
`‑Page`	Int32Parameter sets: `All by ID`, `All by name`Pipeline input: False The page number index, starting at the default value of `1`.
`‑PageSize`	Int32Parameter sets: `All by ID`, `All by name`Pipeline input: False The number of endpoints on each page of results, `25` by default.
`‑Section`	StringPipeline input: False The section name in your EdgeGrid resource file to retrieve authentication credentials from. Defaults to `default`.
`‑Show`	StringAccepted values: `ONLY_VISIBLE`, `ONLY_HIDDEN`, `ALL`Parameter sets: `All by ID`, `All by name`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_VISIBLE` endpoints, or `ONLY_HIDDEN` endpoints.
`‑SortBy`	StringAccepted values: `updateDate`, `updatedBy`, `description`, `versionNumber`, `basedOn`, `stagingStatus`, `productionStatus`Parameter sets: `All by ID`, `All by name`Pipeline input: False The field to sort endpoints by, either the API `name` (corresponding to the `apiEndPointName` member) or `updateDate`.
`‑SortOrder`	StringAccepted values: `asc`, `desc`Parameter sets: `All by ID`, `All by name`Pipeline input: False The sort order, either `desc` for descending or the default `asc` for ascending.
`‑VersionNumber` Conditionally required	StringParameter sets: `Version by ID`, `Version by name`Pipeline input: False The endpoint version's number. Can be an integer or 'latest'.

Related Links

Updated 20 days ago