Guide

Hostnames & groups

Get-APIHostnamesAndGroups

Suggest Edits

Synopsis

Get hostnames with access control groups.

Syntax

Get-APIHostnamesAndGroups [-GroupID] <Int32> [-ContractID] <String> [[-EdgeRCFile] <String>] [[-Section] <String>] [[-AccountSwitchKey] <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Description

Gets all hostnames through which API consumers can access an endpoint service under a given contract and group pairing. The operation returns each hostname together with the access control group where the hostname is registered.

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.
‑ContractID
Required
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
Required
Int Pipeline input: False

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

The section name in your EdgeGrid resource file to retrieve authentication credentials from. Defaults to default.

Related Links

Updated 6 days ago