Package: harbor-api-client
harbor_clientThese APIs provide services for manipulating Harbor project.This Python package is automatically generated by theSwagger Codegenproject:API version: 2.0Package version: 2.7.0Build package: io.swagger.codegen.languages.PythonClientCodegenRequirements.Python 2.7 and 3.4+Installation & Usagepip installIf the python package is hosted on Github, you can install directly from Githubpipinstallgit+https://github.com/GIT_USER_ID/GIT_REPO_ID.git(you may need to runpipwith root permission:sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)Then import the package:importharbor_clientSetuptoolsInstall viaSetuptools.pythonsetup.pyinstall--user(orsudo python setup.py installto install the package for all users)Then import the package:importharbor_clientGetting StartedPlease follow theinstallation procedureand then run the following:from__future__importprint_functionimporttimeimportharbor_clientfromharbor_client.restimportApiExceptionfrompprintimportpprint# Configure HTTP basic authorization: basicconfiguration=harbor_client.Configuration()configuration.username='YOUR_USERNAME'configuration.password='YOUR_PASSWORD'# create an instance of the API classapi_instance=harbor_client.LdapApi(harbor_client.ApiClient(configuration))uid_list=harbor_client.LdapImportUsers()# LdapImportUsers | The uid listed for importing. This list will check users validity of ldap service based on configuration from the system.x_request_id='x_request_id_example'# str | An unique ID for the request (optional)try:# Import selected available ldap users.api_instance.import_ldap_user(uid_list,x_request_id=x_request_id)exceptApiExceptionase:print("Exception when calling LdapApi->import_ldap_user:%s\n"%e)Documentation for API EndpointsAll URIs are relative tohttp://localhost/api/v2.0ClassMethodHTTP requestDescriptionLdapApiimport_ldap_userPOST/ldap/users/importImport selected available ldap users.LdapApiping_ldapPOST/ldap/pingPing available ldap service.LdapApisearch_ldap_groupGET/ldap/groups/searchSearch available ldap groups.LdapApisearch_ldap_userGET/ldap/users/searchSearch available ldap users.RetentionApicreate_retentionPOST/retentionsCreate Retention PolicyRetentionApidelete_retentionDELETE/retentions/{id}Delete Retention PolicyRetentionApiget_rentenition_metadataGET/retentions/metadatasGet Retention MetadatasRetentionApiget_retentionGET/retentions/{id}Get Retention PolicyRetentionApiget_retention_task_logGET/retentions/{id}/executions/{eid}/tasks/{tid}Get Retention job task logRetentionApilist_retention_executionsGET/retentions/{id}/executionsGet Retention executionsRetentionApilist_retention_tasksGET/retentions/{id}/executions/{eid}/tasksGet Retention tasksRetentionApioperate_retention_executionPATCH/retentions/{id}/executions/{eid}Stop a Retention executionRetentionApitrigger_retention_executionPOST/retentions/{id}/executionsTrigger a Retention ExecutionRetentionApiupdate_retentionPUT/retentions/{id}Update Retention PolicySystemCVEAllowlistApiget_system_cve_allowlistGET/system/CVEAllowlistGet the system level allowlist of CVE.SystemCVEAllowlistApiput_system_cve_allowlistPUT/system/CVEAllowlistUpdate the system level allowlist of CVE.ArtifactApiadd_labelPOST/projects/{project_name}/repositories/{repository_name}/artifacts/{reference}/labelsAdd label to artifactArtifactApicopy_artifactPOST/projects/{project_name}/repositories/{repository_name}/artifactsCopy artifactArtifactApicreate_tagPOST/projects/{project_name}/repositories/{repository_name}/artifacts/{reference}/tagsCreate tagArtifactApidelete_artifactDELETE/projects/{project_name}/repositories/{repository_name}/artifacts/{reference}Delete the specific artifactArtifactApidelete_tagDELETE/projects/{project_name}/repositories/{repository_name}/artifacts/{reference}/tags/{tag_name}Delete tagArtifactApiget_additionGET/projects/{project_name}/repositories/{repository_name}/artifacts/{reference}/additions/{addition}Get the addition of the specific artifactArtifactApiget_artifactGET/projects/{project_name}/repositories/{repository_name}/artifacts/{reference}Get the specific artifactArtifactApiget_vulnerabilities_additionGET/projects/{project_name}/repositories/{repository_name}/artifacts/{reference}/additions/vulnerabilitiesGet the vulnerabilities addition of the specific artifactArtifactApilist_accessoriesGET/projects/{project_name}/repositories/{repository_name}/artifacts/{reference}/accessoriesList accessoriesArtifactApilist_artifactsGET/projects/{project_name}/repositories/{repository_name}/artifactsList artifactsArtifactApilist_tagsGET/projects/{project_name}/repositories/{repository_name}/artifacts/{reference}/tagsList tagsArtifactApiremove_labelDELETE/projects/{project_name}/repositories/{repository_name}/artifacts/{reference}/labels/{label_id}Remove label from artifactAuditlogApilist_audit_logsGET/audit-logsGet recent logs of the projects which the user is a member ofConfigureApiget_configurationsGET/configurationsGet system configurations.ConfigureApiget_internalconfigGET/internalconfigGet internal configurations.ConfigureApiupdate_configurationsPUT/configurationsModify system configurations.GcApicreate_gc_schedulePOST/system/gc/scheduleCreate a gc schedule.GcApiget_gcGET/system/gc/{gc_id}Get gc status.GcApiget_gc_historyGET/system/gcGet gc results.GcApiget_gc_logGET/system/gc/{gc_id}/logGet gc job log.GcApiget_gc_scheduleGET/system/gc/scheduleGet gc's schedule.GcApistop_gcPUT/system/gc/{gc_id}Stop the specific GC executionGcApiupdate_gc_schedulePUT/system/gc/scheduleUpdate gc's schedule.HealthApiget_healthGET/healthCheck the status of Harbor componentsIconApiget_iconGET/icons/{digest}Get artifact iconImmutableApicreate_immu_rulePOST/projects/{project_name_or_id}/immutabletagrulesAdd an immutable tag rule to current projectImmutableApidelete_immu_ruleDELETE/projects/{project_name_or_id}/immutabletagrules/{immutable_rule_id}Delete the immutable tag rule.ImmutableApilist_immu_rulesGET/projects/{project_name_or_id}/immutabletagrulesList all immutable tag rules of current projectImmutableApiupdate_immu_rulePUT/projects/{project_name_or_id}/immutabletagrules/{immutable_rule_id}Update the immutable tag rule or enable or disable the ruleJobserviceApiaction_pending_jobsPUT/jobservice/queues/{job_type}stop and clean, pause, resume pending jobs in the queueJobserviceApiget_worker_poolsGET/jobservice/poolsGet worker poolsJobserviceApiget_workersGET/jobservice/pools/{pool_id}/workersGet workersJobserviceApilist_job_queuesGET/jobservice/queueslist job queuesJobserviceApistop_running_jobPUT/jobservice/jobs/{job_id}Stop running jobLabelApicreate_labelPOST/labelsPost creates a labelLabelApidelete_labelDELETE/labels/{label_id}Delete the label specified by ID.LabelApiget_label_by_idGET/labels/{label_id}Get the label specified by ID.LabelApilist_labelsGET/labelsList labels according to the query strings.LabelApiupdate_labelPUT/labels/{label_id}Update the label properties.MemberApicreate_project_memberPOST/projects/{project_name_or_id}/membersCreate project memberMemberApidelete_project_memberDELETE/projects/{project_name_or_id}/members/{mid}Delete project memberMemberApiget_project_memberGET/projects/{project_name_or_id}/members/{mid}Get the project member informationMemberApilist_project_membersGET/projects/{project_name_or_id}/membersGet all project member informationMemberApiupdate_project_memberPUT/projects/{project_name_or_id}/members/{mid}Update project memberOidcApiping_oidcPOST/system/oidc/pingTest the OIDC endpoint.PingApiget_pingGET/pingPing Harbor to check if it's alive.PreheatApicreate_instancePOST/p2p/preheat/instancesCreate p2p provider instancesPreheatApicreate_policyPOST/projects/{project_name}/preheat/policiesCreate a preheat policy under a projectPreheatApidelete_instanceDELETE/p2p/preheat/instances/{preheat_instance_name}Delete the specified P2P provider instancePreheatApidelete_policyDELETE/projects/{project_name}/preheat/policies/{preheat_policy_name}Delete a preheat policyPreheatApiget_executionGET/projects/{project_name}/preheat/policies/{preheat_policy_name}/executions/{execution_id}Get a execution detail by idPreheatApiget_instanceGET/p2p/preheat/instances/{preheat_instance_name}Get a P2P provider instancePreheatApiget_policyGET/projects/{project_name}/preheat/policies/{preheat_policy_name}Get a preheat policyPreheatApiget_preheat_logGET/projects/{project_name}/preheat/policies/{preheat_policy_name}/executions/{execution_id}/tasks/{task_id}/logsGet the log text stream of the specified task for the given executionPreheatApilist_executionsGET/projects/{project_name}/preheat/policies/{preheat_policy_name}/executionsList executions for the given policyPreheatApilist_instancesGET/p2p/preheat/instancesList P2P provider instancesPreheatApilist_policiesGET/projects/{project_name}/preheat/policiesList preheat policiesPreheatApilist_providersGET/p2p/preheat/providersList P2P providersPreheatApilist_providers_under_projectGET/projects/{project_name}/preheat/providersGet all providers at project levelPreheatApilist_tasksGET/projects/{project_name}/preheat/policies/{preheat_policy_name}/executions/{execution_id}/tasksList all the related tasks for the given executionPreheatApimanual_preheatPOST/projects/{project_name}/preheat/policies/{preheat_policy_name}Manual preheatPreheatApiping_instancesPOST/p2p/preheat/instances/pingPing status of a instance.PreheatApistop_executionPATCH/projects/{project_name}/preheat/policies/{preheat_policy_name}/executions/{execution_id}Stop a executionPreheatApiupdate_instancePUT/p2p/preheat/instances/{preheat_instance_name}Update the specified P2P provider instancePreheatApiupdate_policyPUT/projects/{project_name}/preheat/policies/{preheat_policy_name}Update preheat policyProjectApicreate_projectPOST/projectsCreate a new project.ProjectApidelete_projectDELETE/projects/{project_name_or_id}Delete project by projectIDProjectApiget_logsGET/projects/{project_name}/logsGet recent logs of the projectsProjectApiget_projectGET/projects/{project_name_or_id}Return specific project detail informationProjectApiget_project_deletableGET/projects/{project_name_or_id}/_deletableGet the deletable status of the projectProjectApiget_project_summaryGET/projects/{project_name_or_id}/summaryGet summary of the project.ProjectApiget_scanner_of_projectGET/projects/{project_name_or_id}/scannerGet project level scannerProjectApihead_projectHEAD/projectsCheck if the project name user provided already exists.ProjectApilist_projectsGET/projectsList projectsProjectApilist_scanner_candidates_of_projectGET/projects/{project_name_or_id}/scanner/candidatesGet scanner registration candidates for configurating project level scannerProjectApiset_scanner_of_projectPUT/projects/{project_name_or_id}/scannerConfigure scanner for the specified projectProjectApiupdate_projectPUT/projects/{project_name_or_id}Update properties for a selected project.ProjectMetadataApiadd_project_metadatasPOST/projects/{project_name_or_id}/metadatas/Add metadata for the specific projectProjectMetadataApidelete_project_metadataDELETE/projects/{project_name_or_id}/metadatas/{meta_name}Delete the specific metadata for the specific projectProjectMetadataApiget_project_metadataGET/projects/{project_name_or_id}/metadatas/{meta_name}Get the specific metadata of the specific projectProjectMetadataApilist_project_metadatasGET/projects/{project_name_or_id}/metadatas/Get the metadata of the specific projectProjectMetadataApiupdate_project_metadataPUT/projects/{project_name_or_id}/metadatas/{meta_name}Update the specific metadata for the specific projectPurgeApicreate_purge_schedulePOST/system/purgeaudit/scheduleCreate a purge job schedule.PurgeApiget_purge_historyGET/system/purgeauditGet purge job results.PurgeApiget_purge_jobGET/system/purgeaudit/{purge_id}Get purge job status.PurgeApiget_purge_job_logGET/system/purgeaudit/{purge_id}/logGet purge job log.PurgeApiget_purge_scheduleGET/system/purgeaudit/scheduleGet purge's schedule.PurgeApistop_purgePUT/system/purgeaudit/{purge_id}Stop the specific purge audit log executionPurgeApiupdate_purge_schedulePUT/system/purgeaudit/scheduleUpdate purge job's schedule.QuotaApiget_quotaGET/quotas/{id}Get the specified quotaQuotaApilist_quotasGET/quotasList quotasQuotaApiupdate_quotaPUT/quotas/{id}Update the specified quotaRegistryApicreate_registryPOST/registriesCreate a registryRegistryApidelete_registryDELETE/registries/{id}Delete the specific registryRegistryApiget_registryGET/registries/{id}Get the specific registryRegistryApiget_registry_infoGET/registries/{id}/infoGet the registry infoRegistryApilist_registriesGET/registriesList the registriesRegistryApilist_registry_provider_infosGET/replication/adapterinfosList all registered registry provider informationRegistryApilist_registry_provider_typesGET/replication/adaptersList registry adaptersRegistryApiping_registryPOST/registries/pingCheck status of a registryRegistryApiupdate_registryPUT/registries/{id}Update the registryReplicationApicreate_replication_policyPOST/replication/policiesCreate a replication policyReplicationApidelete_replication_policyDELETE/replication/policies/{id}Delete the specific replication policyReplicationApiget_replication_executionGET/replication/executions/{id}Get the specific replication executionReplicationApiget_replication_logGET/replication/executions/{id}/tasks/{task_id}/logGet the log of the specific replication taskReplicationApiget_replication_policyGET/replication/policies/{id}Get the specific replication policyReplicationApilist_replication_executionsGET/replication/executionsList replication executionsReplicationApilist_replication_policiesGET/replication/policiesList replication policiesReplicationApilist_replication_tasksGET/replication/executions/{id}/tasksList replication tasks for a specific executionReplicationApistart_replicationPOST/replication/executionsStart one replication executionReplicationApistop_replicationPUT/replication/executions/{id}Stop the specific replication executionReplicationApiupdate_replication_policyPUT/replication/policies/{id}Update the replication policyRepositoryApidelete_repositoryDELETE/projects/{project_name}/repositories/{repository_name}Delete repositoryRepositoryApiget_repositoryGET/projects/{project_name}/repositories/{repository_name}Get repositoryRepositoryApilist_all_repositoriesGET/repositoriesList all authorized repositoriesRepositoryApilist_repositoriesGET/projects/{project_name}/repositoriesList repositoriesRepositoryApiupdate_repositoryPUT/projects/{project_name}/repositories/{repository_name}Update repositoryRobotApicreate_robotPOST/robotsCreate a robot accountRobotApidelete_robotDELETE/robots/{robot_id}Delete a robot accountRobotApiget_robot_by_idGET/robots/{robot_id}Get a robot accountRobotApilist_robotGET/robotsGet robot accountRobotApirefresh_secPATCH/robots/{robot_id}Refresh the robot secretRobotApiupdate_robotPUT/robots/{robot_id}Update a robot accountRobotv1Apicreate_robot_v1POST/projects/{project_name_or_id}/robotsCreate a robot accountRobotv1Apidelete_robot_v1DELETE/projects/{project_name_or_id}/robots/{robot_id}Delete a robot accountRobotv1Apiget_robot_by_idv1GET/projects/{project_name_or_id}/robots/{robot_id}Get a robot accountRobotv1Apilist_robot_v1GET/projects/{project_name_or_id}/robotsGet all robot accounts of specified projectRobotv1Apiupdate_robot_v1PUT/projects/{project_name_or_id}/robots/{robot_id}Update status of robot account.ScanApiget_report_logGET/projects/{project_name}/repositories/{repository_name}/artifacts/{reference}/scan/{report_id}/logGet the log of the scan reportScanApiscan_artifactPOST/projects/{project_name}/repositories/{repository_name}/artifacts/{reference}/scanScan the artifactScanApistop_scan_artifactPOST/projects/{project_name}/repositories/{repository_name}/artifacts/{reference}/scan/stopCancelling a scan job for a particular artifactScanAllApicreate_scan_all_schedulePOST/system/scanAll/scheduleCreate a schedule or a manual trigger for the scan all job.ScanAllApiget_latest_scan_all_metricsGET/scans/all/metricsGet the metrics of the latest scan all processScanAllApiget_latest_scheduled_scan_all_metricsGET/scans/schedule/metricsGet the metrics of the latest scheduled scan all processScanAllApiget_scan_all_scheduleGET/system/scanAll/scheduleGet scan all's schedule.ScanAllApistop_scan_allPOST/system/scanAll/stopStop scanAll job executionScanAllApiupdate_scan_all_schedulePUT/system/scanAll/scheduleUpdate scan all's schedule.ScanDataExportApidownload_scan_dataGET/export/cve/download/{execution_id}Download the scan data export fileScanDataExportApiexport_scan_dataPOST/export/cveExport scan data for selected projectsScanDataExportApiget_scan_data_export_executionGET/export/cve/execution/{execution_id}Get the specific scan data export executionScanDataExportApiget_scan_data_export_execution_listGET/export/cve/executionsGet a list of specific scan data export execution jobs for a specified userScannerApicreate_scannerPOST/scannersCreate a scanner registrationScannerApidelete_scannerDELETE/scanners/{registration_id}Delete a scanner registrationScannerApiget_scannerGET/scanners/{registration_id}Get a scanner registration detailsScannerApiget_scanner_metadataGET/scanners/{registration_id}/metadataGet the metadata of the specified scanner registrationScannerApilist_scannersGET/scannersList scanner registrationsScannerApiping_scannerPOST/scanners/pingTests scanner registration settingsScannerApiset_scanner_as_defaultPATCH/scanners/{registration_id}Set system default scanner registrationScannerApiupdate_scannerPUT/scanners/{registration_id}Update a scanner registrationScheduleApiget_schedule_pausedGET/schedules/{job_type}/pausedScheduleApilist_schedulesGET/schedulesSearchApisearchGET/searchSearch for projects, repositories and helm chartsStatisticApiget_statisticGET/statisticsGet the statistic information about the projects and repositoriesSysteminfoApiget_certGET/systeminfo/getcertGet default root certificate.SysteminfoApiget_system_infoGET/systeminfoGet general system infoSysteminfoApiget_volumesGET/systeminfo/volumesGet system volume info (total/free size).UserApicreate_userPOST/usersCreate a local user.UserApidelete_userDELETE/users/{user_id}Mark a registered user as be removed.UserApiget_current_user_infoGET/users/currentGet current user info.UserApiget_current_user_permissionsGET/users/current/permissionsGet current user permissions.UserApiget_userGET/users/{user_id}Get a user's profile.UserApilist_usersGET/usersList usersUserApisearch_usersGET/users/searchSearch users by usernameUserApiset_cli_secretPUT/users/{user_id}/cli_secretSet CLI secret for a user.UserApiset_user_sys_adminPUT/users/{user_id}/sysadminUpdate a registered user to change to be an administrator of Harbor.UserApiupdate_user_passwordPUT/users/{user_id}/passwordChange the password on a user that already exists.UserApiupdate_user_profilePUT/users/{user_id}Update user's profile.UsergroupApicreate_user_groupPOST/usergroupsCreate user groupUsergroupApidelete_user_groupDELETE/usergroups/{group_id}Delete user groupUsergroupApiget_user_groupGET/usergroups/{group_id}Get user group informationUsergroupApilist_user_groupsGET/usergroupsGet all user groups informationUsergroupApisearch_user_groupsGET/usergroups/searchSearch groups by groupnameUsergroupApiupdate_user_groupPUT/usergroups/{group_id}Update group informationWebhookApicreate_webhook_policy_of_projectPOST/projects/{project_name_or_id}/webhook/policiesCreate project webhook policy.WebhookApidelete_webhook_policy_of_projectDELETE/projects/{project_name_or_id}/webhook/policies/{webhook_policy_id}Delete webhook policy of a projectWebhookApiget_supported_event_typesGET/projects/{project_name_or_id}/webhook/eventsGet supported event types and notify types.WebhookApiget_webhook_policy_of_projectGET/projects/{project_name_or_id}/webhook/policies/{webhook_policy_id}Get project webhook policyWebhookApilast_triggerGET/projects/{project_name_or_id}/webhook/lasttriggerGet project webhook policy last trigger infoWebhookApilist_webhook_policies_of_projectGET/projects/{project_name_or_id}/webhook/policiesList project webhook policies.WebhookApiupdate_webhook_policy_of_projectPUT/projects/{project_name_or_id}/webhook/policies/{webhook_policy_id}Update webhook policy of a project.WebhookjobApilist_webhook_jobsGET/projects/{project_name_or_id}/webhook/jobsList project webhook jobsDocumentation For ModelsAccessAccessoryActionRequestAdditionLinkAdditionLinksAnnotationsArtifactAuditLogAuthproxySettingBodyBody1BoolConfigItemCVEAllowlistCVEAllowlistItemChartMetadataChartVersionComponentHealthStatusConfigurationsConfigurationsResponseConfigurationsResponseScanAllPolicyConfigurationsResponseScanAllPolicyParameterEndpointErrorErrorsEventTypeExecHistoryExecutionExtraAttrsFilterStyleGCHistoryGeneralInfoIconImmutableRuleImmutableSelectorInstanceIntegerConfigItemInternalConfigurationValueInternalConfigurationsResponseIsDefaultJobQueueLabelLdapConfLdapFailedImportUserLdapImportUsersLdapPingResultLdapUserMetadataMetricsNativeReportSummaryNotifyTypeOIDCCliSecretReqOIDCUserInfoOverallHealthStatusPasswordReqPermissionPlatformPreheatPolicyProjectProjectDeletableProjectMemberProjectMemberEntityProjectMetadataProjectReqProjectScannerProjectSummaryProjectSummaryQuotaProviderUnderProjectQuotaQuotaRefObjectQuotaUpdateReqReferenceRegistryRegistryCredentialRegistryEndpointRegistryInfoRegistryPingRegistryProviderCredentialPatternRegistryProviderEndpointPatternRegistryProviderInfoRegistryUpdateReplicationExecutionReplicationFilterReplicationPolicyReplicationTaskReplicationTriggerReplicationTriggerSettingsRepositoryResourceListRetentionExecutionRetentionExecutionTaskRetentionMetadataRetentionPolicyRetentionPolicyScopeRetentionRuleRetentionRuleMetadataRetentionRuleParamMetadataRetentionRuleTriggerRetentionSelectorRetentionSelectorMetadataRobotRobotCreateRobotCreateV1RobotCreatedRobotPermissionRobotSecRoleRequestScanDataExportExecutionScanDataExportExecutionListScanDataExportJobScanDataExportRequestScanOverviewScannerScannerAdapterMetadataScannerCapabilityScannerRegistrationScannerRegistrationReqScannerRegistrationSettingsScheduleScheduleObjScheduleTaskSchedulerStatusSearchSearchRepositorySearchResultStartReplicationExecutionStatisticStatsStorageStringConfigItemSupportedWebhookEventTypesSystemInfoTagTaskUserCreationReqUserEntityUserGroupUserGroupSearchItemUserProfileUserRespUserSearchUserSearchRespItemUserSysAdminFlagVulnerabilitySummaryWebhookJobWebhookLastTriggerWebhookPolicyWebhookTargetObjectWorkerWorkerPoolDocumentation For AuthorizationbasicType: HTTP basic authenticationAuthor