Endpoint

Synopsis

Get endpoint(s).

Syntax

Get-APIEndpoint [-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>]

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

Get-APIEndpoint [-APIEndpointID <Int32>] [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Description

Lists the available API endpoints, with results optionally paginated, sorted, and filtered. If no endpoints are available, the operation responds with an empty array.

Parameters

`‑APIEndpointID`	Int32Parameter sets: `ID`Pipeline input: ByValue The endpoint's ID.
`‑APIEndpointName`	StringParameter sets: `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.
`‑Category`	StringParameter sets: `Get all`Pipeline input: False Filters endpoints by the specified `-ApiCategoryName`, including the `UNCATEGORIZED` keyword.
`‑Contains`	StringParameter sets: `Get all`Pipeline input: False The search query substring criteria matching the endpoint's name, description, `basePath`, `apiCategoryName`, and `resourcePath`.
`‑ContractID`	StringParameter sets: `Get all`Pipeline input: False Filters endpoints to a specific contract. You need to specify this along with a `-GroupID`.
`‑EdgeRCFile`	StringPipeline input: False Your EdgeGrid resource file to authenticate your command. Defaults to `~/.edgerc`.
`‑GroupID`	Int32Parameter sets: `Get all`Pipeline input: False Filters endpoints to a specific group. You need to specify this along with a `-ContractID`.
`‑PIIOnly`	SwitchParameter sets: `Get all`Pipeline input: False Returns only endpoints with personally identifiable information (PII).
`‑Page`	Int32Parameter sets: `Get all`Pipeline input: False The page number index, starting at the default value of `1`.
`‑PageSize`	Int32Parameter sets: `Get all`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: `Get all`Pipeline input: False The type of endpoints to return based on their visibility status. Possible values are: `ALL` endpoints. You can instead decide to return. `ONLY_VISIBLE` endpoints. `ONLY_HIDDEN` endpoints.
`‑SortBy`	StringAccepted values: `Name`, `updateDate`Parameter sets: `Get all`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: `Get all`Pipeline input: False The sort order, either `desc` for descending or the default `asc` for ascending.
`‑VersionPreference`	StringAccepted values: `ACTIVATED_FIRST`, `LAST_UPDATED`Parameter sets: `Get all`Pipeline input: False 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 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.
`‑ProgressAction` Alias: `‑proga`	ActionpreferencePipeline input: False Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the `Write-Progress` cmdlet. The `Write-Progress` cmdlet creates progress bars that show a command's status. The `-ProgressAction` parameter takes one of the `-ActionPreference` enumeration values: `SilentlyContinue`, `Stop`, `Continue`, `Inquire`, `Ignore`, `Suspend`, or `Break`.

Related Links

Updated 5 days ago