Skip to main content
API docs by Redocly

pkg/apis/v1/api.proto (version not set)

Download OpenAPI specification:Download

Backup

Creates a new backup object

Authorizations:
bearer
Request Body schema: application/json
required
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)

Responses

Request samples

Content type
application/json
{
  • "metadata": {
    },
  • "backup_location": "string",
  • "cluster": "string",
  • "namespaces": [
    ],
  • "label_selectors": {
    },
  • "pre_exec_rule": "string",
  • "post_exec_rule": "string",
  • "include_resources": [
    ],
  • "csi_snapshot_class_name": "string",
  • "resource_types": [
    ],
  • "backup_location_ref": {
    },
  • "pre_exec_rule_ref": {
    },
  • "post_exec_rule_ref": {
    },
  • "backup_type": "Invalid",
  • "cluster_ref": {
    },
  • "ns_label_selectors": "string",
  • "backup_object_type": {
    },
  • "skip_vm_auto_exec_rules": true,
  • "volume_snapshot_class_mapping": {
    },
  • "direct_kdmp": true,
  • "exclude_resource_types": [
    ],
  • "keep_cr_status": true,
  • "advanced_resource_label_selector": "string",
  • "volume_resource_only_policy_ref": {
    }
}

Response samples

Content type
application/json
{
  • "backup": {
    }
}

Update given backup details

Authorizations:
bearer
Request Body schema: application/json
required
object (CreateMetadata)
cloud_credential
string

Reference to cloud credential object used for backup cloud_credential is deprecated, not to be used.

object (ObjectRef)

Responses

Request samples

Content type
application/json
{
  • "metadata": {
    },
  • "cloud_credential": "string",
  • "cloud_credential_ref": {
    }
}

Response samples

Content type
application/json
{ }

For VirtualMachine backup object type, it returns the details of VirtualMachine and its resources mapped under it

Authorizations:
bearer
path Parameters
org_id
required
string
name
required
string

Backup name

uid
required
string

Backup uid

Responses

Response samples

Content type
application/json
{
  • "backup": {
    }
}

RetryBackupResources retries backup of a failed or partial success backup

Authorizations:
bearer
Request Body schema: application/json
required
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)

Responses

Request samples

Content type
application/json
{
  • "org_id": "string",
  • "name": "string",
  • "uid": "string",
  • "include_resources": [
    ],
  • "skip_vm_auto_exec_rules": true
}

Response samples

Content type
application/json
{
  • "backup": {
    }
}

UpdateBackupShare updates backupshare of existing backup object

Authorizations:
bearer
Request Body schema: application/json
required
org_id
string
name
string (Backup to be updated)
object (BackupShare for storing user and group details for whom the backups will be shared)
uid
string

Responses

Request samples

Content type
application/json
{
  • "org_id": "string",
  • "name": "string",
  • "backupshare": {
    },
  • "uid": "string"
}

Response samples

Content type
application/json
{ }

Enumerate returns a list of objects

Authorizations:
bearer
path Parameters
org_id
required
string

Organization id

query Parameters
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.

Responses

Response samples

Content type
application/json
{
  • "backups": [
    ],
  • "total_count": "string",
  • "complete": true
}

Enumerate returns a list of objects

Authorizations:
bearer
path Parameters
org_id
required
string

Organization id

Request Body schema: application/json
required
org_id
string (Organization id)
object (EnumerateOptions)

Responses

Request samples

Content type
application/json
{
  • "org_id": "string",
  • "enumerate_options": {
    }
}

Response samples

Content type
application/json
{
  • "backups": [
    ],
  • "total_count": "string",
  • "complete": true
}

Inspect returns detail information about a specified object

Authorizations:
bearer
path Parameters
org_id
required
string
name
required
string
query Parameters
uid
string

Responses

Response samples

Content type
application/json
{
  • "backup": {
    }
}

Delete triggers delete of a backup

Authorizations:
bearer
path Parameters
org_id
required
string
name
required
string
query Parameters
cluster
string

cluster name or uid to perform delete through.

uid
string
cluster_ref.name
string
cluster_ref.uid
string

Responses

Response samples

