{"type":"api","title":"Get Backup And Restore Executions","meta":{"id":"/apps/pubhub/media/cisco-catalyst-center-api-3-1-3/9b7bce247bccb0311419e593770ef07f9552d9e1/d41c7da7-f399-330a-bd19-886309e55849","info":{"title":"Intent API","description":"Cisco Catalyst Center Platform v. 3.1.3","version":"3.1.3"},"tags":[{"name":"Authentication","description":"Access Token Request"},{"name":"Sites","description":"Create sites, assign devices to them and get site health"},{"name":"Topology","description":"Get topology details and overall network health"},{"name":"Devices","description":"Manage network devices"},{"name":"Clients","description":"Get client (by MAC Address) health, status, and information"},{"name":"Users","description":"Obtain information about *Users* and associated connections and devices"},{"name":"Issues","description":"Obtain issue details, impacted hosts, and suggested actions for remediation"},{"name":"Site Design","description":"Design/provision NFV device to site/area/building/floor"},{"name":"Network Settings","description":"Manage Network Settings"},{"name":"Software Image Management (SWIM)","description":"Manage activation and distribution of software images"},{"name":"Device Onboarding (PnP)","description":"Zero-touch deployment of network devices"},{"name":"Configuration Templates","description":"Configure and manage CLI templates"},{"name":"Configuration Archive","description":"Export device configurations to an encrypted zip file"},{"name":"SDA","description":"(BETA) Configure and manage SDA wired fabric border devices"},{"name":"Sensors","description":"Manage sensor test templates"},{"name":"Wireless","description":"Configure and manage SSIDs, Wireless, and RF profiles in non-fabric wireless network"},{"name":"Command Runner","description":"Retrieve real-time device configuration and CLI keywords"},{"name":"Discovery","description":"Discover network devices and manage discovery jobs"},{"name":"Path Trace","description":"Network route and flow analysis"},{"name":"File","description":"Get configuration files by namespace and ID"},{"name":"Task","description":"Get information about asynchronous tasks"},{"name":"Tag","description":"Assign administrator-defined tags to network devices"},{"name":"Application Policy","description":"Create and manage applications, application sets, and application policies"},{"name":"Applications","description":"Intent API to get a list of applications for a specific site, a device, or a client device's MAC address"},{"name":"ITSM","description":"Provide the details of the various third party integrations that are supported"},{"name":"Event Management","description":"Event based notification to external handlers"},{"name":"Security Advisories","description":"Provides the details of advisories on the network and devices"},{"name":"Compliance","description":"Provides compliance status data on the devices"}],"x-parser-conf":{"expand":0,"labelConfig":{"endpoint":"summary"}},"openapi":"3.0.3","servers":[{"url":"/"}]},"spec":{"operationId":"getBackupAndRestoreExecutions","tags":["Backup"],"summary":"Get Backup And Restore Executions","deprecated":false,"description":"This api is used to get all the backup and restore executions.","parameters":[{"name":"backupId","description":"The `backupId` of the backup execution to be retrieved.Obtain the `backupId` from the id attribute in the response of the `/dna/system/api/v1/backups` API.","schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"jobType","description":"The `jobType` of the backup execution to be retrieved.","schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"status","description":"The `status` of the backup execution to be retrieved.","schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"offset","description":"The first record to show for this page.","schema":{"type":"integer","default":"application/json"},"in":"query"},{"name":"limit","description":"The number of records to show for this page.","schema":{"type":"integer","default":"application/json"},"in":"query"},{"name":"sortBy","description":"A property within the response to sort by.","schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"order","description":"Whether ascending or descending order should be used to sort the response.","schema":{"type":"string","default":"application/json"},"in":"query"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"filter":{"type":"object","description":"Records are filtered based on the fields"},"page":{"type":"object","description":"Contains pagination information."},"response":{"type":"array","items":{"type":"object","properties":{"_metadata":{"type":"object","properties":{},"description":"This field holds additional information"},"backupId":{"type":"string","description":"The UUID of the backup"},"completedPercentage":{"type":"number","description":"Execution completion percentage"},"createdBy":{"type":"string","description":"This field represents the user who triggered this execution"},"duration":{"type":"integer","description":"Total time taken to complete this execution process"},"endDate":{"type":"string","description":"The end data and time of the backup execution"},"errorCode":{"type":"string","description":"Error code of the backup execution process"},"errorMessage":{"type":"string","description":"Error message of this backup execution process"},"failedTaskDetail":{"type":"object","description":"Failed task detail of this execution"},"id":{"type":"string","description":"The UUID of the execution process"},"isForceUpdate":{"type":"boolean","description":"This states whether the execution is forcefully updated or not"},"jobType":{"type":"string","enum":["CREATE_BACKUP","DELETE_BACKUP","RESTORE_BACKUP"],"description":"The backup execution job type"},"scope":{"type":"string","enum":["CISCO_DNA_DATA_WITH_ASSURANCE","CISCO_DNA_DATA_WITHOUT_ASSURANCE"],"description":"The backup scope states whether the backup is with assurance or without assurance data"},"startDate":{"type":"string","description":"The start data and time of the backup execution"},"status":{"type":"string","enum":["IN_PROGRESS","SUCCESS","FAILED","CANCELLED"],"description":"The status of the backup execution"},"systemErrorMessage":{"type":"string","description":"System error message of this backup execution process"},"updateMessage":{"type":"string","description":"Force update message"}}},"description":"Contains information about backup executions."},"version":{"type":"string","description":"The version of the response"}},"description":"","$$ref":"#/components/schemas/getBackupAndRestoreExecutionsResponse"}}}},"400":{"description":"Bad Request","content":{}},"404":{"description":"Not Found","content":{}}},"x-rapi-id":"a5a0-8bd1-4fa8-871f","x-rapi-overview":"This api is used to get all the backup and restore executions.","x-rapi-domain":"System","x-rapi-subdomain":"Backup","x-rapi-version":"1.0.0","x-rapi-internalPath":"/dna/system/api/v1/backupRestoreExecutions","x-rapi-publicPath":"/dna/system/api/v1/backupRestoreExecutions","x-rapi-registerInKONG":false,"x-rapi-banner":["Intent"],"x-rapi-deprecationMessage":"","x-rapi-rateLimiting":"10~MINUTE","__originalOperationId":"getBackupAndRestoreExecutions","method":"get","path":"/dna/system/api/v1/backupRestoreExecutions"}}