harbor_swagger_client
SwaggerClient - the Ruby gem for the Harbor API
These APIs provide services for manipulating Harbor project.
This SDK is automatically generated by the Swagger Codegen project:
- API version: 1.10.0
- Package version: 1.0.0
- Build package: io.swagger.codegen.languages.RubyClientCodegen
Installation
Build a gem
To build the Ruby code into a gem:
gem build harbor_swagger_client.gemspec
Then either install the gem locally:
gem install ./harbor_swagger_client-1.0.0.gem
(for development, run gem install --dev ./harbor_swagger_client-1.0.0.gem to install the development dependencies)
or publish the gem to a gem hosting service, e.g. RubyGems.
Finally add this to the Gemfile:
gem 'harbor_swagger_client', '~> 1.0.0'
Install from Git
If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:
gem 'harbor_swagger_client', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'
Include the Ruby code directly
Include the Ruby code directly using -I as follows:
ruby -Ilib script.rb
Getting Started
Please follow the installation procedure and then run the following code:
# Load the gem
require 'harbor_swagger_client'
# Setup authorization
SwaggerClient.configure do |config|
# Configure HTTP basic authorization: basicAuth
config.username = 'YOUR USERNAME'
config.password = 'YOUR PASSWORD'
end
api_instance = SwaggerClient::ChartRepositoryApi.new
chart = File.new('/path/to/file.txt') # File | The chart file
opts = {
prov: File.new('/path/to/file.txt') # File | The provance file
}
begin
#Upload a chart file to the defult 'library' project.
api_instance.chartrepo_charts_post(chart, opts)
rescue SwaggerClient::ApiError => e
puts "Exception when calling ChartRepositoryApi->chartrepo_charts_post: #{e}"
end
Documentation for API Endpoints
All URIs are relative to http://localhost/api
| Class | Method | HTTP request | Description |
|---|---|---|---|
| SwaggerClient::ChartRepositoryApi | chartrepo_charts_post | POST /chartrepo/charts | Upload a chart file to the defult 'library' project. |
| SwaggerClient::ChartRepositoryApi | chartrepo_health_get | GET /chartrepo/health | Check the health of chart repository service. |
| SwaggerClient::ChartRepositoryApi | chartrepo_repo_charts_get | GET /chartrepo/repo/charts | Get all the charts under the specified project |
| SwaggerClient::ChartRepositoryApi | chartrepo_repo_charts_name_delete | DELETE /chartrepo/repo/charts/name | Delete all the versions of the specified chart |
| SwaggerClient::ChartRepositoryApi | chartrepo_repo_charts_name_get | GET /chartrepo/repo/charts/name | Get all the versions of the specified chart |
| SwaggerClient::ChartRepositoryApi | chartrepo_repo_charts_name_version_delete | DELETE /chartrepo/repo/charts/name/version | Delete the specified chart version |
| SwaggerClient::ChartRepositoryApi | chartrepo_repo_charts_name_version_get | GET /chartrepo/repo/charts/name/version | Get the specified chart version |
| SwaggerClient::ChartRepositoryApi | chartrepo_repo_charts_name_version_labels_get | GET /chartrepo/repo/charts/name/version/labels | Return the attahced labels of chart. |
| SwaggerClient::ChartRepositoryApi | chartrepo_repo_charts_name_version_labels_id_delete | DELETE /chartrepo/repo/charts/name/version/labels/id | Remove label from chart. |
| SwaggerClient::ChartRepositoryApi | chartrepo_repo_charts_name_version_labels_post | POST /chartrepo/repo/charts/name/version/labels | Mark label to chart. |
| SwaggerClient::ChartRepositoryApi | chartrepo_repo_charts_post | POST /chartrepo/repo/charts | Upload a chart file to the specified project. |
| SwaggerClient::ChartRepositoryApi | chartrepo_repo_prov_post | POST /chartrepo/repo/prov | Upload a provance file to the specified project. |
| SwaggerClient::LabelApi | chartrepo_repo_charts_name_version_labels_get | GET /chartrepo/repo/charts/name/version/labels | Return the attahced labels of chart. |
| SwaggerClient::LabelApi | chartrepo_repo_charts_name_version_labels_id_delete | DELETE /chartrepo/repo/charts/name/version/labels/id | Remove label from chart. |
| SwaggerClient::LabelApi | chartrepo_repo_charts_name_version_labels_post | POST /chartrepo/repo/charts/name/version/labels | Mark label to chart. |
| SwaggerClient::ProductsApi | chartrepo_charts_post | POST /chartrepo/charts | Upload a chart file to the defult 'library' project. |
| SwaggerClient::ProductsApi | chartrepo_health_get | GET /chartrepo/health | Check the health of chart repository service. |
| SwaggerClient::ProductsApi | chartrepo_repo_charts_get | GET /chartrepo/repo/charts | Get all the charts under the specified project |
| SwaggerClient::ProductsApi | chartrepo_repo_charts_name_delete | DELETE /chartrepo/repo/charts/name | Delete all the versions of the specified chart |
| SwaggerClient::ProductsApi | chartrepo_repo_charts_name_get | GET /chartrepo/repo/charts/name | Get all the versions of the specified chart |
| SwaggerClient::ProductsApi | chartrepo_repo_charts_name_version_delete | DELETE /chartrepo/repo/charts/name/version | Delete the specified chart version |
| SwaggerClient::ProductsApi | chartrepo_repo_charts_name_version_get | GET /chartrepo/repo/charts/name/version | Get the specified chart version |
| SwaggerClient::ProductsApi | chartrepo_repo_charts_name_version_labels_get | GET /chartrepo/repo/charts/name/version/labels | Return the attahced labels of chart. |
| SwaggerClient::ProductsApi | chartrepo_repo_charts_name_version_labels_id_delete | DELETE /chartrepo/repo/charts/name/version/labels/id | Remove label from chart. |
| SwaggerClient::ProductsApi | chartrepo_repo_charts_name_version_labels_post | POST /chartrepo/repo/charts/name/version/labels | Mark label to chart. |
| SwaggerClient::ProductsApi | chartrepo_repo_charts_post | POST /chartrepo/repo/charts | Upload a chart file to the specified project. |
| SwaggerClient::ProductsApi | chartrepo_repo_prov_post | POST /chartrepo/repo/prov | Upload a provance file to the specified project. |
| SwaggerClient::ProductsApi | configurations_get | GET /configurations | Get system configurations. |
| SwaggerClient::ProductsApi | configurations_put | PUT /configurations | Modify system configurations. |
| SwaggerClient::ProductsApi | email_ping_post | POST /email/ping | Test connection and authentication with email server. |
| SwaggerClient::ProductsApi | health_get | GET /health | Health check API |
| SwaggerClient::ProductsApi | internal_switchquota_put | PUT /internal/switchquota | Enable or disable quota. |
| SwaggerClient::ProductsApi | internal_syncquota_post | POST /internal/syncquota | Sync quota from registry/chart to DB. |
| SwaggerClient::ProductsApi | internal_syncregistry_post | POST /internal/syncregistry | Sync repositories from registry to DB. |
| SwaggerClient::ProductsApi | labels_get | GET /labels | List labels according to the query strings. |
| SwaggerClient::ProductsApi | labels_id_delete | DELETE /labels/id | Delete the label specified by ID. |
| SwaggerClient::ProductsApi | labels_id_get | GET /labels/id | Get the label specified by ID. |
| SwaggerClient::ProductsApi | labels_id_put | PUT /labels/id | Update the label properties. |
| SwaggerClient::ProductsApi | labels_id_resources_get | GET /labels/id/resources | Get the resources that the label is referenced by. |
| SwaggerClient::ProductsApi | labels_post | POST /labels | Post creates a label |
| SwaggerClient::ProductsApi | ldap_groups_search_get | GET /ldap/groups/search | Search available ldap groups. |
| SwaggerClient::ProductsApi | ldap_ping_post | POST /ldap/ping | Ping available ldap service. |
| SwaggerClient::ProductsApi | ldap_users_import_post | POST /ldap/users/import | Import selected available ldap users. |
| SwaggerClient::ProductsApi | ldap_users_search_get | GET /ldap/users/search | Search available ldap users. |
| SwaggerClient::ProductsApi | logs_get | GET /logs | Get recent logs of the projects which the user is a member of |
| SwaggerClient::ProductsApi | projects_get | GET /projects | List projects |
| SwaggerClient::ProductsApi | projects_head | HEAD /projects | Check if the project name user provided already exists. |
| SwaggerClient::ProductsApi | projects_post | POST /projects | Create a new project. |
| SwaggerClient::ProductsApi | projects_project_id_delete | DELETE /projects/project_id | Delete project by projectID |
| SwaggerClient::ProductsApi | projects_project_id_get | GET /projects/project_id | Return specific project detail information |
| SwaggerClient::ProductsApi | projects_project_id_immutabletagrules_get | GET /projects/project_id/immutabletagrules | List all immutable tag rules of current project |
| SwaggerClient::ProductsApi | projects_project_id_immutabletagrules_id_delete | DELETE /projects/project_id/immutabletagrules/id | Delete the immutable tag rule. |
| SwaggerClient::ProductsApi | projects_project_id_immutabletagrules_id_put | PUT /projects/project_id/immutabletagrules/id | Update the immutable tag rule or enable or disable the rule |
| SwaggerClient::ProductsApi | projects_project_id_immutabletagrules_post | POST /projects/project_id/immutabletagrules | Add an immutable tag rule to current project |
| SwaggerClient::ProductsApi | projects_project_id_logs_get | GET /projects/project_id/logs | Get access logs accompany with a relevant project. |
| SwaggerClient::ProductsApi | projects_project_id_members_get | GET /projects/project_id/members | Get all project member information |
| SwaggerClient::ProductsApi | projects_project_id_members_mid_delete | DELETE /projects/project_id/members/mid | Delete project member |
| SwaggerClient::ProductsApi | projects_project_id_members_mid_get | GET /projects/project_id/members/mid | Get the project member information |
| SwaggerClient::ProductsApi | projects_project_id_members_mid_put | PUT /projects/project_id/members/mid | Update project member |
| SwaggerClient::ProductsApi | projects_project_id_members_post | POST /projects/project_id/members | Create project member |
| SwaggerClient::ProductsApi | projects_project_id_metadatas_get | GET /projects/project_id/metadatas | Get project metadata. |
| SwaggerClient::ProductsApi | projects_project_id_metadatas_meta_name_delete | DELETE /projects/project_id/metadatas/meta_name | Delete metadata of a project |
| SwaggerClient::ProductsApi | projects_project_id_metadatas_meta_name_get | GET /projects/project_id/metadatas/meta_name | Get project metadata |
| SwaggerClient::ProductsApi | projects_project_id_metadatas_meta_name_put | PUT /projects/project_id/metadatas/meta_name | Update metadata of a project. |
| SwaggerClient::ProductsApi | projects_project_id_metadatas_post | POST /projects/project_id/metadatas | Add metadata for the project. |
| SwaggerClient::ProductsApi | projects_project_id_put | PUT /projects/project_id | Update properties for a selected project. |
| SwaggerClient::ProductsApi | projects_project_id_robots_get | GET /projects/project_id/robots | Get all robot accounts of specified project |
| SwaggerClient::ProductsApi | projects_project_id_robots_post | POST /projects/project_id/robots | Create a robot account for project |
| SwaggerClient::ProductsApi | projects_project_id_robots_robot_id_delete | DELETE /projects/project_id/robots/robot_id | Delete the specified robot account |
| SwaggerClient::ProductsApi | projects_project_id_robots_robot_id_get | GET /projects/project_id/robots/robot_id | Return the infor of the specified robot account. |
| SwaggerClient::ProductsApi | projects_project_id_robots_robot_id_put | PUT /projects/project_id/robots/robot_id | Update status of robot account. |
| SwaggerClient::ProductsApi | projects_project_id_scanner_candidates_get | GET /projects/project_id/scanner/candidates | Get scanner registration candidates for configurating project level scanner |
| SwaggerClient::ProductsApi | projects_project_id_scanner_get | GET /projects/project_id/scanner | Get project level scanner |
| SwaggerClient::ProductsApi | projects_project_id_summary_get | GET /projects/project_id/summary | Get summary of the project. |
| SwaggerClient::ProductsApi | projects_project_id_webhook_jobs_get | GET /projects/project_id/webhook/jobs | List project webhook jobs |
| SwaggerClient::ProductsApi | projects_project_id_webhook_lasttrigger_get | GET /projects/project_id/webhook/lasttrigger | Get project webhook policy last trigger info |
| SwaggerClient::ProductsApi | projects_project_id_webhook_policies_get | GET /projects/project_id/webhook/policies | List project webhook policies. |
| SwaggerClient::ProductsApi | projects_project_id_webhook_policies_policy_id_delete | DELETE /projects/project_id/webhook/policies/policy_id | Delete webhook policy of a project |
| SwaggerClient::ProductsApi | projects_project_id_webhook_policies_policy_id_get | GET /projects/project_id/webhook/policies/policy_id | Get project webhook policy |
| SwaggerClient::ProductsApi | projects_project_id_webhook_policies_policy_id_put | PUT /projects/project_id/webhook/policies/policy_id | Update webhook policy of a project. |
| SwaggerClient::ProductsApi | projects_project_id_webhook_policies_post | POST /projects/project_id/webhook/policies | Create project webhook policy. |
| SwaggerClient::ProductsApi | projects_project_id_webhook_policies_test_post | POST /projects/project_id/webhook/policies/test | Test project webhook connection |
| SwaggerClient::ProductsApi | quotas_get | GET /quotas | List quotas |
| SwaggerClient::ProductsApi | quotas_id_get | GET /quotas/id | Get the specified quota |
| SwaggerClient::ProductsApi | quotas_id_put | PUT /quotas/id | Update the specified quota |
| SwaggerClient::ProductsApi | registries_get | GET /registries | List registries. |
| SwaggerClient::ProductsApi | registries_id_delete | DELETE /registries/id | Delete specific registry. |
| SwaggerClient::ProductsApi | registries_id_get | GET /registries/id | Get registry. |
| SwaggerClient::ProductsApi | registries_id_info_get | GET /registries/id/info | Get registry info. |
| SwaggerClient::ProductsApi | registries_id_namespace_get | GET /registries/id/namespace | List namespaces of registry |
| SwaggerClient::ProductsApi | registries_id_put | PUT /registries/id | Update a given registry. |
| SwaggerClient::ProductsApi | registries_ping_post | POST /registries/ping | Ping status of a registry. |
| SwaggerClient::ProductsApi | registries_post | POST /registries | Create a new registry. |
| SwaggerClient::ProductsApi | replication_adapters_get | GET /replication/adapters | List supported adapters. |
| SwaggerClient::ProductsApi | replication_executions_get | GET /replication/executions | List replication executions. |
| SwaggerClient::ProductsApi | replication_executions_id_get | GET /replication/executions/id | Get the execution of the replication. |
| SwaggerClient::ProductsApi | replication_executions_id_put | PUT /replication/executions/id | Stop the execution of the replication. |
| SwaggerClient::ProductsApi | replication_executions_id_tasks_get | GET /replication/executions/id/tasks | Get the task list of one execution. |
| SwaggerClient::ProductsApi | replication_executions_id_tasks_task_id_log_get | GET /replication/executions/id/tasks/task_id/log | Get the log of one task. |
| SwaggerClient::ProductsApi | replication_executions_post | POST /replication/executions | Start one execution of the replication. |
| SwaggerClient::ProductsApi | replication_policies_get | GET /replication/policies | List replication policies |
| SwaggerClient::ProductsApi | replication_policies_id_delete | DELETE /replication/policies/id | Delete the replication policy specified by ID. |
| SwaggerClient::ProductsApi | replication_policies_id_get | GET /replication/policies/id | Get replication policy. |
| SwaggerClient::ProductsApi | replication_policies_id_put | PUT /replication/policies/id | Update the replication policy |
| SwaggerClient::ProductsApi | replication_policies_post | POST /replication/policies | Create a replication policy |
| SwaggerClient::ProductsApi | repositories_get | GET /repositories | Get repositories accompany with relevant project and repo name. |
| SwaggerClient::ProductsApi | repositories_repo_name_delete | DELETE /repositories/repo_name | Delete a repository. |
| SwaggerClient::ProductsApi | repositories_repo_name_labels_get | GET /repositories/repo_name/labels | Get labels of a repository. |
| SwaggerClient::ProductsApi | repositories_repo_name_labels_label_id_delete | DELETE /repositories/repo_name/labels/label_id | Delete label from the repository. |
| SwaggerClient::ProductsApi | repositories_repo_name_labels_post | POST /repositories/repo_name/labels | Add a label to the repository. |
| SwaggerClient::ProductsApi | repositories_repo_name_put | PUT /repositories/repo_name | Update description of the repository. |
| SwaggerClient::ProductsApi | repositories_repo_name_signatures_get | GET /repositories/repo_name/signatures | Get signature information of a repository |
| SwaggerClient::ProductsApi | repositories_repo_name_tags_get | GET /repositories/repo_name/tags | Get tags of a relevant repository. |
| SwaggerClient::ProductsApi | repositories_repo_name_tags_post | POST /repositories/repo_name/tags | Retag an image |
| SwaggerClient::ProductsApi | repositories_repo_name_tags_tag_delete | DELETE /repositories/repo_name/tags/tag | Delete a tag in a repository. |
| SwaggerClient::ProductsApi | repositories_repo_name_tags_tag_get | GET /repositories/repo_name/tags/tag | Get the tag of the repository. |
| SwaggerClient::ProductsApi | repositories_repo_name_tags_tag_labels_get | GET /repositories/repo_name/tags/tag/labels | Get labels of an image. |
| SwaggerClient::ProductsApi | repositories_repo_name_tags_tag_labels_label_id_delete | DELETE /repositories/repo_name/tags/tag/labels/label_id | Delete label from the image. |
| SwaggerClient::ProductsApi | repositories_repo_name_tags_tag_labels_post | POST /repositories/repo_name/tags/tag/labels | Add a label to image. |
| SwaggerClient::ProductsApi | repositories_repo_name_tags_tag_manifest_get | GET /repositories/repo_name/tags/tag/manifest | Get manifests of a relevant repository. |
| SwaggerClient::ProductsApi | repositories_repo_name_tags_tag_scan_post | POST /repositories/repo_name/tags/tag/scan | Scan the image. |
| SwaggerClient::ProductsApi | repositories_repo_name_tags_tag_scan_uuid_log_get | GET /repositories/repo_name/tags/tag/scan/uuid/log | Get scan log |
| SwaggerClient::ProductsApi | repositories_top_get | GET /repositories/top | Get public repositories which are accessed most. |
| SwaggerClient::ProductsApi | retentions_id_executions_eid_patch | PATCH /retentions/id/executions/eid | Stop a Retention job |
| SwaggerClient::ProductsApi | retentions_id_executions_eid_tasks_get | GET /retentions/id/executions/eid/tasks | Get Retention job tasks |
| SwaggerClient::ProductsApi | retentions_id_executions_eid_tasks_tid_get | GET /retentions/id/executions/eid/tasks/tid | Get Retention job task log |
| SwaggerClient::ProductsApi | retentions_id_executions_get | GET /retentions/id/executions | Get a Retention job |
| SwaggerClient::ProductsApi | retentions_id_executions_post | POST /retentions/id/executions | Trigger a Retention job |
| SwaggerClient::ProductsApi | retentions_id_get | GET /retentions/id | Get Retention Policy |
| SwaggerClient::ProductsApi | retentions_id_put | PUT /retentions/id | Update Retention Policy |
| SwaggerClient::ProductsApi | retentions_metadatas_get | GET /retentions/metadatas | Get Retention Metadatas |
| SwaggerClient::ProductsApi | retentions_post | POST /retentions | Create Retention Policy |
| SwaggerClient::ProductsApi | scanners_get | GET /scanners | List scanner registrations |
| SwaggerClient::ProductsApi | scanners_ping_post | POST /scanners/ping | Tests scanner registration settings |
| SwaggerClient::ProductsApi | scanners_registration_id_get | GET /scanners/registration_id | Get a scanner registration details |
| SwaggerClient::ProductsApi | scanners_registration_id_metadata_get | GET /scanners/registration_id/metadata | Get the metadata of the specified scanner registration |
| SwaggerClient::ProductsApi | scans_all_metrics_get | GET /scans/all/metrics | Get the metrics of the latest scan all process |
| SwaggerClient::ProductsApi | scans_schedule_metrics_get | GET /scans/schedule/metrics | Get the metrics of the latest scheduled scan all process |
| SwaggerClient::ProductsApi | search_get | GET /search | Search for projects, repositories and helm charts |
| SwaggerClient::ProductsApi | statistics_get | GET /statistics | Get projects number and repositories number relevant to the user |
| SwaggerClient::ProductsApi | system_cve_whitelist_get | GET /system/CVEWhitelist | Get the system level whitelist of CVE. |
| SwaggerClient::ProductsApi | system_cve_whitelist_put | PUT /system/CVEWhitelist | Update the system level whitelist of CVE. |
| SwaggerClient::ProductsApi | system_gc_get | GET /system/gc | Get gc results. |
| SwaggerClient::ProductsApi | system_gc_id_get | GET /system/gc/id | Get gc status. |
| SwaggerClient::ProductsApi | system_gc_id_log_get | GET /system/gc/id/log | Get gc job log. |
| SwaggerClient::ProductsApi | system_gc_schedule_get | GET /system/gc/schedule | Get gc's schedule. |
| SwaggerClient::ProductsApi | system_gc_schedule_post | POST /system/gc/schedule | Create a gc schedule. |
| SwaggerClient::ProductsApi | system_gc_schedule_put | PUT /system/gc/schedule | Update gc's schedule. |
| SwaggerClient::ProductsApi | system_oidc_ping_post | POST /system/oidc/ping | Test the OIDC endpoint. |
| SwaggerClient::ProductsApi | system_scan_all_schedule_get | GET /system/scanAll/schedule | Get scan_all's schedule. |
| SwaggerClient::ProductsApi | system_scan_all_schedule_post | POST /system/scanAll/schedule | Create a schedule or a manual trigger for the scan all job. |
| SwaggerClient::ProductsApi | system_scan_all_schedule_put | PUT /system/scanAll/schedule | Update scan all's schedule. |
| SwaggerClient::ProductsApi | systeminfo_get | GET /systeminfo | Get general system info |
| SwaggerClient::ProductsApi | systeminfo_getcert_get | GET /systeminfo/getcert | Get default root certificate. |
| SwaggerClient::ProductsApi | systeminfo_volumes_get | GET /systeminfo/volumes | Get system volume info (total/free size). |
| SwaggerClient::ProductsApi | usergroups_get | GET /usergroups | Get all user groups information |
| SwaggerClient::ProductsApi | usergroups_group_id_delete | DELETE /usergroups/group_id | Delete user group |
| SwaggerClient::ProductsApi | usergroups_group_id_get | GET /usergroups/group_id | Get user group information |
| SwaggerClient::ProductsApi | usergroups_group_id_put | PUT /usergroups/group_id | Update group information |
| SwaggerClient::ProductsApi | usergroups_post | POST /usergroups | Create user group |
| SwaggerClient::ProductsApi | users_current_get | GET /users/current | Get current user info. |
| SwaggerClient::ProductsApi | users_current_permissions_get | GET /users/current/permissions | Get current user permissions. |
| SwaggerClient::ProductsApi | users_get | GET /users | Get registered users of Harbor. |
| SwaggerClient::ProductsApi | users_post | POST /users | Creates a new user account. |
| SwaggerClient::ProductsApi | users_search_get | GET /users/search | Search users by username |
| SwaggerClient::ProductsApi | users_user_id_cli_secret_put | PUT /users/user_id/cli_secret | Set CLI secret for a user. |
| SwaggerClient::ProductsApi | users_user_id_delete | DELETE /users/user_id | Mark a registered user as be removed. |
| SwaggerClient::ProductsApi | users_user_id_get | GET /users/user_id | Get a user's profile. |
| SwaggerClient::ProductsApi | users_user_id_password_put | PUT /users/user_id/password | Change the password on a user that already exists. |
| SwaggerClient::ProductsApi | users_user_id_put | PUT /users/user_id | Update a registered user to change his profile. |
| SwaggerClient::ProductsApi | users_user_id_sysadmin_put | PUT /users/user_id/sysadmin | Update a registered user to change to be an administrator of Harbor. |
| SwaggerClient::QuotaApi | quotas_id_get | GET /quotas/id | Get the specified quota |
| SwaggerClient::QuotaApi | quotas_id_put | PUT /quotas/id | Update the specified quota |
| SwaggerClient::RetentionApi | retentions_id_executions_eid_patch | PATCH /retentions/id/executions/eid | Stop a Retention job |
| SwaggerClient::RetentionApi | retentions_id_executions_eid_tasks_get | GET /retentions/id/executions/eid/tasks | Get Retention job tasks |
| SwaggerClient::RetentionApi | retentions_id_executions_eid_tasks_tid_get | GET /retentions/id/executions/eid/tasks/tid | Get Retention job task log |
| SwaggerClient::RetentionApi | retentions_id_executions_get | GET /retentions/id/executions | Get a Retention job |
| SwaggerClient::RetentionApi | retentions_id_executions_post | POST /retentions/id/executions | Trigger a Retention job |
| SwaggerClient::RetentionApi | retentions_id_get | GET /retentions/id | Get Retention Policy |
| SwaggerClient::RetentionApi | retentions_metadatas_get | GET /retentions/metadatas | Get Retention Metadatas |
| SwaggerClient::RetentionApi | retentions_post | POST /retentions | Create Retention Policy |
| SwaggerClient::RobotAccountApi | projects_project_id_robots_get | GET /projects/project_id/robots | Get all robot accounts of specified project |
| SwaggerClient::RobotAccountApi | projects_project_id_robots_post | POST /projects/project_id/robots | Create a robot account for project |
| SwaggerClient::RobotAccountApi | projects_project_id_robots_robot_id_delete | DELETE /projects/project_id/robots/robot_id | Delete the specified robot account |
| SwaggerClient::RobotAccountApi | projects_project_id_robots_robot_id_get | GET /projects/project_id/robots/robot_id | Return the infor of the specified robot account. |
| SwaggerClient::RobotAccountApi | projects_project_id_robots_robot_id_put | PUT /projects/project_id/robots/robot_id | Update status of robot account. |
| SwaggerClient::ScanApi | repositories_repo_name_tags_tag_scan_get | GET /repositories/repo_name/tags/tag/scan | Get the scan report |
| SwaggerClient::ScanApi | repositories_repo_name_tags_tag_scan_post | POST /repositories/repo_name/tags/tag/scan | Scan the image. |
| SwaggerClient::ScanApi | repositories_repo_name_tags_tag_scan_uuid_log_get | GET /repositories/repo_name/tags/tag/scan/uuid/log | Get scan log |
| SwaggerClient::ScanApi | scans_all_metrics_get | GET /scans/all/metrics | Get the metrics of the latest scan all process |
| SwaggerClient::ScanApi | scans_schedule_metrics_get | GET /scans/schedule/metrics | Get the metrics of the latest scheduled scan all process |
| SwaggerClient::ScannersApi | projects_project_id_scanner_candidates_get | GET /projects/project_id/scanner/candidates | Get scanner registration candidates for configurating project level scanner |
| SwaggerClient::ScannersApi | projects_project_id_scanner_get | GET /projects/project_id/scanner | Get project level scanner |
| SwaggerClient::ScannersApi | projects_project_id_scanner_put | PUT /projects/project_id/scanner | Configure scanner for the specified project |
| SwaggerClient::ScannersApi | scanners_get | GET /scanners | List scanner registrations |
| SwaggerClient::ScannersApi | scanners_ping_post | POST /scanners/ping | Tests scanner registration settings |
| SwaggerClient::ScannersApi | scanners_post | POST /scanners | Create a scanner registration |
| SwaggerClient::ScannersApi | scanners_registration_id_delete | DELETE /scanners/registration_id | Delete a scanner registration |
| SwaggerClient::ScannersApi | scanners_registration_id_get | GET /scanners/registration_id | Get a scanner registration details |
| SwaggerClient::ScannersApi | scanners_registration_id_metadata_get | GET /scanners/registration_id/metadata | Get the metadata of the specified scanner registration |
| SwaggerClient::ScannersApi | scanners_registration_id_patch | PATCH /scanners/registration_id | Set system default scanner registration |
| SwaggerClient::ScannersApi | scanners_registration_id_put | PUT /scanners/registration_id | Update a scanner registration |
| SwaggerClient::SystemApi | system_cve_whitelist_get | GET /system/CVEWhitelist | Get the system level whitelist of CVE. |
| SwaggerClient::SystemApi | system_cve_whitelist_put | PUT /system/CVEWhitelist | Update the system level whitelist of CVE. |
| SwaggerClient::SystemApi | system_oidc_ping_post | POST /system/oidc/ping | Test the OIDC endpoint. |
Documentation for Models
- SwaggerClient::AccessLog
- SwaggerClient::Action
- SwaggerClient::Action1
- SwaggerClient::AdminJobSchedule
- SwaggerClient::AdminJobScheduleObj
- SwaggerClient::BoolConfigItem
- SwaggerClient::CVEWhitelist
- SwaggerClient::CVEWhitelistItem
- SwaggerClient::ChartAPIError
- SwaggerClient::ChartInfoEntry
- SwaggerClient::ChartInfoList
- SwaggerClient::ChartMetadata
- SwaggerClient::ChartVersionDetails
- SwaggerClient::ChartVersions
- SwaggerClient::ComponentHealthStatus
- SwaggerClient::ComponentOverviewEntry
- SwaggerClient::Configurations
- SwaggerClient::ConfigurationsResponse
- SwaggerClient::ConfigurationsScanAllPolicy
- SwaggerClient::ConfigurationsScanAllPolicyParameter
- SwaggerClient::Dependency
- SwaggerClient::DetailedTag
- SwaggerClient::DigitalSignature
- SwaggerClient::EmailServerSetting
- SwaggerClient::Endpoint
- SwaggerClient::FilterStyle
- SwaggerClient::GCResult
- SwaggerClient::GeneralInfo
- SwaggerClient::GeneralInfoClairVulnerabilityStatus
- SwaggerClient::HasAdminRole
- SwaggerClient::ImmutableTagRule
- SwaggerClient::InlineResponse200
- SwaggerClient::InputSecret
- SwaggerClient::IntegerConfigItem
- SwaggerClient::IsDefault
- SwaggerClient::JobStatus
- SwaggerClient::Label
- SwaggerClient::Labels
- SwaggerClient::LdapConf
- SwaggerClient::LdapFailedImportUsers
- SwaggerClient::LdapImportUsers
- SwaggerClient::LdapUsers
- SwaggerClient::Manifest
- SwaggerClient::Namespace
- SwaggerClient::NativeReportSummary
- SwaggerClient::OverallHealthStatus
- SwaggerClient::Password
- SwaggerClient::Permission
- SwaggerClient::PingRegistry
- SwaggerClient::Project
- SwaggerClient::ProjectMember
- SwaggerClient::ProjectMemberEntity
- SwaggerClient::ProjectMetadata
- SwaggerClient::ProjectReq
- SwaggerClient::ProjectScanner
- SwaggerClient::ProjectSummary
- SwaggerClient::ProjectSummaryQuota
- SwaggerClient::PutRegistry
- SwaggerClient::Quota
- SwaggerClient::QuotaRefObject
- SwaggerClient::QuotaSwitcher
- SwaggerClient::QuotaUpdateReq
- SwaggerClient::Registry
- SwaggerClient::RegistryCredential
- SwaggerClient::RegistryInfo
- SwaggerClient::ReplicationExecution
- SwaggerClient::ReplicationFilter
- SwaggerClient::ReplicationPolicy
- SwaggerClient::ReplicationTask
- SwaggerClient::ReplicationTrigger
- SwaggerClient::RepoSignature
- SwaggerClient::Report
- SwaggerClient::Repository
- SwaggerClient::RepositoryDescription
- SwaggerClient::Resource
- SwaggerClient::ResourceList
- SwaggerClient::RetagReq
- SwaggerClient::RetentionExecution
- SwaggerClient::RetentionExecutionTask
- SwaggerClient::RetentionMetadata
- SwaggerClient::RetentionPolicy
- SwaggerClient::RetentionPolicyScope
- SwaggerClient::RetentionRule
- SwaggerClient::RetentionRuleMetadata
- SwaggerClient::RetentionRuleParamMetadata
- SwaggerClient::RetentionRuleTrigger
- SwaggerClient::RetentionSelector
- SwaggerClient::RetentionSelectorMetadata
- SwaggerClient::RobotAccount
- SwaggerClient::RobotAccountAccess
- SwaggerClient::RobotAccountCreate
- SwaggerClient::RobotAccountPostRep
- SwaggerClient::RobotAccountUpdate
- SwaggerClient::Role
- SwaggerClient::RoleParam
- SwaggerClient::RoleRequest
- SwaggerClient::ScanOverview
- SwaggerClient::Scanner
- SwaggerClient::ScannerAdapterMetadata
- SwaggerClient::ScannerCapability
- SwaggerClient::ScannerRegistration
- SwaggerClient::ScannerRegistrationReq
- SwaggerClient::ScannerRegistrationSettings
- SwaggerClient::Search
- SwaggerClient::SearchRepository
- SwaggerClient::SearchResult
- SwaggerClient::SecurityReport
- SwaggerClient::StatisticMap
- SwaggerClient::Stats
- SwaggerClient::Storage
- SwaggerClient::StringConfigItem
- SwaggerClient::SystemInfo
- SwaggerClient::Tags
- SwaggerClient::TriggerSettings
- SwaggerClient::User
- SwaggerClient::UserEntity
- SwaggerClient::UserGroup
- SwaggerClient::UserProfile
- SwaggerClient::UserSearch
- SwaggerClient::VulnNamespaceTimestamp
- SwaggerClient::VulnerabilityItem
- SwaggerClient::VulnerabilitySummary
- SwaggerClient::WebhookJob
- SwaggerClient::WebhookLastTrigger
- SwaggerClient::WebhookPolicy
- SwaggerClient::WebhookTargetObject
- SwaggerClient::BadRequestFormatedError
- SwaggerClient::ChartVersion
- SwaggerClient::ConflictFormatedError
- SwaggerClient::ForbiddenChartAPIError
- SwaggerClient::InsufficientStorageChartAPIError
- SwaggerClient::InternalChartAPIError
- SwaggerClient::NotFoundChartAPIError
- SwaggerClient::UnauthorizedChartAPIError
Documentation for Authorization
basicAuth
- Type: HTTP basic authentication