Guide

Endpoints

Get-APIEndpoints

Suggest Edits

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
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.
‑Category
String Pipeline input: False

Filters endpoints by the specified -ApiCategoryName, including the UNCATEGORIZED keyword.
‑Contains
String Pipeline input: False

The search query substring criteria matching the endpoint's name, description, basePath, apiCategoryName, and resourcePath.
‑ContractID
String Pipeline input: False

Filters endpoints to a specific contract. You need to specify this along with a -GroupID.
‑EdgeRCFile
String Pipeline input: False

Your EdgeGrid resource file to authenticate your command. Defaults to ~/.edgerc.
‑GroupID
Int Pipeline input: False

Filters endpoints to a specific group. You need to specify this along with a -ContractID.
‑PIIOnly
Switch Pipeline input: False

Returns only endpoints with personally identifiable information (PII).
‑Page
Int Pipeline input: False

The page number index, starting at the default value of 1.
‑PageSize
Int 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 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: name, updateDate 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 Pipeline input: False

The sort order, either desc for descending or the default asc for ascending.
‑VersionPreference
String Accepted values: ACTIVATED_FIRST, LAST_UPDATED Pipeline input: False

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

If you set the preference to ACTIVATEDFIRST, the API first attempts to return the version currently active on the production network. If such a 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.

Related Links

Updated about 1 month ago