NSX-T Data Center REST API

BackupOverviewRequestParameters (schema)

Backup overview request parameters

Parameters, that REST API client needs to provide, in order to get data for
a backup/restore card with or without a list of generated backups.

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