Guide
  1. API Definitions
  2. Get

Hostnames

Synopsis

Get hostnames.

Syntax

Get-APIHostnames [-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.

Parameters

‑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.

‑ContractID
Required
StringPipeline 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
Required
IntPipeline input: False

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

‑Section
StringPipeline input: False

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

Related Links

Updated 3 months ago