For AI agents: a markdown representation of this page is available at https://container-registry.com/docs/harbor-api-client/model/body/index.md. The site index is at https://container-registry.com/llms.txt.

Skip to content

8gears Container Registry Harbor Registry as a Service Harbor Satellite

Knowledge Base For DevOps & Platform Engineers For CISOs & Security Teams For Developers

Partners Blog Contact

Talk to Our Team

8gears Container Registry Harbor Registry as a Service Harbor Satellite

Knowledge Base For DevOps & Platform Engineers For CISOs & Security Teams For Developers

Partners Blog Contact Talk to Our Team

Getting Started Guide

Prerequisites New User Sign Up Working With Helm Charts and OCI Registries Push and Pull Images Other Useful Features

Working With Projects

Project Configuration

Robot Accounts Webhooks

Repositories Managing Project Users

Working With Artifacts

Tag Retention Tag Immutability

Push and Pull Images Artifact Page

Why Use Container Registry What Is Harbor? Container Registry User Interface: A Short Overview Working With Logs Dedicated vs Individual Account Double-Starred Patterns

Python API Client

ArtifactApi AuditlogApi ConfigureApi GcApi HealthApi IconApi ImmutableApi JobserviceApi LabelApi LdapApi MemberApi OidcApi PingApi PreheatApi ProjectApi ProjectMetadataApi PurgeApi QuotaApi RegistryApi ReplicationApi RepositoryApi RetentionApi RobotApi Robotv1Api ScanAllApi ScanApi ScanDataExportApi ScannerApi ScheduleApi SearchApi StatisticApi SystemCVEAllowlistApi SysteminfoApi UserApi UsergroupApi WebhookApi WebhookjobApi

Access Accessory ActionRequest AdditionLink AdditionLinks Annotations Artifact AuditLog AuthproxySetting Body Body1 BoolConfigItem ChartMetadata ChartVersion ComponentHealthStatus Configurations ConfigurationsResponse ConfigurationsResponseScanAllPolicy ConfigurationsResponseScanAllPolicyParameter CVEAllowlist CVEAllowlistItem Endpoint Error Errors EventType ExecHistory Execution ExtraAttrs FilterStyle GCHistory GeneralInfo Icon ImmutableRule ImmutableSelector Instance IntegerConfigItem InternalConfigurationsResponse InternalConfigurationValue IsDefault JobQueue Label LdapConf LdapFailedImportUser LdapImportUsers LdapPingResult LdapUser Metadata Metrics NativeReportSummary NotifyType OIDCCliSecretReq OIDCUserInfo OverallHealthStatus PasswordReq Permission Platform PreheatPolicy Project ProjectDeletable ProjectMember ProjectMemberEntity ProjectMetadata ProjectReq ProjectScanner ProjectSummary ProjectSummaryQuota ProviderUnderProject Quota QuotaRefObject QuotaUpdateReq Reference Registry RegistryCredential RegistryEndpoint RegistryInfo RegistryPing RegistryProviderCredentialPattern RegistryProviderEndpointPattern RegistryProviderInfo RegistryUpdate ReplicationExecution ReplicationFilter ReplicationPolicy ReplicationTask ReplicationTrigger ReplicationTriggerSettings Repository ResourceList RetentionExecution RetentionExecutionTask RetentionMetadata RetentionPolicy RetentionPolicyScope RetentionRule RetentionRuleMetadata RetentionRuleParamMetadata RetentionRuleTrigger RetentionSelector RetentionSelectorMetadata Robot RobotCreate RobotCreated RobotCreateV1 RobotPermission RobotSec RoleRequest ScanDataExportExecution ScanDataExportExecutionList ScanDataExportJob ScanDataExportRequest Scanner ScannerAdapterMetadata ScannerCapability ScannerRegistration ScannerRegistrationReq ScannerRegistrationSettings ScanOverview Schedule ScheduleObj SchedulerStatus ScheduleTask Search SearchRepository SearchResult StartReplicationExecution Statistic Stats Storage StringConfigItem SupportedWebhookEventTypes SystemInfo Tag Task UserCreationReq UserEntity UserGroup UserGroupSearchItem UserProfile UserResp UserSearch UserSearchRespItem UserSysAdminFlag VulnerabilitySummary WebhookJob WebhookLastTrigger WebhookPolicy WebhookTargetObject Worker WorkerPool

Administration Manual

Configure User Authentication

Database Authentication UAA Authentication LDAP/AD Authentication OIDC Authentication

Configure Artifacts Replication

Configure Replication Rules

Vulnerability Scanners

Manage Pre-Installed Scanners Add New Scanners Scanning Artifacts General Configurations

Registration for System Admins User Management System Robot Accounts Endpoints For Replications and Proxy Cache System-Wide Labels Project Quotas Terminal Deletion of Images Other System Settings Proxy Cache Projects

OIDC configuration for Azure AD OIDC configuration for Google Workspaces

Searching...

No results found for ""

Try different keywords or check your spelling.

Body

Properties

Name	Type	Description	Notes
dry_run	bool		[optional]

