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 |
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 |
Filters endpoints by the specified |
‑Contains |
The search query substring criteria matching the endpoint's name, description, |
‑ContractID |
Filters endpoints to a specific contract. You need to specify this along with a |
‑EdgeRCFile |
Your EdgeGrid resource file to authenticate your command. Defaults to |
‑GroupID |
Filters endpoints to a specific group. You need to specify this along with a |
‑PIIOnly |
Returns only endpoints with personally identifiable information (PII). |
‑Page |
The page number index, starting at the default value of |
‑PageSize |
The number of endpoints on each page of results, |
‑Section |
The section name in your EdgeGrid resource file to retrieve authentication credentials from. Defaults to |
‑Show |
The type of endpoints to return based on their visibility status. By default the API returns |
‑SortBy |
The field to sort endpoints by, either the API |
‑SortOrder |
The sort order, either |
‑VersionPreference |
The preference for selecting the endpoint version to return. By default, the API returns the If you set the preference to |
Related Links
Updated 16 days ago