Content type
application/json
{ }

BackupLocation

Creates new backup location

Authorizations:
bearer
Request Body schema: application/json
required
object (CreateMetadata)
object (BackupLocationInfo)

Responses

Request samples

Content type
application/json
{
  • "metadata": {
    },
  • "backup_location": {
    }
}

Response samples

Content type
application/json
{
  • "backup_location": {
    }
}

Update given backup location details

Authorizations:
bearer
Request Body schema: application/json
required
object (CreateMetadata)
object (BackupLocationInfo)

Responses

Request samples

Content type
application/json
{
  • "metadata": {
    },
  • "backup_location": {
    }
}

Response samples

Content type
application/json
{ }

UpdateOwnership updates ownership of existing object

Authorizations:
bearer
Request Body schema: application/json
required
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 *, meaning, every group.

uid
string

Responses

Request samples

Content type
application/json
{
  • "org_id": "string",
  • "name": "string",
  • "ownership": {
    },
  • "uid": "string"
}

Response samples

Content type
application/json
{ }

Verify if a backup location is valid

Authorizations:
bearer
Request Body schema: application/json
required
org_id
string
name
string
uid
string

Responses

Request samples

Content type
application/json
{
  • "org_id": "string",
  • "name": "string",
  • "uid": "string"
}

Response samples

Content type
application/json
{ }

Enumerate returns a list of backup locations

Authorizations:
bearer
path Parameters
org_id
required
string
query Parameters
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.

Responses

Response samples

Content type
application/json
{
  • "backup_locations": [
    ]
}

Inspect returns detailed information about a specified backup location

Authorizations:
bearer
path Parameters
org_id
required
string
name
required
string
uid
required
string
query Parameters
include_secrets
boolean <boolean>

enable include_secrets to get the encryptionKey value.

Responses

Response samples

Content type
application/json
{
  • "backup_location": {
    }
}

Delete removes a backup location

Authorizations:
bearer
path Parameters
org_id
required
string
name
required
string
uid
required
string
query Parameters
delete_backups
boolean <boolean>

delete_backups is deprecated, not to be used.

Responses

Response samples

Content type
application/json
{ }

BackupSchedule

Creates new backup schedule

Authorizations:
bearer
Request Body schema: application/json
required
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)

Responses

Request samples

Content type
application/json
{
  • "metadata": {
    },
  • "schedule_policy": "string",
  • "reclaim_policy": "Invalid",
  • "backup_location": "string",
  • "cluster": "string",
  • "namespaces": [
    ],
  • "label_selectors": {
    },
  • "pre_exec_rule": "string",
  • "post_exec_rule": "string",
  • "include_resources": [
    ],
  • "csi_snapshot_class_name": "string",
  • "resource_types": [
    ],
  • "schedule_policy_ref": {
    },
  • "backup_location_ref": {
    },
  • "pre_exec_rule_ref": {
    },
  • "post_exec_rule_ref": {
    },
  • "backup_type": "Invalid",
  • "ns_label_selectors": "string",
  • "cluster_ref": {
    },
  • "backup_object_type": {
    },
  • "skip_vm_auto_exec_rules": true,
  • "volume_snapshot_class_mapping": {
    },
  • "direct_kdmp": true,
  • "exclude_resource_types": [
    ],
  • "parallel_backup": true,
  • "keep_cr_status": true,
  • "advanced_resource_label_selector": "string",
  • "volume_resource_only_policy_ref": {
    }
}

Response samples

Content type
application/json
{
  • "backup_schedule": {
    }
}

Updates a backup schedule

Authorizations:
bearer
Request Body schema: application/json
required
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)

Responses

Request samples

