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

Download OpenAPI specification:Download

Backup

Creates a new backup object

Authorizations:

bearer

Request Body schema: application/json

	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))
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

Responses

Request samples

Payload

Content type

application/json

{"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"
}

Response samples

200
default

Content type

application/json

{ }

Update given backup details

Authorizations:

bearer

Request Body schema: application/json

	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

Content type

application/json

{"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
default

Content type

application/json

{ }

UpdateBackupShare updates backupshare of existing backup object

Authorizations:

bearer

Request Body schema: application/json

org_id	string
name	string (Backup to be updated)
	object (BackupShare for storing user and group details for whom the backups will be shared)
uid	string

Responses

Request samples

Payload

Content type

application/json

{"org_id": "string",
"name": "string",
"backupshare": {"groups": [{"id": "string",
"access": "Invalid"
}
],
"collaborators": [{"id": "string",
"access": "Invalid"
}
]
},
"uid": "string"
}

Response samples

200
default

Content type

application/json

{ }

Enumerate returns a list of objects

Authorizations:

bearer

path Parameters

org_id

required

string

Organization id

query Parameters

enumerate_options.max_objects	string <uint64> max objects to fetch.
enumerate_options.time_range.start_time	string <date-time>
enumerate_options.time_range.end_time	string <date-time>
enumerate_options.name_filter	string Filter to use for name of objects. Any object that contains the filter will be returned.
enumerate_options.cluster_name_filter	string Filter to use for cluster name of objects. Any object that contains the filter will be returned.
enumerate_options.object_index	string <uint64>
enumerate_options.include_detailed_resources	boolean 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.

Responses

Response samples

200
default

Content type

application/json

{"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"
}
],
"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
}
}
],
"total_count": "string",
"complete": true
}

Inspect returns detail information about a specified object

Authorizations:

bearer

path Parameters

org_id required	string
name required	string

query Parameters

uid

string

Responses

Response samples

200
default

Content type

application/json

{"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"
}
],
"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
}
}
}

Delete triggers delete of a backup

Authorizations:

bearer

path Parameters

org_id required	string
name required	string

query Parameters

cluster	string cluster name or uid to perform delete through.
uid	string
cluster_ref.name	string
cluster_ref.uid	string

Responses

Response samples

200
default

Content type

application/json

{ }

BackupLocation

Creates new backup location

Authorizations:

bearer

Request Body schema: application/json

	object (CreateMetadata)
	object (BackupLocationInfo)

Responses

Request samples

Payload

Content type

application/json

{"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"
},
"nfs_config": {"server_addr": "string",
"sub_path": "string",
"mount_option": "string"
}
}
}

Response samples

200
default

Content type

application/json

{ }

Update given backup location details

Authorizations:

bearer

Request Body schema: application/json

	object (CreateMetadata)
	object (BackupLocationInfo)

Responses

Request samples

Payload

Content type

application/json

{"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"
},
"nfs_config": {"server_addr": "string",
"sub_path": "string",
"mount_option": "string"
}
}
}

Response samples

200
default

Content type

application/json

{ }

UpdateOwnership updates ownership of existing object

Authorizations:

bearer

Request Body schema: application/json

org_id	string
name	string (Backup location to be updated)
	object (Ownership) Ownership information for objects(eg: backup object, schedule object). Administrators are users who belong to the group `*`, meaning, every group.
uid	string

Responses

Request samples

Payload

Content type

application/json

{"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
default

Content type

application/json

{ }

Verify if a backup location is valid

Authorizations:

bearer

Request Body schema: application/json

org_id	string
name	string
uid	string

Responses

Request samples

Payload

Content type

application/json

{"org_id": "string",
"name": "string",
"uid": "string"
}

Response samples

200
default

Content type

application/json

{ }

Enumerate returns a list of backup locations

Authorizations:

bearer

path Parameters

org_id

required

string

query Parameters

cloud_credential	string cloud credential name. Enumerate will return list of backuplocation that uses this cloud credential cloud_credential is deprecated, not to be used.
cloud_credential_ref.name	string
cloud_credential_ref.uid	string
include_secrets	boolean enable include_secrets to get the encryptionKey value.
include_validation_state	boolean If true, include backuplocation that are in ValidationInProgress state as well.

Responses

Response samples

200
default

Content type

application/json

{"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"
},
"nfs_config": {"server_addr": "string",
"sub_path": "string",
"mount_option": "string"
}
}
}
]
}

