Request-PBackup

NAME Request-PBackup



SYNOPSIS

Requests a backup of your Populi data, delivered as a ZIP file in CSV format.

You can be notified by email when it's ready for download, or have an HTTP request made to another web application.





SYNTAX

Request-PBackup [-PopuliUri] <String> [-PopuliAuthkey] <String> [-OnCompleteEmail <MailAddress>] [-OnCompleteUrl

<Uri>] [<CommonParameters>]





DESCRIPTION

The <BackupId> returned is the ID of the backup request (the same ID that will be passed to on_complete_url).

See downloadBackup to download the backup after it's completed.





PARAMETERS

-PopuliUri <String>

Set to the correct URL for your college (i.e. https://<YOUR_SUBDOMAIN_HERE>.populiweb.com/api/).

This parameter is required.



Required? true

Position? 1

Default value

Accept pipeline input? false

Accept wildcard characters? false



-PopuliAuthkey <String>

The authentication key with necessary permissions for the data you are requesting.

This parameter is required.



Required? true

Position? 2

Default value

Accept pipeline input? false

Accept wildcard characters? false



-OnCompleteEmail <MailAddress>

Where to send the "Backup Ready for Download" email.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-OnCompleteUrl <Uri>

If set, when the backup is ready for download we'll make an HTTP request to this URL, including the backup_id

as a POST variable.



Required? false

Position? named

Default value

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



OUTPUTS

Returns PowerShell objects:

BackupId





NOTES





Author: Matthew Rehm

Creation Date: 02/07/2019



-------------------------- EXAMPLE 1 --------------------------



Request-PBackup -PopuliUri 'https://<YOUR_SUBDOMAIN_HERE>.populiweb.com/api/ -PopuliAuthkey '1234567890'

-OnCompleteEmail "mtest@school.com"













-------------------------- EXAMPLE 2 --------------------------



PS C:\\>#Store your Populi Credentials in a hash table:



$PopuliCredentials = @{

PopuliURI = https://<YOUR_SUBDOMAIN_HERE>.populiweb.com/api/

PopuliAuthkey = '1ReallyLongAlphaNumericSequence'

}

Request-PBackup @PopuliCredentials











RELATED LINKS