Getting Started Guide

Prerequisites New User Sign Up Working With Helm Charts and OCI Registries Push and Pull Images Other Useful Features

Working With Projects

Project Configuration

Robot Accounts Webhooks

Repositories Managing Project Users

Working With Artifacts

Tag Retention Tag Immutability

Push and Pull Images Artifact Page

Why Use Container Registry What Is Harbor? Container Registry User Interface: A Short Overview Working With Logs Dedicated vs Individual Account Double-Starred Patterns

Python API Client

ArtifactApi AuditlogApi ConfigureApi GcApi HealthApi IconApi ImmutableApi JobserviceApi LabelApi LdapApi MemberApi OidcApi PingApi PreheatApi ProjectApi ProjectMetadataApi PurgeApi QuotaApi RegistryApi ReplicationApi RepositoryApi RetentionApi RobotApi Robotv1Api ScanAllApi ScanApi ScanDataExportApi ScannerApi ScheduleApi SearchApi StatisticApi SystemCVEAllowlistApi SysteminfoApi UserApi UsergroupApi WebhookApi WebhookjobApi

Access Accessory ActionRequest AdditionLink AdditionLinks Annotations Artifact AuditLog AuthproxySetting Body Body1 BoolConfigItem ChartMetadata ChartVersion ComponentHealthStatus Configurations ConfigurationsResponse ConfigurationsResponseScanAllPolicy ConfigurationsResponseScanAllPolicyParameter CVEAllowlist CVEAllowlistItem Endpoint Error Errors EventType ExecHistory Execution ExtraAttrs FilterStyle GCHistory GeneralInfo Icon ImmutableRule ImmutableSelector Instance IntegerConfigItem InternalConfigurationsResponse InternalConfigurationValue IsDefault JobQueue Label LdapConf LdapFailedImportUser LdapImportUsers LdapPingResult LdapUser Metadata Metrics NativeReportSummary NotifyType OIDCCliSecretReq OIDCUserInfo OverallHealthStatus PasswordReq Permission Platform PreheatPolicy Project ProjectDeletable ProjectMember ProjectMemberEntity ProjectMetadata ProjectReq ProjectScanner ProjectSummary ProjectSummaryQuota ProviderUnderProject Quota QuotaRefObject QuotaUpdateReq Reference Registry RegistryCredential RegistryEndpoint RegistryInfo RegistryPing RegistryProviderCredentialPattern RegistryProviderEndpointPattern RegistryProviderInfo RegistryUpdate ReplicationExecution ReplicationFilter ReplicationPolicy ReplicationTask ReplicationTrigger ReplicationTriggerSettings Repository ResourceList RetentionExecution RetentionExecutionTask RetentionMetadata RetentionPolicy RetentionPolicyScope RetentionRule RetentionRuleMetadata RetentionRuleParamMetadata RetentionRuleTrigger RetentionSelector RetentionSelectorMetadata Robot RobotCreate RobotCreated RobotCreateV1 RobotPermission RobotSec RoleRequest ScanDataExportExecution ScanDataExportExecutionList ScanDataExportJob ScanDataExportRequest Scanner ScannerAdapterMetadata ScannerCapability ScannerRegistration ScannerRegistrationReq ScannerRegistrationSettings ScanOverview Schedule ScheduleObj SchedulerStatus ScheduleTask Search SearchRepository SearchResult StartReplicationExecution Statistic Stats Storage StringConfigItem SupportedWebhookEventTypes SystemInfo Tag Task UserCreationReq UserEntity UserGroup UserGroupSearchItem UserProfile UserResp UserSearch UserSearchRespItem UserSysAdminFlag VulnerabilitySummary WebhookJob WebhookLastTrigger WebhookPolicy WebhookTargetObject Worker WorkerPool

Administration Manual

Configure User Authentication

Database Authentication UAA Authentication LDAP/AD Authentication OIDC Authentication

Configure Artifacts Replication

Configure Replication Rules

Vulnerability Scanners

Manage Pre-Installed Scanners Add New Scanners Scanning Artifacts General Configurations

Registration for System Admins User Management System Robot Accounts Endpoints For Replications and Proxy Cache System-Wide Labels Project Quotas Terminal Deletion of Images Other System Settings Proxy Cache Projects

OIDC configuration for Azure AD OIDC configuration for Google Workspaces

Products & Services

8gears Container Registry Harbor Registry as a Service Harbor Satellite Pricing

Resources

Knowledge Base Harbor For Blog FAQ Live Tech Support Service Status C8N Exoscale Registry Customer Portal

Compare

8gcr vs Cloud Registries 8gcr vs JFrog Artifactory 8gcr vs Sonatype Nexus 8gcr vs Harbor 8gcr vs Docker Hub 8gcr vs AWS ECR 8gcr vs Azure ACR 8gcr vs Google GAR

Company

About Partners Career Contact

Connect

Twitter/X LinkedIn GitHub Contact

©Copyright - Container Registry by 8gears Ltd Privacy Policy Terms of Service