Property hostname

Get-PropertyHostname

Synopsis

Get hostnames for a property version.

Syntax

Get-PropertyHostname [-Offset <Int32>] [-Limit <Int32>] [-Sort <String>] [-Hostname <String>] [-CnameTo <String>] [-Network <String>] [-GroupID <String>] [-ContractId <String>] [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
Get-PropertyHostname [-PropertyName] <String> [-PropertyVersion] <String> [-ValidateHostnames] [-IncludeCertStatus] [-GroupID <String>] [-ContractId <String>] [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
Get-PropertyHostname -PropertyID <String> [-PropertyVersion] <String> [-ValidateHostnames] [-IncludeCertStatus] [-GroupID <String>] [-ContractId <String>] [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Description

Gets all hostnames for an entire account, or a specified property version. You can specify a property by its name, ID, or version. The -PropertyVersion parameter is either an integer or the word latest.

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.

‑CnameTo

Filters the results by edge hostname. Supports wildcard matches with *.

‑ContractId

Your contract's ID. The parameter is optional if a property belongs to only one contract; otherwise, you need to specify it along with the -GroupID. This parameter is optional except for the create requests.

‑EdgeRCFile

Your EdgeGrid resource file to authenticate your command. Defaults to ~/.edgerc.

‑GroupID

Your group's ID. The parameter is optional if a property belongs to only one group, otherwise you need to specify it along with the -ContractID. This parameter is optional except for the create requests.

‑Hostname

The cnameFrom for the hostname your end users see, indicated by the Host header in the end-user requests.

‑IncludeCertStatus

When enabled, the response includes the certificate status for the hostname on staging and production networks.

‑Limit

For paginated responses, the number of hostnames objects to include on each page.

‑Network

The network to activate on, either STAGING or PRODUCTION.

‑Offset

For paginated responses, the page of results you want to navigate to, starting from 0.

‑PropertyID
Conditionally required

Your property's ID. Commonly, you only need to specify either -PropertyName or -PropertyID.

‑PropertyName
Conditionally required

A human-readable name for your property. Commonly, you only need to specify either -PropertyName or -PropertyID.

‑PropertyVersion
Conditionally required

Property's incremental version number. Can be an integer or the word latest.

‑Section

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

‑Sort

Sorts the results based on the cnameFrom value, either hostname:a for ascending or hostname:d for descending order. The default is hostname:a.

‑ValidateHostnames

When enabled, runs validation tests that would identify potential hostname-related problems within the response object's errors and warnings arrays.

Related Links