Bucket hostname
Get-BucketHostname
Synopsis
Get hostnames for a property.
Syntax
Get-BucketHostname [-PropertyName] <String> -Network <String> [-GroupID <String>] [-ContractId <String>] [-OffSet <String>] [-Limit <String>] [-Sort <String>] [-HostnameFilter <String>] [-CNAMEToFilter <String>] [-IncludeCertStatus] [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
Get-BucketHostname -PropertyID <String> -Network <String> [-GroupID <String>] [-ContractId <String>] [-OffSet <String>] [-Limit <String>] [-Sort <String>] [-HostnameFilter <String>] [-CNAMEToFilter <String>] [-IncludeCertStatus] [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
Description
Gets active property hostnames on either the staging or production network. You can filter the results by -HostnameFilter
or -CNAMEToFilter
. Use the -IncludeCertStatus
switch to retrieve the property hostnames with the Secure by Default status.
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. |
‑CNAMEToFilter |
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 |
‑EdgeRCFile |
Your EdgeGrid resource file to authenticate your command. Defaults to |
‑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 |
‑HostnameFilter |
Filters the results by |
‑IncludeCertStatus |
When enabled, the response includes the certificate status for the hostname on staging and production networks. |
‑Limit |
For paginated responses, the number of |
‑Network Required |
The network to activate on, either |
‑OffSet |
For paginated responses, the page of results you want to navigate to, starting from |
‑PropertyID Conditionally required |
Your property's ID. Commonly, you only need to specify either |
‑PropertyName Conditionally required |
A human-readable name for your property. Commonly, you only need to specify either |
‑Section |
The section name in your EdgeGrid resource file to retrieve authentication credentials from. Defaults to |
‑Sort |
Sorts the results based on the |
Related Links
Updated 14 days ago