Restore.Metadata structure Structure representing metadata


Required Property Name Type Description
required applicable boolean

Does the VCSA match the deployment type, network properties and version of backed up VC

required boxname string

Box name is PNID/ FQDN etc

required comment string

Custom comment

required messages array of RecoveryRestoreLocalizableMessage

Any messages if the backup is not aplicable

required parts array of string

List of parts included in the backup.

optional sso_login_required boolean

Is SSO login required for the vCenter server. This field is optional because it was added in a newer version than its parent node.

required timestamp string

Time when this backup was completed.

required version string

VCSA version

JSON Example

    "applicable": false,
    "boxname": "string",
    "comment": "string",
    "messages": [
            "args": [
            "default_message": "string",
            "id": "string"
    "parts": [
    "timestamp": "string",
    "version": "string"

Was this page helpful?