| external help file | Module Name | online version | schema |
|---|---|---|---|
PSShlink-help.xml |
PSShlink |
2.0.0 |
Removes a short code from the Shlink server
Remove-ShlinkUrl [-ShortCode] <String[]> [[-Domain] <String>] [[-ShlinkServer] <String>]
[[-ShlinkApiKey] <SecureString>] [-WhatIf] [-Confirm] [<CommonParameters>]
Removes a short code from the Shlink server
Remove-ShlinkUrl -ShortCode "profile" -WhatIf
Reports what would happen if the command was invoked, because the -WhatIf parameter is present.
Remove-ShlinkUrl -ShortCode "profile" -Domain "example.com"
Removes the short code "profile" associated with the domain "example.com" from the Shlink server.
Get-ShlinkUrl -SearchTerm "oldwebsite" | Remove-ShlinkUrl
Removes all existing short codes which match the search term "oldwebsite".
"profile", "house" | Remove-ShlinkUrl
Removes the short codes "profile" and "house" from the Shlink instance.
The name of the short code you wish to remove from the Shlink server.
Type: String[]
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: FalseThe domain associated with the short code you wish to remove from the Shlink server. This is useful if your Shlink instance is responding/creating short URLs for multiple domains.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseThe 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: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseA 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: 4
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseShows what would happen if the cmdlet runs. The cmdlet is not run.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalsePrompts you for confirmation before running the cmdlet.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseThis cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.