Endpoints

Get-APIEndpoints

Synopsis

Get endpoints.

Syntax

Get-APIEndpoints [[-Category] <String>] [[-Contains] <String>] [[-ContractID] <String>] [[-GroupID] <Int32>]
 [[-Page] <Int32>] [[-PageSize] <Int32>] [-PIIOnly] [[-Show] <String>] [[-SortBy] <String>]
 [[-SortOrder] <String>] [[-VersionPreference] <String>] [[-EdgeRCFile] <String>] [[-Section] <String>]
 [[-AccountSwitchKey] <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Description

Gets all available API endpoints. Optionally, you can paginate, sort, or filter the results. If no endpoints are available, the operation responds with an empty array.

Parameters

-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: 12
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Category

Filters endpoints by the specified apiCategoryName, including the UNCATEGORIZED keyword.

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

-Contains

The search query substring criteria matching the endpoint's name, description, basePath, apiCategoryName, and resourcePath.

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

-ContractID

Filters endpoints to a specific contract. You need to specify this along with a -GroupID.

Type: String
Parameter Sets: (All)
Aliases: None
Required: False
Position: 2
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: 10
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-GroupID

Filters endpoints to a specific group. You need to specify this along with a -ContractID.

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

-PIIOnly

Whether to return only endpoints with personally identifiable information (PII).

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

-Page

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

Type: Int32
Parameter Sets: (All)
Aliases: None
Required: False
Position: 4
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: (All)
Aliases: None
Required: False
Position: 5
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: 11
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: (All)
Aliases:
Accepted values: ONLY_VISIBLE, ONLY_HIDDEN, ALL

Required: False
Position: 6
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: (All)
Aliases:
Accepted values: name, updateDate

Required: False
Position: 7
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: (All)
Aliases:
Accepted values: asc, desc

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

-VersionPreference

The preference for selecting the endpoint version to return. By default the API returns the LAST_UPDATED version.

If you set the preference to ACTIVATED_FIRST, the API first attempts to return the version currently active on the production network. If such version doesn't exist, the API attempts to return the version currently active on the staging network. If both of these checks fail, the API returns the last updated version.

Type: String
Parameter Sets: (All)
Aliases:
Accepted values: ACTIVATED_FIRST, LAST_UPDATED

Required: False
Position: 9
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