Content type
application/json
{
  • "metadata": {
    },
  • "schedule_policy": "string",
  • "reclaim_policy": "Invalid",
  • "backup_location": "string",
  • "cluster": "string",
  • "namespaces": [
    ],
  • "label_selectors": {
    },
  • "pre_exec_rule": "string",
  • "post_exec_rule": "string",
  • "suspend": true,
  • "include_resources": [
    ],
  • "csi_snapshot_class_name": "string",
  • "schedule_policy_ref": {
    },
  • "backup_location_ref": {
    },
  • "pre_exec_rule_ref": {
    },
  • "post_exec_rule_ref": {
    },
  • "volume_snapshot_class_mapping": {
    },
  • "skip_vm_auto_exec_rules": true,
  • "parallel_backup": true,
  • "advanced_resource_label_selector": "string",
  • "backup_object_type": {
    },
  • "policy_ref": [
    ],
  • "exclude_objects": [
    ],
  • "include_objects": [
    ],
  • "include_filter": "string",
  • "exclude_filter": "string",
  • "cluster_scope": {
    },
  • "volume_resource_only_policy_ref": {
    }
}

Response samples

Content type
application/json
{ }

Enumerate returns a list of backup schedule

Authorizations:
bearer
path Parameters
org_id
required
string
query Parameters
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.

Responses

Response samples

Content type
application/json
{
  • "backup_schedules": [
    ],
  • "total_count": "string",
  • "complete": true
}

Delete removes a backup schedule

Authorizations:
bearer
path Parameters
org_id
required
string
Request Body schema: application/json
required
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)

Responses

Request samples

Content type
application/json
{
  • "org_id": "string",
  • "name": "string",
  • "delete_backups": true,
  • "uid": "string",
  • "include_objects": [
    ],
  • "backup_object_type": {
    },
  • "policy_ref": [
    ],
  • "exclude_objects": [
    ],
  • "include_filter": "string",
  • "exclude_filter": "string",
  • "cluster_scope": {
    }
}

Response samples

Content type
application/json
{ }

Enumerate returns a list of backup schedule

Authorizations:
bearer
path Parameters
org_id
required
string
Request Body schema: application/json
required
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)

Responses

Request samples

Content type
application/json
{
  • "org_id": "string",
  • "labels": {
    },
  • "backup_location": "string",
  • "backup_location_ref": {
    },
  • "enumerate_options": {
    }
}

Response samples

Content type
application/json
{
  • "backup_schedules": [
    ],
  • "total_count": "string",
  • "complete": true
}

Inspect returns detail information about a specified backup schedule

Authorizations:
bearer
path Parameters
org_id
required
string
name
required
string
query Parameters
uid
string

Responses

Response samples

Content type
application/json
{
  • "backup_schedule": {
    }
}

Delete removes a backup schedule

Authorizations:
bearer
path Parameters
org_id
required
string
name
required
string
uid
required
string
query Parameters
delete_backups
boolean <boolean>

delete_backups is deprecated, not to be used.

backup_object_type.type
string
Default: "Invalid"
Enum: "Invalid" "NS" "VM" "All"
  • NS: Represents backup schedules scoped to Kubernetes namespaces (non-VM workloads). Typically used for application-level backups.
  • VM: Represents backup schedules scoped to VirtualMachine workloads. Used for VM-based backup scenarios.
  • All: Represents both NS and VM backup schedule types. Used when an operation should apply to all types.
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>

Responses

Response samples

Content type
application/json
{ }

CloudCredential

Creates new cloud credential

Authorizations:
bearer
Request Body schema: application/json
required
object (CreateMetadata)
object (CloudCredentialInfo)

Responses

Request samples

Content type
application/json
{
  • "metadata": {
    },
  • "cloud_credential": {
    }
}

Response samples

Content type
application/json
{
  • "cloud_credential": {
    }
}

Update given cloud credential details

Authorizations:
bearer
Request Body schema: application/json
required
object (CreateMetadata)
object (CloudCredentialInfo)

Responses

Request samples

Content type
application/json
{
  • "metadata": {
    },
  • "cloud_credential": {
    }
}

Response samples

Content type
application/json
{ }

UpdateOwnership updates ownership of existing object

Authorizations:
bearer
Request Body schema: application/json
required
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 *, meaning, every group.

uid
string

Responses

Request samples

Content type
application/json
{
  • "org_id": "string",
  • "name": "string",
  • "ownership": {
    },
  • "uid": "string"
}

Response samples

Content type
application/json
{ }

Enumerate returns a list of cloud credentials

Authorizations:
bearer
path Parameters
org_id
required
string
query Parameters
include_secrets
boolean <boolean>

