NSX-T Data Center REST API

BackupOverviewRequestParameters (type)

{
  "description": "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.",
  "extends": {
    "$ref": "ListRequestParameters"
  },
  "id": "BackupOverviewRequestParameters",
  "module_id": "BackupConfiguration",
  "properties": {
    "cursor": {
      "readonly": false,
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
      "type": "string"
    },
    "frame_type": {
      "default": "LOCAL_LOCAL_MANAGER",
      "description": "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.",
      "enum": [
        "GLOBAL_MANAGER",
        "LOCAL_MANAGER",
        "LOCAL_LOCAL_MANAGER",
        "NSX_INTELLIGENCE"
      ],
      "readonly": true,
      "required": false,
      "title": "Frame type",
      "type": "string"
    },
    "included_fields": {
      "description": "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.",
      "title": "Comma separated list of fields that should be included in query result",
      "type": "string"
    },
    "page_size": {
      "default": 1000,
      "maximum": 1000,
      "minimum": 0,
      "title": "Maximum number of results to return in this page (server may return fewer)",
      "type": "integer"
    },
    "show_backups_list": {
      "default": true,
      "description": "True to request a list of backups",
      "required": false,
      "title": "Need a list of backups",
      "type": "boolean"
    },
    "site_id": {
      "default": "localhost",
      "description": "UUID of LM site, which will be supported in a frame",
      "required": false,
      "title": "UUID of the site",
      "type": "string"
    },
    "sort_ascending": {
      "type": "boolean"
    },
    "sort_by": {
      "title": "Field by which records are sorted",
      "type": "string"
    }
  },
  "title": "Backup overview request parameters",
  "type": "object"
}