pkg/apis/v1/api.proto (version not set)
Download OpenAPI specification:Download
Creates a new backup object
Authorizations:
Request Body schema: application/jsonrequired
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 |
Responses
Request samples
- Payload
{- "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"
]
}
Response samples
- 200
{- "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"
}
}
], - "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
}
}
}
Update given backup details
Authorizations:
Request Body schema: application/jsonrequired
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
- Payload
{- "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"
}
}
Response samples
- 200
{ }
Enumerate returns a list of objects
Authorizations:
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"}. |
Responses
Response samples
- 200
{- "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"
}
}
], - "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
}
}
], - "total_count": "string",
- "complete": true
}
Inspect returns detail information about a specified object
Authorizations:
path Parameters
org_id required | string |
name required | string |
query Parameters
uid | string |
Responses
Response samples
- 200
{- "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"
}
}
], - "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
}
}
}
Delete triggers delete of a backup
Authorizations:
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
- 200
{ }
Creates new backup location
Authorizations:
Request Body schema: application/jsonrequired
object (CreateMetadata) | |
object (BackupLocationInfo) |
Responses
Request samples
- Payload
{- "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"
}
}
}
Response samples
- 200
{- "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"
}
}
}
}
Update given backup location details
Authorizations:
Request Body schema: application/jsonrequired
object (CreateMetadata) | |
object (BackupLocationInfo) |
Responses
Request samples
- Payload
{- "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"
}
}
}
Response samples
- 200
{ }
UpdateOwnership updates ownership of existing object
Authorizations:
Request Body schema: application/jsonrequired
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 |
Responses
Request samples
- Payload
{- "org_id": "string",
- "name": "string",
- "ownership": {
- "owner": "string",
- "groups": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "collaborators": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "public": {
- "type": "Invalid"
}
}, - "uid": "string"
}
Response samples
- 200
{ }
Verify if a backup location is valid
Authorizations:
Request Body schema: application/jsonrequired
org_id | string |
name | string |
uid | string |
Responses
Request samples
- Payload
{- "org_id": "string",
- "name": "string",
- "uid": "string"
}
Response samples
- 200
{ }
Enumerate returns a list of backup locations
Authorizations:
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
- 200
{- "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"
}
}
}
]
}
Inspect returns detailed information about a specified backup location
Authorizations:
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
- 200
{- "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"
}
}
}
}
Creates new backup schedule
Authorizations:
Request Body schema: application/jsonrequired
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. |
Responses
Request samples
- Payload
{- "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
}
Response samples
- 200
{- "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
}
}
}
Updates a backup schedule
Authorizations:
Request Body schema: application/jsonrequired
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. |
Responses
Request samples
- Payload
{- "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
}
Response samples
- 200
{ }
Enumerate returns a list of backup schedule
Authorizations:
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"}. |
Responses
Response samples
- 200
{- "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
}
}
], - "total_count": "string",
- "complete": true
}
Inspect returns detail information about a specified backup schedule
Authorizations:
path Parameters
org_id required | string |
name required | string |
query Parameters
uid | string |
Responses
Response samples
- 200
{- "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
}
}
}
Creates new cloud credential
Authorizations:
Request Body schema: application/jsonrequired
object (CreateMetadata) | |
object (CloudCredentialInfo) |
Responses
Request samples
- Payload
{- "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"
}
}
}
Response samples
- 200
{- "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"
}
}
}
}
Update given cloud credential details
Authorizations:
Request Body schema: application/jsonrequired
object (CreateMetadata) | |
object (CloudCredentialInfo) |
Responses
Request samples
- Payload
{- "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"
}
}
}
Response samples
- 200
{ }
UpdateOwnership updates ownership of existing object
Authorizations:
Request Body schema: application/jsonrequired
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 |
Responses
Request samples
- Payload
{- "org_id": "string",
- "name": "string",
- "ownership": {
- "owner": "string",
- "groups": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "collaborators": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "public": {
- "type": "Invalid"
}
}, - "uid": "string"
}
Response samples
- 200
{ }
Enumerate returns a list of cloud credentials
Authorizations:
path Parameters
org_id required | string |
query Parameters
include_secrets | boolean <boolean> |
Responses
Response samples
- 200
{- "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"
}
}
}
]
}
Inspect returns detailed information about the specified cloud credential
Authorizations:
path Parameters
org_id required | string |
name required | string |
uid required | string |
query Parameters
include_secrets | boolean <boolean> |
Responses
Response samples
- 200
{- "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"
}
}
}
}
Creates a new cluster
Authorizations:
Request Body schema: application/jsonrequired
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
- Payload
{- "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"
}
Response samples
- 200
{- "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
}
}
}
Update given cluster details
Authorizations:
Request Body schema: application/jsonrequired
object (CreateMetadata) | |
object (PXConfig) | |
kubeconfig | string |
cloud_credential | string cloud_credential is deprecated, not to be used. |
object (ObjectRef) | |
object (ObjectRef) |
Responses
Request samples
- Payload
{- "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"
}
}
Response samples
- 200
{ }
Enumerate returns a list of clusters
Authorizations:
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
- 200
{- "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
}
}
]
}
Delete removes a cluster
Authorizations:
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
- 200
{ }
Inspect returns detail information about a specified cluster
Authorizations:
path Parameters
org_id required | string |
name required | string |
uid required | string |
query Parameters
include_secrets | boolean <boolean> |
Responses
Response samples
- 200
{- "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
}
}
}
Activate activate a new license
Authorizations:
Request Body schema: application/jsonrequired
object (CreateMetadata) | |
activation_id | string |
license_data | string <byte> |
usage_based_id | string |
usaged_based_airgapped_id | string |
Responses
Request samples
- Payload
{- "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"
}
Response samples
- 200
{ }
Updates Usage Based activation ID
Authorizations:
Request Body schema: application/jsonrequired
object (CreateMetadata) | |
usage_based_id | string |
Responses
Request samples
- Payload
{- "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"
}
Response samples
- 200
{ }
Enumerate returns a list of license for given cluster
Authorizations:
path Parameters
org_id required | string |
Responses
Response samples
- 200
{- "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"
}
}
}
EnumerateLicenseUsageAirGapped
Authorizations:
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
- 200
{- "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"
}
Inspect returns detailed information on a managed cluster from providers like AWS, Azure, GCE, IBM using the given credentials
Authorizations:
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
- 200
{- "cluster": {
- "name": "string",
- "uid": "string",
- "cloud_credential": {
- "name": "string",
- "uid": "string"
}, - "kubeconfig": "string",
- "k8s_version": "string",
- "status": "Invalid"
}
}
Bulk add discovered clusters
Authorizations:
Request Body schema: application/jsonrequired
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
- Payload
{- "org_id": "string",
- "cloud_credential": {
- "name": "string",
- "uid": "string"
}, - "cluster_name": [
- "string"
], - "provider": "Invalid",
- "aws_config": {
- "region": "string"
}, - "google_config": { },
- "azure_config": { }
}
Response samples
- 200
{ }
Returns metrics details of backups
Authorizations:
path Parameters
org_id required | string |
Responses
Response samples
- 200
{- "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"
}
Pass metrics from other pods to px-backup, which will push as px-backup metrics to Prometheus
Authorizations:
path Parameters
org_id required | string |
Request Body schema: application/jsonrequired
org_id | string |
object (MetricsInfo) |
Responses
Request samples
- Payload
{- "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"
}
}
], - "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
}
}
}
}
Response samples
- 200
{ }
Response samples
- 200
{- "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"
}
}
}
}
]
}
Creates new organization object in datastore
Authorizations:
Request Body schema: application/jsonrequired
object (CreateMetadata) | |||||||||||||
|
Responses
Request samples
- Payload
{- "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"
}
}
Response samples
- 200
{ }
Inspect returns detailed information about specified organization object
Authorizations:
path Parameters
name required | string |
Responses
Response samples
- 200
{- "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"
}
}
}
}
}
Create new alert manager receiver
Authorizations:
Request Body schema: application/jsonrequired
object (CreateMetadata) | |
object (ReceiverInfo) |
Responses
Request samples
- Payload
{- "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"
}
}
}
Response samples
- 200
{- "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"
}
}
}
}
Update the details of a alert manager receiver
Authorizations:
Request Body schema: application/jsonrequired
object (CreateMetadata) | |
object (ReceiverInfo) |
Responses
Request samples
- Payload
{- "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"
}
}
}
Response samples
- 200
{ }
Validates SMTP service
Authorizations:
Request Body schema: application/jsonrequired
object (CreateMetadata) | |
recipient_id | Array of strings |
object (ReceiverInfo) | |
object (ReceiverInspectRequest) |
Responses
Request samples
- Payload
{- "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"
}
}, - "receiver_inspect_config": {
- "org_id": "string",
- "name": "string",
- "include_secrets": true,
- "uid": "string",
- "type": "string"
}
}
Response samples
- 200
{ }
Returns a list of alert manager receivers
Authorizations:
path Parameters
org_id required | string |
query Parameters
include_secrets | boolean <boolean> |
Responses
Response samples
- 200
{- "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"
}
}
}
]
}
Returns the details of a specific alert manager receiver
Authorizations:
path Parameters
org_id required | string |
name required | string |
uid required | string |
include_secrets required | boolean <boolean> |
type required | string |
Responses
Response samples
- 200
{- "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"
}
}
}
}
Create
Authorizations:
Request Body schema: application/jsonrequired
object (CreateMetadata) | |
object (RecipientInfo) |
Responses
Request samples
- Payload
{- "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"
}
}
Response samples
- 200
{- "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"
}
}
}
Update the details of a recipient
Authorizations:
Request Body schema: application/jsonrequired
object (CreateMetadata) | |
object (RecipientInfo) |
Responses
Request samples
- Payload
{- "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"
}
}
Response samples
- 200
{ }
Returns a list of recipients for alerting
Authorizations:
path Parameters
org_id required | string |
query Parameters
type | string Default: "INVALID" Enum: "INVALID" "EMAIL" Type of notification on user level. |
Responses
Response samples
- 200
{- "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
}
Returns the details of a specific recipient
Authorizations:
path Parameters
org_id required | string |
name required | string |
uid required | string |
Responses
Response samples
- 200
{- "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"
}
}
}
Creates new restore object in datastore It will also trigger a restore operation on the target cluster
Authorizations:
Request Body schema: application/jsonrequired
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
- Payload
{- "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"
}
}
Response samples
- 200
{- "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"
}
}
}
}
Update given restore details
Authorizations:
Request Body schema: application/jsonrequired
object (CreateMetadata) | |||||||||||||
|
Responses
Request samples
- Payload
{- "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"
}
}
Response samples
- 200
{ }
Enumerate returns a list of restore objects
Authorizations:
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"}. |
Responses
Response samples
- 200
{- "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
}
Inspect returns detailed information about specified restore object
Authorizations:
path Parameters
org_id required | string |
name required | string |
query Parameters
uid | string indicate the uid of the particular object. |
Responses
Response samples
- 200
{- "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"
}
}
}
}
Enumerate returns a list of activity data for a given time period
Authorizations:
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 |
Responses
Response samples
- 200
{- "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"
}
]
}
Creates new role object in datastore
Authorizations:
Request Body schema: application/jsonrequired
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
- Payload
{- "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"
}
Response samples
- 200
{- "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"
}
}
Update given role information
Authorizations:
Request Body schema: application/jsonrequired
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
- Payload
{- "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"
}
Response samples
- 200
{ }
Enumerate returns a list of roles object
Authorizations:
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"}. |
Responses
Response samples
- 200
{- "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"
}
]
}
Inspect returns detailed information about requested role object
Authorizations:
path Parameters
org_id required | string |
name required | string |
uid required | string |
Responses
Response samples
- 200
{- "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"
}
}
Creates new rule
Authorizations:
Request Body schema: application/jsonrequired
object (CreateMetadata) | |
object (Message for passing pre and post exec rules for backup) |
Responses
Request samples
- Payload
{- "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"
}
]
}
}
Response samples
- 200
{- "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"
}
]
}
}
}
Update given rule details
Authorizations:
Request Body schema: application/jsonrequired
object (CreateMetadata) | |
object (Message for passing pre and post exec rules for backup) |
Responses
Request samples
- Payload
{- "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"
}
]
}
}
Response samples
- 200
{ }
UpdateOwnership updates ownership of existing object
Authorizations:
Request Body schema: application/jsonrequired
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 |
Responses
Request samples
- Payload
{- "org_id": "string",
- "name": "string",
- "ownership": {
- "owner": "string",
- "groups": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "collaborators": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "public": {
- "type": "Invalid"
}
}, - "uid": "string"
}
Response samples
- 200
{ }
Enumerate returns a list of rules
Authorizations:
path Parameters
org_id required | string |
Responses
Response samples
- 200
{- "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"
}
]
}
}
]
}
Inspect returns detailed information about the specified rule
Authorizations:
path Parameters
org_id required | string |
name required | string |
uid required | string |
Responses
Response samples
- 200
{- "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"
}
]
}
}
}
Creates new schedule policy.
Authorizations:
Request Body schema: application/jsonrequired
object (CreateMetadata) | |
object (SchedulePolicyInfo) |
Responses
Request samples
- Payload
{- "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
}
}
Response samples
- 200
{- "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
}
}
}
Update given schedule policy details
Authorizations:
Request Body schema: application/jsonrequired
object (CreateMetadata) | |
object (SchedulePolicyInfo) |
Responses
Request samples
- Payload
{- "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
}
}
Response samples
- 200
{ }
UpdateOwnership updates ownership of existing object
Authorizations:
Request Body schema: application/jsonrequired
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 |
Responses
Request samples
- Payload
{- "org_id": "string",
- "name": "string",
- "ownership": {
- "owner": "string",
- "groups": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "collaborators": [
- {
- "id": "string",
- "access": "Invalid"
}
], - "public": {
- "type": "Invalid"
}
}, - "uid": "string"
}
Response samples
- 200
{ }
Enumerate returns a list of schedule policy
Authorizations:
path Parameters
org_id required | string |
Responses
Response samples
- 200
{- "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
}
}
]
}
Inspect returns detail information about a specified schedule policy
Authorizations:
path Parameters
org_id required | string |
name required | string |
uid required | string |
Responses
Response samples
- 200
{- "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
}
}
}