Inspect returns detailed information about a specified backup location

Authorizations:

bearer

path Parameters

org_id required	string
name required	string
uid required	string

query Parameters

include_secrets

boolean

enable include_secrets to get the encryptionKey value.

Responses

Response samples

200
default

Content type

application/json

{"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"
},
"nfs_config": {"server_addr": "string",
"sub_path": "string",
"mount_option": "string"
}
}
}
}

Delete removes a backup location

Authorizations:

bearer

path Parameters

org_id required	string
name required	string
uid required	string

query Parameters

delete_backups

boolean

delete_backups indicates whether the cloud backup files need to be deleted or retained.

Responses

Response samples

200
default

Content type

application/json

{ }

BackupSchedule

Creates new backup schedule

Authorizations:

bearer

Request Body schema: application/json

	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))
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)

Responses

Request samples

Payload

Content type

application/json

{"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"
}
}

Response samples

200
default

Content type

application/json

{ }

Updates a backup schedule

Authorizations:

bearer

Request Body schema: application/json

	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
	Array of objects (List of resources to backup (optional))
csi_snapshot_class_name	string (Snapshot class name to use for backup schedule (optional))
	object (ObjectRef)
	object (ObjectRef)
	object (ObjectRef)
	object (ObjectRef)

Responses

Request samples

Payload

Content type

application/json

{"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"
}
}

Response samples

200
default

Content type

application/json

{ }

Enumerate returns a list of backup schedule

Authorizations:

bearer

path Parameters

org_id

required

string

query Parameters

backup_location	string Backuplocation name. Enumerate will return list of backupschedule that uses this backuplocation backup_location is deprecated, not to be used.
backup_location_ref.name	string
backup_location_ref.uid	string
enumerate_options.max_objects	string <uint64> max objects to fetch.
enumerate_options.time_range.start_time	string <date-time>
enumerate_options.time_range.end_time	string <date-time>
enumerate_options.name_filter	string Filter to use for name of objects. Any object that contains the filter will be returned.
enumerate_options.cluster_name_filter	string Filter to use for cluster name of objects. Any object that contains the filter will be returned.
enumerate_options.object_index	string <uint64>
enumerate_options.include_detailed_resources	boolean 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.

Responses

Response samples

200
default

Content type

application/json

{"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"
}
}
}
],
"total_count": "string"
}

Inspect returns detail information about a specified backup schedule

Authorizations:

bearer

path Parameters

org_id required	string
name required	string

query Parameters

uid

string

Responses

Response samples

200
default

Content type

application/json

{"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"
}
}
}
}

Delete removes a backup schedule

Authorizations:

bearer

path Parameters

org_id required	string
name required	string

query Parameters

delete_backups	boolean delete_backups indicates whether the cloud backup files need to be deleted or retained.
uid	string

Responses

Response samples

200
default

Content type

application/json

{ }

CloudCredential

Creates new cloud credential

Authorizations:

bearer

Request Body schema: application/json

	object (CreateMetadata)
	object (CloudCredentialInfo)

Responses

Request samples

Payload

Content type

application/json