Responses

Response samples

Content type
application/json
{
  • "cloud_credentials": [
    ]
}

Inspect returns detailed information about the specified cloud credential

Authorizations:
bearer
path Parameters
org_id
required
string
name
required
string
uid
required
string
query Parameters
include_secrets
boolean <boolean>

Responses

Response samples

Content type
application/json
{
  • "cloud_credential": {
    }
}

Delete removes a cloud credential

Authorizations:
bearer
path Parameters
org_id
required
string
name
required
string
uid
required
string

Responses

Response samples

Content type
application/json
{ }

Cluster

Creates a new cluster

Authorizations:
bearer
Request Body schema: application/json
required
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"

Responses

Request samples

Content type
application/json
{
  • "metadata": {
    },
  • "px_config": {
    },
  • "kubeconfig": "string",
  • "cloud_credential": "string",
  • "cloud_credential_ref": {
    },
  • "platform_credential_ref": {
    },
  • "teleport_cluster_id": "string",
  • "tenant_id": "string",
  • "service_token": "string",
  • "provider": "Invalid"
}

Response samples

Content type
application/json
{
  • "cluster": {
    }
}

Update given cluster details

Authorizations:
bearer
Request Body schema: application/json
required
object (CreateMetadata)
object (PXConfig)
kubeconfig
string
cloud_credential
string

cloud_credential is deprecated, not to be used.

object (ObjectRef)
object (ObjectRef)

Responses

Request samples

Content type
application/json
{
  • "metadata": {
    },
  • "px_config": {
    },
  • "kubeconfig": "string",
  • "cloud_credential": "string",
  • "cloud_credential_ref": {
    },
  • "platform_credential_ref": {
    }
}

Response samples

Content type
application/json
{ }

UpdateBackupShare updates ownership details for backup share at cluster level

Authorizations:
bearer
Request Body schema: application/json
required
org_id
string
name
string
object (BackupShare for storing user and group details for whom the backups will be shared)
object (BackupShare for storing user and group details for whom the backups will be shared)
uid
string

Responses

Request samples

Content type
application/json
{
  • "org_id": "string",
  • "name": "string",
  • "add_backup_share": {
    },
  • "del_backup_share": {
    },
  • "uid": "string"
}

Response samples

Content type
application/json
{ }

Enumerate returns a list of clusters

Authorizations:
bearer
path Parameters
org_id
required
string
query Parameters
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.

Responses

Response samples

Content type
application/json
{
  • "clusters": [
    ]
}

Delete removes a cluster

Authorizations:
bearer
path Parameters
org_id
required
string
name
required
string
query Parameters
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.

Responses

Response samples

Content type
application/json
{ }

Inspect returns detail information about a specified cluster

Authorizations:
bearer
path Parameters
org_id
required
string
name
required
string
uid
required
string
query Parameters
include_secrets
boolean <boolean>

Responses

Response samples

Content type
application/json
{
  • "cluster": {
    }
}

ShareCluster shares access to the cluster to the user(s) or group(s)

Authorizations:
bearer
Request Body schema: application/json
required
org_id
string
object (ObjectRef)
users
Array of strings (userid of the user(s) to share the cluster with)
groups
Array of strings (group(s) to share the cluster with)
share_cluster_backups
boolean <boolean> (share_cluster_backups share is optional, if set to true, it will additionally share existing backups)

Responses

Request samples

Content type
application/json
{
  • "org_id": "string",
  • "cluster_ref": {
    },
  • "users": [
    ],
  • "groups": [
    ],
  • "share_cluster_backups": true
}

Response samples

Content type
application/json
{ }

UnShareCluster removes shared access for the user(s) or group(s) to the cluster

Authorizations:
bearer
Request Body schema: application/json
required
org_id
string
object (ObjectRef)
users
Array of strings (userid of the user(s) to share the cluster with)
groups
Array of strings (group(s) to share the cluster with)

Responses

Request samples

Content type
application/json
{
  • "org_id": "string",
  • "cluster_ref": {
    },
  • "users": [
    ],
  • "groups": [
    ]
}

Response samples

Content type
application/json
{ }

