Download OpenAPI specification:Download
object (CreateMetadata) | |
backup_location | string Name or UID + orgid of BackupLocation backup_location is deprecated, not to be used. |
cluster | string (Name or UID of Cluster) |
namespaces | Array of strings (Namespaces to backup. Only an admin can provide multiple namespaces) |
object (Label selectors to choose resources) | |
pre_exec_rule | string Pre check rule to run before backup is started deprecated, not to be used. |
post_exec_rule | string Post check rule to run after backup is completed deprecated, not to be used. |
Array of objects (List of resources to backup (optional)) | |
csi_snapshot_class_name | string Snapshot class name to use for backup (optional) deprecated, not to be used. |
resource_types | Array of strings (List of resource types to backup (optional)) |
object (ObjectRef) | |
object (ObjectRef) | |
object (ObjectRef) | |
backup_type | string (BackupCreateRequestBackupType) Default: "Invalid" Enum: "Invalid" "Generic" "Normal" |
object (ObjectRef) | |
ns_label_selectors | string |
object (BackupCreateRequestBackupObjectType) | |
skip_vm_auto_exec_rules | boolean <boolean> (Skip auto rules for VirtualMachine Backup Object type) |
object (volume snapshot class mapping for csi based backup <provisioner(string), volumesnapshotclass(string)> (optional)) | |
direct_kdmp | boolean <boolean> (option to take backup as direct kdmp) |
exclude_resource_types | Array of strings |
keep_cr_status | boolean <boolean> option to enable to keep the CR status of the resources in the backup. |
advanced_resource_label_selector | string (older label selector does not support string type. Map type has contraint of supporting operator, So introducing this new parameter) |
object (ObjectRef) |
{- "metadata": {
- "name": "string",
- "org_id": "string",
- "owner": "string",
- "labels": {
- "property1": "string",
- "property2": "string"
}, - "ownership": {
- "owner": "string",
- "groups": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "collaborators": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "public": {
- "type": "Invalid"
}
}, - "uid": "string"
}, - "backup_location": "string",
- "cluster": "string",
- "namespaces": [
- "string"
], - "label_selectors": {
- "property1": "string",
- "property2": "string"
}, - "pre_exec_rule": "string",
- "post_exec_rule": "string",
- "include_resources": [
- {
- "name": "string",
- "namespace": "string",
- "group": "string",
- "kind": "string",
- "version": "string"
}
], - "csi_snapshot_class_name": "string",
- "resource_types": [
- "string"
], - "backup_location_ref": {
- "name": "string",
- "uid": "string"
}, - "pre_exec_rule_ref": {
- "name": "string",
- "uid": "string"
}, - "post_exec_rule_ref": {
- "name": "string",
- "uid": "string"
}, - "backup_type": "Invalid",
- "cluster_ref": {
- "name": "string",
- "uid": "string"
}, - "ns_label_selectors": "string",
- "backup_object_type": {
- "type": "Invalid"
}, - "skip_vm_auto_exec_rules": true,
- "volume_snapshot_class_mapping": {
- "property1": "string",
- "property2": "string"
}, - "direct_kdmp": true,
- "exclude_resource_types": [
- "string"
], - "keep_cr_status": true,
- "advanced_resource_label_selector": "string",
- "volume_resource_only_policy_ref": {
- "name": "string",
- "uid": "string"
}
}
{- "backup": {
- "metadata": {
- "name": "string",
- "uid": "string",
- "owner": "string",
- "org_id": "string",
- "create_time": "2019-08-24T14:15:22Z",
- "last_update_time": "2019-08-24T14:15:22Z",
- "labels": {
- "property1": "string",
- "property2": "string"
}, - "create_time_in_sec": "string",
- "ownership": {
- "owner": "string",
- "groups": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "collaborators": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "public": {
- "type": "Invalid"
}
}
}, - "backup_info": {
- "backup_location": "string",
- "cluster": "string",
- "namespaces": [
- "string"
], - "label_selectors": {
- "property1": "string",
- "property2": "string"
}, - "status": {
- "status": "Invalid",
- "reason": "string"
}, - "resources": [
- {
- "name": "string",
- "namespace": "string",
- "group": "string",
- "kind": "string",
- "version": "string"
}
], - "volumes": [
- {
- "name": "string",
- "namespace": "string",
- "pvc": "string",
- "backup_id": "string",
- "status": {
- "status": "Invalid",
- "reason": "string"
}, - "driver_name": "string",
- "zones": [
- "string"
], - "options": {
- "property1": "string",
- "property2": "string"
}, - "total_size": "string",
- "actual_size": "string",
- "storage_class": "string",
- "pvc_id": "string",
- "provisioner": "string",
- "volumesnapshot": "string",
- "job_security_context": {
- "runAsUser": "string",
- "runAsGroup": "string"
}, - "virtual_machine_name": "string",
- "backup_mode": {
- "type": "Invalid"
}
}
], - "backup_path": "string",
- "stage": "Invalid",
- "pre_exec_rule": "string",
- "post_exec_rule": "string",
- "backup_schedule": {
- "uid": "string",
- "name": "string"
}, - "cr_name": "string",
- "total_size": "string",
- "cloud_credential": "string",
- "include_resources": [
- {
- "name": "string",
- "namespace": "string",
- "group": "string",
- "kind": "string",
- "version": "string"
}
], - "resource_count": "string",
- "stork_version": "string",
- "csi_snapshot_class_name": "string",
- "resource_types": [
- "string"
], - "backup_location_ref": {
- "name": "string",
- "uid": "string"
}, - "pre_exec_rule_ref": {
- "name": "string",
- "uid": "string"
}, - "post_exec_rule_ref": {
- "name": "string",
- "uid": "string"
}, - "cloud_credential_ref": {
- "name": "string",
- "uid": "string"
}, - "backup_type": {
- "type": "Invalid"
}, - "cr_uid": "string",
- "retention_period": "string",
- "backup_share": {
- "groups": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "collaborators": [
- {
- "id": "string",
- "access": "Invalid"
}
]
}, - "user_backupshare_access": "Invalid",
- "cluster_ref": {
- "name": "string",
- "uid": "string"
}, - "ns_label_selectors": "string",
- "rancher_projects": {
- "property1": "string",
- "property2": "string"
}, - "target_namespace": "string",
- "large_resource_enabled": true,
- "backup_object_type": {
- "type": "Invalid"
}, - "skip_vm_auto_exec_rules": true,
- "volume_snapshot_class_mapping": {
- "property1": "string",
- "property2": "string"
}, - "direct_kdmp": true,
- "retention_time": "2019-08-24T14:15:22Z",
- "completion_time_info": {
- "volumes_completion_time": "2019-08-24T14:15:22Z",
- "resources_completion_time": "2019-08-24T14:15:22Z",
- "total_completion_time": "2019-08-24T14:15:22Z"
}, - "exclude_resource_types": [
- "string"
], - "parallel_backup": true,
- "keep_cr_status": true,
- "isBackupReady_for_PXDLocalSnapshotRestore": true,
- "advanced_resource_label_selector": "string",
- "schedule_policy_ref": {
- "name": "string",
- "uid": "string"
}, - "virtual_machines": [
- {
- "name": "string",
- "namespace": "string",
- "os_name": "string",
- "status": {
- "status": "Invalid",
- "reason": "string"
}
}
], - "virtual_machines_total_count": "string",
- "virtual_machines_failed_count": "string",
- "retry_parent": {
- "name": "string",
- "uid": "string"
}, - "volume_resource_only_policy_ref": {
- "name": "string",
- "uid": "string"
}, - "virtual_machine_resources": [
- {
- "resource_info": {
- "name": "string",
- "namespace": "string",
- "group": "string",
- "kind": "string",
- "version": "string"
}, - "virtual_machine_names": [
- "string"
]
}
]
}
}
}
object (CreateMetadata) | |
cloud_credential | string Reference to cloud credential object used for backup cloud_credential is deprecated, not to be used. |
object (ObjectRef) |
{- "metadata": {
- "name": "string",
- "org_id": "string",
- "owner": "string",
- "labels": {
- "property1": "string",
- "property2": "string"
}, - "ownership": {
- "owner": "string",
- "groups": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "collaborators": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "public": {
- "type": "Invalid"
}
}, - "uid": "string"
}, - "cloud_credential": "string",
- "cloud_credential_ref": {
- "name": "string",
- "uid": "string"
}
}
{ }
org_id required | string |
name required | string Backup name |
uid required | string Backup uid |
{- "backup": {
- "metadata": {
- "name": "string",
- "uid": "string",
- "owner": "string",
- "org_id": "string",
- "create_time": "2019-08-24T14:15:22Z",
- "last_update_time": "2019-08-24T14:15:22Z",
- "labels": {
- "property1": "string",
- "property2": "string"
}, - "create_time_in_sec": "string",
- "ownership": {
- "owner": "string",
- "groups": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "collaborators": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "public": {
- "type": "Invalid"
}
}
}, - "cluster": "string",
- "label_selectors": {
- "property1": "string",
- "property2": "string"
}, - "status": {
- "status": "Invalid",
- "reason": "string"
}, - "stage": "Invalid",
- "total_size": "string",
- "csi_snapshot_class_name": "string",
- "resource_types": [
- "string"
], - "backup_location_ref": {
- "name": "string",
- "uid": "string"
}, - "cluster_ref": {
- "name": "string",
- "uid": "string"
}, - "ns_label_selectors": "string",
- "rancher_projects": {
- "property1": "string",
- "property2": "string"
}, - "direct_kdmp": true,
- "large_resource_enabled": true,
- "backup_object_type": {
- "type": "Invalid"
}, - "skip_vm_auto_exec_rules": true,
- "volume_snapshot_class_mapping": {
- "property1": "string",
- "property2": "string"
}, - "retention_time": "2019-08-24T14:15:22Z",
- "completion_time_info": {
- "volumes_completion_time": "2019-08-24T14:15:22Z",
- "resources_completion_time": "2019-08-24T14:15:22Z",
- "total_completion_time": "2019-08-24T14:15:22Z"
}, - "advanced_resource_label_selector": "string",
- "virtual_machines_total_count": "string",
- "virtual_machines_failed_count": "string",
- "namespaces": [
- "string"
], - "volumes": [
- {
- "name": "string",
- "namespace": "string",
- "pvc": "string",
- "backup_id": "string",
- "status": {
- "status": "Invalid",
- "reason": "string"
}, - "driver_name": "string",
- "zones": [
- "string"
], - "options": {
- "property1": "string",
- "property2": "string"
}, - "total_size": "string",
- "actual_size": "string",
- "storage_class": "string",
- "pvc_id": "string",
- "provisioner": "string",
- "volumesnapshot": "string",
- "job_security_context": {
- "runAsUser": "string",
- "runAsGroup": "string"
}, - "virtual_machine_name": "string",
- "backup_mode": {
- "type": "Invalid"
}
}
], - "resources": [
- {
- "name": "string",
- "namespace": "string",
- "group": "string",
- "kind": "string",
- "version": "string"
}
], - "resource_details": {
- "virtual_machine_list": {
- "virtual_machines": [
- {
- "vm_info": {
- "name": "string",
- "namespace": "string",
- "os_name": "string",
- "status": {
- "status": "Invalid",
- "reason": "string"
}
}, - "volumes": [
- {
- "name": "string",
- "size": "string",
- "backup_mode": {
- "type": "Invalid"
}, - "status": {
- "status": "Invalid",
- "reason": "string"
}
}
], - "resources": [
- {
- "name": "string",
- "group": "string",
- "kind": "string",
- "version": "string",
- "status": {
- "status": "Invalid",
- "reason": "string"
}
}
]
}
]
}
}
}
}
org_id | string (Organization id) |
name | string (Name of the failed or partial success backup to be retried) |
uid | string (UID of the failed or partial success backup to be retried) |
Array of objects (ResourceInfo) List of failed VirtualMachine resource only. If not passed, will retry all Failed VMs from Backup object. | |
skip_vm_auto_exec_rules | boolean <boolean> (skip_vm_auto_exec_rules when set to true will take crash-consistent backup for retry) |
{- "org_id": "string",
- "name": "string",
- "uid": "string",
- "include_resources": [
- {
- "name": "string",
- "namespace": "string",
- "group": "string",
- "kind": "string",
- "version": "string"
}
], - "skip_vm_auto_exec_rules": true
}
{- "backup": {
- "metadata": {
- "name": "string",
- "uid": "string",
- "owner": "string",
- "org_id": "string",
- "create_time": "2019-08-24T14:15:22Z",
- "last_update_time": "2019-08-24T14:15:22Z",
- "labels": {
- "property1": "string",
- "property2": "string"
}, - "create_time_in_sec": "string",
- "ownership": {
- "owner": "string",
- "groups": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "collaborators": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "public": {
- "type": "Invalid"
}
}
}, - "backup_info": {
- "backup_location": "string",
- "cluster": "string",
- "namespaces": [
- "string"
], - "label_selectors": {
- "property1": "string",
- "property2": "string"
}, - "status": {
- "status": "Invalid",
- "reason": "string"
}, - "resources": [
- {
- "name": "string",
- "namespace": "string",
- "group": "string",
- "kind": "string",
- "version": "string"
}
], - "volumes": [
- {
- "name": "string",
- "namespace": "string",
- "pvc": "string",
- "backup_id": "string",
- "status": {
- "status": "Invalid",
- "reason": "string"
}, - "driver_name": "string",
- "zones": [
- "string"
], - "options": {
- "property1": "string",
- "property2": "string"
}, - "total_size": "string",
- "actual_size": "string",
- "storage_class": "string",
- "pvc_id": "string",
- "provisioner": "string",
- "volumesnapshot": "string",
- "job_security_context": {
- "runAsUser": "string",
- "runAsGroup": "string"
}, - "virtual_machine_name": "string",
- "backup_mode": {
- "type": "Invalid"
}
}
], - "backup_path": "string",
- "stage": "Invalid",
- "pre_exec_rule": "string",
- "post_exec_rule": "string",
- "backup_schedule": {
- "uid": "string",
- "name": "string"
}, - "cr_name": "string",
- "total_size": "string",
- "cloud_credential": "string",
- "include_resources": [
- {
- "name": "string",
- "namespace": "string",
- "group": "string",
- "kind": "string",
- "version": "string"
}
], - "resource_count": "string",
- "stork_version": "string",
- "csi_snapshot_class_name": "string",
- "resource_types": [
- "string"
], - "backup_location_ref": {
- "name": "string",
- "uid": "string"
}, - "pre_exec_rule_ref": {
- "name": "string",
- "uid": "string"
}, - "post_exec_rule_ref": {
- "name": "string",
- "uid": "string"
}, - "cloud_credential_ref": {
- "name": "string",
- "uid": "string"
}, - "backup_type": {
- "type": "Invalid"
}, - "cr_uid": "string",
- "retention_period": "string",
- "backup_share": {
- "groups": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "collaborators": [
- {
- "id": "string",
- "access": "Invalid"
}
]
}, - "user_backupshare_access": "Invalid",
- "cluster_ref": {
- "name": "string",
- "uid": "string"
}, - "ns_label_selectors": "string",
- "rancher_projects": {
- "property1": "string",
- "property2": "string"
}, - "target_namespace": "string",
- "large_resource_enabled": true,
- "backup_object_type": {
- "type": "Invalid"
}, - "skip_vm_auto_exec_rules": true,
- "volume_snapshot_class_mapping": {
- "property1": "string",
- "property2": "string"
}, - "direct_kdmp": true,
- "retention_time": "2019-08-24T14:15:22Z",
- "completion_time_info": {
- "volumes_completion_time": "2019-08-24T14:15:22Z",
- "resources_completion_time": "2019-08-24T14:15:22Z",
- "total_completion_time": "2019-08-24T14:15:22Z"
}, - "exclude_resource_types": [
- "string"
], - "parallel_backup": true,
- "keep_cr_status": true,
- "isBackupReady_for_PXDLocalSnapshotRestore": true,
- "advanced_resource_label_selector": "string",
- "schedule_policy_ref": {
- "name": "string",
- "uid": "string"
}, - "virtual_machines": [
- {
- "name": "string",
- "namespace": "string",
- "os_name": "string",
- "status": {
- "status": "Invalid",
- "reason": "string"
}
}
], - "virtual_machines_total_count": "string",
- "virtual_machines_failed_count": "string",
- "retry_parent": {
- "name": "string",
- "uid": "string"
}, - "volume_resource_only_policy_ref": {
- "name": "string",
- "uid": "string"
}, - "virtual_machine_resources": [
- {
- "resource_info": {
- "name": "string",
- "namespace": "string",
- "group": "string",
- "kind": "string",
- "version": "string"
}, - "virtual_machine_names": [
- "string"
]
}
]
}
}
}
org_id required | string Organization id |
enumerate_options.max_objects | string <uint64> max objects to fetch. |
enumerate_options.time_range.start_time | string <date-time> |
enumerate_options.time_range.end_time | string <date-time> |
enumerate_options.name_filter | string Filter to use for name of objects. Any object that contains the filter will be returned. |
enumerate_options.cluster_name_filter | string Filter to use for cluster name of objects. Any object that contains the filter will be returned. |
enumerate_options.object_index | string <uint64> |
enumerate_options.include_detailed_resources | boolean <boolean> Ths option will be set to true by the caller, when they want to have complete backup object. That means the backupObject's resource list will be set to complete list of resources. If this option is set to false, resource list will be set to nil and rest of the backupObject details will be returned in the response. |
enumerate_options.cluster_uid_filter | string Filter to use with cluster uid on objects. Any object that contains the filter will be returned Currently backup enumerate request should pass this along with cluster name. |
enumerate_options.owners | Array of strings Filter to use owner uids on objects. Any object that contains the filter will be returned. |
enumerate_options.backup_object_type | string filter to use backupObjectType on object. |
enumerate_options.status | Array of strings filter based on the object status. Need to pass the string value of the status field of the object ( backup /restore ) For example, {"Success", "Failed"}. |
enumerate_options.sort_option.sortBy.type | string Default: "Invalid" Enum: "Invalid" "CreationTimestamp" "Name" "ClusterName" "Size" "RestoreBackupName" Name of the field by which sort to be performed. |
enumerate_options.sort_option.sortOrder.type | string Default: "Invalid" Enum: "Invalid" "Ascending" "Descending" Order of sorting. |
{- "backups": [
- {
- "metadata": {
- "name": "string",
- "uid": "string",
- "owner": "string",
- "org_id": "string",
- "create_time": "2019-08-24T14:15:22Z",
- "last_update_time": "2019-08-24T14:15:22Z",
- "labels": {
- "property1": "string",
- "property2": "string"
}, - "create_time_in_sec": "string",
- "ownership": {
- "owner": "string",
- "groups": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "collaborators": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "public": {
- "type": "Invalid"
}
}
}, - "backup_info": {
- "backup_location": "string",
- "cluster": "string",
- "namespaces": [
- "string"
], - "label_selectors": {
- "property1": "string",
- "property2": "string"
}, - "status": {
- "status": "Invalid",
- "reason": "string"
}, - "resources": [
- {
- "name": "string",
- "namespace": "string",
- "group": "string",
- "kind": "string",
- "version": "string"
}
], - "volumes": [
- {
- "name": "string",
- "namespace": "string",
- "pvc": "string",
- "backup_id": "string",
- "status": {
- "status": "Invalid",
- "reason": "string"
}, - "driver_name": "string",
- "zones": [
- "string"
], - "options": {
- "property1": "string",
- "property2": "string"
}, - "total_size": "string",
- "actual_size": "string",
- "storage_class": "string",
- "pvc_id": "string",
- "provisioner": "string",
- "volumesnapshot": "string",
- "job_security_context": {
- "runAsUser": "string",
- "runAsGroup": "string"
}, - "virtual_machine_name": "string",
- "backup_mode": {
- "type": "Invalid"
}
}
], - "backup_path": "string",
- "stage": "Invalid",
- "pre_exec_rule": "string",
- "post_exec_rule": "string",
- "backup_schedule": {
- "uid": "string",
- "name": "string"
}, - "cr_name": "string",
- "total_size": "string",
- "cloud_credential": "string",
- "include_resources": [
- {
- "name": "string",
- "namespace": "string",
- "group": "string",
- "kind": "string",
- "version": "string"
}
], - "resource_count": "string",
- "stork_version": "string",
- "csi_snapshot_class_name": "string",
- "resource_types": [
- "string"
], - "backup_location_ref": {
- "name": "string",
- "uid": "string"
}, - "pre_exec_rule_ref": {
- "name": "string",
- "uid": "string"
}, - "post_exec_rule_ref": {
- "name": "string",
- "uid": "string"
}, - "cloud_credential_ref": {
- "name": "string",
- "uid": "string"
}, - "backup_type": {
- "type": "Invalid"
}, - "cr_uid": "string",
- "retention_period": "string",
- "backup_share": {
- "groups": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "collaborators": [
- {
- "id": "string",
- "access": "Invalid"
}
]
}, - "user_backupshare_access": "Invalid",
- "cluster_ref": {
- "name": "string",
- "uid": "string"
}, - "ns_label_selectors": "string",
- "rancher_projects": {
- "property1": "string",
- "property2": "string"
}, - "target_namespace": "string",
- "large_resource_enabled": true,
- "backup_object_type": {
- "type": "Invalid"
}, - "skip_vm_auto_exec_rules": true,
- "volume_snapshot_class_mapping": {
- "property1": "string",
- "property2": "string"
}, - "direct_kdmp": true,
- "retention_time": "2019-08-24T14:15:22Z",
- "completion_time_info": {
- "volumes_completion_time": "2019-08-24T14:15:22Z",
- "resources_completion_time": "2019-08-24T14:15:22Z",
- "total_completion_time": "2019-08-24T14:15:22Z"
}, - "exclude_resource_types": [
- "string"
], - "parallel_backup": true,
- "keep_cr_status": true,
- "isBackupReady_for_PXDLocalSnapshotRestore": true,
- "advanced_resource_label_selector": "string",
- "schedule_policy_ref": {
- "name": "string",
- "uid": "string"
}, - "virtual_machines": [
- {
- "name": "string",
- "namespace": "string",
- "os_name": "string",
- "status": {
- "status": "Invalid",
- "reason": "string"
}
}
], - "virtual_machines_total_count": "string",
- "virtual_machines_failed_count": "string",
- "retry_parent": {
- "name": "string",
- "uid": "string"
}, - "volume_resource_only_policy_ref": {
- "name": "string",
- "uid": "string"
}, - "virtual_machine_resources": [
- {
- "resource_info": {
- "name": "string",
- "namespace": "string",
- "group": "string",
- "kind": "string",
- "version": "string"
}, - "virtual_machine_names": [
- "string"
]
}
]
}
}
], - "total_count": "string",
- "complete": true
}
org_id required | string Organization id |
org_id | string (Organization id) |
object (EnumerateOptions) |
{- "org_id": "string",
- "enumerate_options": {
- "labels": {
- "property1": "string",
- "property2": "string"
}, - "max_objects": "string",
- "time_range": {
- "start_time": "2019-08-24T14:15:22Z",
- "end_time": "2019-08-24T14:15:22Z"
}, - "name_filter": "string",
- "cluster_name_filter": "string",
- "object_index": "string",
- "include_detailed_resources": true,
- "cluster_uid_filter": "string",
- "owners": [
- "string"
], - "backup_object_type": "string",
- "status": [
- "string"
], - "schedule_policy_ref": [
- {
- "name": "string",
- "uid": "string"
}
], - "backup_schedule_ref": [
- {
- "name": "string",
- "uid": "string"
}
], - "sort_option": {
- "sortBy": {
- "type": "Invalid"
}, - "sortOrder": {
- "type": "Invalid"
}
}
}
}
{- "backups": [
- {
- "metadata": {
- "name": "string",
- "uid": "string",
- "owner": "string",
- "org_id": "string",
- "create_time": "2019-08-24T14:15:22Z",
- "last_update_time": "2019-08-24T14:15:22Z",
- "labels": {
- "property1": "string",
- "property2": "string"
}, - "create_time_in_sec": "string",
- "ownership": {
- "owner": "string",
- "groups": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "collaborators": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "public": {
- "type": "Invalid"
}
}
}, - "backup_info": {
- "backup_location": "string",
- "cluster": "string",
- "namespaces": [
- "string"
], - "label_selectors": {
- "property1": "string",
- "property2": "string"
}, - "status": {
- "status": "Invalid",
- "reason": "string"
}, - "resources": [
- {
- "name": "string",
- "namespace": "string",
- "group": "string",
- "kind": "string",
- "version": "string"
}
], - "volumes": [
- {
- "name": "string",
- "namespace": "string",
- "pvc": "string",
- "backup_id": "string",
- "status": {
- "status": "Invalid",
- "reason": "string"
}, - "driver_name": "string",
- "zones": [
- "string"
], - "options": {
- "property1": "string",
- "property2": "string"
}, - "total_size": "string",
- "actual_size": "string",
- "storage_class": "string",
- "pvc_id": "string",
- "provisioner": "string",
- "volumesnapshot": "string",
- "job_security_context": {
- "runAsUser": "string",
- "runAsGroup": "string"
}, - "virtual_machine_name": "string",
- "backup_mode": {
- "type": "Invalid"
}
}
], - "backup_path": "string",
- "stage": "Invalid",
- "pre_exec_rule": "string",
- "post_exec_rule": "string",
- "backup_schedule": {
- "uid": "string",
- "name": "string"
}, - "cr_name": "string",
- "total_size": "string",
- "cloud_credential": "string",
- "include_resources": [
- {
- "name": "string",
- "namespace": "string",
- "group": "string",
- "kind": "string",
- "version": "string"
}
], - "resource_count": "string",
- "stork_version": "string",
- "csi_snapshot_class_name": "string",
- "resource_types": [
- "string"
], - "backup_location_ref": {
- "name": "string",
- "uid": "string"
}, - "pre_exec_rule_ref": {
- "name": "string",
- "uid": "string"
}, - "post_exec_rule_ref": {
- "name": "string",
- "uid": "string"
}, - "cloud_credential_ref": {
- "name": "string",
- "uid": "string"
}, - "backup_type": {
- "type": "Invalid"
}, - "cr_uid": "string",
- "retention_period": "string",
- "backup_share": {
- "groups": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "collaborators": [
- {
- "id": "string",
- "access": "Invalid"
}
]
}, - "user_backupshare_access": "Invalid",
- "cluster_ref": {
- "name": "string",
- "uid": "string"
}, - "ns_label_selectors": "string",
- "rancher_projects": {
- "property1": "string",
- "property2": "string"
}, - "target_namespace": "string",
- "large_resource_enabled": true,
- "backup_object_type": {
- "type": "Invalid"
}, - "skip_vm_auto_exec_rules": true,
- "volume_snapshot_class_mapping": {
- "property1": "string",
- "property2": "string"
}, - "direct_kdmp": true,
- "retention_time": "2019-08-24T14:15:22Z",
- "completion_time_info": {
- "volumes_completion_time": "2019-08-24T14:15:22Z",
- "resources_completion_time": "2019-08-24T14:15:22Z",
- "total_completion_time": "2019-08-24T14:15:22Z"
}, - "exclude_resource_types": [
- "string"
], - "parallel_backup": true,
- "keep_cr_status": true,
- "isBackupReady_for_PXDLocalSnapshotRestore": true,
- "advanced_resource_label_selector": "string",
- "schedule_policy_ref": {
- "name": "string",
- "uid": "string"
}, - "virtual_machines": [
- {
- "name": "string",
- "namespace": "string",
- "os_name": "string",
- "status": {
- "status": "Invalid",
- "reason": "string"
}
}
], - "virtual_machines_total_count": "string",
- "virtual_machines_failed_count": "string",
- "retry_parent": {
- "name": "string",
- "uid": "string"
}, - "volume_resource_only_policy_ref": {
- "name": "string",
- "uid": "string"
}, - "virtual_machine_resources": [
- {
- "resource_info": {
- "name": "string",
- "namespace": "string",
- "group": "string",
- "kind": "string",
- "version": "string"
}, - "virtual_machine_names": [
- "string"
]
}
]
}
}
], - "total_count": "string",
- "complete": true
}
org_id required | string |
name required | string |
uid | string |
{- "backup": {
- "metadata": {
- "name": "string",
- "uid": "string",
- "owner": "string",
- "org_id": "string",
- "create_time": "2019-08-24T14:15:22Z",
- "last_update_time": "2019-08-24T14:15:22Z",
- "labels": {
- "property1": "string",
- "property2": "string"
}, - "create_time_in_sec": "string",
- "ownership": {
- "owner": "string",
- "groups": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "collaborators": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "public": {
- "type": "Invalid"
}
}
}, - "backup_info": {
- "backup_location": "string",
- "cluster": "string",
- "namespaces": [
- "string"
], - "label_selectors": {
- "property1": "string",
- "property2": "string"
}, - "status": {
- "status": "Invalid",
- "reason": "string"
}, - "resources": [
- {
- "name": "string",
- "namespace": "string",
- "group": "string",
- "kind": "string",
- "version": "string"
}
], - "volumes": [
- {
- "name": "string",
- "namespace": "string",
- "pvc": "string",
- "backup_id": "string",
- "status": {
- "status": "Invalid",
- "reason": "string"
}, - "driver_name": "string",
- "zones": [
- "string"
], - "options": {
- "property1": "string",
- "property2": "string"
}, - "total_size": "string",
- "actual_size": "string",
- "storage_class": "string",
- "pvc_id": "string",
- "provisioner": "string",
- "volumesnapshot": "string",
- "job_security_context": {
- "runAsUser": "string",
- "runAsGroup": "string"
}, - "virtual_machine_name": "string",
- "backup_mode": {
- "type": "Invalid"
}
}
], - "backup_path": "string",
- "stage": "Invalid",
- "pre_exec_rule": "string",
- "post_exec_rule": "string",
- "backup_schedule": {
- "uid": "string",
- "name": "string"
}, - "cr_name": "string",
- "total_size": "string",
- "cloud_credential": "string",
- "include_resources": [
- {
- "name": "string",
- "namespace": "string",
- "group": "string",
- "kind": "string",
- "version": "string"
}
], - "resource_count": "string",
- "stork_version": "string",
- "csi_snapshot_class_name": "string",
- "resource_types": [
- "string"
], - "backup_location_ref": {
- "name": "string",
- "uid": "string"
}, - "pre_exec_rule_ref": {
- "name": "string",
- "uid": "string"
}, - "post_exec_rule_ref": {
- "name": "string",
- "uid": "string"
}, - "cloud_credential_ref": {
- "name": "string",
- "uid": "string"
}, - "backup_type": {
- "type": "Invalid"
}, - "cr_uid": "string",
- "retention_period": "string",
- "backup_share": {
- "groups": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "collaborators": [
- {
- "id": "string",
- "access": "Invalid"
}
]
}, - "user_backupshare_access": "Invalid",
- "cluster_ref": {
- "name": "string",
- "uid": "string"
}, - "ns_label_selectors": "string",
- "rancher_projects": {
- "property1": "string",
- "property2": "string"
}, - "target_namespace": "string",
- "large_resource_enabled": true,
- "backup_object_type": {
- "type": "Invalid"
}, - "skip_vm_auto_exec_rules": true,
- "volume_snapshot_class_mapping": {
- "property1": "string",
- "property2": "string"
}, - "direct_kdmp": true,
- "retention_time": "2019-08-24T14:15:22Z",
- "completion_time_info": {
- "volumes_completion_time": "2019-08-24T14:15:22Z",
- "resources_completion_time": "2019-08-24T14:15:22Z",
- "total_completion_time": "2019-08-24T14:15:22Z"
}, - "exclude_resource_types": [
- "string"
], - "parallel_backup": true,
- "keep_cr_status": true,
- "isBackupReady_for_PXDLocalSnapshotRestore": true,
- "advanced_resource_label_selector": "string",
- "schedule_policy_ref": {
- "name": "string",
- "uid": "string"
}, - "virtual_machines": [
- {
- "name": "string",
- "namespace": "string",
- "os_name": "string",
- "status": {
- "status": "Invalid",
- "reason": "string"
}
}
], - "virtual_machines_total_count": "string",
- "virtual_machines_failed_count": "string",
- "retry_parent": {
- "name": "string",
- "uid": "string"
}, - "volume_resource_only_policy_ref": {
- "name": "string",
- "uid": "string"
}, - "virtual_machine_resources": [
- {
- "resource_info": {
- "name": "string",
- "namespace": "string",
- "group": "string",
- "kind": "string",
- "version": "string"
}, - "virtual_machine_names": [
- "string"
]
}
]
}
}
}
org_id required | string |
name required | string |
cluster | string cluster name or uid to perform delete through. |
uid | string |
cluster_ref.name | string |
cluster_ref.uid | string |
{ }
object (CreateMetadata) | |
object (BackupLocationInfo) |
{- "metadata": {
- "name": "string",
- "org_id": "string",
- "owner": "string",
- "labels": {
- "property1": "string",
- "property2": "string"
}, - "ownership": {
- "owner": "string",
- "groups": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "collaborators": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "public": {
- "type": "Invalid"
}
}, - "uid": "string"
}, - "backup_location": {
- "type": "Invalid",
- "path": "string",
- "encryption_key": "string",
- "cloud_credential": "string",
- "status": {
- "status": "Invalid",
- "reason": "string"
}, - "delete_backups": true,
- "validate_cloud_credential": true,
- "cloud_credential_ref": {
- "name": "string",
- "uid": "string"
}, - "object_lock_enabled": true,
- "s3_config": {
- "endpoint": "string",
- "region": "string",
- "disable_ssl": true,
- "disable_path_style": true,
- "storage_class": "string",
- "sse_type": "Invalid",
- "azure_environment": {
- "type": "Invalid"
}, - "azure_resource_group_name": "string"
}, - "nfs_config": {
- "server_addr": "string",
- "sub_path": "string",
- "mount_option": "string"
}
}
}
{- "backup_location": {
- "metadata": {
- "name": "string",
- "uid": "string",
- "owner": "string",
- "org_id": "string",
- "create_time": "2019-08-24T14:15:22Z",
- "last_update_time": "2019-08-24T14:15:22Z",
- "labels": {
- "property1": "string",
- "property2": "string"
}, - "create_time_in_sec": "string",
- "ownership": {
- "owner": "string",
- "groups": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "collaborators": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "public": {
- "type": "Invalid"
}
}
}, - "backup_location_info": {
- "type": "Invalid",
- "path": "string",
- "encryption_key": "string",
- "cloud_credential": "string",
- "status": {
- "status": "Invalid",
- "reason": "string"
}, - "delete_backups": true,
- "validate_cloud_credential": true,
- "cloud_credential_ref": {
- "name": "string",
- "uid": "string"
}, - "object_lock_enabled": true,
- "s3_config": {
- "endpoint": "string",
- "region": "string",
- "disable_ssl": true,
- "disable_path_style": true,
- "storage_class": "string",
- "sse_type": "Invalid",
- "azure_environment": {
- "type": "Invalid"
}, - "azure_resource_group_name": "string"
}, - "nfs_config": {
- "server_addr": "string",
- "sub_path": "string",
- "mount_option": "string"
}
}
}
}
object (CreateMetadata) | |
object (BackupLocationInfo) |
{- "metadata": {
- "name": "string",
- "org_id": "string",
- "owner": "string",
- "labels": {
- "property1": "string",
- "property2": "string"
}, - "ownership": {
- "owner": "string",
- "groups": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "collaborators": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "public": {
- "type": "Invalid"
}
}, - "uid": "string"
}, - "backup_location": {
- "type": "Invalid",
- "path": "string",
- "encryption_key": "string",
- "cloud_credential": "string",
- "status": {
- "status": "Invalid",
- "reason": "string"
}, - "delete_backups": true,
- "validate_cloud_credential": true,
- "cloud_credential_ref": {
- "name": "string",
- "uid": "string"
}, - "object_lock_enabled": true,
- "s3_config": {
- "endpoint": "string",
- "region": "string",
- "disable_ssl": true,
- "disable_path_style": true,
- "storage_class": "string",
- "sse_type": "Invalid",
- "azure_environment": {
- "type": "Invalid"
}, - "azure_resource_group_name": "string"
}, - "nfs_config": {
- "server_addr": "string",
- "sub_path": "string",
- "mount_option": "string"
}
}
}
{ }
org_id | string |
name | string (Backup location to be updated) |
object (Ownership) Ownership information for objects(eg: backup object, schedule object).
Administrators are users who belong to the group | |
uid | string |
{- "org_id": "string",
- "name": "string",
- "ownership": {
- "owner": "string",
- "groups": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "collaborators": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "public": {
- "type": "Invalid"
}
}, - "uid": "string"
}
{ }
org_id | string |
name | string |
uid | string |
{- "org_id": "string",
- "name": "string",
- "uid": "string"
}
{ }
org_id required | string |
cloud_credential | string cloud credential name. Enumerate will return list of backuplocation that uses this cloud credential cloud_credential is deprecated, not to be used. |
cloud_credential_ref.name | string |
cloud_credential_ref.uid | string |
include_secrets | boolean <boolean> enable include_secrets to get the encryptionKey value. |
include_validation_state | boolean <boolean> If true, include backuplocation that are in ValidationInProgress state as well. |
{- "backup_locations": [
- {
- "metadata": {
- "name": "string",
- "uid": "string",
- "owner": "string",
- "org_id": "string",
- "create_time": "2019-08-24T14:15:22Z",
- "last_update_time": "2019-08-24T14:15:22Z",
- "labels": {
- "property1": "string",
- "property2": "string"
}, - "create_time_in_sec": "string",
- "ownership": {
- "owner": "string",
- "groups": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "collaborators": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "public": {
- "type": "Invalid"
}
}
}, - "backup_location_info": {
- "type": "Invalid",
- "path": "string",
- "encryption_key": "string",
- "cloud_credential": "string",
- "status": {
- "status": "Invalid",
- "reason": "string"
}, - "delete_backups": true,
- "validate_cloud_credential": true,
- "cloud_credential_ref": {
- "name": "string",
- "uid": "string"
}, - "object_lock_enabled": true,
- "s3_config": {
- "endpoint": "string",
- "region": "string",
- "disable_ssl": true,
- "disable_path_style": true,
- "storage_class": "string",
- "sse_type": "Invalid",
- "azure_environment": {
- "type": "Invalid"
}, - "azure_resource_group_name": "string"
}, - "nfs_config": {
- "server_addr": "string",
- "sub_path": "string",
- "mount_option": "string"
}
}
}
]
}
org_id required | string |
name required | string |
uid required | string |
include_secrets | boolean <boolean> enable include_secrets to get the encryptionKey value. |
{- "backup_location": {
- "metadata": {
- "name": "string",
- "uid": "string",
- "owner": "string",
- "org_id": "string",
- "create_time": "2019-08-24T14:15:22Z",
- "last_update_time": "2019-08-24T14:15:22Z",
- "labels": {
- "property1": "string",
- "property2": "string"
}, - "create_time_in_sec": "string",
- "ownership": {
- "owner": "string",
- "groups": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "collaborators": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "public": {
- "type": "Invalid"
}
}
}, - "backup_location_info": {
- "type": "Invalid",
- "path": "string",
- "encryption_key": "string",
- "cloud_credential": "string",
- "status": {
- "status": "Invalid",
- "reason": "string"
}, - "delete_backups": true,
- "validate_cloud_credential": true,
- "cloud_credential_ref": {
- "name": "string",
- "uid": "string"
}, - "object_lock_enabled": true,
- "s3_config": {
- "endpoint": "string",
- "region": "string",
- "disable_ssl": true,
- "disable_path_style": true,
- "storage_class": "string",
- "sse_type": "Invalid",
- "azure_environment": {
- "type": "Invalid"
}, - "azure_resource_group_name": "string"
}, - "nfs_config": {
- "server_addr": "string",
- "sub_path": "string",
- "mount_option": "string"
}
}
}
}
object (CreateMetadata) | |
schedule_policy | string (schedule_policy is deprecated, not to be used) |
reclaim_policy | string (BackupScheduleInfoReclaimPolicyType) Default: "Invalid" Enum: "Invalid" "Delete" "Retain" |
backup_location | string (Name of BackupLocation, is deprecated. Not to be used) |
cluster | string (Name of Cluster) |
namespaces | Array of strings (Namespaces to backup. Only an admin can provide multiple namespaces) |
object (Label selectors to choose resources) | |
pre_exec_rule | string pre_exec_rule and post_exec_rule are deprecated. Not to be used. |
post_exec_rule | string |
Array of objects (List of resources to backup (optional)) | |
csi_snapshot_class_name | string Snapshot class name to use for backup schedule (optional) deprecated, not to be used. |
resource_types | Array of strings (List of resource types to backup (optional)) |
object (ObjectRef) | |
object (ObjectRef) | |
object (ObjectRef) | |
object (ObjectRef) | |
backup_type | string (BackupScheduleCreateRequestBackupType) Default: "Invalid" Enum: "Invalid" "Generic" "Normal" |
ns_label_selectors | string |
object (ObjectRef) | |
object (BackupScheduleCreateRequestBackupObjectType) | |
skip_vm_auto_exec_rules | boolean <boolean> (Skip auto rules for VirtualMachine Backup Object type) |
object (volume snapshot class mapping for csi based backup <provisioner(string), volumesnapshotclass(string)> (optional)) | |
direct_kdmp | boolean <boolean> (option to take backup as direct kdmp) |
exclude_resource_types | Array of strings |
parallel_backup | boolean <boolean> option to enable parallel schedule backups. |
keep_cr_status | boolean <boolean> option to enable to keep the CR status of the resources in the backupschedule. |
advanced_resource_label_selector | string (older label selector does not support string type. Map type has contraint of supporting operator, So introducing this new parameter) |
object (ObjectRef) |
{- "metadata": {
- "name": "string",
- "org_id": "string",
- "owner": "string",
- "labels": {
- "property1": "string",
- "property2": "string"
}, - "ownership": {
- "owner": "string",
- "groups": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "collaborators": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "public": {
- "type": "Invalid"
}
}, - "uid": "string"
}, - "schedule_policy": "string",
- "reclaim_policy": "Invalid",
- "backup_location": "string",
- "cluster": "string",
- "namespaces": [
- "string"
], - "label_selectors": {
- "property1": "string",
- "property2": "string"
}, - "pre_exec_rule": "string",
- "post_exec_rule": "string",
- "include_resources": [
- {
- "name": "string",
- "namespace": "string",
- "group": "string",
- "kind": "string",
- "version": "string"
}
], - "csi_snapshot_class_name": "string",
- "resource_types": [
- "string"
], - "schedule_policy_ref": {
- "name": "string",
- "uid": "string"
}, - "backup_location_ref": {
- "name": "string",
- "uid": "string"
}, - "pre_exec_rule_ref": {
- "name": "string",
- "uid": "string"
}, - "post_exec_rule_ref": {
- "name": "string",
- "uid": "string"
}, - "backup_type": "Invalid",
- "ns_label_selectors": "string",
- "cluster_ref": {
- "name": "string",
- "uid": "string"
}, - "backup_object_type": {
- "type": "Invalid"
}, - "skip_vm_auto_exec_rules": true,
- "volume_snapshot_class_mapping": {
- "property1": "string",
- "property2": "string"
}, - "direct_kdmp": true,
- "exclude_resource_types": [
- "string"
], - "parallel_backup": true,
- "keep_cr_status": true,
- "advanced_resource_label_selector": "string",
- "volume_resource_only_policy_ref": {
- "name": "string",
- "uid": "string"
}
}
{- "backup_schedule": {
- "metadata": {
- "name": "string",
- "uid": "string",
- "owner": "string",
- "org_id": "string",
- "create_time": "2019-08-24T14:15:22Z",
- "last_update_time": "2019-08-24T14:15:22Z",
- "labels": {
- "property1": "string",
- "property2": "string"
}, - "create_time_in_sec": "string",
- "ownership": {
- "owner": "string",
- "groups": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "collaborators": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "public": {
- "type": "Invalid"
}
}
}, - "backup_schedule_info": {
- "schedule_policy": "string",
- "suspend": true,
- "reclaim_policy": "Invalid",
- "backup_status": {
- "property1": {
- "status": [
- {
- "backup_name": "string",
- "create_time": "2019-08-24T14:15:22Z",
- "finish_time": "2019-08-24T14:15:22Z",
- "status": "Invalid",
- "Reason": "string"
}
]
}, - "property2": {
- "status": [
- {
- "backup_name": "string",
- "create_time": "2019-08-24T14:15:22Z",
- "finish_time": "2019-08-24T14:15:22Z",
- "status": "Invalid",
- "Reason": "string"
}
]
}
}, - "backup_location": "string",
- "cluster": "string",
- "namespaces": [
- "string"
], - "label_selectors": {
- "property1": "string",
- "property2": "string"
}, - "pre_exec_rule": "string",
- "post_exec_rule": "string",
- "delete_backups": true,
- "status": {
- "backup_name": "string",
- "create_time": "2019-08-24T14:15:22Z",
- "finish_time": "2019-08-24T14:15:22Z",
- "status": "Invalid",
- "Reason": "string"
}, - "suspended_by": {
- "source": "Invalid"
}, - "include_resources": [
- {
- "name": "string",
- "namespace": "string",
- "group": "string",
- "kind": "string",
- "version": "string"
}
], - "stork_version": "string",
- "csi_snapshot_class_name": "string",
- "resource_types": [
- "string"
], - "schedule_policy_ref": {
- "name": "string",
- "uid": "string"
}, - "backup_location_ref": {
- "name": "string",
- "uid": "string"
}, - "pre_exec_rule_ref": {
- "name": "string",
- "uid": "string"
}, - "post_exec_rule_ref": {
- "name": "string",
- "uid": "string"
}, - "backup_type": {
- "type": "Invalid"
}, - "ns_label_selectors": "string",
- "target_namespace": "string",
- "cluster_ref": {
- "name": "string",
- "uid": "string"
}, - "backup_object_type": {
- "type": "Invalid"
}, - "skip_vm_auto_exec_rules": true,
- "volume_snapshot_class_mapping": {
- "property1": "string",
- "property2": "string"
}, - "direct_kdmp": true,
- "exclude_resource_types": [
- "string"
], - "parallel_backup": true,
- "keep_cr_status": true,
- "advanced_resource_label_selector": "string",
- "volume_resource_only_policy_ref": {
- "name": "string",
- "uid": "string"
}
}
}
}
object (CreateMetadata) | |
schedule_policy | string (schedule_policy is deprecated, not to be used) |
reclaim_policy | string (BackupScheduleInfoReclaimPolicyType) Default: "Invalid" Enum: "Invalid" "Delete" "Retain" |
backup_location | string (Name of BackupLocation, is deprecated. Not to be used) |
cluster | string (Name of Cluster) |
namespaces | Array of strings (Namespaces to backup. Only an admin can provide multiple namespaces) |
object (Label selectors to choose resources) | |
pre_exec_rule | string pre_exec_rule and post_exec_rule are deprecated. Not to be used. |
post_exec_rule | string |
suspend | boolean <boolean> |
Array of objects (List of resources to backup (optional)) | |
csi_snapshot_class_name | string Snapshot class name to use for backup schedule (optional) deprecated, not to be used. |
object (ObjectRef) | |
object (ObjectRef) | |
object (ObjectRef) | |
object (ObjectRef) | |
object (volume snapshot class mapping for csi based backup <provisioner(string), volumesnapshotclass(string)> (optional)) | |
skip_vm_auto_exec_rules | boolean <boolean> (Skip auto rules for VirtualMachine Backup Object type) |
parallel_backup | boolean <boolean> option to enable parallel schedule backups. |
advanced_resource_label_selector | string advanced_resource_label_selector is not supported for update; No-op. |
object (BackupObjectType) | |
Array of objects (multiple policy reference for filtering) | |
Array of objects (ObjectRef) List of exact backup schedules to exclude (name + UID required). | |
Array of objects (ObjectRef) List of exact backup schedules to include (name + UID required). | |
include_filter | string Substring or regex pattern to match backup schedules and include (e.g. "*" for All, "pxb-" or any valid regex) Cannot be used with include_objects. |
exclude_filter | string Substring or regex pattern to match backup schedules and exclude (e.g. "*" for All, "pxb-" or any valid regex) Cannot be used with exclude_objects. |
object (ClusterScope) | |
object (ObjectRef) |
{- "metadata": {
- "name": "string",
- "org_id": "string",
- "owner": "string",
- "labels": {
- "property1": "string",
- "property2": "string"
}, - "ownership": {
- "owner": "string",
- "groups": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "collaborators": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "public": {
- "type": "Invalid"
}
}, - "uid": "string"
}, - "schedule_policy": "string",
- "reclaim_policy": "Invalid",
- "backup_location": "string",
- "cluster": "string",
- "namespaces": [
- "string"
], - "label_selectors": {
- "property1": "string",
- "property2": "string"
}, - "pre_exec_rule": "string",
- "post_exec_rule": "string",
- "suspend": true,
- "include_resources": [
- {
- "name": "string",
- "namespace": "string",
- "group": "string",
- "kind": "string",
- "version": "string"
}
], - "csi_snapshot_class_name": "string",
- "schedule_policy_ref": {
- "name": "string",
- "uid": "string"
}, - "backup_location_ref": {
- "name": "string",
- "uid": "string"
}, - "pre_exec_rule_ref": {
- "name": "string",
- "uid": "string"
}, - "post_exec_rule_ref": {
- "name": "string",
- "uid": "string"
}, - "volume_snapshot_class_mapping": {
- "property1": "string",
- "property2": "string"
}, - "skip_vm_auto_exec_rules": true,
- "parallel_backup": true,
- "advanced_resource_label_selector": "string",
- "backup_object_type": {
- "type": "Invalid"
}, - "policy_ref": [
- {
- "name": "string",
- "uid": "string"
}
], - "exclude_objects": [
- {
- "name": "string",
- "uid": "string"
}
], - "include_objects": [
- {
- "name": "string",
- "uid": "string"
}
], - "include_filter": "string",
- "exclude_filter": "string",
- "cluster_scope": {
- "cluster_refs": {
- "refs": [
- {
- "name": "string",
- "uid": "string"
}
]
}, - "all_clusters": true
}, - "volume_resource_only_policy_ref": {
- "name": "string",
- "uid": "string"
}
}
{ }
org_id required | string |
backup_location | string Backuplocation name. Enumerate will return list of backupschedule that uses this backuplocation backup_location is deprecated, not to be used. |
backup_location_ref.name | string |
backup_location_ref.uid | string |
enumerate_options.max_objects | string <uint64> max objects to fetch. |
enumerate_options.time_range.start_time | string <date-time> |
enumerate_options.time_range.end_time | string <date-time> |
enumerate_options.name_filter | string Filter to use for name of objects. Any object that contains the filter will be returned. |
enumerate_options.cluster_name_filter | string Filter to use for cluster name of objects. Any object that contains the filter will be returned. |
enumerate_options.object_index | string <uint64> |
enumerate_options.include_detailed_resources | boolean <boolean> Ths option will be set to true by the caller, when they want to have complete backup object. That means the backupObject's resource list will be set to complete list of resources. If this option is set to false, resource list will be set to nil and rest of the backupObject details will be returned in the response. |
enumerate_options.cluster_uid_filter | string Filter to use with cluster uid on objects. Any object that contains the filter will be returned Currently backup enumerate request should pass this along with cluster name. |
enumerate_options.owners | Array of strings Filter to use owner uids on objects. Any object that contains the filter will be returned. |
enumerate_options.backup_object_type | string filter to use backupObjectType on object. |
enumerate_options.status | Array of strings filter based on the object status. Need to pass the string value of the status field of the object ( backup /restore ) For example, {"Success", "Failed"}. |
enumerate_options.sort_option.sortBy.type | string Default: "Invalid" Enum: "Invalid" "CreationTimestamp" "Name" "ClusterName" "Size" "RestoreBackupName" Name of the field by which sort to be performed. |
enumerate_options.sort_option.sortOrder.type | string Default: "Invalid" Enum: "Invalid" "Ascending" "Descending" Order of sorting. |
{- "backup_schedules": [
- {
- "metadata": {
- "name": "string",
- "uid": "string",
- "owner": "string",
- "org_id": "string",
- "create_time": "2019-08-24T14:15:22Z",
- "last_update_time": "2019-08-24T14:15:22Z",
- "labels": {
- "property1": "string",
- "property2": "string"
}, - "create_time_in_sec": "string",
- "ownership": {
- "owner": "string",
- "groups": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "collaborators": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "public": {
- "type": "Invalid"
}
}
}, - "backup_schedule_info": {
- "schedule_policy": "string",
- "suspend": true,
- "reclaim_policy": "Invalid",
- "backup_status": {
- "property1": {
- "status": [
- {
- "backup_name": "string",
- "create_time": "2019-08-24T14:15:22Z",
- "finish_time": "2019-08-24T14:15:22Z",
- "status": "Invalid",
- "Reason": "string"
}
]
}, - "property2": {
- "status": [
- {
- "backup_name": "string",
- "create_time": "2019-08-24T14:15:22Z",
- "finish_time": "2019-08-24T14:15:22Z",
- "status": "Invalid",
- "Reason": "string"
}
]
}
}, - "backup_location": "string",
- "cluster": "string",
- "namespaces": [
- "string"
], - "label_selectors": {
- "property1": "string",
- "property2": "string"
}, - "pre_exec_rule": "string",
- "post_exec_rule": "string",
- "delete_backups": true,
- "status": {
- "backup_name": "string",
- "create_time": "2019-08-24T14:15:22Z",
- "finish_time": "2019-08-24T14:15:22Z",
- "status": "Invalid",
- "Reason": "string"
}, - "suspended_by": {
- "source": "Invalid"
}, - "include_resources": [
- {
- "name": "string",
- "namespace": "string",
- "group": "string",
- "kind": "string",
- "version": "string"
}
], - "stork_version": "string",
- "csi_snapshot_class_name": "string",
- "resource_types": [
- "string"
], - "schedule_policy_ref": {
- "name": "string",
- "uid": "string"
}, - "backup_location_ref": {
- "name": "string",
- "uid": "string"
}, - "pre_exec_rule_ref": {
- "name": "string",
- "uid": "string"
}, - "post_exec_rule_ref": {
- "name": "string",
- "uid": "string"
}, - "backup_type": {
- "type": "Invalid"
}, - "ns_label_selectors": "string",
- "target_namespace": "string",
- "cluster_ref": {
- "name": "string",
- "uid": "string"
}, - "backup_object_type": {
- "type": "Invalid"
}, - "skip_vm_auto_exec_rules": true,
- "volume_snapshot_class_mapping": {
- "property1": "string",
- "property2": "string"
}, - "direct_kdmp": true,
- "exclude_resource_types": [
- "string"
], - "parallel_backup": true,
- "keep_cr_status": true,
- "advanced_resource_label_selector": "string",
- "volume_resource_only_policy_ref": {
- "name": "string",
- "uid": "string"
}
}
}
], - "total_count": "string",
- "complete": true
}
org_id required | string |
org_id | string |
name | string |
delete_backups | boolean <boolean> delete_backups is deprecated, not to be used. |
uid | string |
Array of objects (ObjectRef) List of exact backup schedules to include (name + UID required). | |
object (BackupObjectType) | |
Array of objects (multiple policy reference for filtering) | |
Array of objects (ObjectRef) List of exact backup schedules to exclude (name + UID required). | |
include_filter | string Substring or regex pattern to match backup schedules and include (e.g. "*" for All, "pxb-" or any valid regex) Cannot be used with include_objects. |
exclude_filter | string Substring or regex pattern to match backup schedules and exclude (e.g. "*" for All, "pxb-" or any valid regex) Cannot be used with exclude_objects. |
object (ClusterScope) |
{- "org_id": "string",
- "name": "string",
- "delete_backups": true,
- "uid": "string",
- "include_objects": [
- {
- "name": "string",
- "uid": "string"
}
], - "backup_object_type": {
- "type": "Invalid"
}, - "policy_ref": [
- {
- "name": "string",
- "uid": "string"
}
], - "exclude_objects": [
- {
- "name": "string",
- "uid": "string"
}
], - "include_filter": "string",
- "exclude_filter": "string",
- "cluster_scope": {
- "cluster_refs": {
- "refs": [
- {
- "name": "string",
- "uid": "string"
}
]
}, - "all_clusters": true
}
}
{ }
org_id required | string |
org_id | string |
object (label selectors for the object for filtering) | |
backup_location | string Backuplocation name. Enumerate will return list of backupschedule that uses this backuplocation backup_location is deprecated, not to be used. |
object (ObjectRef) | |
object (EnumerateOptions) |
{- "org_id": "string",
- "labels": {
- "property1": "string",
- "property2": "string"
}, - "backup_location": "string",
- "backup_location_ref": {
- "name": "string",
- "uid": "string"
}, - "enumerate_options": {
- "labels": {
- "property1": "string",
- "property2": "string"
}, - "max_objects": "string",
- "time_range": {
- "start_time": "2019-08-24T14:15:22Z",
- "end_time": "2019-08-24T14:15:22Z"
}, - "name_filter": "string",
- "cluster_name_filter": "string",
- "object_index": "string",
- "include_detailed_resources": true,
- "cluster_uid_filter": "string",
- "owners": [
- "string"
], - "backup_object_type": "string",
- "status": [
- "string"
], - "schedule_policy_ref": [
- {
- "name": "string",
- "uid": "string"
}
], - "backup_schedule_ref": [
- {
- "name": "string",
- "uid": "string"
}
], - "sort_option": {
- "sortBy": {
- "type": "Invalid"
}, - "sortOrder": {
- "type": "Invalid"
}
}
}
}
{- "backup_schedules": [
- {
- "metadata": {
- "name": "string",
- "uid": "string",
- "owner": "string",
- "org_id": "string",
- "create_time": "2019-08-24T14:15:22Z",
- "last_update_time": "2019-08-24T14:15:22Z",
- "labels": {
- "property1": "string",
- "property2": "string"
}, - "create_time_in_sec": "string",
- "ownership": {
- "owner": "string",
- "groups": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "collaborators": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "public": {
- "type": "Invalid"
}
}
}, - "backup_schedule_info": {
- "schedule_policy": "string",
- "suspend": true,
- "reclaim_policy": "Invalid",
- "backup_status": {
- "property1": {
- "status": [
- {
- "backup_name": "string",
- "create_time": "2019-08-24T14:15:22Z",
- "finish_time": "2019-08-24T14:15:22Z",
- "status": "Invalid",
- "Reason": "string"
}
]
}, - "property2": {
- "status": [
- {
- "backup_name": "string",
- "create_time": "2019-08-24T14:15:22Z",
- "finish_time": "2019-08-24T14:15:22Z",
- "status": "Invalid",
- "Reason": "string"
}
]
}
}, - "backup_location": "string",
- "cluster": "string",
- "namespaces": [
- "string"
], - "label_selectors": {
- "property1": "string",
- "property2": "string"
}, - "pre_exec_rule": "string",
- "post_exec_rule": "string",
- "delete_backups": true,
- "status": {
- "backup_name": "string",
- "create_time": "2019-08-24T14:15:22Z",
- "finish_time": "2019-08-24T14:15:22Z",
- "status": "Invalid",
- "Reason": "string"
}, - "suspended_by": {
- "source": "Invalid"
}, - "include_resources": [
- {
- "name": "string",
- "namespace": "string",
- "group": "string",
- "kind": "string",
- "version": "string"
}
], - "stork_version": "string",
- "csi_snapshot_class_name": "string",
- "resource_types": [
- "string"
], - "schedule_policy_ref": {
- "name": "string",
- "uid": "string"
}, - "backup_location_ref": {
- "name": "string",
- "uid": "string"
}, - "pre_exec_rule_ref": {
- "name": "string",
- "uid": "string"
}, - "post_exec_rule_ref": {
- "name": "string",
- "uid": "string"
}, - "backup_type": {
- "type": "Invalid"
}, - "ns_label_selectors": "string",
- "target_namespace": "string",
- "cluster_ref": {
- "name": "string",
- "uid": "string"
}, - "backup_object_type": {
- "type": "Invalid"
}, - "skip_vm_auto_exec_rules": true,
- "volume_snapshot_class_mapping": {
- "property1": "string",
- "property2": "string"
}, - "direct_kdmp": true,
- "exclude_resource_types": [
- "string"
], - "parallel_backup": true,
- "keep_cr_status": true,
- "advanced_resource_label_selector": "string",
- "volume_resource_only_policy_ref": {
- "name": "string",
- "uid": "string"
}
}
}
], - "total_count": "string",
- "complete": true
}
org_id required | string |
name required | string |
uid | string |
{- "backup_schedule": {
- "metadata": {
- "name": "string",
- "uid": "string",
- "owner": "string",
- "org_id": "string",
- "create_time": "2019-08-24T14:15:22Z",
- "last_update_time": "2019-08-24T14:15:22Z",
- "labels": {
- "property1": "string",
- "property2": "string"
}, - "create_time_in_sec": "string",
- "ownership": {
- "owner": "string",
- "groups": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "collaborators": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "public": {
- "type": "Invalid"
}
}
}, - "backup_schedule_info": {
- "schedule_policy": "string",
- "suspend": true,
- "reclaim_policy": "Invalid",
- "backup_status": {
- "property1": {
- "status": [
- {
- "backup_name": "string",
- "create_time": "2019-08-24T14:15:22Z",
- "finish_time": "2019-08-24T14:15:22Z",
- "status": "Invalid",
- "Reason": "string"
}
]
}, - "property2": {
- "status": [
- {
- "backup_name": "string",
- "create_time": "2019-08-24T14:15:22Z",
- "finish_time": "2019-08-24T14:15:22Z",
- "status": "Invalid",
- "Reason": "string"
}
]
}
}, - "backup_location": "string",
- "cluster": "string",
- "namespaces": [
- "string"
], - "label_selectors": {
- "property1": "string",
- "property2": "string"
}, - "pre_exec_rule": "string",
- "post_exec_rule": "string",
- "delete_backups": true,
- "status": {
- "backup_name": "string",
- "create_time": "2019-08-24T14:15:22Z",
- "finish_time": "2019-08-24T14:15:22Z",
- "status": "Invalid",
- "Reason": "string"
}, - "suspended_by": {
- "source": "Invalid"
}, - "include_resources": [
- {
- "name": "string",
- "namespace": "string",
- "group": "string",
- "kind": "string",
- "version": "string"
}
], - "stork_version": "string",
- "csi_snapshot_class_name": "string",
- "resource_types": [
- "string"
], - "schedule_policy_ref": {
- "name": "string",
- "uid": "string"
}, - "backup_location_ref": {
- "name": "string",
- "uid": "string"
}, - "pre_exec_rule_ref": {
- "name": "string",
- "uid": "string"
}, - "post_exec_rule_ref": {
- "name": "string",
- "uid": "string"
}, - "backup_type": {
- "type": "Invalid"
}, - "ns_label_selectors": "string",
- "target_namespace": "string",
- "cluster_ref": {
- "name": "string",
- "uid": "string"
}, - "backup_object_type": {
- "type": "Invalid"
}, - "skip_vm_auto_exec_rules": true,
- "volume_snapshot_class_mapping": {
- "property1": "string",
- "property2": "string"
}, - "direct_kdmp": true,
- "exclude_resource_types": [
- "string"
], - "parallel_backup": true,
- "keep_cr_status": true,
- "advanced_resource_label_selector": "string",
- "volume_resource_only_policy_ref": {
- "name": "string",
- "uid": "string"
}
}
}
}
org_id required | string |
name required | string |
uid required | string |
delete_backups | boolean <boolean> delete_backups is deprecated, not to be used. |
backup_object_type.type | string Default: "Invalid" Enum: "Invalid" "NS" "VM" "All"
|
include_filter | string Substring or regex pattern to match backup schedules and include (e.g. "*" for All, "pxb-" or any valid regex) Cannot be used with include_objects. |
exclude_filter | string Substring or regex pattern to match backup schedules and exclude (e.g. "*" for All, "pxb-" or any valid regex) Cannot be used with exclude_objects. |
cluster_scope.all_clusters | boolean <boolean> |
{ }
object (CreateMetadata) | |
object (CloudCredentialInfo) |
{- "metadata": {
- "name": "string",
- "org_id": "string",
- "owner": "string",
- "labels": {
- "property1": "string",
- "property2": "string"
}, - "ownership": {
- "owner": "string",
- "groups": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "collaborators": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "public": {
- "type": "Invalid"
}
}, - "uid": "string"
}, - "cloud_credential": {
- "type": "Invalid",
- "aws_config": {
- "access_key": "string",
- "secret_key": "string"
}, - "azure_config": {
- "account_name": "string",
- "account_key": "string",
- "client_secret": "string",
- "client_id": "string",
- "tenant_id": "string",
- "subscription_id": "string"
}, - "google_config": {
- "project_id": "string",
- "json_key": "string"
}, - "ibm_config": {
- "api_key": "string"
}, - "rancher_config": {
- "endpoint": "string",
- "token": "string"
}
}
}
{- "cloud_credential": {
- "metadata": {
- "name": "string",
- "uid": "string",
- "owner": "string",
- "org_id": "string",
- "create_time": "2019-08-24T14:15:22Z",
- "last_update_time": "2019-08-24T14:15:22Z",
- "labels": {
- "property1": "string",
- "property2": "string"
}, - "create_time_in_sec": "string",
- "ownership": {
- "owner": "string",
- "groups": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "collaborators": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "public": {
- "type": "Invalid"
}
}
}, - "cloud_credential_info": {
- "type": "Invalid",
- "aws_config": {
- "access_key": "string",
- "secret_key": "string"
}, - "azure_config": {
- "account_name": "string",
- "account_key": "string",
- "client_secret": "string",
- "client_id": "string",
- "tenant_id": "string",
- "subscription_id": "string"
}, - "google_config": {
- "project_id": "string",
- "json_key": "string"
}, - "ibm_config": {
- "api_key": "string"
}, - "rancher_config": {
- "endpoint": "string",
- "token": "string"
}
}
}
}
object (CreateMetadata) | |
object (CloudCredentialInfo) |
{- "metadata": {
- "name": "string",
- "org_id": "string",
- "owner": "string",
- "labels": {
- "property1": "string",
- "property2": "string"
}, - "ownership": {
- "owner": "string",
- "groups": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "collaborators": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "public": {
- "type": "Invalid"
}
}, - "uid": "string"
}, - "cloud_credential": {
- "type": "Invalid",
- "aws_config": {
- "access_key": "string",
- "secret_key": "string"
}, - "azure_config": {
- "account_name": "string",
- "account_key": "string",
- "client_secret": "string",
- "client_id": "string",
- "tenant_id": "string",
- "subscription_id": "string"
}, - "google_config": {
- "project_id": "string",
- "json_key": "string"
}, - "ibm_config": {
- "api_key": "string"
}, - "rancher_config": {
- "endpoint": "string",
- "token": "string"
}
}
}
{ }
org_id | string |
name | string Cloud credential name to be updated. |
object (Ownership) Ownership information for objects(eg: backup object, schedule object).
Administrators are users who belong to the group | |
uid | string |
{- "org_id": "string",
- "name": "string",
- "ownership": {
- "owner": "string",
- "groups": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "collaborators": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "public": {
- "type": "Invalid"
}
}, - "uid": "string"
}
{ }
org_id required | string |
include_secrets | boolean <boolean> |
{- "cloud_credentials": [
- {
- "metadata": {
- "name": "string",
- "uid": "string",
- "owner": "string",
- "org_id": "string",
- "create_time": "2019-08-24T14:15:22Z",
- "last_update_time": "2019-08-24T14:15:22Z",
- "labels": {
- "property1": "string",
- "property2": "string"
}, - "create_time_in_sec": "string",
- "ownership": {
- "owner": "string",
- "groups": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "collaborators": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "public": {
- "type": "Invalid"
}
}
}, - "cloud_credential_info": {
- "type": "Invalid",
- "aws_config": {
- "access_key": "string",
- "secret_key": "string"
}, - "azure_config": {
- "account_name": "string",
- "account_key": "string",
- "client_secret": "string",
- "client_id": "string",
- "tenant_id": "string",
- "subscription_id": "string"
}, - "google_config": {
- "project_id": "string",
- "json_key": "string"
}, - "ibm_config": {
- "api_key": "string"
}, - "rancher_config": {
- "endpoint": "string",
- "token": "string"
}
}
}
]
}
org_id required | string |
name required | string |
uid required | string |
include_secrets | boolean <boolean> |
{- "cloud_credential": {
- "metadata": {
- "name": "string",
- "uid": "string",
- "owner": "string",
- "org_id": "string",
- "create_time": "2019-08-24T14:15:22Z",
- "last_update_time": "2019-08-24T14:15:22Z",
- "labels": {
- "property1": "string",
- "property2": "string"
}, - "create_time_in_sec": "string",
- "ownership": {
- "owner": "string",
- "groups": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "collaborators": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "public": {
- "type": "Invalid"
}
}
}, - "cloud_credential_info": {
- "type": "Invalid",
- "aws_config": {
- "access_key": "string",
- "secret_key": "string"
}, - "azure_config": {
- "account_name": "string",
- "account_key": "string",
- "client_secret": "string",
- "client_id": "string",
- "tenant_id": "string",
- "subscription_id": "string"
}, - "google_config": {
- "project_id": "string",
- "json_key": "string"
}, - "ibm_config": {
- "api_key": "string"
}, - "rancher_config": {
- "endpoint": "string",
- "token": "string"
}
}
}
}
object (CreateMetadata) | |
object (PXConfig) | |
kubeconfig | string |
cloud_credential | string cloud_credential is deprecated, not to be used. |
object (ObjectRef) | |
object (ObjectRef) | |
teleport_cluster_id | string (Teleport cluster ID) |
tenant_id | string (Tenant ID of the user account (aka PDS account)) |
service_token | string (PDS account service token to fetch rest.Config for
teleport based cluster) |
provider | string (Cloud provider type) Default: "Invalid" Enum: "Invalid" "AWS" "Azure" "Google" "IBM" "Rancher" |
{- "metadata": {
- "name": "string",
- "org_id": "string",
- "owner": "string",
- "labels": {
- "property1": "string",
- "property2": "string"
}, - "ownership": {
- "owner": "string",
- "groups": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "collaborators": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "public": {
- "type": "Invalid"
}
}, - "uid": "string"
}, - "px_config": {
- "access_token": "string"
}, - "kubeconfig": "string",
- "cloud_credential": "string",
- "cloud_credential_ref": {
- "name": "string",
- "uid": "string"
}, - "platform_credential_ref": {
- "name": "string",
- "uid": "string"
}, - "teleport_cluster_id": "string",
- "tenant_id": "string",
- "service_token": "string",
- "provider": "Invalid"
}
{- "cluster": {
- "metadata": {
- "name": "string",
- "uid": "string",
- "owner": "string",
- "org_id": "string",
- "create_time": "2019-08-24T14:15:22Z",
- "last_update_time": "2019-08-24T14:15:22Z",
- "labels": {
- "property1": "string",
- "property2": "string"
}, - "create_time_in_sec": "string",
- "ownership": {
- "owner": "string",
- "groups": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "collaborators": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "public": {
- "type": "Invalid"
}
}
}, - "clusterInfo": {
- "px_config": {
- "access_token": "string"
}, - "kubeconfig": "string",
- "cloud_credential": "string",
- "status": {
- "status": "Invalid",
- "reason": "string"
}, - "delete_backups": true,
- "delete_restores": true,
- "stork_version": "string",
- "cloud_credential_ref": {
- "name": "string",
- "uid": "string"
}, - "add_backup_share": {
- "groups": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "collaborators": [
- {
- "id": "string",
- "access": "Invalid"
}
]
}, - "del_backup_share": {
- "groups": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "collaborators": [
- {
- "id": "string",
- "access": "Invalid"
}
]
}, - "backup_share_status_info": {
- "status": "Invalid",
- "reason": "string"
}, - "owner_group_list": [
- "string"
], - "platform_credential_ref": {
- "name": "string",
- "uid": "string"
}, - "teleport_cluster_id": "string",
- "tenant_id": "string",
- "service_token": "string",
- "provider": "Invalid",
- "k8s_version": "string",
- "add_user_backup_share": {
- "property1": {
- "groups": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "collaborators": [
- {
- "id": "string",
- "access": "Invalid"
}
]
}, - "property2": {
- "groups": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "collaborators": [
- {
- "id": "string",
- "access": "Invalid"
}
]
}
}, - "del_user_backup_share": {
- "property1": {
- "groups": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "collaborators": [
- {
- "id": "string",
- "access": "Invalid"
}
]
}, - "property2": {
- "groups": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "collaborators": [
- {
- "id": "string",
- "access": "Invalid"
}
]
}
}, - "deleted_by": "string",
- "delete_all_cluster_backups": true,
- "time_zone": "string"
}
}
}
object (CreateMetadata) | |
object (PXConfig) | |
kubeconfig | string |
cloud_credential | string cloud_credential is deprecated, not to be used. |
object (ObjectRef) | |
object (ObjectRef) |
{- "metadata": {
- "name": "string",
- "org_id": "string",
- "owner": "string",
- "labels": {
- "property1": "string",
- "property2": "string"
}, - "ownership": {
- "owner": "string",
- "groups": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "collaborators": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "public": {
- "type": "Invalid"
}
}, - "uid": "string"
}, - "px_config": {
- "access_token": "string"
}, - "kubeconfig": "string",
- "cloud_credential": "string",
- "cloud_credential_ref": {
- "name": "string",
- "uid": "string"
}, - "platform_credential_ref": {
- "name": "string",
- "uid": "string"
}
}
{ }
org_id required | string |
include_secrets | boolean <boolean> |
cloud_credential | string cloud credential name. Enumerate will return list of cluster that uses this cloud credential cloud_credential is deprecated, not to be used. |
cloud_credential_ref.name | string |
cloud_credential_ref.uid | string |
only_backup_share | boolean <boolean> Set this to true, to get the backupshare enabled cluster list. |
{- "clusters": [
- {
- "metadata": {
- "name": "string",
- "uid": "string",
- "owner": "string",
- "org_id": "string",
- "create_time": "2019-08-24T14:15:22Z",
- "last_update_time": "2019-08-24T14:15:22Z",
- "labels": {
- "property1": "string",
- "property2": "string"
}, - "create_time_in_sec": "string",
- "ownership": {
- "owner": "string",
- "groups": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "collaborators": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "public": {
- "type": "Invalid"
}
}
}, - "clusterInfo": {
- "px_config": {
- "access_token": "string"
}, - "kubeconfig": "string",
- "cloud_credential": "string",
- "status": {
- "status": "Invalid",
- "reason": "string"
}, - "delete_backups": true,
- "delete_restores": true,
- "stork_version": "string",
- "cloud_credential_ref": {
- "name": "string",
- "uid": "string"
}, - "add_backup_share": {
- "groups": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "collaborators": [
- {
- "id": "string",
- "access": "Invalid"
}
]
}, - "del_backup_share": {
- "groups": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "collaborators": [
- {
- "id": "string",
- "access": "Invalid"
}
]
}, - "backup_share_status_info": {
- "status": "Invalid",
- "reason": "string"
}, - "owner_group_list": [
- "string"
], - "platform_credential_ref": {
- "name": "string",
- "uid": "string"
}, - "teleport_cluster_id": "string",
- "tenant_id": "string",
- "service_token": "string",
- "provider": "Invalid",
- "k8s_version": "string",
- "add_user_backup_share": {
- "property1": {
- "groups": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "collaborators": [
- {
- "id": "string",
- "access": "Invalid"
}
]
}, - "property2": {
- "groups": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "collaborators": [
- {
- "id": "string",
- "access": "Invalid"
}
]
}
}, - "del_user_backup_share": {
- "property1": {
- "groups": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "collaborators": [
- {
- "id": "string",
- "access": "Invalid"
}
]
}, - "property2": {
- "groups": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "collaborators": [
- {
- "id": "string",
- "access": "Invalid"
}
]
}
}, - "deleted_by": "string",
- "delete_all_cluster_backups": true,
- "time_zone": "string"
}
}
]
}
org_id required | string |
name required | string |
delete_backups | boolean <boolean> delete_backups is deprecated, not to be used. |
delete_restores | boolean <boolean> delete_restores indicates whether the restore related to cluster need to be deleted or retained. |
uid | string indicate the uid of the particular object. |
delete_all_cluster_backups | boolean <boolean> delete_all_cluster_backup if set will delete all backups on the cluster allowed only to super admin Role. |
{ }
org_id required | string |
name required | string |
uid required | string |
include_secrets | boolean <boolean> |
{- "cluster": {
- "metadata": {
- "name": "string",
- "uid": "string",
- "owner": "string",
- "org_id": "string",
- "create_time": "2019-08-24T14:15:22Z",
- "last_update_time": "2019-08-24T14:15:22Z",
- "labels": {
- "property1": "string",
- "property2": "string"
}, - "create_time_in_sec": "string",
- "ownership": {
- "owner": "string",
- "groups": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "collaborators": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "public": {
- "type": "Invalid"
}
}
}, - "clusterInfo": {
- "px_config": {
- "access_token": "string"
}, - "kubeconfig": "string",
- "cloud_credential": "string",
- "status": {
- "status": "Invalid",
- "reason": "string"
}, - "delete_backups": true,
- "delete_restores": true,
- "stork_version": "string",
- "cloud_credential_ref": {
- "name": "string",
- "uid": "string"
}, - "add_backup_share": {
- "groups": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "collaborators": [
- {
- "id": "string",
- "access": "Invalid"
}
]
}, - "del_backup_share": {
- "groups": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "collaborators": [
- {
- "id": "string",
- "access": "Invalid"
}
]
}, - "backup_share_status_info": {
- "status": "Invalid",
- "reason": "string"
}, - "owner_group_list": [
- "string"
], - "platform_credential_ref": {
- "name": "string",
- "uid": "string"
}, - "teleport_cluster_id": "string",
- "tenant_id": "string",
- "service_token": "string",
- "provider": "Invalid",
- "k8s_version": "string",
- "add_user_backup_share": {
- "property1": {
- "groups": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "collaborators": [
- {
- "id": "string",
- "access": "Invalid"
}
]
}, - "property2": {
- "groups": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "collaborators": [
- {
- "id": "string",
- "access": "Invalid"
}
]
}
}, - "del_user_backup_share": {
- "property1": {
- "groups": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "collaborators": [
- {
- "id": "string",
- "access": "Invalid"
}
]
}, - "property2": {
- "groups": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "collaborators": [
- {
- "id": "string",
- "access": "Invalid"
}
]
}
}, - "deleted_by": "string",
- "delete_all_cluster_backups": true,
- "time_zone": "string"
}
}
}
object (CreateMetadata) | |
activation_id | string |
license_data | string <byte> |
usage_based_id | string |
usaged_based_airgapped_id | string |
{- "metadata": {
- "name": "string",
- "org_id": "string",
- "owner": "string",
- "labels": {
- "property1": "string",
- "property2": "string"
}, - "ownership": {
- "owner": "string",
- "groups": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "collaborators": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "public": {
- "type": "Invalid"
}
}, - "uid": "string"
}, - "activation_id": "string",
- "license_data": "string",
- "usage_based_id": "string",
- "usaged_based_airgapped_id": "string"
}
{ }
object (CreateMetadata) | |
usage_based_id | string |
{- "metadata": {
- "name": "string",
- "org_id": "string",
- "owner": "string",
- "labels": {
- "property1": "string",
- "property2": "string"
}, - "ownership": {
- "owner": "string",
- "groups": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "collaborators": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "public": {
- "type": "Invalid"
}
}, - "uid": "string"
}, - "usage_based_id": "string"
}
{ }
org_id required | string |
{- "license_resp_info": {
- "feature_info": [
- {
- "name": "string",
- "consumed": "string",
- "entitlement_info": [
- {
- "count": "string",
- "expires": "2019-08-24T14:15:22Z",
- "starts": "2019-08-24T14:15:22Z",
- "type": "Invalid"
}
]
}
], - "status": {
- "status": "string",
- "reason": "string"
}
}
}
org_id required | string |
object_index | string <uint64> index from where object fetch has to happen. |
max_objects | string <uint64> max objects to fetch. |
{- "licenseUsageAirgapped": [
- {
- "metadata": {
- "name": "string",
- "uid": "string",
- "owner": "string",
- "org_id": "string",
- "create_time": "2019-08-24T14:15:22Z",
- "last_update_time": "2019-08-24T14:15:22Z",
- "labels": {
- "property1": "string",
- "property2": "string"
}, - "create_time_in_sec": "string",
- "ownership": {
- "owner": "string",
- "groups": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "collaborators": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "public": {
- "type": "Invalid"
}
}
}, - "node_count": "string",
- "report_time": "string"
}
], - "complete": true,
- "total_count": "string",
- "account_id": "string",
- "subscription_id": "string"
}
org_id required | string |
name | string Managed cluster name to be searched for. |
cloud_credential.name | string |
cloud_credential.uid | string |
include_secrets | boolean <boolean> |
provider | string Default: "Invalid" Enum: "Invalid" "AWS" "Azure" "Google" |
uid | string indicate the uid of the particular object. |
aws_config.region | string Region for scanning clusters. |
{- "cluster": {
- "name": "string",
- "uid": "string",
- "cloud_credential": {
- "name": "string",
- "uid": "string"
}, - "kubeconfig": "string",
- "k8s_version": "string",
- "status": "Invalid"
}
}
org_id | string |
object (ObjectRef) | |
cluster_name | Array of strings (Region for scanning cluster
cluster name to be added) |
provider | string (Cloud provider type) Default: "Invalid" Enum: "Invalid" "AWS" "Azure" "Google" |
object (ManagedClusterBulkAddRequestAWSConfig) | |
google_config | object (ManagedClusterBulkAddRequestGoogleConfig) |
azure_config | object (ManagedClusterBulkAddRequestAzureConfig) |
{- "org_id": "string",
- "cloud_credential": {
- "name": "string",
- "uid": "string"
}, - "cluster_name": [
- "string"
], - "provider": "Invalid",
- "aws_config": {
- "region": "string"
}, - "google_config": { },
- "azure_config": { }
}
{ }
org_id required | string |
{- "stats": [
- {
- "cluster": "string",
- "num_namespaces": "string",
- "total_backup_size": "string",
- "num_schedules": "string",
- "cluster_ref": {
- "name": "string",
- "uid": "string"
}, - "total_namespaces": "string"
}
], - "last_sync_time": "string"
}
org_id required | string |
org_id | string |
object (MetricsInfo) |
{- "org_id": "string",
- "metrics_info": {
- "type": "Invalid",
- "backup": {
- "metadata": {
- "name": "string",
- "uid": "string",
- "owner": "string",
- "org_id": "string",
- "create_time": "2019-08-24T14:15:22Z",
- "last_update_time": "2019-08-24T14:15:22Z",
- "labels": {
- "property1": "string",
- "property2": "string"
}, - "create_time_in_sec": "string",
- "ownership": {
- "owner": "string",
- "groups": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "collaborators": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "public": {
- "type": "Invalid"
}
}
}, - "backup_info": {
- "backup_location": "string",
- "cluster": "string",
- "namespaces": [
- "string"
], - "label_selectors": {
- "property1": "string",
- "property2": "string"
}, - "status": {
- "status": "Invalid",
- "reason": "string"
}, - "resources": [
- {
- "name": "string",
- "namespace": "string",
- "group": "string",
- "kind": "string",
- "version": "string"
}
], - "volumes": [
- {
- "name": "string",
- "namespace": "string",
- "pvc": "string",
- "backup_id": "string",
- "status": {
- "status": "Invalid",
- "reason": "string"
}, - "driver_name": "string",
- "zones": [
- "string"
], - "options": {
- "property1": "string",
- "property2": "string"
}, - "total_size": "string",
- "actual_size": "string",
- "storage_class": "string",
- "pvc_id": "string",
- "provisioner": "string",
- "volumesnapshot": "string",
- "job_security_context": {
- "runAsUser": "string",
- "runAsGroup": "string"
}, - "virtual_machine_name": "string",
- "backup_mode": {
- "type": "Invalid"
}
}
], - "backup_path": "string",
- "stage": "Invalid",
- "pre_exec_rule": "string",
- "post_exec_rule": "string",
- "backup_schedule": {
- "uid": "string",
- "name": "string"
}, - "cr_name": "string",
- "total_size": "string",
- "cloud_credential": "string",
- "include_resources": [
- {
- "name": "string",
- "namespace": "string",
- "group": "string",
- "kind": "string",
- "version": "string"
}
], - "resource_count": "string",
- "stork_version": "string",
- "csi_snapshot_class_name": "string",
- "resource_types": [
- "string"
], - "backup_location_ref": {
- "name": "string",
- "uid": "string"
}, - "pre_exec_rule_ref": {
- "name": "string",
- "uid": "string"
}, - "post_exec_rule_ref": {
- "name": "string",
- "uid": "string"
}, - "cloud_credential_ref": {
- "name": "string",
- "uid": "string"
}, - "backup_type": {
- "type": "Invalid"
}, - "cr_uid": "string",
- "retention_period": "string",
- "backup_share": {
- "groups": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "collaborators": [
- {
- "id": "string",
- "access": "Invalid"
}
]
}, - "user_backupshare_access": "Invalid",
- "cluster_ref": {
- "name": "string",
- "uid": "string"
}, - "ns_label_selectors": "string",
- "rancher_projects": {
- "property1": "string",
- "property2": "string"
}, - "target_namespace": "string",
- "large_resource_enabled": true,
- "backup_object_type": {
- "type": "Invalid"
}, - "skip_vm_auto_exec_rules": true,
- "volume_snapshot_class_mapping": {
- "property1": "string",
- "property2": "string"
}, - "direct_kdmp": true,
- "retention_time": "2019-08-24T14:15:22Z",
- "completion_time_info": {
- "volumes_completion_time": "2019-08-24T14:15:22Z",
- "resources_completion_time": "2019-08-24T14:15:22Z",
- "total_completion_time": "2019-08-24T14:15:22Z"
}, - "exclude_resource_types": [
- "string"
], - "parallel_backup": true,
- "keep_cr_status": true,
- "isBackupReady_for_PXDLocalSnapshotRestore": true,
- "advanced_resource_label_selector": "string",
- "schedule_policy_ref": {
- "name": "string",
- "uid": "string"
}, - "virtual_machines": [
- {
- "name": "string",
- "namespace": "string",
- "os_name": "string",
- "status": {
- "status": "Invalid",
- "reason": "string"
}
}
], - "virtual_machines_total_count": "string",
- "virtual_machines_failed_count": "string",
- "retry_parent": {
- "name": "string",
- "uid": "string"
}, - "volume_resource_only_policy_ref": {
- "name": "string",
- "uid": "string"
}, - "virtual_machine_resources": [
- {
- "resource_info": {
- "name": "string",
- "namespace": "string",
- "group": "string",
- "kind": "string",
- "version": "string"
}, - "virtual_machine_names": [
- "string"
]
}
]
}
}
}
}
{ }
{- "organizations": [
- {
- "metadata": {
- "name": "string",
- "uid": "string",
- "owner": "string",
- "org_id": "string",
- "create_time": "2019-08-24T14:15:22Z",
- "last_update_time": "2019-08-24T14:15:22Z",
- "labels": {
- "property1": "string",
- "property2": "string"
}, - "create_time_in_sec": "string",
- "ownership": {
- "owner": "string",
- "groups": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "collaborators": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "public": {
- "type": "Invalid"
}
}
}
}
]
}
object (CreateMetadata) | |||||||||||||
|
{- "metadata": {
- "name": "string",
- "org_id": "string",
- "owner": "string",
- "labels": {
- "property1": "string",
- "property2": "string"
}, - "ownership": {
- "owner": "string",
- "groups": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "collaborators": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "public": {
- "type": "Invalid"
}
}, - "uid": "string"
}
}
{ }
name required | string |
{- "organization": {
- "metadata": {
- "name": "string",
- "uid": "string",
- "owner": "string",
- "org_id": "string",
- "create_time": "2019-08-24T14:15:22Z",
- "last_update_time": "2019-08-24T14:15:22Z",
- "labels": {
- "property1": "string",
- "property2": "string"
}, - "create_time_in_sec": "string",
- "ownership": {
- "owner": "string",
- "groups": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "collaborators": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "public": {
- "type": "Invalid"
}
}
}
}
}
object (CreateMetadata) | |
object (ReceiverInfo) |
{- "metadata": {
- "name": "string",
- "org_id": "string",
- "owner": "string",
- "labels": {
- "property1": "string",
- "property2": "string"
}, - "ownership": {
- "owner": "string",
- "groups": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "collaborators": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "public": {
- "type": "Invalid"
}
}, - "uid": "string"
}, - "receiver_info": {
- "type": "INVALID",
- "email_config": {
- "from": "string",
- "host": "string",
- "port": "string",
- "encryption_ssl": true,
- "encryption_starttls": true,
- "authentication": true,
- "auth_username": "string",
- "auth_password": "string",
- "allow_custom_certificate": true,
- "tls_config": {
- "cert_file": "string",
- "key_file": "string",
- "ca_cert_file": "string"
}
}
}
}
{- "receiver": {
- "metadata": {
- "name": "string",
- "uid": "string",
- "owner": "string",
- "org_id": "string",
- "create_time": "2019-08-24T14:15:22Z",
- "last_update_time": "2019-08-24T14:15:22Z",
- "labels": {
- "property1": "string",
- "property2": "string"
}, - "create_time_in_sec": "string",
- "ownership": {
- "owner": "string",
- "groups": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "collaborators": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "public": {
- "type": "Invalid"
}
}
}, - "receiver_info": {
- "type": "INVALID",
- "email_config": {
- "from": "string",
- "host": "string",
- "port": "string",
- "encryption_ssl": true,
- "encryption_starttls": true,
- "authentication": true,
- "auth_username": "string",
- "auth_password": "string",
- "allow_custom_certificate": true,
- "tls_config": {
- "cert_file": "string",
- "key_file": "string",
- "ca_cert_file": "string"
}
}
}
}
}
object (CreateMetadata) | |
object (ReceiverInfo) |
{- "metadata": {
- "name": "string",
- "org_id": "string",
- "owner": "string",
- "labels": {
- "property1": "string",
- "property2": "string"
}, - "ownership": {
- "owner": "string",
- "groups": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "collaborators": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "public": {
- "type": "Invalid"
}
}, - "uid": "string"
}, - "receiver_info": {
- "type": "INVALID",
- "email_config": {
- "from": "string",
- "host": "string",
- "port": "string",
- "encryption_ssl": true,
- "encryption_starttls": true,
- "authentication": true,
- "auth_username": "string",
- "auth_password": "string",
- "allow_custom_certificate": true,
- "tls_config": {
- "cert_file": "string",
- "key_file": "string",
- "ca_cert_file": "string"
}
}
}
}
{ }
object (CreateMetadata) | |
recipient_id | Array of strings |
object (ReceiverInfo) | |
object (ReceiverInspectRequest) |
{- "metadata": {
- "name": "string",
- "org_id": "string",
- "owner": "string",
- "labels": {
- "property1": "string",
- "property2": "string"
}, - "ownership": {
- "owner": "string",
- "groups": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "collaborators": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "public": {
- "type": "Invalid"
}
}, - "uid": "string"
}, - "recipient_id": [
- "string"
], - "receiver_info_config": {
- "type": "INVALID",
- "email_config": {
- "from": "string",
- "host": "string",
- "port": "string",
- "encryption_ssl": true,
- "encryption_starttls": true,
- "authentication": true,
- "auth_username": "string",
- "auth_password": "string",
- "allow_custom_certificate": true,
- "tls_config": {
- "cert_file": "string",
- "key_file": "string",
- "ca_cert_file": "string"
}
}
}, - "receiver_inspect_config": {
- "org_id": "string",
- "name": "string",
- "include_secrets": true,
- "uid": "string",
- "type": "string"
}
}
{ }
org_id required | string |
include_secrets | boolean <boolean> |
{- "receivers": [
- {
- "metadata": {
- "name": "string",
- "uid": "string",
- "owner": "string",
- "org_id": "string",
- "create_time": "2019-08-24T14:15:22Z",
- "last_update_time": "2019-08-24T14:15:22Z",
- "labels": {
- "property1": "string",
- "property2": "string"
}, - "create_time_in_sec": "string",
- "ownership": {
- "owner": "string",
- "groups": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "collaborators": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "public": {
- "type": "Invalid"
}
}
}, - "receiver_info": {
- "type": "INVALID",
- "email_config": {
- "from": "string",
- "host": "string",
- "port": "string",
- "encryption_ssl": true,
- "encryption_starttls": true,
- "authentication": true,
- "auth_username": "string",
- "auth_password": "string",
- "allow_custom_certificate": true,
- "tls_config": {
- "cert_file": "string",
- "key_file": "string",
- "ca_cert_file": "string"
}
}
}
}
]
}
org_id required | string |
name required | string |
uid required | string |
include_secrets required | boolean <boolean> |
type required | string |
{- "receiver": {
- "metadata": {
- "name": "string",
- "uid": "string",
- "owner": "string",
- "org_id": "string",
- "create_time": "2019-08-24T14:15:22Z",
- "last_update_time": "2019-08-24T14:15:22Z",
- "labels": {
- "property1": "string",
- "property2": "string"
}, - "create_time_in_sec": "string",
- "ownership": {
- "owner": "string",
- "groups": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "collaborators": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "public": {
- "type": "Invalid"
}
}
}, - "receiver_info": {
- "type": "INVALID",
- "email_config": {
- "from": "string",
- "host": "string",
- "port": "string",
- "encryption_ssl": true,
- "encryption_starttls": true,
- "authentication": true,
- "auth_username": "string",
- "auth_password": "string",
- "allow_custom_certificate": true,
- "tls_config": {
- "cert_file": "string",
- "key_file": "string",
- "ca_cert_file": "string"
}
}
}
}
}
object (CreateMetadata) | |
object (RecipientInfo) |
{- "metadata": {
- "name": "string",
- "org_id": "string",
- "owner": "string",
- "labels": {
- "property1": "string",
- "property2": "string"
}, - "ownership": {
- "owner": "string",
- "groups": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "collaborators": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "public": {
- "type": "Invalid"
}
}, - "uid": "string"
}, - "recipient_info": {
- "type": "INVALID",
- "recipient_id": [
- "string"
], - "active": true,
- "receiver_ref": {
- "name": "string",
- "uid": "string"
}, - "severity": "UNKNOWN"
}
}
{- "recipient": {
- "metadata": {
- "name": "string",
- "uid": "string",
- "owner": "string",
- "org_id": "string",
- "create_time": "2019-08-24T14:15:22Z",
- "last_update_time": "2019-08-24T14:15:22Z",
- "labels": {
- "property1": "string",
- "property2": "string"
}, - "create_time_in_sec": "string",
- "ownership": {
- "owner": "string",
- "groups": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "collaborators": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "public": {
- "type": "Invalid"
}
}
}, - "recipient_info": {
- "type": "INVALID",
- "recipient_id": [
- "string"
], - "active": true,
- "receiver_ref": {
- "name": "string",
- "uid": "string"
}, - "severity": "UNKNOWN"
}
}
}
object (CreateMetadata) | |
object (RecipientInfo) |
{- "metadata": {
- "name": "string",
- "org_id": "string",
- "owner": "string",
- "labels": {
- "property1": "string",
- "property2": "string"
}, - "ownership": {
- "owner": "string",
- "groups": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "collaborators": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "public": {
- "type": "Invalid"
}
}, - "uid": "string"
}, - "recipient_info": {
- "type": "INVALID",
- "recipient_id": [
- "string"
], - "active": true,
- "receiver_ref": {
- "name": "string",
- "uid": "string"
}, - "severity": "UNKNOWN"
}
}
{ }
org_id required | string |
type | string Default: "INVALID" Enum: "INVALID" "EMAIL" Type of notification on user level. |
{- "recipients": [
- {
- "metadata": {
- "name": "string",
- "uid": "string",
- "owner": "string",
- "org_id": "string",
- "create_time": "2019-08-24T14:15:22Z",
- "last_update_time": "2019-08-24T14:15:22Z",
- "labels": {
- "property1": "string",
- "property2": "string"
}, - "create_time_in_sec": "string",
- "ownership": {
- "owner": "string",
- "groups": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "collaborators": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "public": {
- "type": "Invalid"
}
}
}, - "recipient_info": {
- "type": "INVALID",
- "recipient_id": [
- "string"
], - "active": true,
- "receiver_ref": {
- "name": "string",
- "uid": "string"
}, - "severity": "UNKNOWN"
}
}
], - "enabled": true
}
org_id required | string |
name required | string |
uid required | string |
{- "recipient": {
- "metadata": {
- "name": "string",
- "uid": "string",
- "owner": "string",
- "org_id": "string",
- "create_time": "2019-08-24T14:15:22Z",
- "last_update_time": "2019-08-24T14:15:22Z",
- "labels": {
- "property1": "string",
- "property2": "string"
}, - "create_time_in_sec": "string",
- "ownership": {
- "owner": "string",
- "groups": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "collaborators": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "public": {
- "type": "Invalid"
}
}
}, - "recipient_info": {
- "type": "INVALID",
- "recipient_id": [
- "string"
], - "active": true,
- "receiver_ref": {
- "name": "string",
- "uid": "string"
}, - "severity": "UNKNOWN"
}
}
}
object (CreateMetadata) | |
backup | string backup is deprecated, not to be used. |
cluster | string (uid or name of cluster) |
object (mapping of the namespaces from the backup to which restore should be done) | |
replace_policy | string (ReplacePolicyType) Default: "Invalid" Enum: "Invalid" "Retain" "Delete" |
include_optional_resource_types | Array of strings (optional resource types to be restored (eg Jobs)) |
Array of objects (List of resources to restore (optional)) | |
object (storage class mapping for generic backup <source, destination>) | |
object (ObjectRef) | |
object (mapping of the rancher projects from the backup to which restore should
be done) | |
object (mapping of source rancher project display names to target rancher project display names) | |
object (ObjectRef) | |
object (RestoreCreateRequestBackupObjectType) |
{- "metadata": {
- "name": "string",
- "org_id": "string",
- "owner": "string",
- "labels": {
- "property1": "string",
- "property2": "string"
}, - "ownership": {
- "owner": "string",
- "groups": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "collaborators": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "public": {
- "type": "Invalid"
}
}, - "uid": "string"
}, - "backup": "string",
- "cluster": "string",
- "namespace_mapping": {
- "property1": "string",
- "property2": "string"
}, - "replace_policy": "Invalid",
- "include_optional_resource_types": [
- "string"
], - "include_resources": [
- {
- "name": "string",
- "namespace": "string",
- "group": "string",
- "kind": "string",
- "version": "string"
}
], - "storage_class_mapping": {
- "property1": "string",
- "property2": "string"
}, - "backup_ref": {
- "name": "string",
- "uid": "string"
}, - "rancher_project_mapping": {
- "property1": "string",
- "property2": "string"
}, - "rancher_project_name_mapping": {
- "property1": "string",
- "property2": "string"
}, - "cluster_ref": {
- "name": "string",
- "uid": "string"
}, - "backup_object_type": {
- "type": "Invalid"
}
}
{- "restore": {
- "metadata": {
- "name": "string",
- "uid": "string",
- "owner": "string",
- "org_id": "string",
- "create_time": "2019-08-24T14:15:22Z",
- "last_update_time": "2019-08-24T14:15:22Z",
- "labels": {
- "property1": "string",
- "property2": "string"
}, - "create_time_in_sec": "string",
- "ownership": {
- "owner": "string",
- "groups": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "collaborators": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "public": {
- "type": "Invalid"
}
}
}, - "restore_info": {
- "backup": "string",
- "backup_location": "string",
- "label_selectors": {
- "property1": "string",
- "property2": "string"
}, - "namespace_mapping": {
- "property1": "string",
- "property2": "string"
}, - "replace_policy": "Invalid",
- "status": {
- "status": "Invalid",
- "reason": "string"
}, - "resources": [
- {
- "name": "string",
- "namespace": "string",
- "group": "string",
- "kind": "string",
- "version": "string",
- "status": {
- "status": "Invalid",
- "reason": "string"
}
}
], - "volumes": [
- {
- "pvc": "string",
- "source_namespace": "string",
- "source_volume": "string",
- "restore_volume": "string",
- "status": {
- "status": "Invalid",
- "reason": "string"
}, - "driver_name": "string",
- "zones": [
- "string"
], - "options": {
- "property1": "string",
- "property2": "string"
}, - "total_size": "string"
}
], - "cluster": "string",
- "include_optional_resource_types": [
- "string"
], - "total_size": "string",
- "include_resources": [
- {
- "name": "string",
- "namespace": "string",
- "group": "string",
- "kind": "string",
- "version": "string"
}
], - "resource_count": "string",
- "stork_version": "string",
- "backup_location_ref": {
- "name": "string",
- "uid": "string"
}, - "storage_class_mapping": {
- "property1": "string",
- "property2": "string"
}, - "backup_ref": {
- "name": "string",
- "uid": "string"
}, - "rancher_project_mapping": {
- "property1": "string",
- "property2": "string"
}, - "rancher_project_name_mapping": {
- "property1": "string",
- "property2": "string"
}, - "large_resource_enabled": true,
- "restored_resource_count": "string",
- "restore_status": {
- "restore_status": "Preparing"
}, - "cluster_ref": {
- "name": "string",
- "uid": "string"
}, - "backup_object_type": {
- "type": "Invalid"
}
}
}
}
object (CreateMetadata) | |||||||||||||
|
{- "metadata": {
- "name": "string",
- "org_id": "string",
- "owner": "string",
- "labels": {
- "property1": "string",
- "property2": "string"
}, - "ownership": {
- "owner": "string",
- "groups": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "collaborators": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "public": {
- "type": "Invalid"
}
}, - "uid": "string"
}
}
{ }
org_id required | string Organization id |
enumerate_options.max_objects | string <uint64> max objects to fetch. |
enumerate_options.time_range.start_time | string <date-time> |
enumerate_options.time_range.end_time | string <date-time> |
enumerate_options.name_filter | string Filter to use for name of objects. Any object that contains the filter will be returned. |
enumerate_options.cluster_name_filter | string Filter to use for cluster name of objects. Any object that contains the filter will be returned. |
enumerate_options.object_index | string <uint64> |
enumerate_options.include_detailed_resources | boolean <boolean> Ths option will be set to true by the caller, when they want to have complete backup object. That means the backupObject's resource list will be set to complete list of resources. If this option is set to false, resource list will be set to nil and rest of the backupObject details will be returned in the response. |
enumerate_options.cluster_uid_filter | string Filter to use with cluster uid on objects. Any object that contains the filter will be returned Currently backup enumerate request should pass this along with cluster name. |
enumerate_options.owners | Array of strings Filter to use owner uids on objects. Any object that contains the filter will be returned. |
enumerate_options.backup_object_type | string filter to use backupObjectType on object. |
enumerate_options.status | Array of strings filter based on the object status. Need to pass the string value of the status field of the object ( backup /restore ) For example, {"Success", "Failed"}. |
enumerate_options.sort_option.sortBy.type | string Default: "Invalid" Enum: "Invalid" "CreationTimestamp" "Name" "ClusterName" "Size" "RestoreBackupName" Name of the field by which sort to be performed. |
enumerate_options.sort_option.sortOrder.type | string Default: "Invalid" Enum: "Invalid" "Ascending" "Descending" Order of sorting. |
{- "restores": [
- {
- "metadata": {
- "name": "string",
- "uid": "string",
- "owner": "string",
- "org_id": "string",
- "create_time": "2019-08-24T14:15:22Z",
- "last_update_time": "2019-08-24T14:15:22Z",
- "labels": {
- "property1": "string",
- "property2": "string"
}, - "create_time_in_sec": "string",
- "ownership": {
- "owner": "string",
- "groups": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "collaborators": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "public": {
- "type": "Invalid"
}
}
}, - "restore_info": {
- "backup": "string",
- "backup_location": "string",
- "label_selectors": {
- "property1": "string",
- "property2": "string"
}, - "namespace_mapping": {
- "property1": "string",
- "property2": "string"
}, - "replace_policy": "Invalid",
- "status": {
- "status": "Invalid",
- "reason": "string"
}, - "resources": [
- {
- "name": "string",
- "namespace": "string",
- "group": "string",
- "kind": "string",
- "version": "string",
- "status": {
- "status": "Invalid",
- "reason": "string"
}
}
], - "volumes": [
- {
- "pvc": "string",
- "source_namespace": "string",
- "source_volume": "string",
- "restore_volume": "string",
- "status": {
- "status": "Invalid",
- "reason": "string"
}, - "driver_name": "string",
- "zones": [
- "string"
], - "options": {
- "property1": "string",
- "property2": "string"
}, - "total_size": "string"
}
], - "cluster": "string",
- "include_optional_resource_types": [
- "string"
], - "total_size": "string",
- "include_resources": [
- {
- "name": "string",
- "namespace": "string",
- "group": "string",
- "kind": "string",
- "version": "string"
}
], - "resource_count": "string",
- "stork_version": "string",
- "backup_location_ref": {
- "name": "string",
- "uid": "string"
}, - "storage_class_mapping": {
- "property1": "string",
- "property2": "string"
}, - "backup_ref": {
- "name": "string",
- "uid": "string"
}, - "rancher_project_mapping": {
- "property1": "string",
- "property2": "string"
}, - "rancher_project_name_mapping": {
- "property1": "string",
- "property2": "string"
}, - "large_resource_enabled": true,
- "restored_resource_count": "string",
- "restore_status": {
- "restore_status": "Preparing"
}, - "cluster_ref": {
- "name": "string",
- "uid": "string"
}, - "backup_object_type": {
- "type": "Invalid"
}
}
}
], - "total_count": "string",
- "complete": true
}
org_id required | string |
name required | string |
uid | string indicate the uid of the particular object. |
{- "restore": {
- "metadata": {
- "name": "string",
- "uid": "string",
- "owner": "string",
- "org_id": "string",
- "create_time": "2019-08-24T14:15:22Z",
- "last_update_time": "2019-08-24T14:15:22Z",
- "labels": {
- "property1": "string",
- "property2": "string"
}, - "create_time_in_sec": "string",
- "ownership": {
- "owner": "string",
- "groups": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "collaborators": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "public": {
- "type": "Invalid"
}
}
}, - "restore_info": {
- "backup": "string",
- "backup_location": "string",
- "label_selectors": {
- "property1": "string",
- "property2": "string"
}, - "namespace_mapping": {
- "property1": "string",
- "property2": "string"
}, - "replace_policy": "Invalid",
- "status": {
- "status": "Invalid",
- "reason": "string"
}, - "resources": [
- {
- "name": "string",
- "namespace": "string",
- "group": "string",
- "kind": "string",
- "version": "string",
- "status": {
- "status": "Invalid",
- "reason": "string"
}
}
], - "volumes": [
- {
- "pvc": "string",
- "source_namespace": "string",
- "source_volume": "string",
- "restore_volume": "string",
- "status": {
- "status": "Invalid",
- "reason": "string"
}, - "driver_name": "string",
- "zones": [
- "string"
], - "options": {
- "property1": "string",
- "property2": "string"
}, - "total_size": "string"
}
], - "cluster": "string",
- "include_optional_resource_types": [
- "string"
], - "total_size": "string",
- "include_resources": [
- {
- "name": "string",
- "namespace": "string",
- "group": "string",
- "kind": "string",
- "version": "string"
}
], - "resource_count": "string",
- "stork_version": "string",
- "backup_location_ref": {
- "name": "string",
- "uid": "string"
}, - "storage_class_mapping": {
- "property1": "string",
- "property2": "string"
}, - "backup_ref": {
- "name": "string",
- "uid": "string"
}, - "rancher_project_mapping": {
- "property1": "string",
- "property2": "string"
}, - "rancher_project_name_mapping": {
- "property1": "string",
- "property2": "string"
}, - "large_resource_enabled": true,
- "restored_resource_count": "string",
- "restore_status": {
- "restore_status": "Preparing"
}, - "cluster_ref": {
- "name": "string",
- "uid": "string"
}, - "backup_object_type": {
- "type": "Invalid"
}
}
}
}
org_id required | string |
days required | integer <int32> Time period for which activity is needed |
interval required | string Enum: "Invalid" "Hourly" "Daily" Interval for which we want the activity For now Hourly and Daily are supported |
time_zone | string |
cluster | string |
kind | string For which type of Actvity data eg: backup, restore, etc.. |
cluster_ref.name | string |
cluster_ref.uid | string |
owners | Array of strings Filter to use owner uids on objects. |
{- "activity_data": [
- {
- "start_time": "2019-08-24T14:15:22Z",
- "end_time": "2019-08-24T14:15:22Z",
- "successful": "string",
- "failed": "string",
- "in_progress": "string",
- "completion_time": 0.1,
- "total": "string"
}
]
}
object (CreateMetadata) | |
Array of objects (RoleConfig object for set of rules associated with each role object
services - PX-Backup services names
apis - allowed apis for px-backup services) | |
role_id | string (Keyclock UID associated with role) |
{- "metadata": {
- "name": "string",
- "org_id": "string",
- "owner": "string",
- "labels": {
- "property1": "string",
- "property2": "string"
}, - "ownership": {
- "owner": "string",
- "groups": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "collaborators": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "public": {
- "type": "Invalid"
}
}, - "uid": "string"
}, - "rules": [
- {
- "services": [
- "string"
], - "apis": [
- "string"
]
}
], - "role_id": "string"
}
{- "role": {
- "metadata": {
- "name": "string",
- "uid": "string",
- "owner": "string",
- "org_id": "string",
- "create_time": "2019-08-24T14:15:22Z",
- "last_update_time": "2019-08-24T14:15:22Z",
- "labels": {
- "property1": "string",
- "property2": "string"
}, - "create_time_in_sec": "string",
- "ownership": {
- "owner": "string",
- "groups": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "collaborators": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "public": {
- "type": "Invalid"
}
}
}, - "rules": [
- {
- "services": [
- "string"
], - "apis": [
- "string"
]
}
], - "role_id": "string"
}
}
object (CreateMetadata) | |
Array of objects (RoleConfig object for set of rules associated with each role object
services - PX-Backup services names
apis - allowed apis for px-backup services) | |
role_id | string (Keyclock UID associated with role) |
{- "metadata": {
- "name": "string",
- "org_id": "string",
- "owner": "string",
- "labels": {
- "property1": "string",
- "property2": "string"
}, - "ownership": {
- "owner": "string",
- "groups": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "collaborators": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "public": {
- "type": "Invalid"
}
}, - "uid": "string"
}, - "rules": [
- {
- "services": [
- "string"
], - "apis": [
- "string"
]
}
], - "role_id": "string"
}
{ }
org_id required | string |
enumerate_options.max_objects | string <uint64> max objects to fetch. |
enumerate_options.time_range.start_time | string <date-time> |
enumerate_options.time_range.end_time | string <date-time> |
enumerate_options.name_filter | string Filter to use for name of objects. Any object that contains the filter will be returned. |
enumerate_options.cluster_name_filter | string Filter to use for cluster name of objects. Any object that contains the filter will be returned. |
enumerate_options.object_index | string <uint64> |
enumerate_options.include_detailed_resources | boolean <boolean> Ths option will be set to true by the caller, when they want to have complete backup object. That means the backupObject's resource list will be set to complete list of resources. If this option is set to false, resource list will be set to nil and rest of the backupObject details will be returned in the response. |
enumerate_options.cluster_uid_filter | string Filter to use with cluster uid on objects. Any object that contains the filter will be returned Currently backup enumerate request should pass this along with cluster name. |
enumerate_options.owners | Array of strings Filter to use owner uids on objects. Any object that contains the filter will be returned. |
enumerate_options.backup_object_type | string filter to use backupObjectType on object. |
enumerate_options.status | Array of strings filter based on the object status. Need to pass the string value of the status field of the object ( backup /restore ) For example, {"Success", "Failed"}. |
enumerate_options.sort_option.sortBy.type | string Default: "Invalid" Enum: "Invalid" "CreationTimestamp" "Name" "ClusterName" "Size" "RestoreBackupName" Name of the field by which sort to be performed. |
enumerate_options.sort_option.sortOrder.type | string Default: "Invalid" Enum: "Invalid" "Ascending" "Descending" Order of sorting. |
{- "roles": [
- {
- "metadata": {
- "name": "string",
- "uid": "string",
- "owner": "string",
- "org_id": "string",
- "create_time": "2019-08-24T14:15:22Z",
- "last_update_time": "2019-08-24T14:15:22Z",
- "labels": {
- "property1": "string",
- "property2": "string"
}, - "create_time_in_sec": "string",
- "ownership": {
- "owner": "string",
- "groups": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "collaborators": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "public": {
- "type": "Invalid"
}
}
}, - "rules": [
- {
- "services": [
- "string"
], - "apis": [
- "string"
]
}
], - "role_id": "string"
}
]
}
org_id required | string |
name required | string |
uid required | string |
{- "role": {
- "metadata": {
- "name": "string",
- "uid": "string",
- "owner": "string",
- "org_id": "string",
- "create_time": "2019-08-24T14:15:22Z",
- "last_update_time": "2019-08-24T14:15:22Z",
- "labels": {
- "property1": "string",
- "property2": "string"
}, - "create_time_in_sec": "string",
- "ownership": {
- "owner": "string",
- "groups": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "collaborators": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "public": {
- "type": "Invalid"
}
}
}, - "rules": [
- {
- "services": [
- "string"
], - "apis": [
- "string"
]
}
], - "role_id": "string"
}
}
object (CreateMetadata) | |
object (Message for passing pre and post exec rules for backup) |
{- "metadata": {
- "name": "string",
- "org_id": "string",
- "owner": "string",
- "labels": {
- "property1": "string",
- "property2": "string"
}, - "ownership": {
- "owner": "string",
- "groups": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "collaborators": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "public": {
- "type": "Invalid"
}
}, - "uid": "string"
}, - "rules_info": {
- "rules": [
- {
- "pod_selector": {
- "property1": "string",
- "property2": "string"
}, - "actions": [
- {
- "background": true,
- "run_in_single_pod": true,
- "value": "string"
}
], - "container": "string"
}
]
}
}
{- "rule": {
- "metadata": {
- "name": "string",
- "uid": "string",
- "owner": "string",
- "org_id": "string",
- "create_time": "2019-08-24T14:15:22Z",
- "last_update_time": "2019-08-24T14:15:22Z",
- "labels": {
- "property1": "string",
- "property2": "string"
}, - "create_time_in_sec": "string",
- "ownership": {
- "owner": "string",
- "groups": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "collaborators": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "public": {
- "type": "Invalid"
}
}
}, - "rules_info": {
- "rules": [
- {
- "pod_selector": {
- "property1": "string",
- "property2": "string"
}, - "actions": [
- {
- "background": true,
- "run_in_single_pod": true,
- "value": "string"
}
], - "container": "string"
}
]
}
}
}
object (CreateMetadata) | |
object (Message for passing pre and post exec rules for backup) |
{- "metadata": {
- "name": "string",
- "org_id": "string",
- "owner": "string",
- "labels": {
- "property1": "string",
- "property2": "string"
}, - "ownership": {
- "owner": "string",
- "groups": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "collaborators": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "public": {
- "type": "Invalid"
}
}, - "uid": "string"
}, - "rules_info": {
- "rules": [
- {
- "pod_selector": {
- "property1": "string",
- "property2": "string"
}, - "actions": [
- {
- "background": true,
- "run_in_single_pod": true,
- "value": "string"
}
], - "container": "string"
}
]
}
}
{ }
org_id | string |
name | string (Rule to be updated) |
object (Ownership) Ownership information for objects(eg: backup object, schedule object).
Administrators are users who belong to the group | |
uid | string |
{- "org_id": "string",
- "name": "string",
- "ownership": {
- "owner": "string",
- "groups": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "collaborators": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "public": {
- "type": "Invalid"
}
}, - "uid": "string"
}
{ }
org_id required | string |
{- "rules": [
- {
- "metadata": {
- "name": "string",
- "uid": "string",
- "owner": "string",
- "org_id": "string",
- "create_time": "2019-08-24T14:15:22Z",
- "last_update_time": "2019-08-24T14:15:22Z",
- "labels": {
- "property1": "string",
- "property2": "string"
}, - "create_time_in_sec": "string",
- "ownership": {
- "owner": "string",
- "groups": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "collaborators": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "public": {
- "type": "Invalid"
}
}
}, - "rules_info": {
- "rules": [
- {
- "pod_selector": {
- "property1": "string",
- "property2": "string"
}, - "actions": [
- {
- "background": true,
- "run_in_single_pod": true,
- "value": "string"
}
], - "container": "string"
}
]
}
}
]
}
org_id required | string |
name required | string |
uid required | string |
{- "rule": {
- "metadata": {
- "name": "string",
- "uid": "string",
- "owner": "string",
- "org_id": "string",
- "create_time": "2019-08-24T14:15:22Z",
- "last_update_time": "2019-08-24T14:15:22Z",
- "labels": {
- "property1": "string",
- "property2": "string"
}, - "create_time_in_sec": "string",
- "ownership": {
- "owner": "string",
- "groups": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "collaborators": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "public": {
- "type": "Invalid"
}
}
}, - "rules_info": {
- "rules": [
- {
- "pod_selector": {
- "property1": "string",
- "property2": "string"
}, - "actions": [
- {
- "background": true,
- "run_in_single_pod": true,
- "value": "string"
}
], - "container": "string"
}
]
}
}
}
object (CreateMetadata) | |
object (SchedulePolicyInfo) |
{- "metadata": {
- "name": "string",
- "org_id": "string",
- "owner": "string",
- "labels": {
- "property1": "string",
- "property2": "string"
}, - "ownership": {
- "owner": "string",
- "groups": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "collaborators": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "public": {
- "type": "Invalid"
}
}, - "uid": "string"
}, - "schedule_policy": {
- "interval": {
- "minutes": "string",
- "retain": "string",
- "incremental_count": {
- "count": "string"
}
}, - "daily": {
- "time": "string",
- "retain": "string",
- "incremental_count": {
- "count": "string"
}
}, - "weekly": {
- "day": "string",
- "time": "string",
- "retain": "string",
- "incremental_count": {
- "count": "string"
}
}, - "monthly": {
- "date": "string",
- "time": "string",
- "retain": "string",
- "incremental_count": {
- "count": "string"
}
}, - "backup_schedule": [
- "string"
], - "for_object_lock": true,
- "auto_delete": true
}
}
{- "schedule_policy": {
- "metadata": {
- "name": "string",
- "uid": "string",
- "owner": "string",
- "org_id": "string",
- "create_time": "2019-08-24T14:15:22Z",
- "last_update_time": "2019-08-24T14:15:22Z",
- "labels": {
- "property1": "string",
- "property2": "string"
}, - "create_time_in_sec": "string",
- "ownership": {
- "owner": "string",
- "groups": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "collaborators": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "public": {
- "type": "Invalid"
}
}
}, - "schedule_policy_info": {
- "interval": {
- "minutes": "string",
- "retain": "string",
- "incremental_count": {
- "count": "string"
}
}, - "daily": {
- "time": "string",
- "retain": "string",
- "incremental_count": {
- "count": "string"
}
}, - "weekly": {
- "day": "string",
- "time": "string",
- "retain": "string",
- "incremental_count": {
- "count": "string"
}
}, - "monthly": {
- "date": "string",
- "time": "string",
- "retain": "string",
- "incremental_count": {
- "count": "string"
}
}, - "backup_schedule": [
- "string"
], - "for_object_lock": true,
- "auto_delete": true
}
}
}
object (CreateMetadata) | |
object (SchedulePolicyInfo) |
{- "metadata": {
- "name": "string",
- "org_id": "string",
- "owner": "string",
- "labels": {
- "property1": "string",
- "property2": "string"
}, - "ownership": {
- "owner": "string",
- "groups": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "collaborators": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "public": {
- "type": "Invalid"
}
}, - "uid": "string"
}, - "schedule_policy": {
- "interval": {
- "minutes": "string",
- "retain": "string",
- "incremental_count": {
- "count": "string"
}
}, - "daily": {
- "time": "string",
- "retain": "string",
- "incremental_count": {
- "count": "string"
}
}, - "weekly": {
- "day": "string",
- "time": "string",
- "retain": "string",
- "incremental_count": {
- "count": "string"
}
}, - "monthly": {
- "date": "string",
- "time": "string",
- "retain": "string",
- "incremental_count": {
- "count": "string"
}
}, - "backup_schedule": [
- "string"
], - "for_object_lock": true,
- "auto_delete": true
}
}
{ }
org_id | string |
name | string |
object (Ownership) Ownership information for objects(eg: backup object, schedule object).
Administrators are users who belong to the group | |
uid | string |
{- "org_id": "string",
- "name": "string",
- "ownership": {
- "owner": "string",
- "groups": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "collaborators": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "public": {
- "type": "Invalid"
}
}, - "uid": "string"
}
{ }
org_id required | string |
{- "schedule_policies": [
- {
- "metadata": {
- "name": "string",
- "uid": "string",
- "owner": "string",
- "org_id": "string",
- "create_time": "2019-08-24T14:15:22Z",
- "last_update_time": "2019-08-24T14:15:22Z",
- "labels": {
- "property1": "string",
- "property2": "string"
}, - "create_time_in_sec": "string",
- "ownership": {
- "owner": "string",
- "groups": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "collaborators": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "public": {
- "type": "Invalid"
}
}
}, - "schedule_policy_info": {
- "interval": {
- "minutes": "string",
- "retain": "string",
- "incremental_count": {
- "count": "string"
}
}, - "daily": {
- "time": "string",
- "retain": "string",
- "incremental_count": {
- "count": "string"
}
}, - "weekly": {
- "day": "string",
- "time": "string",
- "retain": "string",
- "incremental_count": {
- "count": "string"
}
}, - "monthly": {
- "date": "string",
- "time": "string",
- "retain": "string",
- "incremental_count": {
- "count": "string"
}
}, - "backup_schedule": [
- "string"
], - "for_object_lock": true,
- "auto_delete": true
}
}
]
}
org_id required | string |
name required | string |
uid required | string |
{- "schedule_policy": {
- "metadata": {
- "name": "string",
- "uid": "string",
- "owner": "string",
- "org_id": "string",
- "create_time": "2019-08-24T14:15:22Z",
- "last_update_time": "2019-08-24T14:15:22Z",
- "labels": {
- "property1": "string",
- "property2": "string"
}, - "create_time_in_sec": "string",
- "ownership": {
- "owner": "string",
- "groups": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "collaborators": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "public": {
- "type": "Invalid"
}
}
}, - "schedule_policy_info": {
- "interval": {
- "minutes": "string",
- "retain": "string",
- "incremental_count": {
- "count": "string"
}
}, - "daily": {
- "time": "string",
- "retain": "string",
- "incremental_count": {
- "count": "string"
}
}, - "weekly": {
- "day": "string",
- "time": "string",
- "retain": "string",
- "incremental_count": {
- "count": "string"
}
}, - "monthly": {
- "date": "string",
- "time": "string",
- "retain": "string",
- "incremental_count": {
- "count": "string"
}
}, - "backup_schedule": [
- "string"
], - "for_object_lock": true,
- "auto_delete": true
}
}
}
object (CreateMetadata) | |
object (VolumeResourceOnlyPolicyInfo) |
{- "metadata": {
- "name": "string",
- "org_id": "string",
- "owner": "string",
- "labels": {
- "property1": "string",
- "property2": "string"
}, - "ownership": {
- "owner": "string",
- "groups": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "collaborators": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "public": {
- "type": "Invalid"
}
}, - "uid": "string"
}, - "volume_resource_only_policy": {
- "volume_types": [
- "Invalid"
], - "csi_drivers": [
- "string"
], - "nfs_servers": [
- "string"
]
}
}
{- "volume_resource_only_policy": {
- "metadata": {
- "name": "string",
- "uid": "string",
- "owner": "string",
- "org_id": "string",
- "create_time": "2019-08-24T14:15:22Z",
- "last_update_time": "2019-08-24T14:15:22Z",
- "labels": {
- "property1": "string",
- "property2": "string"
}, - "create_time_in_sec": "string",
- "ownership": {
- "owner": "string",
- "groups": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "collaborators": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "public": {
- "type": "Invalid"
}
}
}, - "volume_resource_only_policy_info": {
- "volume_types": [
- "Invalid"
], - "csi_drivers": [
- "string"
], - "nfs_servers": [
- "string"
]
}
}
}
object (CreateMetadata) | |
object (VolumeResourceOnlyPolicyInfo) |
{- "metadata": {
- "name": "string",
- "org_id": "string",
- "owner": "string",
- "labels": {
- "property1": "string",
- "property2": "string"
}, - "ownership": {
- "owner": "string",
- "groups": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "collaborators": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "public": {
- "type": "Invalid"
}
}, - "uid": "string"
}, - "volume_resource_only_policy": {
- "volume_types": [
- "Invalid"
], - "csi_drivers": [
- "string"
], - "nfs_servers": [
- "string"
]
}
}
{ }
org_id | string |
name | string |
object (Ownership) Ownership information for objects(eg: backup object, schedule object).
Administrators are users who belong to the group | |
uid | string |
{- "org_id": "string",
- "name": "string",
- "ownership": {
- "owner": "string",
- "groups": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "collaborators": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "public": {
- "type": "Invalid"
}
}, - "uid": "string"
}
{ }
org_id required | string |
enumerate_options.generic_enumerate_options.max_objects | string <uint64> max objects to fetch. |
enumerate_options.generic_enumerate_options.name_filter | string Filter to use for name of objects. Any object that contains the filter will be returned. |
enumerate_options.generic_enumerate_options.object_index | string <uint64> |
{- "volume_resource_only_policies": [
- {
- "metadata": {
- "name": "string",
- "uid": "string",
- "owner": "string",
- "org_id": "string",
- "create_time": "2019-08-24T14:15:22Z",
- "last_update_time": "2019-08-24T14:15:22Z",
- "labels": {
- "property1": "string",
- "property2": "string"
}, - "create_time_in_sec": "string",
- "ownership": {
- "owner": "string",
- "groups": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "collaborators": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "public": {
- "type": "Invalid"
}
}
}, - "volume_resource_only_policy_info": {
- "volume_types": [
- "Invalid"
], - "csi_drivers": [
- "string"
], - "nfs_servers": [
- "string"
]
}
}
], - "total_count": "string",
- "complete": true
}
org_id required | string |
name required | string |
uid required | string |
{- "volume_resource_only_policy": {
- "metadata": {
- "name": "string",
- "uid": "string",
- "owner": "string",
- "org_id": "string",
- "create_time": "2019-08-24T14:15:22Z",
- "last_update_time": "2019-08-24T14:15:22Z",
- "labels": {
- "property1": "string",
- "property2": "string"
}, - "create_time_in_sec": "string",
- "ownership": {
- "owner": "string",
- "groups": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "collaborators": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "public": {
- "type": "Invalid"
}
}
}, - "volume_resource_only_policy_info": {
- "volume_types": [
- "Invalid"
], - "csi_drivers": [
- "string"
], - "nfs_servers": [
- "string"
]
}
}
}