Pitchfork - Cloud Backup

Agent Operations

Delete Agent

/v1.0/{ddi}/agent/delete

Permanently and immediately delete an agent

View Documentation

Warning! This action can be destructive or can result in additional charges to the account.

	Parameter		Type	Required	Description
	agent_id		integer	Yes	Agent ID

* Required for API Call

Enable Or Disable Agent

/v1.0/{ddi}/agent/enable

Enables or Disables the agent. Only stops agent from making backups.

View Documentation

Warning! This action can be destructive or can result in additional charges to the account.

	Parameter		Type	Required	Description
	agent_id		integer	Yes	Agent ID
	enabled		boolean	Yes	Enable or Disable the agent

* Required for API Call

Get Agent Details

/v1.0/{ddi}/agent/{agent_id}

Get xdetails about the machine and the agent

View Documentation

	Parameter		Type	Required	Description
	agent_id		integer	Yes	Agent ID

* Required for API Call

List Agents By Server

/v1.0/{ddi}/agent/server/{server_id}

Lists details about the server and its agent

View Documentation

	Parameter		Type	Required	Description
	server_id		text	Yes	Server UUID

* Required for API Call

Migrate Vault

/v1.0/{ddi}/agent/migratevault

Migrate a backup valut from one machine agent to another

View Documentation

Warning! This action can be destructive or can result in additional charges to the account.

	Parameter		Type	Required	Description
	source_agent_id		integer	Yes	Source Agent ID
	dest_agent_id		integer	Yes	Destination Agent ID

* Required for API Call

Update Agent Backup Behavior

/v1.0/{ddi}/agent/{agent_id}

Updates the backup data center and can enable or disable ServiceNet for the agent

View Documentation

Warning! This action can be destructive or can result in additional charges to the account.

Parameter	Type	Required	Description
agent_id	integer	Yes	Agent ID
use_snet	boolean	Yes	Use service net for agent
new_data_center	text	No	Data center to use for backup data

* Required for API Call

Wakeup Agent

/v1.0/{ddi}/user/wakeupagents

Wake up the agent before doing any tasks as it sleeps

View Documentation

Warning! This action can be destructive or can result in additional charges to the account.

Backup Configurations

Create Backup Config

/v1.0/{ddi}/backup-configuration

Creates a backup configuration

View Documentation

Warning! This action can be destructive or can result in additional charges to the account.

Parameter	Type	Required	Description
backup_name	text	Yes	Name of Backup
agent_id	integer	Yes	Agent ID
is_active	boolean	Yes	Is backup active or not
backup_rentention	integer	Yes	Retention period in days. 0 means indefinite
backup_frequency	text	Yes	Frequency of backups
notify_recipient	text	Yes	Email address to notify on success or failure
notify_success	boolean	Yes	Emails are sent on success
notify_failure	boolean	Yes	Emails are sent on failure
missed_action_id	integer	Yes	Missed Backup Action ID: 1 - Send notification immediately 2 - Send next scheduled run
start_hour	integer	Yes	Daily/Weekly Start Hour. Leave null if not applicable
start_minute	integer	Yes	Daily/Weekly Start Minute. Leave null if not applicable
start_time_of_day	text	Yes	Daily/Weekly Start time of Day. Leave null if it does not apply
day_of_week	integer	Yes	Weekly Start Day. 0 is Sunday and leave null if not applicable
hour_interval	text	Yes	Hourly Interval. Leave null if it does not apply
time_zone	text	Yes	Specify the time zone for backups
inclusion_item_path	text	Yes	Include item path in backup
inclusion_item_type	text	Yes	Include path type
excluded_item_path	text	No	Excluded item path if needed
excluded_item_type	text	No	Excluded item type

* Required for API Call

Delete Backup Config

/v1.0/{ddi}/backup-configuration/{backup_config_id}

Deletes the specified backup configuration

View Documentation

Warning! This action can be destructive or can result in additional charges to the account.

	Parameter		Type	Required	Description
	backup_config_id		integer	Yes	Backup Config ID

* Required for API Call

Get All Backup Configs For Agent

/v1.0/{ddi}/backup-configuration/system/{agent_id}

Get a list of all backup configurations for the specified agent

