Endpoint version

Get-APIEndpointVersion

Synopsis

Get one or all versions.

Syntax

name-all (Default)

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

name-version

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

id-all

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

id-version

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

The ID for the endpoint.

Type: Int32
Parameter Sets: id-all, id-version
Aliases: None
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-APIEndpointName

The name of the endpoint.

Type: String
Parameter Sets: name-all, name-version
Aliases: None
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-AccountSwitchKey

Account switch key, for use when you have access to multiple accounts and need to specify which one to use. Run Get-AccountSwitchKey to list the account switch keys available to you.

Type: String
Parameter Sets: (All)
Aliases: None
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-EdgeRCFile

EdgeRC file to authenticate your command. Defaults to ~/.edgerc.

Type: String
Parameter Sets: (All)
Aliases: None
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Page

The page number index, starting at the default value of 1.

Type: Int32
Parameter Sets: name-all, id-all
Aliases: None
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-PageSize

The number of endpoints on each page of results, 25 by default.

Type: Int32
Parameter Sets: name-all, id-all
Aliases: None
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Section

EdgeRC section to retrieve authentication credentials from. Defaults to default.

Type: String
Parameter Sets: (All)
Aliases: None
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Show

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.

Type: String
Parameter Sets: name-all, id-all
Aliases:
Accepted values: ONLY_VISIBLE, ONLY_HIDDEN, ALL

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-SortBy

The field to sort endpoints by, either the API name (corresponding to the apiEndPointName member) or updateDate.

Type: String
Parameter Sets: name-all, id-all
Aliases:
Accepted values: updateDate, updatedBy, Description, versionNumber, basedOn, stagingStatus, productionStatus

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-SortOrder

The sort order, either desc for descending or the default asc for ascending.

Type: String
Parameter Sets: name-all, id-all
Aliases:
Accepted values: asc, desc

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-VersionNumber

The ID for the endpoint version. Defaults to latest.

Type: String
Parameter Sets: name-version, id-version
Aliases: None
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

None

Outputs

System.Object