Connect SendDrop

Connect-SendDrop

SYNOPSIS

Establishes a connection to the SendDrop API using a Bearer Token.

SYNTAX

Connect-SendDrop [[-Token] <Object>] [-Force] [[-APIuri] <String>] 
 [<CommonParameters>]

DESCRIPTION

The Connect-SendDrop function authenticates with the SendDrop API by storing the provided Bearer Token for use in subsequent API calls. If no token is provided, the function will prompt the user to enter it.

The Bearer Token is stored securely in memory for the duration of the PowerShell session.

EXAMPLES

EXAMPLE 1

Connect-SendDrop -Token "your-bearer-token-here" -APIuri "https://custom-api.senddrop.dev"

Connects to a custom SendDrop API endpoint using the specified Bearer Token.

EXAMPLE 2

Connect-SendDrop

Prompts for the Bearer Token and connects to SendDrop.

PARAMETERS

-APIuri

The base URI for the SendDrop API. Defaults to "https://api.senddrop.dev".

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 2
Default value: Https://api.senddrop.com/api/v1
Accept pipeline input: False
Accept wildcard characters: False

-Force

Force reconnection even if already connected.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-Token

The Bearer Token to use for authentication with the SendDrop API. If not provided, the function will prompt for it interactively.

Type: Object
Parameter Sets: (All)
Aliases: BearerToken, APIkey

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

NOTES

The Bearer Token is stored in a script-level variable and will persist for the current PowerShell session. To disconnect, restart PowerShell or call this function with a different token.

RELATED LINKS