This setting allows users to set the temporary folder path. The request is wrapped inside a "tempFolder" block.
This section provides the following topics:
- Input Parameters
- Output Parameters
- Returned Status Codes
- Error codes
Input Parameters
The following table provides the input parameters and descriptions.
Input Parameter | Description |
path | Sets the temporary folder path. This path can be either a local path or a network path. |
credentials | Describes the required data to log in to a secured network path, if necessary and it has the following children:
Note: The credentials are only used by the network path and thus should not be sent along a local path. Even if the path is set to a network path, the credentials can be omitted (the network does not require authentication) or can be set to empty strings as follows in usages. |
Output Parameters
The output is the "actionId" of the operation, which can be used to track completion status via the Action Status command:
GET {siteUrl}/v2/accounts/{accountUserName}/computers/{subaccountId}/action/{actionId}/status
Request example
{
"tempFolder": {
"path": string
"credentials": {
"username": string (can be empty),
"password": string (can be empty)
}
}
}
Online operation:
Response status: 200 OK
Offline operation:
The output is an id of the operation, which can be used to track completion status via the command below.
Response status: 202 Accepted
Response example
{
"data": {
"id": "1"
}
}
Returned Status Codes
The following table provides the returned status codes.
Returned Status Codes | Description |
200 | The request was successful. |
202 | The request was accepted and is processed when the agent is online. The returned id can be used to check the status of the operation. |
400 | Validation errors. |
401 | Authentication errors. |
Usage Examples
There are multiple combinations of the parameters above, resulting in different outcomes:
Set the temp folder path to a local path:
{
"tempFolder": {
"path": "C:\\Users"
}
}
Set the temp folder path to a network path using the IP address, without authentication:
{
"tempFolder": {
"path": "\\\\1.2.3.4\\share"
}
}
Set the temp folder path to a network path using the domain-name, without authentication:
{
"tempFolder": {
"path": "\\\\my-domain.com\\share"
}
}
Set the temp folder path to a network path using the IP address, with authentication:
{
"tempFolder": {
"path": "\\\\1.2.3.4\\share",
"credentials": {
"username": "some_username",
"password": "some_password"
}
}
}
Set the temp folder path to a network path using the domain-name, with authentication:
{
"tempFolder": {
"path": "\\\\my-domain.com\\share",
"credentials": {
"username": "some_username",
"password": "some_password"
}
}
}
Note: The username and password fields can be sent as empty strings individually.
Error Codes
- Running_Actions_PreventPreferencesUpdate - cannot update preferences while Backups, Restores or Deletes are running
- Running_Actions_FailedToAcquireLock - critical error, failed to acquire lock for the operation (this never happens)
Network shares only:
- BackupSetActions_NetworkShareInaccessible - network share address could not be reached
- BackupSetActions_NetworkPathNotFound - the network path could not be found
- BackupSetActions_NetworkShareInvalidAuth - username + password combination failed authentication
- BackupSetActions_NetworkShareNoWritePermissions - username and password ok, but no write permissions for the provided username on that share.
- CreateFolderFailed: general error, failed to create the folder on the file system . Most likely a volume is read only or cannot be written to due to missing permissions on the file system. More details may be available in the agent log.