{"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
default

Content type

application/json

{"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:

bearer

Request Body schema: application/json

	object (CreateMetadata)
	object (CloudCredentialInfo)

Responses

Request samples

Payload

Content type

application/json

{"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
default

Content type

application/json

{ }

UpdateOwnership updates ownership of existing object

Authorizations:

bearer

Request Body schema: application/json

org_id	string
name	string Cloud credential name to be updated.
	object (Ownership) Ownership information for objects(eg: backup object, schedule object). Administrators are users who belong to the group `*`, meaning, every group.
uid	string

Responses

Request samples

Payload

Content type

application/json

{"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
default

Content type

application/json

{ }

Enumerate returns a list of cloud credentials

Authorizations:

bearer

path Parameters

org_id

required

string

query Parameters

include_secrets

boolean

Responses

Response samples

200
default

Content type

application/json

{"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:

bearer

path Parameters

org_id required	string
name required	string
uid required	string

query Parameters

include_secrets

boolean

Responses

Response samples

200
default

Content type

application/json

{"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"
}
}
}
}

Delete removes a cloud credential

Authorizations:

bearer

path Parameters

org_id required	string
name required	string
uid required	string

Responses

Response samples

200
default

Content type

application/json

{ }

Cluster

Creates a new cluster

Authorizations:

bearer

Request Body schema: application/json

	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

Content type

application/json

{"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
default

Content type

application/json

{ }

Update given cluster details

Authorizations:

bearer

Request Body schema: application/json

	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

Content type

application/json

{"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
default

Content type

application/json

{ }

UpdateBackupShare updates ownership details for backup share at cluster level

Authorizations:

bearer

Request Body schema: application/json

org_id	string
name	string
	object (BackupShare for storing user and group details for whom the backups will be shared)
	object (BackupShare for storing user and group details for whom the backups will be shared)
uid	string

Responses

Request samples

Payload

Content type

application/json

{"org_id": "string",
"name": "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"
}
]
},
"uid": "string"
}

Response samples

200
default

Content type

application/json

{ }

Enumerate returns a list of clusters

Authorizations:

bearer

path Parameters

org_id

required

string

query Parameters

include_secrets	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 Set this to true, to get the backupshare enabled cluster list.

Responses

Response samples

200
default

Content type

application/json

{"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"
}
}
]
}

Delete removes a cluster

Authorizations:

bearer

path Parameters

org_id required	string
name required	string

query Parameters

delete_backups	boolean delete_backups indicates whether the backup related to cluster need to be deleted or retained.
delete_restores	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.

Responses

Response samples

200
default

Content type

application/json

{ }

Inspect returns detail information about a specified cluster

Authorizations:

bearer

path Parameters

org_id required	string
name required	string
uid required	string

query Parameters

include_secrets

boolean

Responses

Response samples

200
default

Content type

application/json

{"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"
}
}
}

Health

Status checks the health of the server

Authorizations:

bearer

Responses

Response samples

200
default

Content type

application/json

{ }

License

Activate activate a new license

Authorizations:

bearer

Request Body schema: application/json

	object (CreateMetadata)
activation_id	string
license_data	string <byte>
usage_based_id	string
usaged_based_airgapped_id	string

Responses

Request samples

Payload

Content type

application/json

{"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
default

Content type

application/json

{ }

Updates Usage Based activation ID

Authorizations:

bearer

Request Body schema: application/json

	object (CreateMetadata)
usage_based_id	string

Responses

Request samples

Payload

Content type

application/json

{"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
default

Content type

application/json

{ }

Enumerate returns a list of license for given cluster

Authorizations:

bearer

path Parameters

org_id

required

string

Responses

Response samples

200
default

Content type

application/json

{"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"
}
}
}

License_EnumerateLicenseUsageAirGapped

Authorizations:

bearer

path Parameters

org_id

required

string

query Parameters

object_index	string <uint64> index from where object fetch has to happen.
max_objects	string <uint64> max objects to fetch.

Responses

Response samples

200
default

Content type

application/json

{"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"
}

ManagedClusters

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

Authorizations:

bearer

path Parameters

org_id

required

string

query Parameters

name	string Managed cluster name to be searched for.
cloud_credential.name	string
cloud_credential.uid	string
include_secrets	boolean
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
default

Content type

application/json

{"cluster": {"name": "string",
"uid": "string",
"cloud_credential": {"name": "string",
"uid": "string"
},
"kubeconfig": "string",
"k8s_version": "string",
"status": "Invalid"
}
}

Bulk add discovered clusters

Authorizations:

bearer

Request Body schema: application/json

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

Content type

application/json

