Get Backup Record - Security Cloud Control Firewall Manager API Documentation

{"type":"api","title":"Get Backup Record","meta":{"id":"/apps/pubhub/media/cdo-api-documentation/ee9bdf946673e45c4f256a22e0a754e29a9b2098/54f4ba30-7fe2-3433-bbd5-a4d458aee37e","info":{"title":"Cisco Cloud-delivered Firewall Management Center (cdFMC) API","version":"1.15.0","description":"Use the documentation to explore the endpoints the cdFMC has to offer","contact":{"name":"Cisco Firepower TAC","email":"ngfw-support@cisco.com"}},"tags":[{"name":"Analysis"},{"name":"Audit"},{"name":"Backup"},{"name":"Change Management"},{"name":"Chassis"},{"name":"Deployment"},{"name":"Device Clusters"},{"name":"Device Groups"},{"name":"Device HA Pairs"},{"name":"Devices"},{"name":"Health"},{"name":"Integration"},{"name":"Intelligence"},{"name":"License"},{"name":"Network Map"},{"name":"Object"},{"name":"Policy"},{"name":"Policy Assignments"},{"name":"Search"},{"name":"Status"},{"name":"System Configuration"},{"name":"System Information"},{"name":"Templates"},{"name":"Troubleshoot"},{"name":"Updates"},{"name":"Users"}],"openapi":"3.0.1","servers":[{"url":"https://api.us.security.cisco.com/firewall","description":"US"},{"url":"https://api.eu.security.cisco.com/firewall","description":"EU"},{"url":"https://api.apj.security.cisco.com/firewall","description":"APJ"},{"url":"https://api.au.security.cisco.com/firewall","description":"AUS"},{"url":"https://api.in.security.cisco.com/firewall","description":"IN"},{"url":"https://api.int.security.cisco.com/firewall","description":"Staging"},{"url":"https://scale.manage.security.cisco.com/api/rest","description":"Scale"},{"url":"https://ci.manage.security.cisco.com/api/rest","description":"CI"},{"url":"https://manage.stg.secure.cisco/api/rest","description":"Stgf9"}],"securitySchemes":{"bearerAuth":{"bearerFormat":"JWT","scheme":"bearer","type":"http"}}},"spec":{"deprecated":false,"description":"**Get the specified backup details from the backup database.**","operationId":"getBackupRecord","parameters":[{"description":"UUID of the backup. This field is mandatory.","in":"path","name":"backupUUID","required":true,"schema":{"type":"string"}},{"name":"domainUUID","description":"Domain UUID","in":"path","required":true,"schema":{"type":"string"},"$$ref":"#/components/parameters/domainUUID"}],"responses":{"200":{"content":{"application/json":{"examples":{"Example 1 : GET /fmc_config/v1/domain/DomainUUID/backup/backuprecords/{id} ( GET of backup files to fetch details for particular backup )":{"value":{"backupOptions":["CONFIG","EVENTS","TID"],"creationDate":"1743003380","fileName":"fmc_backup-2024-09-03T12-20-54.tar","id":"4cc6a4c6-27d9-11ed-a420-992c0c0de4fe","links":{"self":"https://www.cisco.com/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/backup/backuprecords/4cc6a4c6-27d9-11ed-a420-992c0c0de4fe"},"name":"FTD1","sizeInMB":98,"storageLocation":"LOCAL","systemInformation":"firepower Secure Firewall Management Center for VMware v7.7.0","target":{"id":"6g5tf6a4-87d1-31wd-a420-992c0c0ded46","links":{"self":"/fmc_platform/v1/info/serverversion/{deviceUUID}"},"type":"Manager"}}}},"schema":{"type":"object","description":"Get details of the backup when backupUUID is provided or get list of all backup.","properties":{"backupIds":{"description":"Input paramater to delete multiple backups for given UUIDs.","items":{"type":"string"},"type":"array"},"backupOptions":{"description":"Type of the backup. Possible values are CONFIG, EVENTS, TID, or a combination of these.","items":{"enum":["CONFIG","TID","EVENTS"],"type":"string"},"type":"array"},"backupUUID":{"type":"string"},"creationDate":{"description":"Date and time when the backup was created.","type":"string"},"deleted":{"items":{"type":"string"},"type":"array"},"description":{"type":"string"},"deviceIds":{"description":"Input parameter to delete multiple backups for provided device/container UUID associated with multiple backups.","items":{"type":"string"},"type":"array"},"failed":{"items":{"type":"object","properties":{"backupId":{"type":"string"},"reason":{"type":"string"}},"$$ref":"#/components/schemas/BackupFailed"},"type":"array"},"fileName":{"description":"Name of the backup file.","type":"string"},"id":{"description":"UUID of the individual backup.","type":"string"},"links":{"type":"object","description":"This defines the self referencing links for the given resource.","properties":{"parent":{"description":"Full resource URL path to reference the parent (if any) for this resource.","type":"string"},"self":{"description":"Full resource URL path to reference this particular resource.","type":"string"}},"$$ref":"#/components/schemas/ILinks"},"messsage":{"type":"string"},"metadata":{"type":"object","properties":{"domain":{"type":"object","properties":{"id":{"type":"string"},"links":{"type":"object","description":"This defines the self referencing links for the given resource.","properties":{"parent":{"description":"Full resource URL path to reference the parent (if any) for this resource.","type":"string"},"self":{"description":"Full resource URL path to reference this particular resource.","type":"string"}},"$$ref":"#/components/schemas/ILinks"},"name":{"type":"string"},"type":{"type":"string"}},"$$ref":"#/components/schemas/IDomain"},"isLocked":{"type":"boolean"},"lastUser":{"type":"object","properties":{"id":{"type":"string"},"links":{"type":"object","description":"This defines the self referencing links for the given resource.","properties":{"parent":{"description":"Full resource URL path to reference the parent (if any) for this resource.","type":"string"},"self":{"description":"Full resource URL path to reference this particular resource.","type":"string"}},"$$ref":"#/components/schemas/ILinks"},"name":{"type":"string"},"type":{"type":"string"}},"$$ref":"#/components/schemas/IMetadataUser"},"matches":{"items":{"type":"string"},"type":"array"},"readOnly":{"type":"object","properties":{"reason":{"enum":["RBAC","SYSTEM","DOMAIN"],"type":"string"},"state":{"type":"boolean"}},"$$ref":"#/components/schemas/IReadonly"},"timestamp":{"format":"int32","type":"integer"}},"$$ref":"#/components/schemas/IMetadata"},"name":{"description":"Name of the FMC, FTD or container.","type":"string"},"sizeInMB":{"description":"Size of the backup in megabytes.","format":"int32","type":"integer"},"status":{"type":"string"},"storageLocation":{"description":"Location where the backup is stored. Possible values are LOCAL and REMOTE.","enum":["LOCAL","REMOTE"],"type":"string"},"systemInformation":{"description":"System details for the backup.","type":"string"},"target":{"description":"Information about the backup target.","type":"object","properties":{"id":{"description":"Unique identifier representing resource.","type":"string"},"links":{"description":"Object containing links to this resource.","type":"object","properties":{"parent":{"description":"Full resource URL path to reference the parent (if any) for this resource.","type":"string"},"self":{"description":"Full resource URL path to reference this particular resource.","type":"string"}},"$$ref":"#/components/schemas/ILinks"},"name":{"description":"User chosen resource name.","type":"string"},"type":{"description":"Response object associated with resource.","type":"string"}},"$$ref":"#/components/schemas/IReference"},"type":{"type":"string"},"version":{"type":"string"}},"$$ref":"#/components/schemas/BackupRecord"}}},"description":"OK"},"default":{"content":{"application/json":{"schema":{"type":"object","properties":{"category":{"description":"Describes the category of the error thrown.","enum":["FRAMEWORK","OTHER","VALIDATION"],"type":"string"},"messages":{"description":"List of error messages which the response has.","items":{"type":"object","properties":{"bulkPayloadIndex":{"description":"More details about the error.","type":"string"},"code":{"description":"More details about the error.","type":"string"},"description":{"description":"More details about the error.","type":"string"},"details":{"description":"More details about the error.","type":"string"},"errorCode":{"description":"More details about the error.","type":"string"},"location":{"description":"More details about the error.","type":"string"},"severity":{"description":"Specifies the Highest level severity among all the error messages.","enum":["ERROR","WARN"],"type":"string"}},"$$ref":"#/components/schemas/ErrorMessagesContainer"},"type":"array"},"severity":{"description":"Specifies the Highest level severity among all the error messages.","enum":["ERROR","WARN"],"type":"string"}},"$$ref":"#/components/schemas/ErrorResponse"}}},"description":"Error"}},"tags":["Backup"],"__originalOperationId":"getBackupRecord","method":"get","path":"/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/backup/backuprecords/{backupUUID}"}}