Health

Status checks the health of the server

Authorizations:
bearer

Responses

Response samples

Content type
application/json
{ }

License

Activate activate a new license

Authorizations:
bearer
Request Body schema: application/json
required
object (CreateMetadata)
activation_id
string
license_data
string <byte>
usage_based_id
string
usaged_based_airgapped_id
string

Responses

Request samples

Content type
application/json
{
  • "metadata": {
    },
  • "activation_id": "string",
  • "license_data": "string",
  • "usage_based_id": "string",
  • "usaged_based_airgapped_id": "string"
}

Response samples

Content type
application/json
{ }

Updates Usage Based activation ID

Authorizations:
bearer
Request Body schema: application/json
required
object (CreateMetadata)
usage_based_id
string

Responses

Request samples

Content type
application/json
{
  • "metadata": {
    },
  • "usage_based_id": "string"
}

Response samples

Content type
application/json
{ }

Enumerate returns a list of license for given cluster

Authorizations:
bearer
path Parameters
org_id
required
string

Responses

Response samples

Content type
application/json
{
  • "license_resp_info": {
    }
}

EnumerateLicenseUsageAirGapped

Authorizations:
bearer
path Parameters
org_id
required
string
query Parameters
object_index
string <uint64>

index from where object fetch has to happen.

max_objects
string <uint64>

max objects to fetch.

Responses

Response samples

Content type
application/json
{
  • "licenseUsageAirgapped": [
    ],
  • "complete": true,
  • "total_count": "string",
  • "account_id": "string",
  • "subscription_id": "string"
}

ManagedClusters

Inspect returns detailed information on a managed cluster from providers like AWS, Azure, GCE, IBM using the given credentials

Authorizations:
bearer
path Parameters
org_id
required
string
query Parameters
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.

Responses

Response samples

Content type
application/json
{
  • "cluster": {
    }
}

Bulk add discovered clusters

Authorizations:
bearer
Request Body schema: application/json
required
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)

Responses

Request samples

Content type
application/json
{
  • "org_id": "string",
  • "cloud_credential": {
    },
  • "cluster_name": [
    ],
  • "provider": "Invalid",
  • "aws_config": {
    },
  • "google_config": { },
  • "azure_config": { }
}

Response samples

Content type
application/json
{ }

Metrics

Returns metrics details of backups

Authorizations:
bearer
path Parameters
org_id
required
string

Responses

Response samples

Content type
application/json
{
  • "stats": [
    ],
  • "last_sync_time": "string"
}

Pass metrics from other pods to px-backup, which will push as px-backup metrics to Prometheus

Authorizations:
bearer
path Parameters
org_id
required
string
Request Body schema: application/json
required
org_id
string
object (MetricsInfo)

Responses

Request samples

Content type
application/json
{
  • "org_id": "string",
  • "metrics_info": {
    }
}

Response samples

Content type
application/json
{ }

Organization

Enumerate returns a list of organization object

Authorizations:
bearer

Responses

Response samples

Content type
application/json
{
  • "organizations": [
    ]
}

Creates new organization object in datastore

Authorizations:
bearer
Request Body schema: application/json
required
object (CreateMetadata)
name
string (name of the object)
org_id
string (org id of the object)
owner
string (owner of the object. This field is deprecated, not to be used)
object (labels associated with the object)
object (Ownership)

Ownership information for objects(eg: backup object, schedule object). Administrators are users who belong to the group *, meaning, every group.

uid
string (uid of the object)

Responses

Request samples

Content type
application/json
{
  • "metadata": {
    }
}

Response samples

Content type
application/json
{ }

Inspect returns detailed information about specified organization object

Authorizations:
bearer
path Parameters
name
required
string

Responses

Response samples

Content type
application/json
{
  • "organization": {
    }
}

Delete

Authorizations:
bearer
path Parameters
name
required
string

Name of the org to be deleted

Responses

Response samples

Content type
application/json
{ }

Receiver

Create new alert manager receiver

Authorizations:
bearer
Request Body schema: application/json
required
object (CreateMetadata)
object (ReceiverInfo)

Responses

Request samples