{"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
default

Content type

application/json

{ }

Metrics

Returns metrics details of backups

Authorizations:

bearer

path Parameters

org_id

required

string

Responses

Response samples

200
default

Content type

application/json

{"stats": [{"cluster": "string",
"num_namespaces": "string",
"total_backup_size": "string",
"num_schedules": "string",
"cluster_ref": {"name": "string",
"uid": "string"
}
}
]
}

Organization

Enumerate returns a list of organization object

Authorizations:

bearer

Responses

Response samples

200
default

Content type

application/json

{"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:

bearer

Request Body schema: application/json

object (CreateMetadata)

name	string (name of the object)
org_id	string (org id of the object)
owner	string (owner of the object. This field is deprecated, not to be used)
	object (labels associated with the object)
	object (Ownership) Ownership information for objects(eg: backup object, schedule object). Administrators are users who belong to the group `*`, meaning, every group.
uid	string (uid of the object)

Responses

Request samples

Payload

Content type

application/json

{"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
default

Content type

application/json

{ }

Inspect returns detailed information about specified organization object

Authorizations:

bearer

path Parameters

name

required

string

Responses

Response samples

200
default

Content type

application/json

{"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"
}
}
}
}
}

Organization_Delete

Authorizations:

bearer

path Parameters

name

required

string

Name of the org to be deleted

Responses

Response samples

200
default

Content type

application/json

{ }

Restore

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

Authorizations:

bearer

Request Body schema: application/json

	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)

Responses

Request samples

Payload

Content type

application/json

{"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"
}
}

Response samples

200
default

Content type

application/json

{ }

Update given restore details

Authorizations:

bearer

Request Body schema: application/json

object (CreateMetadata)

name	string (name of the object)
org_id	string (org id of the object)
owner	string (owner of the object. This field is deprecated, not to be used)
	object (labels associated with the object)
	object (Ownership) Ownership information for objects(eg: backup object, schedule object). Administrators are users who belong to the group `*`, meaning, every group.
uid	string (uid of the object)

Responses

Request samples

Payload

Content type

application/json

{"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
default

Content type

application/json

{ }

Enumerate returns a list of restore objects

Authorizations:

bearer

path Parameters

org_id

required

string

Organization id

query Parameters

enumerate_options.max_objects	string <uint64> max objects to fetch.
enumerate_options.time_range.start_time	string <date-time>
enumerate_options.time_range.end_time	string <date-time>
enumerate_options.name_filter	string Filter to use for name of objects. Any object that contains the filter will be returned.
enumerate_options.cluster_name_filter	string Filter to use for cluster name of objects. Any object that contains the filter will be returned.
enumerate_options.object_index	string <uint64>
enumerate_options.include_detailed_resources	boolean 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.

Responses

Response samples

200
default

Content type

application/json

{"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"
}
}
}
],
"total_count": "string",
"complete": true
}

Inspect returns detailed information about specified restore object

Authorizations:

bearer

path Parameters

org_id required	string
name required	string

query Parameters

uid	string indicate the uid of the particular object.

Responses

Response samples

200
default

Content type

application/json

{"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"
}
}
}
}

Delete removes a restore object

Authorizations:

bearer

path Parameters

org_id required	string
name required	string

query Parameters

uid	string indicate the uid of the particular object.

Responses

Response samples

200
default

Content type

application/json

{ }

ActivityTimeLine

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

Authorizations:

bearer

path Parameters

org_id required	string
days required	integer <int32> Time period for which activity is needed
interval required	string Enum: "Invalid" "Hourly" "Daily" Interval for which we want the activity For now Hourly and Daily are supported

query Parameters

time_zone	string
cluster	string
kind	string For which type of Actvity data eg: backup, restore, etc..
cluster_ref.name	string
cluster_ref.uid	string

Responses

Response samples

200
default

Content type

application/json

{"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"
}
]
}

Role

Permission returns list of service,apis permission for given user

Authorizations:

bearer

query Parameters

org_id

string

Responses

Response samples

200
default

Content type

application/json

{"rules": {"property1": {"full_access": true
},
"property2": {"full_access": true
}
}
}

Creates new role object in datastore

Authorizations:

bearer

Request Body schema: application/json

	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

Content type

application/json

