{"type":"api","title":"Get backup or restore jobs","meta":{"id":"/apps/pubhub/media/crosswork-network-controller-7-1/f445c17e25a1120e8fbde4bd413083d0fd88b2b3/e48c8a9a-1f0a-35b4-9617-f132aa89f152","info":{"title":"Crosswork Backup Restore Manager API","description":"Backup Restore Manager provides API methods for backup and restore operations on Crosswork. This includes backup, data only backup, restore, data only restore and migration.","version":"3.0.0","contact":{"name":"Crosswork Team, Cisco","email":"support@cisco.com"},"license":{"name":"Cisco Software License Agreement","url":"https://www.cisco.com/public/sw-license-agreement.html"}},"x-parser-conf":{"overview":{"markdownPath":"reference/INFRA/BACKUP_RESTORE/backup-restore-v1-overview.md"}},"swagger":"2.0","basePath":"/crosswork/platform/v1","securityDefinitions":{"api_key":{"description":"security definitions details","type":"apiKey","name":"Authorization","in":"header"}}},"spec":{"summary":"Get backup or restore jobs","description":"Retrieves a list of backup and restore jobs with optional filtering and pagination. This endpoint allows you to query job history, filter by status, job type, or name, and paginate through results for better performance with large datasets.","operationId":"BackupServices_RequestJobsBackupRestore","responses":{"200":{"description":"A successful response.","schema":{"type":"object","description":"Response containing a list of backup and restore jobs matching the request criteria","properties":{"jobs":{"type":"array","description":"Array of job information objects","items":{"type":"object","description":"Individual job information with execution details and status","properties":{"jobId":{"type":"string","description":"Unique identifier for the job"},"jobName":{"type":"string","description":"Name of the job"},"jobType":{"type":"string","description":"Type of job (e.g., BACKUP, RESTORE, DATA BACKUP)"},"timeInitiated":{"type":"string","description":"Timestamp when the job was initiated"},"lastCompletedAction":{"type":"string","description":"Last action that was completed in the job"},"currentActionInProgress":{"type":"string","description":"Current action being performed (if job is running)"},"timeCompleted":{"type":"string","description":"Timestamp when the job was completed"},"status":{"type":"string","description":"Current status of the job"},"backupJobId":{"type":"string","description":"Related backup job ID (for restore operations)"},"backupJobName":{"type":"string","description":"Related backup job name (for restore operations)"},"error":{"type":"string","description":"Error message if the job failed"},"backup_job_start_time":{"type":"string","title":"if this job is a geo redundancy restore, the corresponding backup operation started at this time. Empty otherwise"},"backup_job_end_time":{"type":"string","title":"if this job is a geo redundancy restore, the corresponding backup operation ended at this time. Empty otherwise"},"backup_tar_name":{"type":"string","description":"if this job is a geo redundancy restore, this field corresponds to the backup tar file.\r\nif this job is a geo redundancy backup, this field corresponds to the tar file with the backed up content."},"progress":{"type":"integer","format":"int32","description":"job progress 0-100. Will not be set to 100 for a failed job."}},"example":{"jobId":"1a6a2734-6c6f-49b6-a7b2-bfe7adb3606c","jobName":"some-job","jobType":"DATA BACKUP","timeInitiated":"2025-05-16T03:32:41-07:00","lastCompletedAction":"","currentActionInProgress":"","timeCompleted":"2025-05-16T03:34:23-07:00","status":"Failed","backupJobId":"","backupJobName":"","error":"job failed in executing task backupNSOTask. Error: no NSO providers found","backup_job_start_time":"","backup_job_end_time":"","backup_tar_name":"","progress":100},"$$ref":"#/definitions/backupGetJobResult"}}},"example":{"jobs":[{"jobId":"1a6a2734-6c6f-49b6-a7b2-bfe7adb3606c","jobName":"some-job","jobType":"DATA BACKUP","timeInitiated":"2025-05-16T03:32:41-07:00","lastCompletedAction":"","currentActionInProgress":"","timeCompleted":"2025-05-16T03:34:23-07:00","status":"Failed","backupJobId":"","backupJobName":"","error":"job failed in executing task backupNSOTask. Error: no NSO providers found","backup_job_start_time":"","backup_job_end_time":"","backup_tar_name":"","progress":100}]},"$$ref":"#/definitions/backupGetJobsResult"}},"default":{"description":"An unexpected error response.","schema":{"type":"object","description":"Standard error response containing detailed error information","properties":{"error":{"type":"string","description":"Error message"},"code":{"type":"integer","format":"int32","description":"Error code"},"message":{"type":"string","description":"Detailed error message"},"details":{"type":"array","description":"Additional error details","items":{"type":"object","description":"Protocol Buffers Any message type for containing arbitrary serialized messages","properties":{"type_url":{"type":"string","description":"Type URL that identifies the message type"},"value":{"type":"string","format":"byte","description":"Serialized message value"}},"example":{"type_url":"type.googleapis.com/error.details","value":"CgVoZWxsbw=="},"$$ref":"#/definitions/protobufAny"}}},"example":{"error":"","code":13,"message":"failed to marshal error message","details":[]},"$$ref":"#/definitions/runtimeError"}}},"parameters":[{"description":"Get backup or restore jobs","name":"body","in":"body","required":true,"schema":{"type":"object","description":"Request parameters for retrieving backup and restore jobs with filtering options","properties":{"filter":{"description":"Pagination filter settings","type":"object","properties":{"pageSize":{"type":"integer","format":"int32","description":"Number of jobs to return per page"},"pageNum":{"type":"integer","format":"int32","description":"Page number for pagination (1-based)"}},"example":{"pageSize":10,"pageNum":1},"$$ref":"#/definitions/backupGetJobsReqFilter"},"filterData":{"description":"Job filtering criteria","type":"object","properties":{"status":{"type":"string","description":"Filter jobs by status (e.g., Completed, Failed, In Progress)"},"jobType":{"type":"string","description":"Filter jobs by type (e.g., BACKUP, RESTORE, DATA BACKUP)"},"jobName":{"type":"string","description":"Filter jobs by name (partial name matching)"}},"example":{"status":"Completed","jobType":"BACKUP","jobName":"daily-backup"},"$$ref":"#/definitions/backupGetJobsReqPageFilter"}},"example":{"filter":{"pageSize":10,"pageNum":1},"filterData":{"status":"Completed","jobType":"BACKUP","jobName":"daily-backup"}},"$$ref":"#/definitions/backupGetJobsReq"}}],"tags":["BackupServices"],"__originalOperationId":"BackupServices_RequestJobsBackupRestore","consumes":["application/json"],"produces":["application/json"],"method":"post","path":"/platform/backup/get"}}