< Back
Connect-MXOnline
Post
NAME Connect-MXOnline
SYNOPSIS
Connects to MxToolBox RESTful API by setting the global variable $MXAPIKEY
SYNTAX
Connect-MXOnline [-MXAPI_key] <String> [<CommonParameters>]
DESCRIPTION
Connects to MxToolBox RESTful API by setting the global variable $MXAPIKEY. The MxAPIKEY can be found once logged
into the site https://mxtoolbox.com/restapi.aspx
PARAMETERS
-MXAPI_key <String>
The MXToolBox API key. This key can be found by navigating to 'https://mxtoolbox.com/restapi.aspx' in a web
browser
Required? true
Position? 0
Default value None
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
None
OUTPUTS
System.Object
NOTES
-------------------------- Example 1 --------------------------
PS C:\\> Connect-MXOnline -MXAPI_key '8208nota-v317-4787-8841-a16l919i12dk'
Sets the MXAPIKEY to '8208nota-v317-4787-8841-a16l919i12dk' and validates connectivity to MxToolbox.
RELATED LINKS
Online Help Connect-MXOnline https://github.com/scottd3v/PlayGround/ ... XOnline.md
SYNOPSIS
Connects to MxToolBox RESTful API by setting the global variable $MXAPIKEY
SYNTAX
Connect-MXOnline [-MXAPI_key] <String> [<CommonParameters>]
DESCRIPTION
Connects to MxToolBox RESTful API by setting the global variable $MXAPIKEY. The MxAPIKEY can be found once logged
into the site https://mxtoolbox.com/restapi.aspx
PARAMETERS
-MXAPI_key <String>
The MXToolBox API key. This key can be found by navigating to 'https://mxtoolbox.com/restapi.aspx' in a web
browser
Required? true
Position? 0
Default value None
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
None
OUTPUTS
System.Object
NOTES
-------------------------- Example 1 --------------------------
PS C:\\> Connect-MXOnline -MXAPI_key '8208nota-v317-4787-8841-a16l919i12dk'
Sets the MXAPIKEY to '8208nota-v317-4787-8841-a16l919i12dk' and validates connectivity to MxToolbox.
RELATED LINKS
Online Help Connect-MXOnline https://github.com/scottd3v/PlayGround/ ... XOnline.md