Get Restore Config

Get Restore configuration

Request

URI

GET

https://www.mgmt.cloud.vmware.com/ni/api/ni/settings/restore

COPY

Authentication

This operation uses the following authentication methods.

ApiKeyAuth

Responses

200

Returns BackupRestoreRequest of type(s) application/json

{
    "config_filter": {
        "applications": false,
        "snmp": false,
        "smtp": false,
        "data_sources": false,
        "analytics_thresholds": false,
        "analytics_outliers": false,
        "events": false,
        "syslog": false,
        "pinboards": false,
        "ldap": false,
        "vidm": false,
        "user_data": false,
        "user_preferences": false,
        "physical_subnet_vlan": false,
        "saved_searches": false,
        "physical_ip_dns_mapping": false,
        "east_west_ip": false,
        "north_south_ip": false
    },
    "backup_schedule": {
        "enable": false,
        "schedule_period": "DAILY",
        "minute": 30,
        "hour": 12,
        "day_of_week": 1
    },
    "backup_file_server_type": "SSH",
    "local_file_server": {
        "backup_directory": "/home/testuser",
        "backup_file_name": "vrni-backup-12-4-5.tar"
    },
    "ssh_file_server": {
        "server_address": "10.234.12.134",
        "port": 22,
        "username": "testuser",
        "password": "password",
        "backup_directory": "/home/testuser",
        "backup_file_name": "vrni-backup-12-4-5.tar"
    },
    "ftp_file_server": {
        "server_address": "10.234.12.134",
        "port": 21,
        "username": "testuser",
        "password": "password",
        "backup_directory": "/home/testuser",
        "backup_file_name": "vrni-backup-12-4-5.tar"
    },
    "schedule_now": false
}

ConfigDataFilter

config_filter

Optional

config_filter

BackupSchedule

backup_schedule

Optional

backup_schedule

FileServerType

backup_file_server_type

Optional

backup_file_server_type

LocalFileServer

local_file_server

Optional

local_file_server

SshFileServer

ssh_file_server

Optional

ssh_file_server

FtpFileServer

ftp_file_server

Optional

ftp_file_server

boolean

schedule_now

Optional

True, to run backup now (on demand)

400

Bad Request

Returns ApiError of type(s) application/json

{
    "code": 0,
    "message": "string",
    "details": [
        {
            "code": 0,
            "message": "string",
            "target": [
                "string"
            ]
        }
    ]
}

integer As int32 As int32

code

Optional

code

string

message

Optional

message

array of ErrorDetail

details

Optional

details

401

Unauthorized

Returns ApiError of type(s) application/json

{
    "code": 0,
    "message": "string",
    "details": [
        {
            "code": 0,
            "message": "string",
            "target": [
                "string"
            ]
        }
    ]
}

integer As int32 As int32

code

Optional

code

string

message

Optional

message

array of ErrorDetail

details

Optional

details

404

Not Found

Returns ApiError of type(s) application/json

{
    "code": 0,
    "message": "string",
    "details": [
        {
            "code": 0,
            "message": "string",
            "target": [
                "string"
            ]
        }
    ]
}

integer As int32 As int32

code

Optional

code

string

message

Optional

message

array of ErrorDetail

details

Optional

details