Skip to content

Latest commit

 

History

History
79 lines (59 loc) · 2.2 KB

Get-ShlinkDomains.md

File metadata and controls

79 lines (59 loc) · 2.2 KB
external help file Module Name online version schema
PSShlink-help.xml
PSShlink
2.0.0

Get-ShlinkDomains

SYNOPSIS

Returns the list of all domains ever used, with a flag that tells if they are the default domain

SYNTAX

Get-ShlinkDomains [[-ShlinkServer] <String>] [[-ShlinkApiKey] <SecureString>] [<CommonParameters>]

DESCRIPTION

Returns the list of all domains ever used, with a flag that tells if they are the default domain

EXAMPLES

EXAMPLE 1

Get-ShlinkDomains

Returns the list of all domains ever used, with a flag that tells if they are the default domain

PARAMETERS

-ShlinkServer

The URL of your Shlink server (including schema). For example "https://example.com". It is not required to use this parameter for every use of this function. When it is used once for any of the functions in the PSShlink module, its value is retained throughout the life of the PowerShell session and its value is only accessible within the module's scope.

Type: String
Parameter Sets: (All)
Aliases:

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

-ShlinkApiKey

A SecureString object of your Shlink server's API key. It is not required to use this parameter for every use of this function. When it is used once for any of the functions in the PSShlink module, its value is retained throughout the life of the PowerShell session and its value is only accessible within the module's scope.

Type: SecureString
Parameter Sets: (All)
Aliases:

Required: False
Position: 2
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

This function does not accept pipeline input.

OUTPUTS

System.Management.Automation.PSObject

NOTES

RELATED LINKS