# -*- coding: utf-8 -*-
"""Cisco Catalyst Center Backup API wrapper.
Copyright (c) 2026 Cisco Systems.
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
"""
from builtins import * # noqa: F401,F403
from ...restsession import RestSession
from ...utils import (
apply_path_params,
check_type,
dict_from_items_with_values,
dict_of_str,
)
[docs]class Backup(object):
"""Cisco Catalyst Center Backup API (version: 3.1.6.0).
Wraps the Catalyst Center Backup
API and exposes the API as native Python
methods that return native Python objects.
"""
def __init__(self, session, object_factory, request_validator):
"""Initialize a new Backup
object with the provided RestSession.
Args:
session(RestSession): The RESTful session object to be used for
API calls to the Catalyst Center service.
Raises:
TypeError: If the parameter types are incorrect.
"""
check_type(session, RestSession)
super(Backup, self).__init__()
self._session = session
self._object_factory = object_factory
self._request_validator = request_validator
[docs] def get_backup_configuration(self, headers=None, **request_parameters):
"""This api is used to get the backup configuration.
Args:
headers(dict): Dictionary of HTTP Headers to send with the Request
.
**request_parameters: Additional request parameters (provides
support for parameters that may be added in the future).
Returns:
MyDict: JSON response. Access the object's properties by using
the dot notation or the bracket notation.
Raises:
TypeError: If the parameter types are incorrect.
MalformedRequest: If the request body created is invalid.
ApiError: If the Catalyst Center cloud returns an error.
Documentation Link:
https://developer.cisco.com/docs/dna-center/#!get-backup-configuration
"""
check_type(headers, dict)
if headers is not None:
if "X-Auth-Token" in headers:
check_type(headers.get("X-Auth-Token"), str, may_be_none=False)
_params = {}
_params.update(request_parameters)
_params = dict_from_items_with_values(_params)
path_params = {}
with_custom_headers = False
_headers = self._session.headers or {}
if headers:
_headers.update(dict_of_str(headers))
with_custom_headers = True
e_url = "/dna/system/api/v1/backupConfiguration"
endpoint_full_url = apply_path_params(e_url, path_params)
if with_custom_headers:
json_data = self._session.get(
endpoint_full_url, params=_params, headers=_headers
)
else:
json_data = self._session.get(endpoint_full_url, params=_params)
return self._object_factory(
"bpm_dd47c40ef6e75dfeb079b162f5e1d594_v3_1_6_0", json_data
)
[docs] def create_backup_configuration(
self,
dataRetention=None,
encryptionPassphrase=None,
mountPath=None,
type=None,
headers=None,
payload=None,
active_validation=True,
**request_parameters
):
"""This api is used to create or update backup configuration. Obtain the `mountPath` value from the mountPoint
attribute in the response of the `/dna/system/api/v1/backupStorages` API.
Args:
dataRetention(integer): Backup's Date retention policy of the backup.
encryptionPassphrase(string): Backup's Password to encrypt the backup information.
mountPath(string): Backup's Backup storage mount path.
type(string): Backup's The storage type. Available values are 'PHYSICAL_DISK' and 'NFS'.
headers(dict): Dictionary of HTTP Headers to send with the Request
.
payload(dict): A JSON serializable Python object to send in the
body of the Request.
active_validation(bool): Enable/Disable payload validation.
Defaults to True.
**request_parameters: Additional request parameters (provides
support for parameters that may be added in the future).
Returns:
MyDict: JSON response. Access the object's properties by using
the dot notation or the bracket notation.
Raises:
TypeError: If the parameter types are incorrect.
MalformedRequest: If the request body created is invalid.
ApiError: If the Catalyst Center cloud returns an error.
Documentation Link:
https://developer.cisco.com/docs/dna-center/#!create-backup-configuration
"""
check_type(headers, dict)
check_type(payload, dict)
if headers is not None:
if "Content-Type" in headers:
check_type(headers.get("Content-Type"), str, may_be_none=False)
if "X-Auth-Token" in headers:
check_type(headers.get("X-Auth-Token"), str, may_be_none=False)
_params = {}
_params.update(request_parameters)
_params = dict_from_items_with_values(_params)
path_params = {}
_payload = {
"dataRetention": dataRetention,
"encryptionPassphrase": encryptionPassphrase,
"mountPath": mountPath,
"type": type,
}
_payload.update(payload or {})
_payload = dict_from_items_with_values(_payload)
if active_validation:
self._request_validator(
"jsd_b843a90c86875472af1f351e78dd5521_v3_1_6_0"
).validate(_payload)
with_custom_headers = False
_headers = self._session.headers or {}
if headers:
_headers.update(dict_of_str(headers))
with_custom_headers = True
e_url = "/dna/system/api/v1/backupConfiguration"
endpoint_full_url = apply_path_params(e_url, path_params)
if with_custom_headers:
json_data = self._session.post(
endpoint_full_url, params=_params, json=_payload, headers=_headers
)
else:
json_data = self._session.post(
endpoint_full_url, params=_params, json=_payload
)
return self._object_factory(
"bpm_b843a90c86875472af1f351e78dd5521_v3_1_6_0", json_data
)
[docs] def get_all_n_f_s_configurations(self, headers=None, **request_parameters):
"""This api is used to get all the configured NFS.
Args:
headers(dict): Dictionary of HTTP Headers to send with the Request
.
**request_parameters: Additional request parameters (provides
support for parameters that may be added in the future).
Returns:
MyDict: JSON response. Access the object's properties by using
the dot notation or the bracket notation.
Raises:
TypeError: If the parameter types are incorrect.
MalformedRequest: If the request body created is invalid.
ApiError: If the Catalyst Center cloud returns an error.
Documentation Link:
https://developer.cisco.com/docs/dna-center/#!get-all-n-f-s-configurations
"""
check_type(headers, dict)
if headers is not None:
if "X-Auth-Token" in headers:
check_type(headers.get("X-Auth-Token"), str, may_be_none=False)
_params = {}
_params.update(request_parameters)
_params = dict_from_items_with_values(_params)
path_params = {}
with_custom_headers = False
_headers = self._session.headers or {}
if headers:
_headers.update(dict_of_str(headers))
with_custom_headers = True
e_url = "/dna/system/api/v1/backupNfsConfigurations"
endpoint_full_url = apply_path_params(e_url, path_params)
if with_custom_headers:
json_data = self._session.get(
endpoint_full_url, params=_params, headers=_headers
)
else:
json_data = self._session.get(endpoint_full_url, params=_params)
return self._object_factory(
"bpm_f7ccd6a28585516e9858e43b24f5f63d_v3_1_6_0", json_data
)
[docs] def create_n_f_s_configuration(
self,
nfsPort=None,
nfsVersion=None,
portMapperPort=None,
server=None,
sourcePath=None,
headers=None,
payload=None,
active_validation=True,
**request_parameters
):
"""This api is used to create NFS configuration.
Args:
nfsPort(integer): Backup's NFS Port.
nfsVersion(string): Backup's NFS version. Available values are 'nfs3' and 'nfs4'.
portMapperPort(integer): Backup's NFS port mapper port.
server(string): Backup's NFS server host.
sourcePath(string): Backup's NFS server path.
headers(dict): Dictionary of HTTP Headers to send with the Request
.
payload(dict): A JSON serializable Python object to send in the
body of the Request.
active_validation(bool): Enable/Disable payload validation.
Defaults to True.
**request_parameters: Additional request parameters (provides
support for parameters that may be added in the future).
Returns:
MyDict: JSON response. Access the object's properties by using
the dot notation or the bracket notation.
Raises:
TypeError: If the parameter types are incorrect.
MalformedRequest: If the request body created is invalid.
ApiError: If the Catalyst Center cloud returns an error.
Documentation Link:
https://developer.cisco.com/docs/dna-center/#!create-n-f-s-configuration
"""
check_type(headers, dict)
check_type(payload, dict)
if headers is not None:
if "Content-Type" in headers:
check_type(headers.get("Content-Type"), str, may_be_none=False)
if "X-Auth-Token" in headers:
check_type(headers.get("X-Auth-Token"), str, may_be_none=False)
_params = {}
_params.update(request_parameters)
_params = dict_from_items_with_values(_params)
path_params = {}
_payload = {
"nfsPort": nfsPort,
"nfsVersion": nfsVersion,
"portMapperPort": portMapperPort,
"server": server,
"sourcePath": sourcePath,
}
_payload.update(payload or {})
_payload = dict_from_items_with_values(_payload)
if active_validation:
self._request_validator(
"jsd_e9c39175d785a0eb9d6f402f378a2ba_v3_1_6_0"
).validate(_payload)
with_custom_headers = False
_headers = self._session.headers or {}
if headers:
_headers.update(dict_of_str(headers))
with_custom_headers = True
e_url = "/dna/system/api/v1/backupNfsConfigurations"
endpoint_full_url = apply_path_params(e_url, path_params)
if with_custom_headers:
json_data = self._session.post(
endpoint_full_url, params=_params, json=_payload, headers=_headers
)
else:
json_data = self._session.post(
endpoint_full_url, params=_params, json=_payload
)
return self._object_factory(
"bpm_e9c39175d785a0eb9d6f402f378a2ba_v3_1_6_0", json_data
)
[docs] def delete_n_f_s_configuration(self, id, headers=None, **request_parameters):
"""This api is used to delete the NFS configuration. Obtain the `id` from the id attribute in the response of the
`/dna/system/api/v1/backupNfsConfigurations` API.
Args:
id(str): id path parameter. The `id` of the NFS configuration to be deleted.Obtain the `id` from the id
attribute in the response of the `/dna/system/api/v1/backupNfsConfigurations` API.
headers(dict): Dictionary of HTTP Headers to send with the Request
.
**request_parameters: Additional request parameters (provides
support for parameters that may be added in the future).
Returns:
MyDict: JSON response. Access the object's properties by using
the dot notation or the bracket notation.
Raises:
TypeError: If the parameter types are incorrect.
MalformedRequest: If the request body created is invalid.
ApiError: If the Catalyst Center cloud returns an error.
Documentation Link:
https://developer.cisco.com/docs/dna-center/#!delete-n-f-s-configuration
"""
check_type(headers, dict)
check_type(id, str, may_be_none=False)
if headers is not None:
if "X-Auth-Token" in headers:
check_type(headers.get("X-Auth-Token"), str, may_be_none=False)
_params = {}
_params.update(request_parameters)
_params = dict_from_items_with_values(_params)
path_params = {
"id": id,
}
with_custom_headers = False
_headers = self._session.headers or {}
if headers:
_headers.update(dict_of_str(headers))
with_custom_headers = True
e_url = "/dna/system/api/v1/backupNfsConfigurations/{id}"
endpoint_full_url = apply_path_params(e_url, path_params)
if with_custom_headers:
json_data = self._session.delete(
endpoint_full_url, params=_params, headers=_headers
)
else:
json_data = self._session.delete(endpoint_full_url, params=_params)
return self._object_factory(
"bpm_d7282ec01a275f5d9c093c2a4b2cf6af_v3_1_6_0", json_data
)
[docs] def get_backup_and_restore_executions(
self,
backup_id=None,
job_type=None,
limit=None,
offset=None,
order=None,
sort_by=None,
status=None,
headers=None,
**request_parameters
):
"""This api is used to get all the backup and restore executions.
Args:
backup_id(str): backupId query parameter. 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.
job_type(str): jobType query parameter. Execution type of the backup workflow . If the workflow is
`Create Backup` The jobType is `CREATE_BACKUP`. If the workflow is `Delete Backup` The
jobType is `DELETE_BACKUP`. If the workflow is `Restore Backup` The jobType is
`RESTORE_BACKUP`.
status(str): status query parameter. Execution status of the workflow.If the workflow execution has
started, the status is `IN_PROGRESS`.If the workflow execution has completed, the status
is `SUCCESS`.If the workflow execution has failed, the status is `FAILED`.
offset(int): offset query parameter. The first record to show for this page.
limit(int): limit query parameter. The number of records to show for this page.
sort_by(str): sortBy query parameter. A property within the response to sort by.
order(str): order query parameter. Whether ascending or descending order should be used to sort the
response.Use `asc` for ascending and `desc` for descending order .
headers(dict): Dictionary of HTTP Headers to send with the Request
.
**request_parameters: Additional request parameters (provides
support for parameters that may be added in the future).
Returns:
MyDict: JSON response. Access the object's properties by using
the dot notation or the bracket notation.
Raises:
TypeError: If the parameter types are incorrect.
MalformedRequest: If the request body created is invalid.
ApiError: If the Catalyst Center cloud returns an error.
Documentation Link:
https://developer.cisco.com/docs/dna-center/#!get-backup-and-restore-executions
"""
check_type(headers, dict)
check_type(backup_id, str)
check_type(job_type, str)
check_type(status, str)
check_type(offset, int)
check_type(limit, int)
check_type(sort_by, str)
check_type(order, str)
if headers is not None:
if "X-Auth-Token" in headers:
check_type(headers.get("X-Auth-Token"), str, may_be_none=False)
_params = {
"backupId": backup_id,
"jobType": job_type,
"status": status,
"offset": offset,
"limit": limit,
"sortBy": sort_by,
"order": order,
}
_params.update(request_parameters)
_params = dict_from_items_with_values(_params)
path_params = {}
with_custom_headers = False
_headers = self._session.headers or {}
if headers:
_headers.update(dict_of_str(headers))
with_custom_headers = True
e_url = "/dna/system/api/v1/backupRestoreExecutions"
endpoint_full_url = apply_path_params(e_url, path_params)
if with_custom_headers:
json_data = self._session.get(
endpoint_full_url, params=_params, headers=_headers
)
else:
json_data = self._session.get(endpoint_full_url, params=_params)
return self._object_factory(
"bpm_e87332fa345c06b01cc351ca31a35c_v3_1_6_0", json_data
)
[docs] def get_backup_and_restore_execution(self, id, headers=None, **request_parameters):
"""This api is used to get the execution detail of a specific backup or restore worflow process.
Args:
id(str): id path parameter. The `id` of the backup execution to be retrieved.
headers(dict): Dictionary of HTTP Headers to send with the Request
.
**request_parameters: Additional request parameters (provides
support for parameters that may be added in the future).
Returns:
MyDict: JSON response. Access the object's properties by using
the dot notation or the bracket notation.
Raises:
TypeError: If the parameter types are incorrect.
MalformedRequest: If the request body created is invalid.
ApiError: If the Catalyst Center cloud returns an error.
Documentation Link:
https://developer.cisco.com/docs/dna-center/#!get-backup-and-restore-execution
"""
check_type(headers, dict)
check_type(id, str, may_be_none=False)
if headers is not None:
if "X-Auth-Token" in headers:
check_type(headers.get("X-Auth-Token"), str, may_be_none=False)
_params = {}
_params.update(request_parameters)
_params = dict_from_items_with_values(_params)
path_params = {
"id": id,
}
with_custom_headers = False
_headers = self._session.headers or {}
if headers:
_headers.update(dict_of_str(headers))
with_custom_headers = True
e_url = "/dna/system/api/v1/backupRestoreExecutions/{id}"
endpoint_full_url = apply_path_params(e_url, path_params)
if with_custom_headers:
json_data = self._session.get(
endpoint_full_url, params=_params, headers=_headers
)
else:
json_data = self._session.get(endpoint_full_url, params=_params)
return self._object_factory(
"bpm_aa285ec05ff68b1101c7a15254e3_v3_1_6_0", json_data
)
[docs] def get_backup_storages(self, storage_type, headers=None, **request_parameters):
"""This api is used to get all the mounted backup storage information like mount point, disk size based on the
provided storage type.
Args:
storage_type(str): storageType query parameter. The `storageType` of the backup storage to be retrieved.
If the backup storage is physical disk , storageType is `PHYSICAL_DISK`. If the backup
storage is nfs , storageType is `NFS`.
headers(dict): Dictionary of HTTP Headers to send with the Request
.
**request_parameters: Additional request parameters (provides
support for parameters that may be added in the future).
Returns:
MyDict: JSON response. Access the object's properties by using
the dot notation or the bracket notation.
Raises:
TypeError: If the parameter types are incorrect.
MalformedRequest: If the request body created is invalid.
ApiError: If the Catalyst Center cloud returns an error.
Documentation Link:
https://developer.cisco.com/docs/dna-center/#!get-backup-storages
"""
check_type(headers, dict)
check_type(storage_type, str, may_be_none=False)
if headers is not None:
if "X-Auth-Token" in headers:
check_type(headers.get("X-Auth-Token"), str, may_be_none=False)
_params = {
"storageType": storage_type,
}
_params.update(request_parameters)
_params = dict_from_items_with_values(_params)
path_params = {}
with_custom_headers = False
_headers = self._session.headers or {}
if headers:
_headers.update(dict_of_str(headers))
with_custom_headers = True
e_url = "/dna/system/api/v1/backupStorages"
endpoint_full_url = apply_path_params(e_url, path_params)
if with_custom_headers:
json_data = self._session.get(
endpoint_full_url, params=_params, headers=_headers
)
else:
json_data = self._session.get(endpoint_full_url, params=_params)
return self._object_factory(
"bpm_adbfee1ef7015fbfb1bd47020ab90f89_v3_1_6_0", json_data
)
[docs] def get_all_backup(
self,
limit=None,
offset=None,
order=None,
query=None,
sort_by=None,
headers=None,
**request_parameters
):
"""This api is used to get all the backup available in the configured storage.
Args:
query(str): query query parameter. Filter based on the provided text on predefined fields.
offset(int): offset query parameter. The first record to show for this page.
limit(int): limit query parameter. The number of records to show for this page.
sort_by(str): sortBy query parameter. A property within the response to sort by.
order(str): order query parameter. Whether ascending or descending order should be used to sort the
response.Use `asc` for ascending and `desc` for descending order .
headers(dict): Dictionary of HTTP Headers to send with the Request
.
**request_parameters: Additional request parameters (provides
support for parameters that may be added in the future).
Returns:
MyDict: JSON response. Access the object's properties by using
the dot notation or the bracket notation.
Raises:
TypeError: If the parameter types are incorrect.
MalformedRequest: If the request body created is invalid.
ApiError: If the Catalyst Center cloud returns an error.
Documentation Link:
https://developer.cisco.com/docs/dna-center/#!get-all-backup
"""
check_type(headers, dict)
check_type(query, str)
check_type(offset, int)
check_type(limit, int)
check_type(sort_by, str)
check_type(order, str)
if headers is not None:
if "X-Auth-Token" in headers:
check_type(headers.get("X-Auth-Token"), str, may_be_none=False)
_params = {
"query": query,
"offset": offset,
"limit": limit,
"sortBy": sort_by,
"order": order,
}
_params.update(request_parameters)
_params = dict_from_items_with_values(_params)
path_params = {}
with_custom_headers = False
_headers = self._session.headers or {}
if headers:
_headers.update(dict_of_str(headers))
with_custom_headers = True
e_url = "/dna/system/api/v1/backups"
endpoint_full_url = apply_path_params(e_url, path_params)
if with_custom_headers:
json_data = self._session.get(
endpoint_full_url, params=_params, headers=_headers
)
else:
json_data = self._session.get(endpoint_full_url, params=_params)
return self._object_factory(
"bpm_f09b1316bea5602aaadebe1102b8b86_v3_1_6_0", json_data
)
[docs] def create_backup(
self,
name=None,
scope=None,
headers=None,
payload=None,
active_validation=True,
**request_parameters
):
"""This api is used to trigger a workflow to create an on demand backup. To monitor the progress and completion of
the backup creation , please call `/dna/system/api/v1/backupRestoreExecutions/{id}` api , where id is
the taskId attribute from the response of the curent endpoint.
Args:
name(string): Backup's The backup name.
scope(string): Backup's The backup scope states whether the backup is with assurance or without
assurance data. Available values are 'CISCO_DNA_DATA_WITH_ASSURANCE' and
'CISCO_DNA_DATA_WITHOUT_ASSURANCE'.
headers(dict): Dictionary of HTTP Headers to send with the Request
.
payload(dict): A JSON serializable Python object to send in the
body of the Request.
active_validation(bool): Enable/Disable payload validation.
Defaults to True.
**request_parameters: Additional request parameters (provides
support for parameters that may be added in the future).
Returns:
MyDict: JSON response. Access the object's properties by using
the dot notation or the bracket notation.
Raises:
TypeError: If the parameter types are incorrect.
MalformedRequest: If the request body created is invalid.
ApiError: If the Catalyst Center cloud returns an error.
Documentation Link:
https://developer.cisco.com/docs/dna-center/#!create-backup
"""
check_type(headers, dict)
check_type(payload, dict)
if headers is not None:
if "Content-Type" in headers:
check_type(headers.get("Content-Type"), str, may_be_none=False)
if "X-Auth-Token" in headers:
check_type(headers.get("X-Auth-Token"), str, may_be_none=False)
_params = {}
_params.update(request_parameters)
_params = dict_from_items_with_values(_params)
path_params = {}
_payload = {
"name": name,
"scope": scope,
}
_payload.update(payload or {})
_payload = dict_from_items_with_values(_payload)
if active_validation:
self._request_validator(
"jsd_c9d3ba6208e5d6eb45fa5c9b8f7e327_v3_1_6_0"
).validate(_payload)
with_custom_headers = False
_headers = self._session.headers or {}
if headers:
_headers.update(dict_of_str(headers))
with_custom_headers = True
e_url = "/dna/system/api/v1/backups"
endpoint_full_url = apply_path_params(e_url, path_params)
if with_custom_headers:
json_data = self._session.post(
endpoint_full_url, params=_params, json=_payload, headers=_headers
)
else:
json_data = self._session.post(
endpoint_full_url, params=_params, json=_payload
)
return self._object_factory(
"bpm_c9d3ba6208e5d6eb45fa5c9b8f7e327_v3_1_6_0", json_data
)
[docs] def delete_backup(self, id, headers=None, **request_parameters):
"""This api is used to trigger delete workflow of a specific backup based on the provided `id` Obtain the `id` from
the id attribute in the response of the `/dna/system/api/v1/backups` API. To monitor the progress and
completion of the backup deletion , please call `/dna/system/api/v1/backupRestoreExecutions/{id}` api ,
where id is the taskId attribute from the response of the curent endpoint.
Args:
id(str): id path parameter. The `id` of the backup to be deleted.Obtain the 'id' from the id attribute
in the response of the `/dna/system/api/v1/backups` API.
headers(dict): Dictionary of HTTP Headers to send with the Request
.
**request_parameters: Additional request parameters (provides
support for parameters that may be added in the future).
Returns:
MyDict: JSON response. Access the object's properties by using
the dot notation or the bracket notation.
Raises:
TypeError: If the parameter types are incorrect.
MalformedRequest: If the request body created is invalid.
ApiError: If the Catalyst Center cloud returns an error.
Documentation Link:
https://developer.cisco.com/docs/dna-center/#!delete-backup
"""
check_type(headers, dict)
check_type(id, str, may_be_none=False)
if headers is not None:
if "X-Auth-Token" in headers:
check_type(headers.get("X-Auth-Token"), str, may_be_none=False)
_params = {}
_params.update(request_parameters)
_params = dict_from_items_with_values(_params)
path_params = {
"id": id,
}
with_custom_headers = False
_headers = self._session.headers or {}
if headers:
_headers.update(dict_of_str(headers))
with_custom_headers = True
e_url = "/dna/system/api/v1/backups/{id}"
endpoint_full_url = apply_path_params(e_url, path_params)
if with_custom_headers:
json_data = self._session.delete(
endpoint_full_url, params=_params, headers=_headers
)
else:
json_data = self._session.delete(endpoint_full_url, params=_params)
return self._object_factory(
"bpm_c468255fb65851c2b356d2dcf5397cd6_v3_1_6_0", json_data
)
[docs] def get_backup_by_id(self, id, headers=None, **request_parameters):
"""This api is used to get a specific backup based on the provided `backup id`.
Args:
id(str): id path parameter. The `id` of the backup to be retrieved.
headers(dict): Dictionary of HTTP Headers to send with the Request
.
**request_parameters: Additional request parameters (provides
support for parameters that may be added in the future).
Returns:
MyDict: JSON response. Access the object's properties by using
the dot notation or the bracket notation.
Raises:
TypeError: If the parameter types are incorrect.
MalformedRequest: If the request body created is invalid.
ApiError: If the Catalyst Center cloud returns an error.
Documentation Link:
https://developer.cisco.com/docs/dna-center/#!get-backup-by-id
"""
check_type(headers, dict)
check_type(id, str, may_be_none=False)
if headers is not None:
if "X-Auth-Token" in headers:
check_type(headers.get("X-Auth-Token"), str, may_be_none=False)
_params = {}
_params.update(request_parameters)
_params = dict_from_items_with_values(_params)
path_params = {
"id": id,
}
with_custom_headers = False
_headers = self._session.headers or {}
if headers:
_headers.update(dict_of_str(headers))
with_custom_headers = True
e_url = "/dna/system/api/v1/backups/{id}"
endpoint_full_url = apply_path_params(e_url, path_params)
if with_custom_headers:
json_data = self._session.get(
endpoint_full_url, params=_params, headers=_headers
)
else:
json_data = self._session.get(endpoint_full_url, params=_params)
return self._object_factory(
"bpm_efd1d42f31af56dd8b395df3685dd465_v3_1_6_0", json_data
)
# Alias Functions