NSX-T Data Center REST API

Get all backup related information for a site

Get a configuration of a file server, timers for automated backup,
latest backup status, backups list for a site.
Fields that contain secrets (password, passphrase) are not returned.

Request:

Method:

GET

URI Path(s):

/policy/api/v1/cluster/backups/overview
/api/v1/cluster/backups/overview

Request Headers:

n/a

Query Parameters:

BackupOverviewRequestParameters+

BackupOverviewRequestParameters (schema)

Name	Description	Type	Notes
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string
frame_type	Frame type This attribute is used to indicate the service on current site or other site for which backup is handled in a frame. LOCAL_LOCAL_MANAGER corresponds to local LM of the site. LOCAL_MANAGER cprresponds to LM of other site.	string	Readonly Enum: GLOBAL_MANAGER, LOCAL_MANAGER, LOCAL_LOCAL_MANAGER, NSX_INTELLIGENCE Default: "LOCAL_LOCAL_MANAGER"
included_fields	Comma separated list of fields that should be included in query result Note - this parameter currently only works when used with the search APIs /policy/api/v1/search/query and /policy/api/v1/search/dsl. It is ignored for other list APIs.	string
page_size	Maximum number of results to return in this page (server may return fewer)	integer	Minimum: 0 Maximum: 1000 Default: "1000"
show_backups_list	Need a list of backups True to request a list of backups	boolean	Default: "True"
site_id	UUID of the site UUID of LM site, which will be supported in a frame	string	Default: "localhost"
sort_ascending		boolean
sort_by	Field by which records are sorted	string

Request Body:

n/a

Example Request:

GET https://<nsx-mgr>/api/v1/cluster/backups/overview?site_id=fec18cee-ccf7-4d7c-bcc2-8634b08195cd&frame_type=LOCAL_MANAGER&show_backups_list=true

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

BackupOverview+

BackupOverview (schema)

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
backup_config	Backup configuration Configuration to generate a manual/automated backup	BackupConfiguration	Required
backup_operation_history	Last backup status Status of the last backup execution per component	BackupOperationHistory	Required
current_backup_operation_status	Current backup status Backup status decribes type, phase, success/failure and time of a \| latest backup execution	CurrentBackupOperationStatus	Required
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
restore_status	Current restore status Status of restore process executing/executed on appliance	ClusterRestoreStatus	Required
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	List of timestamps of backed-up cluster files	array of ClusterBackupInfo	Required Readonly
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

Example Response:

{ "backup_config":{ "backup_enabled" : true; "backup_schedule":{ "resource_type": "WeeklyBackupSchedule", "days_of_week":[ 1, 3, 5 ], "hour_of_day":0, "minute_of_day":0 }, "remote_file_server":{ "server":"10.1.2.3", "port":22, "protocol":{ "protocol_name":"sftp", "ssh_fingerprint":"SHA256:w2NgXhG2Nm76q9PL/bXWKkLbDS31uMLYttUe9eajPaA", "authentication_scheme":{ "scheme_name":"PASSWORD", "username":"admin" } }, "directory_path":"/nsx-backups" }, "inventory_summary_interval":300 }, "current_backup_operation_status":{ "operation_type": "backup", "backup_id": "fec18cee-ccf7-4d7c-bcc2-8634b08195cd-1523411326", "start_time": 1523411326952, "end_time": 1523411628558, "current_step": "BACKUP_CREATING_CLUSTER_BACKUP" }, "backup_operation_history":{ "cluster_backup_statuses": [ { "backup_id" : "2128af2d-d763-4a27-80e0-4933af7e4824-1462221358", "start_time": 1523334840897, "end_time": 1523334916419, "success": true } ], "node_backup_statuses": [ { "backup_id" : "3128af2d-d763-4a27-80e0-4933af7e4824-1462221359", "start_time": 1523411768398, "end_time": 1523411844682, "success": false, "error_code": "BACKUP_SERVER_TIMEOUT", "error_message": "File server is not reachable, please check connectivity to file server" } ], "inventory_backup_statuses": [ { "backup_id" : "4128af2d-d763-4a27-80e0-4933af7e4824-1462221360", "start_time": 1523411625510, "end_time": 1523411701163, "success": true } ] }, "backup_list":[ { "timestamp": 1482253939013, "ip_address": "64.233.187.105", "node_id": "21EA6850-217F-41A2-B3CF-F322A882C54E" "restore_type": ["REGULAR_RESTORE"] }, { "timestamp": 1482081398404, "ip_address": "64.233.187.105", "node_id": "21EA6850-217F-41A2-B3CF-F322A882C54E" "restore_type": ["POLICY_ONLY_RESTORE"] }, { "timestamp": 1481908598404, "ip_address": "64.233.187.105", "node_id": "21EA6850-217F-41A2-B3CF-F322A882C54E" "restore_type": ["POLICY_ONLY_RESTORE"] }, { "timestamp": 1481735798404, "ip_address": "64.233.187.105", "node_id": "21EA6850-217F-41A2-B3CF-F322A882C54E" "restore_type": ["POLICY_ONLY_RESTORE"] } ] }