Harbor API
- API version: 1.10.0
- Build date: 2020-03-06T02:07:22.019Z
These APIs provide services for manipulating Harbor project.
Automatically generated by the Swagger Codegen
Building the API client library requires:
- Java 1.7+
- Maven/Gradle
To install the API client library to your local Maven repository, simply execute:
mvn clean installTo deploy it to a remote Maven repository instead, configure the settings of the repository and execute:
mvn clean deployRefer to the OSSRH Guide for more information.
Add this dependency to your project's POM:
<dependency>
<groupId>com.github.toyangdon</groupId>
<artifactId>harbor-java-client</artifactId>
<version>1.10.0</version>
<scope>compile</scope>
</dependency>Add this dependency to your project's build file:
compile "io.swagger:swagger-java-client:1.0.0"At first generate the JAR by executing:
mvn clean packageThen manually install the following JARs:
target/swagger-java-client-1.0.0.jartarget/lib/*.jar
Please follow the installation instruction and execute the following Java code:
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ChartRepositoryApi;
import java.io.File;
import java.util.*;
public class ChartRepositoryApiExample {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure HTTP basic authorization: basicAuth
HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
basicAuth.setUsername("YOUR USERNAME");
basicAuth.setPassword("YOUR PASSWORD");
ChartRepositoryApi apiInstance = new ChartRepositoryApi();
File chart = new File("/path/to/file.txt"); // File | The chart file
File prov = new File("/path/to/file.txt"); // File | The provance file
try {
apiInstance.chartrepoChartsPost(chart, prov);
} catch (ApiException e) {
System.err.println("Exception when calling ChartRepositoryApi#chartrepoChartsPost");
e.printStackTrace();
}
}
}All URIs are relative to http://localhost/api
| Class | Method | HTTP request | Description |
|---|---|---|---|
| ChartRepositoryApi | chartrepoChartsPost | POST /chartrepo/charts | Upload a chart file to the defult 'library' project. |
| ChartRepositoryApi | chartrepoHealthGet | GET /chartrepo/health | Check the health of chart repository service. |
| ChartRepositoryApi | chartrepoRepoChartsGet | GET /chartrepo/{repo}/charts | Get all the charts under the specified project |
| ChartRepositoryApi | chartrepoRepoChartsNameDelete | DELETE /chartrepo/{repo}/charts/{name} | Delete all the versions of the specified chart |
| ChartRepositoryApi | chartrepoRepoChartsNameGet | GET /chartrepo/{repo}/charts/{name} | Get all the versions of the specified chart |
| ChartRepositoryApi | chartrepoRepoChartsNameVersionDelete | DELETE /chartrepo/{repo}/charts/{name}/{version} | Delete the specified chart version |
| ChartRepositoryApi | chartrepoRepoChartsNameVersionGet | GET /chartrepo/{repo}/charts/{name}/{version} | Get the specified chart version |
| ChartRepositoryApi | chartrepoRepoChartsNameVersionLabelsGet | GET /chartrepo/{repo}/charts/{name}/{version}/labels | Return the attahced labels of chart. |
| ChartRepositoryApi | chartrepoRepoChartsNameVersionLabelsIdDelete | DELETE /chartrepo/{repo}/charts/{name}/{version}/labels/{id} | Remove label from chart. |
| ChartRepositoryApi | chartrepoRepoChartsNameVersionLabelsPost | POST /chartrepo/{repo}/charts/{name}/{version}/labels | Mark label to chart. |
| ChartRepositoryApi | chartrepoRepoChartsPost | POST /chartrepo/{repo}/charts | Upload a chart file to the specified project. |
| ChartRepositoryApi | chartrepoRepoProvPost | POST /chartrepo/{repo}/prov | Upload a provance file to the specified project. |
| LabelApi | chartrepoRepoChartsNameVersionLabelsGet | GET /chartrepo/{repo}/charts/{name}/{version}/labels | Return the attahced labels of chart. |
| LabelApi | chartrepoRepoChartsNameVersionLabelsIdDelete | DELETE /chartrepo/{repo}/charts/{name}/{version}/labels/{id} | Remove label from chart. |
| LabelApi | chartrepoRepoChartsNameVersionLabelsPost | POST /chartrepo/{repo}/charts/{name}/{version}/labels | Mark label to chart. |
| ProductsApi | chartrepoChartsPost | POST /chartrepo/charts | Upload a chart file to the defult 'library' project. |
| ProductsApi | chartrepoHealthGet | GET /chartrepo/health | Check the health of chart repository service. |
| ProductsApi | chartrepoRepoChartsGet | GET /chartrepo/{repo}/charts | Get all the charts under the specified project |
| ProductsApi | chartrepoRepoChartsNameDelete | DELETE /chartrepo/{repo}/charts/{name} | Delete all the versions of the specified chart |
| ProductsApi | chartrepoRepoChartsNameGet | GET /chartrepo/{repo}/charts/{name} | Get all the versions of the specified chart |
| ProductsApi | chartrepoRepoChartsNameVersionDelete | DELETE /chartrepo/{repo}/charts/{name}/{version} | Delete the specified chart version |
| ProductsApi | chartrepoRepoChartsNameVersionGet | GET /chartrepo/{repo}/charts/{name}/{version} | Get the specified chart version |
| ProductsApi | chartrepoRepoChartsNameVersionLabelsGet | GET /chartrepo/{repo}/charts/{name}/{version}/labels | Return the attahced labels of chart. |
| ProductsApi | chartrepoRepoChartsNameVersionLabelsIdDelete | DELETE /chartrepo/{repo}/charts/{name}/{version}/labels/{id} | Remove label from chart. |
| ProductsApi | chartrepoRepoChartsNameVersionLabelsPost | POST /chartrepo/{repo}/charts/{name}/{version}/labels | Mark label to chart. |
| ProductsApi | chartrepoRepoChartsPost | POST /chartrepo/{repo}/charts | Upload a chart file to the specified project. |
| ProductsApi | chartrepoRepoProvPost | POST /chartrepo/{repo}/prov | Upload a provance file to the specified project. |
| ProductsApi | configurationsGet | GET /configurations | Get system configurations. |
| ProductsApi | configurationsPut | PUT /configurations | Modify system configurations. |
| ProductsApi | emailPingPost | POST /email/ping | Test connection and authentication with email server. |
| ProductsApi | healthGet | GET /health | Health check API |
| ProductsApi | internalSwitchquotaPut | PUT /internal/switchquota | Enable or disable quota. |
| ProductsApi | internalSyncquotaPost | POST /internal/syncquota | Sync quota from registry/chart to DB. |
| ProductsApi | internalSyncregistryPost | POST /internal/syncregistry | Sync repositories from registry to DB. |
| ProductsApi | labelsGet | GET /labels | List labels according to the query strings. |
| ProductsApi | labelsIdDelete | DELETE /labels/{id} | Delete the label specified by ID. |
| ProductsApi | labelsIdGet | GET /labels/{id} | Get the label specified by ID. |
| ProductsApi | labelsIdPut | PUT /labels/{id} | Update the label properties. |
| ProductsApi | labelsIdResourcesGet | GET /labels/{id}/resources | Get the resources that the label is referenced by. |
| ProductsApi | labelsPost | POST /labels | Post creates a label |
| ProductsApi | ldapGroupsSearchGet | GET /ldap/groups/search | Search available ldap groups. |
| ProductsApi | ldapPingPost | POST /ldap/ping | Ping available ldap service. |
| ProductsApi | ldapUsersImportPost | POST /ldap/users/import | Import selected available ldap users. |
| ProductsApi | ldapUsersSearchGet | GET /ldap/users/search | Search available ldap users. |
| ProductsApi | logsGet | GET /logs | Get recent logs of the projects which the user is a member of |
| ProductsApi | projectsGet | GET /projects | List projects |
| ProductsApi | projectsHead | HEAD /projects | Check if the project name user provided already exists. |
| ProductsApi | projectsPost | POST /projects | Create a new project. |
| ProductsApi | projectsProjectIdDelete | DELETE /projects/{project_id} | Delete project by projectID |
| ProductsApi | projectsProjectIdGet | GET /projects/{project_id} | Return specific project detail information |
| ProductsApi | projectsProjectIdImmutabletagrulesGet | GET /projects/{project_id}/immutabletagrules | List all immutable tag rules of current project |
| ProductsApi | projectsProjectIdImmutabletagrulesIdDelete | DELETE /projects/{project_id}/immutabletagrules/{id} | Delete the immutable tag rule. |
| ProductsApi | projectsProjectIdImmutabletagrulesIdPut | PUT /projects/{project_id}/immutabletagrules/{id} | Update the immutable tag rule or enable or disable the rule |
| ProductsApi | projectsProjectIdImmutabletagrulesPost | POST /projects/{project_id}/immutabletagrules | Add an immutable tag rule to current project |
| ProductsApi | projectsProjectIdLogsGet | GET /projects/{project_id}/logs | Get access logs accompany with a relevant project. |
| ProductsApi | projectsProjectIdMembersGet | GET /projects/{project_id}/members | Get all project member information |
| ProductsApi | projectsProjectIdMembersMidDelete | DELETE /projects/{project_id}/members/{mid} | Delete project member |
| ProductsApi | projectsProjectIdMembersMidGet | GET /projects/{project_id}/members/{mid} | Get the project member information |
| ProductsApi | projectsProjectIdMembersMidPut | PUT /projects/{project_id}/members/{mid} | Update project member |
| ProductsApi | projectsProjectIdMembersPost | POST /projects/{project_id}/members | Create project member |
| ProductsApi | projectsProjectIdMetadatasGet | GET /projects/{project_id}/metadatas | Get project metadata. |
| ProductsApi | projectsProjectIdMetadatasMetaNameDelete | DELETE /projects/{project_id}/metadatas/{meta_name} | Delete metadata of a project |
| ProductsApi | projectsProjectIdMetadatasMetaNameGet | GET /projects/{project_id}/metadatas/{meta_name} | Get project metadata |
| ProductsApi | projectsProjectIdMetadatasMetaNamePut | PUT /projects/{project_id}/metadatas/{meta_name} | Update metadata of a project. |
| ProductsApi | projectsProjectIdMetadatasPost | POST /projects/{project_id}/metadatas | Add metadata for the project. |
| ProductsApi | projectsProjectIdPut | PUT /projects/{project_id} | Update properties for a selected project. |
| ProductsApi | projectsProjectIdRobotsGet | GET /projects/{project_id}/robots | Get all robot accounts of specified project |
| ProductsApi | projectsProjectIdRobotsPost | POST /projects/{project_id}/robots | Create a robot account for project |
| ProductsApi | projectsProjectIdRobotsRobotIdDelete | DELETE /projects/{project_id}/robots/{robot_id} | Delete the specified robot account |
| ProductsApi | projectsProjectIdRobotsRobotIdGet | GET /projects/{project_id}/robots/{robot_id} | Return the infor of the specified robot account. |
| ProductsApi | projectsProjectIdRobotsRobotIdPut | PUT /projects/{project_id}/robots/{robot_id} | Update status of robot account. |
| ProductsApi | projectsProjectIdScannerCandidatesGet | GET /projects/{project_id}/scanner/candidates | Get scanner registration candidates for configurating project level scanner |
| ProductsApi | projectsProjectIdScannerGet | GET /projects/{project_id}/scanner | Get project level scanner |
| ProductsApi | projectsProjectIdSummaryGet | GET /projects/{project_id}/summary | Get summary of the project. |
| ProductsApi | projectsProjectIdWebhookJobsGet | GET /projects/{project_id}/webhook/jobs | List project webhook jobs |
| ProductsApi | projectsProjectIdWebhookLasttriggerGet | GET /projects/{project_id}/webhook/lasttrigger | Get project webhook policy last trigger info |
| ProductsApi | projectsProjectIdWebhookPoliciesGet | GET /projects/{project_id}/webhook/policies | List project webhook policies. |
| ProductsApi | projectsProjectIdWebhookPoliciesPolicyIdDelete | DELETE /projects/{project_id}/webhook/policies/{policy_id} | Delete webhook policy of a project |
| ProductsApi | projectsProjectIdWebhookPoliciesPolicyIdGet | GET /projects/{project_id}/webhook/policies/{policy_id} | Get project webhook policy |
| ProductsApi | projectsProjectIdWebhookPoliciesPolicyIdPut | PUT /projects/{project_id}/webhook/policies/{policy_id} | Update webhook policy of a project. |
| ProductsApi | projectsProjectIdWebhookPoliciesPost | POST /projects/{project_id}/webhook/policies | Create project webhook policy. |
| ProductsApi | projectsProjectIdWebhookPoliciesTestPost | POST /projects/{project_id}/webhook/policies/test | Test project webhook connection |
| ProductsApi | quotasGet | GET /quotas | List quotas |
| ProductsApi | quotasIdGet | GET /quotas/{id} | Get the specified quota |
| ProductsApi | quotasIdPut | PUT /quotas/{id} | Update the specified quota |
| ProductsApi | registriesGet | GET /registries | List registries. |
| ProductsApi | registriesIdDelete | DELETE /registries/{id} | Delete specific registry. |
| ProductsApi | registriesIdGet | GET /registries/{id} | Get registry. |
| ProductsApi | registriesIdInfoGet | GET /registries/{id}/info | Get registry info. |
| ProductsApi | registriesIdNamespaceGet | GET /registries/{id}/namespace | List namespaces of registry |
| ProductsApi | registriesIdPut | PUT /registries/{id} | Update a given registry. |
| ProductsApi | registriesPingPost | POST /registries/ping | Ping status of a registry. |
| ProductsApi | registriesPost | POST /registries | Create a new registry. |
| ProductsApi | replicationAdaptersGet | GET /replication/adapters | List supported adapters. |
| ProductsApi | replicationExecutionsGet | GET /replication/executions | List replication executions. |
| ProductsApi | replicationExecutionsIdGet | GET /replication/executions/{id} | Get the execution of the replication. |
| ProductsApi | replicationExecutionsIdPut | PUT /replication/executions/{id} | Stop the execution of the replication. |
| ProductsApi | replicationExecutionsIdTasksGet | GET /replication/executions/{id}/tasks | Get the task list of one execution. |
| ProductsApi | replicationExecutionsIdTasksTaskIdLogGet | GET /replication/executions/{id}/tasks/{task_id}/log | Get the log of one task. |
| ProductsApi | replicationExecutionsPost | POST /replication/executions | Start one execution of the replication. |
| ProductsApi | replicationPoliciesGet | GET /replication/policies | List replication policies |
| ProductsApi | replicationPoliciesIdDelete | DELETE /replication/policies/{id} | Delete the replication policy specified by ID. |
| ProductsApi | replicationPoliciesIdGet | GET /replication/policies/{id} | Get replication policy. |
| ProductsApi | replicationPoliciesIdPut | PUT /replication/policies/{id} | Update the replication policy |
| ProductsApi | replicationPoliciesPost | POST /replication/policies | Create a replication policy |
| ProductsApi | repositoriesGet | GET /repositories | Get repositories accompany with relevant project and repo name. |
| ProductsApi | repositoriesRepoNameDelete | DELETE /repositories/{repo_name} | Delete a repository. |
| ProductsApi | repositoriesRepoNameLabelsGet | GET /repositories/{repo_name}/labels | Get labels of a repository. |
| ProductsApi | repositoriesRepoNameLabelsLabelIdDelete | DELETE /repositories/{repo_name}/labels/{label_id} | Delete label from the repository. |
| ProductsApi | repositoriesRepoNameLabelsPost | POST /repositories/{repo_name}/labels | Add a label to the repository. |
| ProductsApi | repositoriesRepoNamePut | PUT /repositories/{repo_name} | Update description of the repository. |
| ProductsApi | repositoriesRepoNameSignaturesGet | GET /repositories/{repo_name}/signatures | Get signature information of a repository |
| ProductsApi | repositoriesRepoNameTagsGet | GET /repositories/{repo_name}/tags | Get tags of a relevant repository. |
| ProductsApi | repositoriesRepoNameTagsPost | POST /repositories/{repo_name}/tags | Retag an image |
| ProductsApi | repositoriesRepoNameTagsTagDelete | DELETE /repositories/{repo_name}/tags/{tag} | Delete a tag in a repository. |
| ProductsApi | repositoriesRepoNameTagsTagGet | GET /repositories/{repo_name}/tags/{tag} | Get the tag of the repository. |
| ProductsApi | repositoriesRepoNameTagsTagLabelsGet | GET /repositories/{repo_name}/tags/{tag}/labels | Get labels of an image. |
| ProductsApi | repositoriesRepoNameTagsTagLabelsLabelIdDelete | DELETE /repositories/{repo_name}/tags/{tag}/labels/{label_id} | Delete label from the image. |
| ProductsApi | repositoriesRepoNameTagsTagLabelsPost | POST /repositories/{repo_name}/tags/{tag}/labels | Add a label to image. |
| ProductsApi | repositoriesRepoNameTagsTagManifestGet | GET /repositories/{repo_name}/tags/{tag}/manifest | Get manifests of a relevant repository. |
| ProductsApi | repositoriesRepoNameTagsTagScanPost | POST /repositories/{repo_name}/tags/{tag}/scan | Scan the image. |
| ProductsApi | repositoriesRepoNameTagsTagScanUuidLogGet | GET /repositories/{repo_name}/tags/{tag}/scan/{uuid}/log | Get scan log |
| ProductsApi | repositoriesTopGet | GET /repositories/top | Get public repositories which are accessed most. |
| ProductsApi | retentionsIdExecutionsEidPatch | PATCH /retentions/{id}/executions/{eid} | Stop a Retention job |
| ProductsApi | retentionsIdExecutionsEidTasksGet | GET /retentions/{id}/executions/{eid}/tasks | Get Retention job tasks |
| ProductsApi | retentionsIdExecutionsEidTasksTidGet | GET /retentions/{id}/executions/{eid}/tasks/{tid} | Get Retention job task log |
| ProductsApi | retentionsIdExecutionsGet | GET /retentions/{id}/executions | Get a Retention job |
| ProductsApi | retentionsIdExecutionsPost | POST /retentions/{id}/executions | Trigger a Retention job |
| ProductsApi | retentionsIdGet | GET /retentions/{id} | Get Retention Policy |
| ProductsApi | retentionsIdPut | PUT /retentions/{id} | Update Retention Policy |
| ProductsApi | retentionsMetadatasGet | GET /retentions/metadatas | Get Retention Metadatas |
| ProductsApi | retentionsPost | POST /retentions | Create Retention Policy |
| ProductsApi | scannersGet | GET /scanners | List scanner registrations |
| ProductsApi | scannersPingPost | POST /scanners/ping | Tests scanner registration settings |
| ProductsApi | scannersRegistrationIdGet | GET /scanners/{registration_id} | Get a scanner registration details |
| ProductsApi | scannersRegistrationIdMetadataGet | GET /scanners/{registration_id}/metadata | Get the metadata of the specified scanner registration |
| ProductsApi | scansAllMetricsGet | GET /scans/all/metrics | Get the metrics of the latest scan all process |
| ProductsApi | scansScheduleMetricsGet | GET /scans/schedule/metrics | Get the metrics of the latest scheduled scan all process |
| ProductsApi | searchGet | GET /search | Search for projects, repositories and helm charts |
| ProductsApi | statisticsGet | GET /statistics | Get projects number and repositories number relevant to the user |
| ProductsApi | systemCVEWhitelistGet | GET /system/CVEWhitelist | Get the system level whitelist of CVE. |
| ProductsApi | systemCVEWhitelistPut | PUT /system/CVEWhitelist | Update the system level whitelist of CVE. |
| ProductsApi | systemGcGet | GET /system/gc | Get gc results. |
| ProductsApi | systemGcIdGet | GET /system/gc/{id} | Get gc status. |
| ProductsApi | systemGcIdLogGet | GET /system/gc/{id}/log | Get gc job log. |
| ProductsApi | systemGcScheduleGet | GET /system/gc/schedule | Get gc's schedule. |
| ProductsApi | systemGcSchedulePost | POST /system/gc/schedule | Create a gc schedule. |
| ProductsApi | systemGcSchedulePut | PUT /system/gc/schedule | Update gc's schedule. |
| ProductsApi | systemOidcPingPost | POST /system/oidc/ping | Test the OIDC endpoint. |
| ProductsApi | systemScanAllScheduleGet | GET /system/scanAll/schedule | Get scan_all's schedule. |
| ProductsApi | systemScanAllSchedulePost | POST /system/scanAll/schedule | Create a schedule or a manual trigger for the scan all job. |
| ProductsApi | systemScanAllSchedulePut | PUT /system/scanAll/schedule | Update scan all's schedule. |
| ProductsApi | systeminfoGet | GET /systeminfo | Get general system info |
| ProductsApi | systeminfoGetcertGet | GET /systeminfo/getcert | Get default root certificate. |
| ProductsApi | systeminfoVolumesGet | GET /systeminfo/volumes | Get system volume info (total/free size). |
| ProductsApi | usergroupsGet | GET /usergroups | Get all user groups information |
| ProductsApi | usergroupsGroupIdDelete | DELETE /usergroups/{group_id} | Delete user group |
| ProductsApi | usergroupsGroupIdGet | GET /usergroups/{group_id} | Get user group information |
| ProductsApi | usergroupsGroupIdPut | PUT /usergroups/{group_id} | Update group information |
| ProductsApi | usergroupsPost | POST /usergroups | Create user group |
| ProductsApi | usersCurrentGet | GET /users/current | Get current user info. |
| ProductsApi | usersCurrentPermissionsGet | GET /users/current/permissions | Get current user permissions. |
| ProductsApi | usersGet | GET /users | Get registered users of Harbor. |
| ProductsApi | usersPost | POST /users | Creates a new user account. |
| ProductsApi | usersSearchGet | GET /users/search | Search users by username |
| ProductsApi | usersUserIdCliSecretPut | PUT /users/{user_id}/cli_secret | Set CLI secret for a user. |
| ProductsApi | usersUserIdDelete | DELETE /users/{user_id} | Mark a registered user as be removed. |
| ProductsApi | usersUserIdGet | GET /users/{user_id} | Get a user's profile. |
| ProductsApi | usersUserIdPasswordPut | PUT /users/{user_id}/password | Change the password on a user that already exists. |
| ProductsApi | usersUserIdPut | PUT /users/{user_id} | Update a registered user to change his profile. |
| ProductsApi | usersUserIdSysadminPut | PUT /users/{user_id}/sysadmin | Update a registered user to change to be an administrator of Harbor. |
| QuotaApi | quotasIdGet | GET /quotas/{id} | Get the specified quota |
| QuotaApi | quotasIdPut | PUT /quotas/{id} | Update the specified quota |
| RetentionApi | retentionsIdExecutionsEidPatch | PATCH /retentions/{id}/executions/{eid} | Stop a Retention job |
| RetentionApi | retentionsIdExecutionsEidTasksGet | GET /retentions/{id}/executions/{eid}/tasks | Get Retention job tasks |
| RetentionApi | retentionsIdExecutionsEidTasksTidGet | GET /retentions/{id}/executions/{eid}/tasks/{tid} | Get Retention job task log |
| RetentionApi | retentionsIdExecutionsGet | GET /retentions/{id}/executions | Get a Retention job |
| RetentionApi | retentionsIdExecutionsPost | POST /retentions/{id}/executions | Trigger a Retention job |
| RetentionApi | retentionsIdGet | GET /retentions/{id} | Get Retention Policy |
| RetentionApi | retentionsMetadatasGet | GET /retentions/metadatas | Get Retention Metadatas |
| RetentionApi | retentionsPost | POST /retentions | Create Retention Policy |
| RobotAccountApi | projectsProjectIdRobotsGet | GET /projects/{project_id}/robots | Get all robot accounts of specified project |
| RobotAccountApi | projectsProjectIdRobotsPost | POST /projects/{project_id}/robots | Create a robot account for project |
| RobotAccountApi | projectsProjectIdRobotsRobotIdDelete | DELETE /projects/{project_id}/robots/{robot_id} | Delete the specified robot account |
| RobotAccountApi | projectsProjectIdRobotsRobotIdGet | GET /projects/{project_id}/robots/{robot_id} | Return the infor of the specified robot account. |
| RobotAccountApi | projectsProjectIdRobotsRobotIdPut | PUT /projects/{project_id}/robots/{robot_id} | Update status of robot account. |
| ScanApi | repositoriesRepoNameTagsTagScanGet | GET /repositories/{repo_name}/tags/{tag}/scan | Get the scan report |
| ScanApi | repositoriesRepoNameTagsTagScanPost | POST /repositories/{repo_name}/tags/{tag}/scan | Scan the image. |
| ScanApi | repositoriesRepoNameTagsTagScanUuidLogGet | GET /repositories/{repo_name}/tags/{tag}/scan/{uuid}/log | Get scan log |
| ScanApi | scansAllMetricsGet | GET /scans/all/metrics | Get the metrics of the latest scan all process |
| ScanApi | scansScheduleMetricsGet | GET /scans/schedule/metrics | Get the metrics of the latest scheduled scan all process |
| ScannersApi | projectsProjectIdScannerCandidatesGet | GET /projects/{project_id}/scanner/candidates | Get scanner registration candidates for configurating project level scanner |
| ScannersApi | projectsProjectIdScannerGet | GET /projects/{project_id}/scanner | Get project level scanner |
| ScannersApi | projectsProjectIdScannerPut | PUT /projects/{project_id}/scanner | Configure scanner for the specified project |
| ScannersApi | scannersGet | GET /scanners | List scanner registrations |
| ScannersApi | scannersPingPost | POST /scanners/ping | Tests scanner registration settings |
| ScannersApi | scannersPost | POST /scanners | Create a scanner registration |
| ScannersApi | scannersRegistrationIdDelete | DELETE /scanners/{registration_id} | Delete a scanner registration |
| ScannersApi | scannersRegistrationIdGet | GET /scanners/{registration_id} | Get a scanner registration details |
| ScannersApi | scannersRegistrationIdMetadataGet | GET /scanners/{registration_id}/metadata | Get the metadata of the specified scanner registration |
| ScannersApi | scannersRegistrationIdPatch | PATCH /scanners/{registration_id} | Set system default scanner registration |
| ScannersApi | scannersRegistrationIdPut | PUT /scanners/{registration_id} | Update a scanner registration |
| SystemApi | systemCVEWhitelistGet | GET /system/CVEWhitelist | Get the system level whitelist of CVE. |
| SystemApi | systemCVEWhitelistPut | PUT /system/CVEWhitelist | Update the system level whitelist of CVE. |
| SystemApi | systemOidcPingPost | POST /system/oidc/ping | Test the OIDC endpoint. |
- AccessLog
- Action
- Action1
- AdminJobSchedule
- AdminJobScheduleObj
- BadRequestFormatedError
- BoolConfigItem
- CVEWhitelist
- CVEWhitelistItem
- ChartAPIError
- ChartInfoEntry
- ChartInfoList
- ChartMetadata
- ChartVersion
- ChartVersionDetails
- ChartVersions
- ComponentHealthStatus
- ComponentOverviewEntry
- Configurations
- ConfigurationsResponse
- ConfigurationsScanAllPolicy
- ConfigurationsScanAllPolicyParameter
- ConflictFormatedError
- Dependency
- DetailedTag
- DigitalSignature
- EmailServerSetting
- Endpoint
- FilterStyle
- ForbiddenChartAPIError
- GCResult
- GeneralInfo
- GeneralInfoClairVulnerabilityStatus
- HasAdminRole
- ImmutableTagRule
- InlineResponse200
- InputSecret
- InsufficientStorageChartAPIError
- IntegerConfigItem
- InternalChartAPIError
- IsDefault
- JobStatus
- Label
- Labels
- LdapConf
- LdapFailedImportUsers
- LdapImportUsers
- LdapUsers
- Manifest
- Namespace
- NativeReportSummary
- NotFoundChartAPIError
- OverallHealthStatus
- Password
- Permission
- PingRegistry
- Project
- ProjectMember
- ProjectMemberEntity
- ProjectMetadata
- ProjectReq
- ProjectScanner
- ProjectSummary
- ProjectSummaryQuota
- PutRegistry
- Quota
- QuotaRefObject
- QuotaSwitcher
- QuotaUpdateReq
- Registry
- RegistryCredential
- RegistryInfo
- ReplicationExecution
- ReplicationFilter
- ReplicationPolicy
- ReplicationTask
- ReplicationTrigger
- RepoSignature
- Report
- Repository
- RepositoryDescription
- Resource
- ResourceList
- RetagReq
- RetentionExecution
- RetentionExecutionTask
- RetentionMetadata
- RetentionPolicy
- RetentionPolicyScope
- RetentionRule
- RetentionRuleMetadata
- RetentionRuleParamMetadata
- RetentionRuleTrigger
- RetentionSelector
- RetentionSelectorMetadata
- RobotAccount
- RobotAccountAccess
- RobotAccountCreate
- RobotAccountPostRep
- RobotAccountUpdate
- Role
- RoleParam
- RoleRequest
- ScanOverview
- Scanner
- ScannerAdapterMetadata
- ScannerCapability
- ScannerRegistration
- ScannerRegistrationReq
- ScannerRegistrationSettings
- Search
- SearchRepository
- SearchResult
- SecurityReport
- StatisticMap
- Stats
- Storage
- StringConfigItem
- SystemInfo
- Tags
- TriggerSettings
- UnauthorizedChartAPIError
- User
- UserEntity
- UserGroup
- UserProfile
- UserSearch
- VulnNamespaceTimestamp
- VulnerabilityItem
- VulnerabilitySummary
- WebhookJob
- WebhookLastTrigger
- WebhookPolicy
- WebhookTargetObject
Authentication schemes defined for the API:
- Type: HTTP basic authentication
It's recommended to create an instance of ApiClient per thread in a multithreaded environment to avoid any potential issues.