Content type
application/json
{
  • "metadata": {
    },
  • "receiver_info": {
    }
}

Response samples

Content type
application/json
{
  • "receiver": {
    }
}

Update the details of a alert manager receiver

Authorizations:
bearer
Request Body schema: application/json
required
object (CreateMetadata)
object (ReceiverInfo)

Responses

Request samples

Content type
application/json
{
  • "metadata": {
    },
  • "receiver_info": {
    }
}

Response samples

Content type
application/json
{ }

Validates SMTP service

Authorizations:
bearer
Request Body schema: application/json
required
object (CreateMetadata)
recipient_id
Array of strings
object (ReceiverInfo)
object (ReceiverInspectRequest)

Responses

Request samples

Content type
application/json
{
  • "metadata": {
    },
  • "recipient_id": [
    ],
  • "receiver_info_config": {
    },
  • "receiver_inspect_config": {
    }
}

Response samples

Content type
application/json
{ }

Returns a list of alert manager receivers

Authorizations:
bearer
path Parameters
org_id
required
string
query Parameters
include_secrets
boolean <boolean>

Responses

Response samples

Content type
application/json
{
  • "receivers": [
    ]
}

Delete a specific alert manager receiver

Authorizations:
bearer
path Parameters
org_id
required
string
name
required
string
uid
required
string

Responses

Response samples

Content type
application/json
{ }

Returns the details of a specific alert manager receiver

Authorizations:
bearer
path Parameters
org_id
required
string
name
required
string
uid
required
string
include_secrets
required
boolean <boolean>
type
required
string

Responses

Response samples

Content type
application/json
{
  • "receiver": {
    }
}

Recipient

Create

Authorizations:
bearer
Request Body schema: application/json
required
object (CreateMetadata)
object (RecipientInfo)

Responses

Request samples

Content type
application/json
{
  • "metadata": {
    },
  • "recipient_info": {
    }
}

Response samples

Content type
application/json
{
  • "recipient": {
    }
}

Update the details of a recipient

Authorizations:
bearer
Request Body schema: application/json
required
object (CreateMetadata)
object (RecipientInfo)

Responses

Request samples

Content type
application/json
{
  • "metadata": {
    },
  • "recipient_info": {
    }
}

Response samples

Content type
application/json
{ }

Returns a list of recipients for alerting

Authorizations:
bearer
path Parameters
org_id
required
string
query Parameters
type
string
Default: "INVALID"
Enum: "INVALID" "EMAIL"

Type of notification on user level.

Responses

Response samples

Content type
application/json
{
  • "recipients": [
    ],
  • "enabled": true
}

Returns the details of a specific recipient

Authorizations:
bearer
path Parameters
org_id
required
string
name
required
string
uid
required
string

Responses

Response samples

Content type
application/json
{
  • "recipient": {
    }
}

Delete a specific recipient

Authorizations:
bearer
path Parameters
org_id
required
string
name
required
string
uid
required
string

Responses

Response samples

Content type
application/json
{ }

ResourceCollector

ResourceTypes api will return the list of ResourceTypes are support by px-backup for backup.

Authorizations:
bearer
path Parameters
org_id
required
string
query Parameters
cluster_ref.name
string
cluster_ref.uid
string

Responses

Response samples

Content type
application/json
{
  • "resource_types": [
    ]
}

Restore

Creates new restore object in datastore It will also trigger a restore operation on the target cluster

Authorizations:
bearer
Request Body schema: application/json
required
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)

Responses

Request samples

Content type
application/json
{
  • "metadata": {
    },
  • "backup": "string",
  • "cluster": "string",
  • "namespace_mapping": {
    },
  • "replace_policy": "Invalid",
  • "include_optional_resource_types": [
    ],
  • "include_resources": [
    ],
  • "storage_class_mapping": {
    },
  • "backup_ref": {
    },
  • "rancher_project_mapping": {
    },
  • "rancher_project_name_mapping": {
    },
  • "cluster_ref": {
    },
  • "backup_object_type": {
    }
}

Response samples

Content type
application/json
{
  • "restore": {
    }
}

Update given restore details

