Pricing
Knowledge Base
FAQ
About
Blog
Contact
Career
Pricing
Knowledge Base
FAQ
About
Blog
Contact
Career
Menu
Getting Started Guide
Prerequisites
New User Sign Up
Working With Helm Charts and OCI Registries
Push and Pull Images
Other Useful Features
User Manual
Why Use Container Registry
What Is Harbor?
Container Registry User Interface: A Short Overview
Working With Projects
Repositories
Managing Project Users
Project Configuration
Robot Accounts
Webhooks
Working With Artifacts
Push and Pull Images
Artifact Page
Tag Policies
Tag Retention
Tag Immutability
Working With Logs
Dedicated vs Individual Account
Double-Starred Patterns
Administration Manual
Registration for System Admins
Configure User Authentication
Database Authentication
UAA Authentication
LDAP/AD Authentication
OIDC Authentication
User Management
System Robot Accounts
Endpoints For Replications and Proxy Cache
Configure Artifacts Replication
Configure Replication Rules
System-Wide Labels
Project Quotas
Vulnerability Scanners
Manage Pre-Installed Scanners
Add New Scanners
Scanning Artifacts
General Configurations
Terminal Deletion of Images
Other System Settings
Proxy Cache Projects
Python API Client
API
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
Models
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
User Guides
OIDC configuration for Google Workspaces
OIDC configuration for Azure AD
Docs menu
LdapPingResult
Properties
Name
Type
Description
Notes
success
bool
Test success
[optional]
message
str
The ping operation output message.
[optional]
