Device backup and disaster recovery — backups, qkview jobs, and NetScaler backup jobs. Auto-generated from the platform OpenAPI schema so it matches the running API.
REST API for this feature — 16 operations across 12 resource paths, auto-generated from the platform's live OpenAPI schema (drf-spectacular).
Base URL
https://<your-versus-host>/api· AuthAuthorization: Bearer <JWT>(fromPOST /api/auth/token/) · 📄 Download the OpenAPI spec for Postman/Insomnia/Swagger · see the API overview for pagination, filtering, and errors.
GET /api/backups/List backups
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
backup_type | query | no | string | * ucs - UCS |
device | query | no | integer | |
ordering | query | no | string | Which field to use when ordering the results. |
page | query | no | integer | A page number within the paginated result set. |
page_size | query | no | integer | Number of results to return per page. |
search | query | no | string | A search term. |
Responses: 200 → PaginatedBackupList
POST /api/backups/Create backup
Request body (application/json): BackupRequest
Responses: 201 → Backup
GET /api/backups/diff/Return a unified diff of one file between two backups.
Responses: 200 → Backup
GET /api/backups/latest/Return the most recent backup for a device identified by name or ID.
Responses: 200 → Backup
GET /api/backups/{id}/Retrieve backup
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this backup. |
Responses: 200 → Backup
PUT /api/backups/{id}/Update backup
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this backup. |
Request body (application/json): BackupRequest
Responses: 200 → Backup
PATCH /api/backups/{id}/Update backup
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this backup. |
Request body (application/json): PatchedBackupRequest
Responses: 200 → Backup
DELETE /api/backups/{id}/Delete backup
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this backup. |
Responses: 204
GET /api/backups/{id}/download/Serve the backup file as an attachment (streamed from local disk or
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this backup. |
Responses: 200 → Backup
GET /api/backups/{id}/file/Return the text content of a single file inside the backup.
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this backup. |
Responses: 200 → Backup
GET /api/backups/{id}/inspect/Return the list of files contained in the backup.
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this backup. |
Responses: 200 → Backup
GET /api/netscaler-backup-jobs/List netscaler backup jobs
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
device | query | no | integer | |
ordering | query | no | string | Which field to use when ordering the results. |
page | query | no | integer | A page number within the paginated result set. |
page_size | query | no | integer | Number of results to return per page. |
search | query | no | string | A search term. |
status | query | no | string | * pending - Pending |
Responses: 200 → PaginatedNetscalerBackupJobList
GET /api/netscaler-backup-jobs/{id}/Retrieve netscaler backup job
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this netscaler backup job. |
Responses: 200 → NetscalerBackupJob
POST /api/netscaler-backup-jobs/{id}/cancel/Cancel: netscaler backup job
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this netscaler backup job. |
Responses: 200 → NetscalerBackupJob
GET /api/qkview-jobs/List qkview jobs
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
device | query | no | integer | |
ordering | query | no | string | Which field to use when ordering the results. |
page | query | no | integer | A page number within the paginated result set. |
page_size | query | no | integer | Number of results to return per page. |
search | query | no | string | A search term. |
status | query | no | string | * generating - Generating on device |
Responses: 200 → PaginatedQKViewJobList
GET /api/qkview-jobs/{id}/Retrieve qkview job
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this qk view job. |
Responses: 200 → QKViewJob
Auto-generated from drf-spectacular OpenAPI. Endpoint descriptions come from viewset docstrings/serializers; enriching those improves this page on the next generation.