Skip to main content

Get-PDHostedSPF

SYNOPSIS​

Retrieves the Hosted SPF (PowerSPF) configuration for one or more PowerDMARC domains.

SYNTAX​

Get-PDHostedSPF [[-DomainId] <Int32[]>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

DESCRIPTION​

Calls the PowerDMARC Hosted SPF API for each domain ID and returns the SPF mechanisms PowerDMARC is currently hosting/flattening on that domain's behalf. Requires an active connection created with Connect-PowerDMARC.

Behavior depends on the mode (and root URI) stored by Connect-PowerDMARC:

  • Default mode (root /api/v1): `GET /hostedspf/{domainId}`
  • Reseller mode (root /api/v1/mssp): `GET /hosted/spf/{domainId}`

EXAMPLES​

EXAMPLE 1​

Get-PDHostedSPF -DomainId 12345

EXAMPLE 2​

12345, 67890 | Get-PDHostedSPF

EXAMPLE 3​

Get-PDDomain | Get-PDHostedSPF

EXAMPLE 4​

Select-PDDomain -DomainId 12345
Get-PDHostedSPF

PARAMETERS​

-DomainId​

The PowerDMARC domain ID(s) to retrieve the Hosted SPF configuration for. Accepts pipeline input, including by property name (e.g. piped from Get-PDDomain). Defaults to the domain selected via Select-PDDomain, if any.

Type: Int32[]
Parameter Sets: (All)
Aliases: Id

Required: False
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False

-ProgressAction​

Fill ProgressAction Description

Type: ActionPreference
Parameter Sets: (All)
Aliases: proga

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters​

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS​

OUTPUTS​

System.Management.Automation.PSObject​

NOTES​

https://api.powerdmarc.com/api/end-user/api-v-1-documentation

https://api.powerdmarc.com/api/mssp/api-v-1-documentation