Authorizations:
bearer
Request Body schema: application/json
required
object (CreateMetadata)
name
string (name of the object)
org_id
string (org id of the object)
owner
string (owner of the object. This field is deprecated, not to be used)
object (labels associated with the object)
object (Ownership)

Ownership information for objects(eg: backup object, schedule object). Administrators are users who belong to the group *, meaning, every group.

uid
string (uid of the object)

Responses

Request samples

Content type
application/json
{
  • "metadata": {
    }
}

Response samples

Content type
application/json
{ }

Enumerate returns a list of restore objects

Authorizations:
bearer
path Parameters
org_id
required
string

Organization id

query Parameters
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.

Responses

Response samples

Content type
application/json
{
  • "restores": [
    ],
  • "total_count": "string",
  • "complete": true
}

Inspect returns detailed information about specified restore object

Authorizations:
bearer
path Parameters
org_id
required
string
name
required
string
query Parameters
uid
string

indicate the uid of the particular object.

Responses

Response samples

Content type
application/json
{
  • "restore": {
    }
}

Delete removes a restore object

Authorizations:
bearer
path Parameters
org_id
required
string
name
required
string
query Parameters
uid
string

indicate the uid of the particular object.

Responses

Response samples

Content type
application/json
{ }

ActivityTimeLine

Enumerate returns a list of activity data for a given time period

Authorizations:
bearer
path Parameters
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

query Parameters
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.

Responses

Response samples

Content type
application/json
{
  • "activity_data": [
    ]
}

Role

Permission returns list of service,apis permission for given user

Authorizations:
bearer
query Parameters
org_id
string

Responses

Response samples

Content type
application/json
{
  • "rules": {
    }
}

Creates new role object in datastore

Authorizations:
bearer
Request Body schema: application/json
required
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)

Responses

Request samples

Content type
application/json
{
  • "metadata": {
    },
  • "rules": [
    ],
  • "role_id": "string"
}

Response samples

Content type
application/json
{
  • "role": {
    }
}

Update given role information

Authorizations:
bearer
Request Body schema: application/json
required
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)

Responses

Request samples

Content type
application/json
{
  • "metadata": {
    },
  • "rules": [
    ],
  • "role_id": "string"
}

Response samples

Content type
application/json
{ }

Enumerate returns a list of roles object

Authorizations:
bearer
path Parameters
org_id
required
string
query Parameters
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.

Responses

Response samples

Content type
application/json
{
  • "roles": [
    ]
}

Inspect returns detailed information about requested role object

Authorizations:
bearer
path Parameters
org_id
required
string
name
required
string
uid
required
string

Responses

Response samples

Content type
application/json
{
  • "role": {
    }
}

Delete removes given role from px-backup

Authorizations:
bearer
path Parameters
org_id
required
string
name
required
string
uid
required
string

Responses

Response samples

Content type
application/json
{ }

Rules

Creates new rule

Authorizations:
bearer
Request Body schema: application/json
required
object (CreateMetadata)
object (Message for passing pre and post exec rules for backup)

Responses

Request samples

Content type
application/json
{
  • "metadata": {
    },
  • "rules_info": {
    }
}

Response samples

Content type
application/json
{
  • "rule": {
    }
}

Update given rule details

Authorizations:
bearer
Request Body schema: application/json
required
object (CreateMetadata)
object (Message for passing pre and post exec rules for backup)

Responses

Request samples

Content type
application/json
{
  • "metadata": {
    },
  • "rules_info": {
    }
}

Response samples

Content type
application/json
{ }

UpdateOwnership updates ownership of existing object

Authorizations:
bearer
Request Body schema: application/json
required
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 *, meaning, every group.

uid
string

Responses

Request samples

Content type
application/json
{
  • "org_id": "string",
  • "name": "string",
  • "ownership": {
    },
  • "uid": "string"
}

Response samples

Content type
application/json
{ }

Enumerate returns a list of rules

Authorizations:
bearer
path Parameters
org_id
required
string

Responses

Response samples

Content type
application/json
{
  • "rules": [
    ]
}

Inspect returns detailed information about the specified rule

Authorizations:
bearer
path Parameters
org_id
required
string
name
required
string
uid
required
string