View Documentation

	Parameter		Type	Required	Description
	agent_id		integer	Yes	Agent ID

* Required for API Call

Get All Backup Configurations

/v1.0/{ddi}/backup-configuration

Get Backup Configuration Details

/v1.0/{ddi}/backup-configuration/{backup_config_id}

Get detailed information for a specified backup configuration

View Documentation

	Parameter		Type	Required	Description
	backup_config_id		integer	Yes	Backup Configuration ID

* Required for API Call

Update Backup Config

/v1.0/{ddi}/backup-configuration/{backup_config_id}

Updates a backup configuration

View Documentation

Warning! This action can be destructive or can result in additional charges to the account.

Parameter	Type	Required	Description
backup_config_id	integer	Yes	Backup Configuration ID
backup_schedule_id	integer	Yes	Backup Config Schedule ID
backup_name	text	Yes	Name of Backup
agent_id	integer	Yes	Agent ID
is_active	boolean	Yes	Is backup active or not
backup_rentention	integer	Yes	Retention period in days. 0 means indefinite
backup_frequency	text	Yes	Frequency of backups
notify_recipient	text	Yes	Email address to notify on success or failure
notify_success	boolean	Yes	Emails are sent on success
notify_failure	boolean	Yes	Emails are sent on failure
missed_action_id	integer	Yes	Missed Backup Action ID: 1 - Send notification immediately 2 - Send next scheduled run
start_hour	integer	Yes	Daily/Weekly Start Hour. Leave null if not applicable
start_minute	integer	Yes	Daily/Weekly Start Minute. Leave null if not applicable
start_time_of_day	text	Yes	Daily/Weekly Start time of Day. Leave null if it does not apply
day_of_week	integer	Yes	Weekly Start Day. 0 is Sunday and leave null if not applicable
hour_interval	text	Yes	Hourly Interval. Leave null if it does not apply
time_zone	text	Yes	Specify the time zone for backups
inclusion_item_path	text	Yes	Include item path in backup
inclusion_item_type	text	Yes	Include path type
excluded_item_path	text	No	Excluded item path if needed
excluded_item_type	text	No	Excluded item type

* Required for API Call

Backup Operations

Enable - Disable Backup Config

/v1.0/{ddi}/backup-configuration/enable/{backup_config_id}

Enable or disable the specified backup configuration

View Documentation

Warning! This action can be destructive or can result in additional charges to the account.

	Parameter		Type	Required	Description
	backup_config_id		integer	Yes	Backup Config ID
	enabled		boolean	Yes	Enabled or Disabled

* Required for API Call

Get Backup Details

/v1.0/{ddi}/backup/{backup_id}

Get details about the specified backup

View Documentation

	Parameter		Type	Required	Description
	backup_id		integer	Yes	Backup ID

* Required for API Call

Get Backup Report

/v1.0/{ddi}/backup/report/{backup_id}

Get details about the completed backup

View Documentation

	Parameter		Type	Required	Description
	backup_id		integer	Yes	Backup ID

* Required for API Call

Get Completed Backups

/v1.0/{ddi}/backup/completed/{backup_config_id}

Get the details for backups that can still be restored

View Documentation

	Parameter		Type	Required	Description
	backup_config_id		integer	Yes	Backup Configuration ID

* Required for API Call

Start - Stop Backup

/v1.0/{ddi}/backup/action-requested

Start or stop a backup manually

View Documentation

Warning! This action can be destructive or can result in additional charges to the account.

	Parameter		Type	Required	Description
	action		text	Yes	Action desired
	backup_config_id		integer	Yes	Backup Configuration ID

* Required for API Call

Restore Configurations

Create Restore Config

/v1.0/{ddi}/restore

Create a restore configuration file

View Documentation

Warning! This action can be destructive or can result in additional charges to the account.

Parameter	Type	Required	Description
backup_id	integer	Yes	Backup ID
backup_machine_id	integer	Yes	Backup Machine ID
dest_machine_id	integer	Yes	Destination Machine ID
dest_restore_path	text	Yes	Restore Path on destination machine
overwrite	boolean	Yes	Overwrite existing files
backup_data_center	text	No	Data center that had the original agent where the backup was created

* Required for API Call

Delete Restore Config

