{"type":"api","title":"Set remote backup file storage location details","meta":{"id":"/apps/pubhub/media/crosswork-network-controller-7-1/f445c17e25a1120e8fbde4bd413083d0fd88b2b3/e48c8a9a-1f0a-35b4-9617-f132aa89f152","info":{"title":"Crosswork Backup Restore Manager API","description":"Backup Restore Manager provides API methods for backup and restore operations on Crosswork. This includes backup, data only backup, restore, data only restore and migration.","version":"3.0.0","contact":{"name":"Crosswork Team, Cisco","email":"support@cisco.com"},"license":{"name":"Cisco Software License Agreement","url":"https://www.cisco.com/public/sw-license-agreement.html"}},"x-parser-conf":{"overview":{"markdownPath":"reference/INFRA/BACKUP_RESTORE/backup-restore-v1-overview.md"}},"swagger":"2.0","basePath":"/crosswork/platform/v1","securityDefinitions":{"api_key":{"description":"security definitions details","type":"apiKey","name":"Authorization","in":"header"}}},"spec":{"summary":"Set remote backup file storage location details","description":"Configures the remote storage location where backup files will be automatically uploaded after creation. This includes setting connection details such as hostname, port, authentication credentials, and the remote directory path for backup storage.","operationId":"BackupServices_RequestVMBackupRemoteLocation","responses":{"200":{"description":"A successful response.","schema":{"type":"object","properties":{"message":{"type":"string"}}},"examples":{"example":{"message":"Remote backup location set successfully"}}},"default":{"description":"An unexpected error response.","schema":{"type":"object","description":"Standard error response containing detailed error information","properties":{"error":{"type":"string","description":"Error message"},"code":{"type":"integer","format":"int32","description":"Error code"},"message":{"type":"string","description":"Detailed error message"},"details":{"type":"array","description":"Additional error details","items":{"type":"object","description":"Protocol Buffers Any message type for containing arbitrary serialized messages","properties":{"type_url":{"type":"string","description":"Type URL that identifies the message type"},"value":{"type":"string","format":"byte","description":"Serialized message value"}},"example":{"type_url":"type.googleapis.com/error.details","value":"CgVoZWxsbw=="},"$$ref":"#/definitions/protobufAny"}}},"example":{"error":"","code":13,"message":"failed to marshal error message","details":[]},"$$ref":"#/definitions/runtimeError"}}},"parameters":[{"description":"Set details of the remote location at which backup files are stored","name":"body","in":"body","required":true,"schema":{"type":"object","description":"Configuration for remote backup storage location including connection details","properties":{"hostName":{"type":"string","description":"Hostname or IP address of the remote storage server"},"port":{"type":"integer","format":"int32","description":"Port number for connecting to the remote storage server"},"username":{"type":"string","description":"Username for authentication to the remote storage server"},"password":{"type":"string","description":"Password for authentication to the remote storage server"},"remotePath":{"type":"string","description":"Path on the remote server where backup files will be stored"}},"example":{"hostName":"0.0.0.0","port":22,"username":"admin","password":"********","remotePath":"/mnt"},"$$ref":"#/definitions/backupRequestVMBackupRemoteLocationOp"}}],"tags":["BackupServices"],"__originalOperationId":"BackupServices_RequestVMBackupRemoteLocation","consumes":["application/json"],"produces":["application/json"],"method":"post","path":"/platform/backup/remote"}}