New-FilesHistoryExport
Create History Export.
Syntax
Description
Create History Export.
The command supports -WhatIf, which describes the change without sending it to Files.com, and -Confirm, which asks before sending it.
Examples
Example 1: Create History Export
Writes the history export returned.
Example 2: Preview the change
Describes the change without sending anything to Files.com.
Parameters
-UserId
User ID. Provide a value of 0 to operate the current session's user.
- Type:
System.Int64 - Parameter sets:
(All)
-StartAt
Start date/time of export range. Give a DateTime from Get-Date, a DateTimeOffset, or ISO 8601 text with an offset such as 2026-01-31T14:00:00Z.
- Type:
System.DateTimeOffset - Parameter sets:
(All)
-EndAt
End date/time of export range. Give a DateTime from Get-Date, a DateTimeOffset, or ISO 8601 text with an offset such as 2026-01-31T14:00:00Z.
- Type:
System.DateTimeOffset - Parameter sets:
(All)
-QueryAction
Filter results by this this action type. Valid values: create, read, update, destroy, move, login, failedlogin, copy, user_create, user_update, user_destroy, group_create, group_update, group_destroy, permission_create, permission_destroy, api_key_create, api_key_update, api_key_destroy, archived_delete
- Type:
System.String - Parameter sets:
(All)
-QueryInterface
Filter results by this this interface type. Valid values: web, ftp, robot, jsapi, webdesktopapi, sftp, dav, desktop, restapi, scim, office, mobile, as2, inbound_email, remote, inbound_s3
- Type:
System.String - Parameter sets:
(All)
-QueryUserId
Return results that are actions performed by the user indicated by this User ID
- Type:
System.String - Parameter sets:
(All)
-QueryFileId
Return results that are file actions related to the file indicated by this File ID
- Type:
System.String - Parameter sets:
(All)
-QueryParentId
Return results that are file actions inside the parent folder specified by this folder ID
- Type:
System.String - Parameter sets:
(All)
-QueryPath
Return results that are file actions related to paths matching this pattern.
- Type:
System.String - Parameter sets:
(All)
-QueryFolder
Return results that are file actions related to files or folders inside folder paths matching this pattern.
- Type:
System.String - Parameter sets:
(All)
-QuerySrc
Return results that are file moves originating from paths matching this pattern.
- Type:
System.String - Parameter sets:
(All)
-QueryDestination
Return results that are file moves with paths matching this pattern as destination.
- Type:
System.String - Parameter sets:
(All)
-QueryIp
Filter results by this IP address.
- Type:
System.String - Parameter sets:
(All)
-QueryUsername
Filter results by this username.
- Type:
System.String - Parameter sets:
(All)
-QueryFailureType
If searching for Histories about login failures, this parameter restricts results to failures of this specific type. Valid values: expired_trial, account_overdue, locked_out, ip_mismatch, password_mismatch, site_mismatch, username_not_found, none, no_ftp_permission, no_web_permission, no_directory, errno_enoent, no_sftp_permission, no_dav_permission, no_restapi_permission, key_mismatch, region_mismatch, expired_access, desktop_ip_mismatch, desktop_api_key_not_used_quickly_enough, disabled, country_mismatch, insecure_ftp, insecure_cipher, rate_limited, no_s3_compatible_endpoint_permission, mobile_ip_mismatch, mobile_api_key_not_used_quickly_enough, desktop_app_disabled, mobile_app_disabled
- Type:
System.String - Parameter sets:
(All)
-QueryTargetId
If searching for Histories about specific objects (such as Users, or API Keys), this parameter restricts results to objects that match this ID.
- Type:
System.String - Parameter sets:
(All)
-QueryTargetName
If searching for Histories about Users, Groups or other objects with names, this parameter restricts results to objects with this name/username.
- Type:
System.String - Parameter sets:
(All)
-QueryTargetPermission
If searching for Histories about Permissions, this parameter restricts results to permissions of this level.
- Type:
System.String - Parameter sets:
(All)
-QueryTargetUserId
If searching for Histories about API keys, this parameter restricts results to API keys created by/for this user ID.
- Type:
System.String - Parameter sets:
(All)
-QueryTargetUsername
If searching for Histories about API keys, this parameter restricts results to API keys created by/for this username.
- Type:
System.String - Parameter sets:
(All)
-QueryTargetPlatform
If searching for Histories about API keys, this parameter restricts results to API keys associated with this platform.
- Type:
System.String - Parameter sets:
(All)
-QueryTargetPermissionSet
If searching for Histories about API keys, this parameter restricts results to API keys with this permission set.
- Type:
System.String - Parameter sets:
(All)
-Connection
The connection to use, from Connect-FilesAccount. Defaults to the connection of the -InputObject or -Continuation given, and otherwise to the current runspace's default connection.
- Type:
FilesCom.PowerShell.FilesConnection - Parameter sets:
(All)
-WorkspaceScope
Runs this command's requests in this workspace, including workspace 0, instead of the connection's or, for an -InputObject, instead of the workspace the object was read in. The connection and the object are unchanged.
- Type:
System.Int64 - Parameter sets:
(All)
-NoWorkspaceScope
Runs this command's requests in no workspace, even if the connection has one. The connection itself is unchanged.
- Type:
System.Management.Automation.SwitchParameter - Parameter sets:
(All)
-Confirm
Prompts you for confirmation before running the cmdlet.
- Type:
System.Management.Automation.SwitchParameter - Confirm impact: Medium. At the default
$ConfirmPreferenceofHigh, the command runs without asking;-Confirmmakes it ask before each change.
-WhatIf
Shows what the cmdlet would change without sending anything to Files.com.
- Type:
System.Management.Automation.SwitchParameter
Common Parameters
This cmdlet supports the PowerShell common parameters, such as -Verbose and -ErrorAction.
Inputs
None. The command takes no pipeline input.
Outputs
FilesCom.PowerShell.Models.HistoryExport: the history export as Files.com returned it.
Notes
Failures are written as error records with IDs such as Files.NotFound or Files.Authentication. Run Get-Help about_FilesCom for connections, paging, errors and previewing changes.