Skip to main content

public/portworx/pds/backup/apiv1/backup.proto

Project description

portworxapis

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

This Python package is automatically generated by the OpenAPI Generator project:

  • API version: version not set
  • Package version: 1.0.0
  • Generator version: 7.10.0-SNAPSHOT
  • Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python 3.7+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)

Then import the package:

import portworxapis

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import portworxapis

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import portworxapis
from portworxapis.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = portworxapis.Configuration(
    host = "http://localhost"
)



# Enter a context with an instance of the API client
with portworxapis.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = portworxapis.AccountServiceApi(api_client)
    account_id = 'account_id_example' # str | account id which is going to be deleted.

    try:
        # DeleteAccount API deletes account for given id.
        api_response = api_instance.account_service_delete_account(account_id)
        print("The response of AccountServiceApi->account_service_delete_account:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling AccountServiceApi->account_service_delete_account: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to http://localhost

Class Method HTTP request Description
AccountServiceApi account_service_delete_account DELETE /core/v1/accounts/{accountId} DeleteAccount API deletes account for given id.
AccountServiceApi account_service_get_account GET /core/v1/accounts/{accountId} GetAccount API returns the info about account for given account id.
ApplicationServiceApi application_service_get_application GET /core/v1/applications/{id} GetApplication API returns the info about application with given id.
ApplicationServiceApi application_service_get_application2 GET /core/v1/clusters/{clusterId}/applications/{id} GetApplication API returns the info about application with given id.
ApplicationServiceApi application_service_install_application POST /core/v1/clusters/{clusterId}/applications InstallApplication API installs specified application on the target cluster.
ApplicationServiceApi application_service_list_applications GET /core/v1/clusters/{clusterId}/applications ListApplications API lists the applications installed on the target cluster.
ApplicationServiceApi application_service_list_available_applications GET /core/v1/tenants/{tenantId}:listAvailableApplications ListAvailableApplications API lists all the applications visible to a caller.
ApplicationServiceApi application_service_uninstall_application DELETE /core/v1/applications/{id} UninstallApplication API uninstalls the specified application on the target cluster.
ApplicationServiceApi application_service_uninstall_application2 DELETE /core/v1/clusters/{clusterId}/applications/{id} UninstallApplication API uninstalls the specified application on the target cluster.
ApplicationServiceApi application_service_update_application PUT /core/v1/applications/{application.meta.uid} UpdateApplication API updates specified application on the target cluster.
BackupConfigServiceApi backup_config_service_create_backup_config POST /pds/v1/projects/{projectId}/backupConfigs CreateBackupConfig API creates the backup configuration of the backup.
BackupConfigServiceApi backup_config_service_delete_backup_config DELETE /pds/v1/backupConfigs/{id} DeleteBackupConfig API deletes the backup configuration.
BackupConfigServiceApi backup_config_service_get_backup_config GET /pds/v1/backupConfigs/{id} GetBackupConfig API returns the the backup configuration resource.
BackupConfigServiceApi backup_config_service_list_backup_configs GET /pds/v1/backupConfigs ListBackupConfigs API lists all the backup configuration for a data service deployment.
BackupConfigServiceApi backup_config_service_update_backup_config PUT /pds/v1/backupConfigs/{id} UpdateBackupConfig API updates the backup configuration of the backup.
BackupLocationServiceApi backup_location_service_create_backup_location POST /core/v1/tenants/{tenantId}/backupLocations Create API creates a backup location for a tenant.
BackupLocationServiceApi backup_location_service_delete_backup_location DELETE /core/v1/backupLocations/{id} Delete API deletes a backup location.
BackupLocationServiceApi backup_location_service_get_backup_location GET /core/v1/backupLocations/{id} Get API returns the backup location.
BackupLocationServiceApi backup_location_service_list_backup_locations GET /core/v1/backupLocations List API lists all the backup locations for a tenant
BackupLocationServiceApi backup_location_service_list_backup_locations2 POST /core/v1/backupLocations:search List API lists all the backup locations for a tenant
BackupLocationServiceApi backup_location_service_update_backup_location PUT /core/v1/backupLocations/{id} Update API updates a backup location.
BackupPolicyServiceApi backup_policy_service_create_backup_policy POST /core/v1/tenants/{tenantId}/backupPolicies Create API creates a backup policy for a tenant.
BackupPolicyServiceApi backup_policy_service_delete_backup_policy DELETE /core/v1/backupPolicies/{id} Delete API deletes a backup policy.
BackupPolicyServiceApi backup_policy_service_get_backup_policy GET /core/v1/backupPolicies/{id} Get API returns the backup policy for the given ID.
BackupPolicyServiceApi backup_policy_service_list_backup_policies GET /core/v1/backupPolicies List API lists all the backup policies for a tenant
BackupPolicyServiceApi backup_policy_service_list_backup_policies2 POST /core/v1/backupPolicies:search List API lists all the backup policies for a tenant
BackupPolicyServiceApi backup_policy_service_update_backup_policy_meta PUT /core/v1/backupPolicies/{meta.uid}:metaUpdate Update API updates a the meta data of a backup policy.
BackupServiceApi backup_service_delete_backup DELETE /pds/v1/backups/{id} DeleteBackup API deletes the Backup resource.
BackupServiceApi backup_service_get_backup GET /pds/v1/backups/{id} GetBackup API returns the Backup resource.
BackupServiceApi backup_service_list_backups GET /pds/v1/backups ListBackups API lists the Backup resources.
CloudCredentialServiceApi cloud_credential_service_create_cloud_credential POST /core/v1/tenants/{tenantId}/cloudCredentials Create API creates a set of cloud credentials for a tenant.
CloudCredentialServiceApi cloud_credential_service_delete_cloud_credential DELETE /core/v1/cloudCredentials/{id} Delete API deletes the cloud credentials.
CloudCredentialServiceApi cloud_credential_service_get_cloud_credential GET /core/v1/cloudCredentials/{id} Get API returns the cloud credential details sans the actual credentials.
CloudCredentialServiceApi cloud_credential_service_list_cloud_credentials GET /core/v1/cloudCredentials List API lists all the cloud credentials for a tenant
CloudCredentialServiceApi cloud_credential_service_list_cloud_credentials2 POST /core/v1/cloudCredentials:search List API lists all the cloud credentials for a tenant
CloudCredentialServiceApi cloud_credential_service_update_cloud_credential PUT /core/v1/cloudCredentials/{id} Update API updates a cloud credential.
CopilotServiceApi copilot_service_search_query POST /pds/v1/copilot/search Search dataservice queries.
DataServiceDeploymentConfigUpdateServiceApi data_service_deployment_config_update_service_create_data_service_deployment_config_update PUT /pds/v1/dataServiceDeployments/{dataServiceDeploymentConfigUpdate.config.dataServiceDeploymentMeta.uid}/dataServiceDeploymentConfigUpdates CreateDataServiceDeploymentConfigUpdate API creates config update for deployment.
DataServiceDeploymentConfigUpdateServiceApi data_service_deployment_config_update_service_get_data_service_deployment_config_update GET /pds/v1/dataServiceDeploymentConfigUpdates/{id} GetDataServiceDeploymentConfigUpdate API returns a DataService deployment config update by id.
DataServiceDeploymentConfigUpdateServiceApi data_service_deployment_config_update_service_list_data_service_deployment_config_updates GET /pds/v1/dataServiceDeploymentConfigUpdates ListDataServiceDeploymentConfigUpdates API returns a list of data service deployment config updates.
DataServiceDeploymentConfigUpdateServiceApi data_service_deployment_config_update_service_retry_data_service_deployment_config_update POST /pds/v1/dataServiceDeploymentConfigUpdates/{id}:retry RetryDataServiceDeploymentConfigUpdate API retries a data service deployment config update.
DataServiceDeploymentEventServiceApi data_service_deployment_event_service_list_data_service_deployment_events GET /pds/v1/dataServiceDeployments/{dataServiceDeploymentId}/events ListDataServiceDeploymentEvents API returns the list of kubernetes events related to a DataService deployment.
DataServiceDeploymentServiceApi data_service_deployment_service_create_data_service_deployment POST /pds/v1/namespaces/{namespaceId}/dataServiceDeployments CreateDataServiceDeployment API creates the Deployment resource.
DataServiceDeploymentServiceApi data_service_deployment_service_create_data_service_deployment_with_scheduled_backup POST /pds/v1/namespaces/{namespaceId}/dataServiceDeployments:createWithScheduledBackup CreateDataServiceDeploymentWithScheduledBackup API creates both Deployment and backup configuration resources.
DataServiceDeploymentServiceApi data_service_deployment_service_delete_data_service_deployment DELETE /pds/v1/dataServiceDeployments/{id} DeleteDataServiceDeployment API deletes the DataService Deployment resource.
DataServiceDeploymentServiceApi data_service_deployment_service_get_data_service_deployment GET /pds/v1/dataServiceDeployments/{id} GetDataServiceDeployment API returns the DataService Deployment resource.
DataServiceDeploymentServiceApi data_service_deployment_service_get_data_service_deployment_credentials GET /pds/v1/dataServiceDeployments/{id}:credentials GetDataServiceDeploymentCredentials API returns the Credentials to be used to access the DataService Deployment.
DataServiceDeploymentServiceApi data_service_deployment_service_get_key_performance_indicators POST /pds/v1/dataServiceDeployments:kpis GetKeyPerformanceIndicator API return the analytics of the DataService Deployment resources.
DataServiceDeploymentServiceApi data_service_deployment_service_list_data_service_deployments POST /pds/v1/dataServiceDeployments:search ListDataServiceDeployments API lists the DataService Deployment resources.
DataServiceVersionServiceApi data_service_version_service_get_data_service_version GET /pds/v1/catalog/dataServiceVersions/{id} GetDataServiceVersion returns a data service version.
DataServiceVersionServiceApi data_service_version_service_list_compatible_data_service_versions GET /pds/v1/catalog/dataServiceVersions:listCompatibleVersions ListCompatibleDataServiceVersions lists all the data service versions compatible with other version of a data service.
DataServiceVersionServiceApi data_service_version_service_list_data_service_versions GET /pds/v1/catalog/dataServices/{dataServiceId}/dataServiceVersions ListDataServiceVersions lists all the versions of a data service.
DataServicesServiceApi data_services_service_get_data_service GET /pds/v1/catalog/dataServices/{id} GetDataService API returns the the data service resource.
DataServicesServiceApi data_services_service_list_data_services GET /pds/v1/catalog/dataServices ListDataServices API lists the the data service resources.
IAMServiceApi i_am_service_create_iam POST /core/v1/iam CreateIAM API creates a new IAM role-binding.
IAMServiceApi i_am_service_delete_iam DELETE /core/v1/iam/{actorId} DeleteIAM API delete IAM, currently required only for name.
IAMServiceApi i_am_service_get_iam GET /core/v1/iam/{actorId} GetIAM API returns the info about IAM for given IAM id.
IAMServiceApi i_am_service_grant_iam POST /core/v1/iam/{actorId}:grant GrantIAM API creates new IAM role-binding at tenant, project and account level.
IAMServiceApi i_am_service_list_iam GET /core/v1/iam ListIAM API lists the role bindings.
IAMServiceApi i_am_service_list_iam_permissions GET /core/v1/iam/permissions ListIAMPermissions API list permissions for Roles in IAM.
IAMServiceApi i_am_service_revoke_iam POST /core/v1/iam/{actorId}:revoke RevokeIAM API delete IAM role-binding at tenant, project and account level.
IAMServiceApi i_am_service_update_iam PUT /core/v1/iam/{iam.meta.uid} UpdateIAM API updates IAM with the new set of role bindings. The request replaces the existing set of bindings.
ImageServiceApi image_service_get_image GET /pds/v1/catalog/images/{id} GetImage API returns the information about the specified image.
ImageServiceApi image_service_list_images GET /pds/v1/catalog/images ListImages API lists the data service images.
InvitationServiceApi invitation_service_accept_invitation POST /core/v1/invite:accept AcceptInvitation API accepts the invitation from the system.
InvitationServiceApi invitation_service_create_invitation POST /core/v1/invite CreateInvitation API creates an invitation.
InvitationServiceApi invitation_service_delete_invitation DELETE /core/v1/invite/{uid} DeleteInvitation deletes the specified invitation from the system.
InvitationServiceApi invitation_service_get_invitation GET /core/v1/invite/{uid} GetInvitation deletes the specified invitation from the system.
InvitationServiceApi invitation_service_list_invitations GET /core/v1/invite ListInvitation API lists invitation in an account/tenant/project.
InvitationServiceApi invitation_service_notify_user GET /core/v1/invite/{uid}:notify Notify re-send the mail notification to the user email in the invitation config.
LoginServiceApi login_service_get_oidc_info GET /core/v1/oauth:oidcInfo GetOIDCInfo API returns an oidc configurations for user client.
LoginServiceApi login_service_login POST /core/v1/oauth:login Login API interacts with central using provided email + password and returns an ID Token which can be used by the user for API authentication.
LoginServiceApi login_service_refresh_token POST /core/v1/oauth:refreshToken RefreshToken API returns an ID Token in exchange for a valid refresh token.
MetricServiceApi metric_service_get_metrics GET /pds/v1/metrics GetMetrics API returns the Metrics of DataService Deployment.
NamespaceServiceApi namespace_service_delete_namespace DELETE /core/v1/namespaces/{id} DeleteNamespace API will trigger deletion and cleanup on the control plane.
NamespaceServiceApi namespace_service_list_namespaces GET /core/v1/namespaces List API lists all the namespaces for a tenant
NamespaceServiceApi namespace_service_list_namespaces2 POST /core/v1/namespaces:search List API lists all the namespaces for a tenant
OnboardServiceApi onboard_service_create_account_registration POST /core/v1/registration creates a new account registration request.
OnboardServiceApi onboard_service_update_account_registration PUT /core/v1/registration/{accountRegistration.meta.uid} For updating account subscription info.
ProjectServiceApi project_service_associate_resources PUT /core/v1/projects/{projectId}:associate AssociateResources will append the supplied resources to existing infra resources of a given project config.
ProjectServiceApi project_service_create_project POST /core/v1/tenants/{tenantId}/projects Create project api creates a project.
ProjectServiceApi project_service_delete_project DELETE /core/v1/projects/{projectId} Deletes a project and its associated resources.
ProjectServiceApi project_service_disassociate_resources PUT /core/v1/projects/{projectId}:disassociate DisassociateResource will remove the infra resources supplied in the request from the project config.
ProjectServiceApi project_service_get_project GET /core/v1/projects/{projectId} Get project apis returns a requested project.
ProjectServiceApi project_service_list_projects GET /core/v1/projects List API lists all the projects for a tenant
ProjectServiceApi project_service_list_projects2 POST /core/v1/projects:search List API lists all the projects for a tenant
ProjectServiceApi project_service_update_project PUT /core/v1/projects/{meta.uid} Update project api updates a project meta.
RestoreServiceApi restore_service_create_restore POST /pds/v1/namespaces/{namespaceId}/restores CreateRestore API creates the Restore resource.
RestoreServiceApi restore_service_get_restore GET /pds/v1/restores/{id} GetRestore API returns the Restore resource.
RestoreServiceApi restore_service_list_restores GET /pds/v1/restores ListRestore API lists the Restore resources.
RestoreServiceApi restore_service_recreate_restore POST /pds/v1/restores/{id}:recreate RecreateRestore API recreates a already failed restore.
ServiceAccountServiceApi service_account_service_create_service_account POST /core/v1/tenants/{tenantId}/serviceAccounts Create a requested service account.
ServiceAccountServiceApi service_account_service_delete_service_account DELETE /core/v1/serviceAccounts/{id} Initiates deletion of a service account.
ServiceAccountServiceApi service_account_service_get_access_token POST /core/v1/tenants/{tenantId}:getToken Get access token for a service account.
ServiceAccountServiceApi service_account_service_get_service_account GET /core/v1/serviceAccounts/{id} Returns a requested service account.
ServiceAccountServiceApi service_account_service_list_service_account GET /core/v1/serviceAccounts Returns a requested list of service accounts.
ServiceAccountServiceApi service_account_service_regenerate_service_account_secret GET /core/v1/serviceAccounts/{id}:regenerate Regenerate access token for a service account.
ServiceAccountServiceApi service_account_service_update_service_account PUT /core/v1/serviceAccounts/{id} Updates a service account.
TargetClusterRegistrationManifestServiceApi target_cluster_registration_manifest_service_generate_target_cluster_registration_manifest POST /core/v1/tenants/{tenantId}:registrationManifests GetTargetClusterRegistrationManifest fetches registration manifest for the given request.
TargetClusterServiceApi target_cluster_service_delete_target_cluster DELETE /core/v1/clusters/{id} DeleteTargetCluster API deletes the specified TargetCluster.
TargetClusterServiceApi target_cluster_service_get_target_cluster GET /core/v1/clusters/{id} GetTargetCluster API returns the info about the TargetCluster for given name.
TargetClusterServiceApi target_cluster_service_list_target_clusters GET /core/v1/clusters List API lists all the target clusters for a tenant
TargetClusterServiceApi target_cluster_service_list_target_clusters2 POST /core/v1/clusters:search List API lists all the target clusters for a tenant
TargetClusterServiceApi target_cluster_service_update_target_cluster PUT /core/v1/clusters/{targetCluster.meta.uid} UpdateTargetCluster API updates the metadata(e.g name/labels/annotations and desc) of the specified TargetCluster.
TemplateDefinitionServiceApi template_definition_service_get_revision GET /pds/v1/catalog/templateDefinition/revisions:get GetRevision gets the revision details, containing the actual schema.
TemplateDefinitionServiceApi template_definition_service_get_template_sample GET /pds/v1/catalog/templateDefinition/samples/{id} GetTemplateSample API returns the template sample for a given template id.
TemplateDefinitionServiceApi template_definition_service_get_template_type GET /pds/v1/catalog/templateDefinition/types/{id} GetTemplateType API returns the template type by id.
TemplateDefinitionServiceApi template_definition_service_list_revisions GET /pds/v1/catalog/templateDefinition/revisions List API lists all the revision
TemplateDefinitionServiceApi template_definition_service_list_revisions2 POST /pds/v1/catalog/templateDefinition/revisions:search List API lists all the revision
TemplateDefinitionServiceApi template_definition_service_list_template_kinds GET /pds/v1/catalog/templateDefinition/kinds ListTemplateKindRequest: Used to list unique template kind(names).
TemplateDefinitionServiceApi template_definition_service_list_template_samples GET /pds/v1/catalog/templateDefinition/samples ListTemplateSamples: Used to list template sample schema.
TemplateDefinitionServiceApi template_definition_service_list_template_types GET /pds/v1/catalog/templateDefinition/types ListTemplateTypes API returns the list of all supported template types.
TemplateServiceApi template_service_create_template POST /core/v1/tenants/{tenantId}/templates Create API creates a set of templates for a tenant.
TemplateServiceApi template_service_delete_template DELETE /core/v1/templates/{id} Delete API deletes the templates.
TemplateServiceApi template_service_get_template GET /core/v1/templates/{id} Get API returns the template details sans the actual credentials.
TemplateServiceApi template_service_list_templates GET /core/v1/templates List API lists all the templates for a tenant
TemplateServiceApi template_service_list_templates2 POST /core/v1/templates:search List API lists all the templates for a tenant
TemplateServiceApi template_service_update_template PUT /core/v1/templates/{template.meta.uid} Update API updates a template.
TenantServiceApi tenant_service_create_tenant POST /core/v1/tenants CreateTenant API creates a new Tenant.
TenantServiceApi tenant_service_delete_tenant DELETE /core/v1/tenants/{tenantId} Delete tenant removes a tenant record.
TenantServiceApi tenant_service_get_tenant GET /core/v1/tenants/{tenantId} GetTenant API returns the info about for given tenant id.
TenantServiceApi tenant_service_list_tenants GET /core/v1/tenants ListTenants API lists the tenants visible to the caller for the current account.
TenantServiceApi tenant_service_update_tenant PUT /core/v1/tenants/{tenant.meta.uid} UpdateTenant API updates tenant.
WhoAmIServiceApi who_am_i_service_invitations_who_am_i GET /core/v1/whoami:invitations InvitationsWhoAmI API returns the current actor pending invitations cross accounts.
WhoAmIServiceApi who_am_i_service_who_am_i GET /core/v1/whoami WhoAmI API returns the current actor accounts.

Documentation For Models

Documentation For Authorization

Endpoints do not require authorization.

Author

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

portworxapis-2024.9.4.tar.gz (162.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

portworxapis-2024.9.4-py3-none-any.whl (516.7 kB view details)

Uploaded Python 3

File details

Details for the file portworxapis-2024.9.4.tar.gz.

File metadata

  • Download URL: portworxapis-2024.9.4.tar.gz
  • Upload date:
  • Size: 162.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.0

File hashes

Hashes for portworxapis-2024.9.4.tar.gz
Algorithm Hash digest
SHA256 79076fe2a757241d1adc551fb355a119b071718edff95a7d6e9425bd2c66b1e0
MD5 bbafc67ece64dfcb21ad153186aac5fc
BLAKE2b-256 0df4bde200d8c7f065561b6705b472952d2b6cefbdf17cb48827340415ec87f0

See more details on using hashes here.

File details

Details for the file portworxapis-2024.9.4-py3-none-any.whl.

File metadata

File hashes

Hashes for portworxapis-2024.9.4-py3-none-any.whl
Algorithm Hash digest
SHA256 31dcb5c7e31d3e329f904b5f5f6ecf9e31cc8635c0ab066fdb358c8f54f4316c
MD5 9cb296490148234a69b9f84106d1d9d4
BLAKE2b-256 604bd8d05fed7919dc9b787905ead71a295e8492b3184907a7e0c2af2ddf2ff2

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page