Responses

Response samples

Content type
application/json
{
  • "rule": {
    }
}

Delete removes rule from px-backup

Authorizations:
bearer
path Parameters
org_id
required
string
name
required
string
uid
required
string

Responses

Response samples

Content type
application/json
{ }

SchedulePolicy

Creates new schedule policy.

Authorizations:
bearer
Request Body schema: application/json
required
object (CreateMetadata)
object (SchedulePolicyInfo)

Responses

Request samples

Content type
application/json
{
  • "metadata": {
    },
  • "schedule_policy": {
    }
}

Response samples

Content type
application/json
{
  • "schedule_policy": {
    }
}

Update given schedule policy details

Authorizations:
bearer
Request Body schema: application/json
required
object (CreateMetadata)
object (SchedulePolicyInfo)

Responses

Request samples

Content type
application/json
{
  • "metadata": {
    },
  • "schedule_policy": {
    }
}

Response samples

Content type
application/json
{ }

UpdateOwnership updates ownership of existing object

Authorizations:
bearer
Request Body schema: application/json
required
org_id
string
name
string
object (Ownership)

Ownership information for objects(eg: backup object, schedule object). Administrators are users who belong to the group *, meaning, every group.

uid
string

Responses

Request samples

Content type
application/json
{
  • "org_id": "string",
  • "name": "string",
  • "ownership": {
    },
  • "uid": "string"
}

Response samples

Content type
application/json
{ }

Enumerate returns a list of schedule policy

Authorizations:
bearer
path Parameters
org_id
required
string

Responses

Response samples

Content type
application/json
{
  • "schedule_policies": [
    ]
}

Inspect returns detail information about a specified schedule policy

Authorizations:
bearer
path Parameters
org_id
required
string
name
required
string
uid
required
string

Responses

Response samples

Content type
application/json
{
  • "schedule_policy": {
    }
}

Delete removes a schedule policy

Authorizations:
bearer
path Parameters
org_id
required
string
name
required
string
uid
required
string

Responses

Response samples

Content type
application/json
{ }

Version

gets the version of the server

Authorizations:
bearer

Responses

Response samples

Content type
application/json
{
  • "version": {
    }
}

VolumeResourceOnlyPolicy

Creates new VolumeResourceOnly Policy.

Authorizations:
bearer
Request Body schema: application/json
required
object (CreateMetadata)
object (VolumeResourceOnlyPolicyInfo)

Responses

Request samples

Content type
application/json
{
  • "metadata": {
    },
  • "volume_resource_only_policy": {
    }
}

Response samples

Content type
application/json
{
  • "volume_resource_only_policy": {
    }
}

Update given volumeResourceOnly policy details

Authorizations:
bearer
Request Body schema: application/json
required
object (CreateMetadata)
object (VolumeResourceOnlyPolicyInfo)

Responses

Request samples

Content type
application/json
{
  • "metadata": {
    },
  • "volume_resource_only_policy": {
    }
}

Response samples

Content type
application/json
{ }

UpdateOwnership updates ownership of existing object

Authorizations:
bearer
Request Body schema: application/json
required
org_id
string
name
string
object (Ownership)

Ownership information for objects(eg: backup object, schedule object). Administrators are users who belong to the group *, meaning, every group.

uid
string

Responses

Request samples

Content type
application/json
{
  • "org_id": "string",
  • "name": "string",
  • "ownership": {
    },
  • "uid": "string"
}

Response samples

Content type
application/json
{ }

Enumerate returns a list of volumeResourceOnly policy

Authorizations:
bearer
path Parameters
org_id
required
string

Responses

Response samples

Content type
application/json
{
  • "volume_resource_only_policies": [
    ]
}

Inspect returns detail information about a specified volumeResourceOnly policy

Authorizations:
bearer
path Parameters
org_id
required
string
name
required
string
uid
required
string

Responses

Response samples

Content type
application/json
{
  • "volume_resource_only_policy": {
    }
}

Delete removes a volumeResourceOnly policy

Authorizations:
bearer
path Parameters
org_id
required
string
name
required
string
uid
required
string

Responses

Response samples

Content type
application/json
{ }