---
title: "Initiate an Appliance Backup."
slug: "initiate-an-appliance-backup-1"
updated: 2026-03-02T22:30:52Z
published: 2026-03-02T22:35:55Z
canonical: "support.appgate.com/initiate-an-appliance-backup-1"
---
> ## Documentation Index
> Fetch the complete documentation index at: https://support.appgate.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Initiate an Appliance Backup.
Post/appliances/{id}/backup
Initiate an Appliance Backup. The progress can be followed by polling the Appliance via "GET appliances//backup//status".
SecurityHTTPType bearer
Path parametersidstring (uuid) Required
ID of the object.
Example12699e27-b584-464a-81ee-5b4784b6d425
Body parameters
Appliance Backup parameters.
object logsboolean
Whether the Appliance Backup should include syslog or not.
auditboolean
Whether the Appliance Backup should include the audit logs or not.
notifyUrlstring
URL to send a POST request to notify about the completion of the backup, that it can now be downloaded and deleted.
Responses202
Appliance Backup has begun.
object idstring (uuid)
Appliance Backup ID to be used as path parameter to follow the progress.
Example4c07bc67-57ea-42dd-b702-c2d6c45419fc
400
JSON error. Check the JSON format.
object
Generic HTTP error.
idstring
Machine readable error code.
messagestring
Human readable error details.
401
Token error. Login again.
object
Generic HTTP error.
idstring
Machine readable error code.
messagestring
Human readable error details.
403
Insufficient permissions to access this resource.
object
Generic HTTP error.
idstring
Machine readable error code.
messagestring
Human readable error details.
404
The requested resource can not be found.
object
Generic HTTP error.
idstring
Machine readable error code.
messagestring
Human readable error details.
406
Invalid 'Accept' header.
object
Generic HTTP error.
idstring
Machine readable error code.
messagestring
Human readable error details.
412
Appliance is not in the right state for this operation.
object
Generic HTTP error.
idstring
Machine readable error code.
messagestring
Human readable error details.
500
Unexpected server side error.
object
Generic HTTP error.
idstring
Machine readable error code.
messagestring
Human readable error details.
503
Service unavailable error.
object
Generic HTTP error.
idstring
Machine readable error code.
messagestring
Human readable error details.