{"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
default

Content type

application/json

{ }

Update given role information

Authorizations:

bearer

Request Body schema: application/json

	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

Content type

application/json

{"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
default

Content type

application/json

{ }

Enumerate returns a list of roles object

Authorizations:

bearer

path Parameters

org_id

required

string

query Parameters

enumerate_options.max_objects	string <uint64> max objects to fetch.
enumerate_options.time_range.start_time	string <date-time>
enumerate_options.time_range.end_time	string <date-time>
enumerate_options.name_filter	string Filter to use for name of objects. Any object that contains the filter will be returned.
enumerate_options.cluster_name_filter	string Filter to use for cluster name of objects. Any object that contains the filter will be returned.
enumerate_options.object_index	string <uint64>
enumerate_options.include_detailed_resources	boolean 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.

Responses

Response samples

200
default

Content type

application/json

{"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:

bearer

path Parameters

org_id required	string
name required	string
uid required	string

Responses

Response samples

200
default

Content type

application/json

{"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"
}
}

Delete removes given role from px-backup

Authorizations:

bearer

path Parameters

org_id required	string
name required	string
uid required	string

Responses

Response samples

200
default

Content type

application/json

{ }

Rules

Creates new rule

Authorizations:

bearer

Request Body schema: application/json

	object (CreateMetadata)
	object (Message for passing pre and post exec rules for backup)

Responses

Request samples

Payload

Content type

application/json

{"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
default

Content type

application/json

{ }

Update given rule details

Authorizations:

bearer

Request Body schema: application/json

	object (CreateMetadata)
	object (Message for passing pre and post exec rules for backup)

Responses

Request samples

Payload

Content type

application/json

{"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
default

Content type

application/json

{ }

UpdateOwnership updates ownership of existing object

Authorizations:

bearer

Request Body schema: application/json

org_id	string
name	string (Rule to be updated)
	object (Ownership) Ownership information for objects(eg: backup object, schedule object). Administrators are users who belong to the group `*`, meaning, every group.
uid	string

Responses

Request samples

Payload

Content type

application/json

{"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
default

Content type

application/json

{ }

Enumerate returns a list of rules

Authorizations:

bearer

path Parameters

org_id

required

string

Responses

Response samples

200
default

Content type

application/json

{"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:

bearer

path Parameters

org_id required	string
name required	string
uid required	string

Responses

Response samples

200
default

Content type

application/json

{"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"
}
]
}
}
}

Delete removes rule from px-backup

Authorizations:

bearer

path Parameters

org_id required	string
name required	string
uid required	string

Responses

Response samples

200
default

Content type

application/json

{ }

SchedulePolicy

Creates new schedule policy.

Authorizations:

bearer

Request Body schema: application/json

	object (CreateMetadata)
	object (SchedulePolicyInfo)

Responses

Request samples

Payload

Content type

application/json

{"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
default

Content type

application/json

{ }

Update given schedule policy details

Authorizations:

bearer

Request Body schema: application/json

	object (CreateMetadata)
	object (SchedulePolicyInfo)

Responses

Request samples

Payload

Content type

application/json

{"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
default

Content type

application/json

{ }

UpdateOwnership updates ownership of existing object

Authorizations:

bearer

Request Body schema: application/json

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

Responses

Request samples

Payload

Content type

application/json

{"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
default

Content type

application/json

{ }

Enumerate returns a list of schedule policy

Authorizations:

bearer

path Parameters

org_id

required

string

Responses

Response samples

200
default

Content type

application/json

{"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:

bearer

path Parameters

org_id required	string
name required	string
uid required	string

Responses

Response samples

200
default

Content type

application/json

{"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
}
}
}

Delete removes a schedule policy

Authorizations:

bearer

path Parameters

org_id required	string
name required	string
uid required	string

Responses

Response samples

200
default

Content type

application/json

{ }

Version

gets the version of the server

Authorizations:

bearer

Responses

Response samples

200
default

Content type

application/json

{"version": {"major": "string",
"minor": "string",
"patch": "string",
"changes": "string",
"git_commit": "string",
"build_date": "string"
}
}