This API may be run on a source or a target. If run on a target, the system ID is that of the source and is run remotely as a REST call.

Allows a user to modify the replication queue by first deleting a series of backups and targets or deleting all backups associated with a particular client or instance, and if desired, re-adding the backups to the end of the queue.

PUT /api/replication/queue
Host: <server host name>
Accept: application/json
AuthToken: <authentication token returned from authenticate>

Modifies the replication queue based on these parameters.

• | id - backup id | long | required
• | target - target name | string | required clients | clients' backups to delete | array of strings | either backups or clients or instances must be specified
• | name - name of client for which all backups/targets are to be deleted | string | required instances | app instance's backups to delete | array of strings | either backups or clients or instances must be specified
• | name of instance for which all backups are to be deleted | string | required action | actions to take after delete | string | required
• | none - remove from the queue, do not re-add |
• | reset - remove from the queue, re-add to the end |

200 success

None.

PUT /api/replication/queue
Host: <server host name>
Accept: application/json
AuthToken: 8a00sjerhterqerjlqkjlk443l4j56869h4f_)(fjdkasHHHHHkdal324

{
  "backups": [
        {
           "id": 341238,
           "target": "cloud-1"
        },
        {
           "id": 34142,
           "target": "cloud-1"
        }
  ],
  "action": "none"
}
 

HTTP Status: 200 (OK)

Failed replication queue modification will return HTTP Status 500 with a result object with an error message and KB link as defined here