/v1.0/{ddi}/restore-configuration/{restore_id}

Delete the specified restore configuration

View Documentation

Warning! This action can be destructive or can result in additional charges to the account.

	Parameter		Type	Required	Description
	restore_id		integer	Yes	Restore Config ID

* Required for API Call

Include - Exclude File In Restore Config

/v1.0/{ddi}/restore/files

Include or Exclude a path or file for a restore config

View Documentation

Warning! This action can be destructive or can result in additional charges to the account.

Parameter	Type	Required	Description
restore_id	integer	Yes	Restore Config ID
item_type	integer	Yes	Item type 0:File 1:Folder 2:Database
item_path	text	Yes	Path of file or folder
include_exclude	text	Yes	Include or Exclude item 1:Include 2:Exclude
encoded_item_path	text	No	64 bit encoding of file path

* Required for API Call

List Included - Excluded Files In Restore Config

/v1.0/{ddi}/restore/files/{restore_id}

List all files that are included or excluded in a restore config

View Documentation

	Parameter		Type	Required	Description
	restore_id		integer	Yes	Restore COnfig ID

* Required for API Call

Update Restore Config

/v1.0/{ddi}/restore

Udates the specified restore config

View Documentation

Warning! This action can be destructive or can result in additional charges to the account.

Parameter	Type	Required	Description
restore_id	integer	Yes	Restore Configuration ID
backup_id	integer	Yes	Backup ID
backup_machine_id	integer	Yes	Backup Machine ID
dest_machine_id	integer	Yes	Destination Machine ID
dest_restore_path	text	Yes	Destination Restore Path
backup_config_id	integer	Yes	Backup Config ID associated with backup
overwrite	text	Yes	Overwrite files

* Required for API Call

Restore Operations

Get Details About Restore

/v1.0/{ddi}/restore/{restore_id}

Get details about the specified restore

View Documentation

	Parameter		Type	Required	Description
	restore_id		integer	Yes	Restore ID

* Required for API Call

Get Restore Report

/v1.0/{ddi}/restore/report/{restore_id}

Gets the details for a completed restore

View Documentation

	Parameter		Type	Required	Description
	restore_id		integer	Yes	Restore ID

* Required for API Call

List Backups Available For Restore

/v1.0/{ddi}/backup/availableforrestore

Start - Stop Restore

/v1.0/{ddi}/restore/action-requested

Start or stop a restore manually

View Documentation

Warning! This action can be destructive or can result in additional charges to the account.

Parameter	Type	Required	Description
action	text	Yes	Action to perform
restore_id	integer	Yes	Restore ID
password	text	No	Password if setup with encryption

* Required for API Call

User Operations

List Agents For User

/v1.0/{ddi}/user/agents

Activity

List Activity For Agent

/v1.0/{ddi}/system/activity/{agent_id}

Lists all activity for the specified agent

View Documentation

	Parameter		Type	Required	Description
	agent_id		integer	Yes	Agent ID

* Required for API Call

List Activity For User

/v1.0/{ddi}/activity

Cloud Backup - API Calls

Agent Operations

Request URL

Request Headers

Request Data Object

Response Headers

Response Body

Request URL

Request Headers

Request Data Object

Response Headers

Response Body

Request URL

Request Headers

Request Data Object

Response Headers

Response Body

Request URL

Request Headers

Request Data Object

Response Headers

Response Body

Request URL

Request Headers

Request Data Object

Response Headers

Response Body

Request URL

Request Headers

Request Data Object

Response Headers

Response Body

Request URL

Request Headers

Request Data Object

Response Headers

Response Body

Backup Configurations

Request URL

Request Headers

Request Data Object

Response Headers

Response Body

Request URL

Request Headers

Request Data Object

Response Headers

Response Body

Request URL

Request Headers

Request Data Object

Response Headers

Response Body

Request URL

Request Headers

Request Data Object

Response Headers

Response Body

Request URL

Request Headers

Request Data Object

Response Headers

Response Body

Request URL

Request Headers

Request Data Object

Response Headers

Response Body

Backup Operations

Request URL

Request Headers

Request Data Object

Response Headers

Response Body

Request URL

Request Headers

Request Data Object

Response Headers

Response Body

Request URL