backup

Resource Fields

Writeable Fields

Field Type Create Update Default Notes
description string Optional Yes -  
name string Optional Yes -  

Read Only Fields

Field Type Notes
accountId account The unique identifier for the associated account
backupTargetId backupTarget  
created date The date of when the backup was created.
id int The unique identifier for the backup
kind string  
removed date The date of when the backup was removed
snapshotId snapshot  
state enum The current state of the backup. The options are created, creating, removed, removing, requested.
transitioning enum Whether or not the backup is in a transitioning state
transitioningMessage string The message to show while in a transitioning state
transitioningProgress int The percentage remaining in the transitioning process of the backup
uri string  
uuid string The universally unique identifier for the backup. This will always be unique across Rancher installations.
volumeId volume  


Edit this page