Additional scan status gathered from ComplianceSuite
- Documentation
- Red Hat Advanced Cluster Security for Kubernetes
- API reference
- Version v2
- ComplianceScanConfigurationService
- GetComplianceScanConfiguration history bug_report picture_as_pdf
OpenShift docs are moving and will soon only be available at docs.redhat.com, the home of all Red Hat product documentation. Explore the new docs experience today.
- About
- Release notes
- RHACS Cloud Service
- Service description
- Overview of responsibilities for RHACS Cloud Service
- RHACS Cloud Service architecture
- Getting started with RHACS Cloud Service
- Default resource requirements for RHACS Cloud Service
- Recommended resource requirements for RHACS Cloud Service
- Setting up RHACS Cloud Service with Red Hat OpenShift secured clusters
- Creating a RHACS Cloud Service instance on Red Hat Cloud
- Creating a project on your Red Hat OpenShift secured cluster
- Generating an init bundle for secured clusters
- Applying an init bundle for secured clusters
- Installing the RHACS Operator for RHACS Cloud Service
- Installing secured cluster services from RHACS Cloud Service
- Configuring the proxy for secured cluster services in RHACS Cloud Service
- Verifying installation of secured clusters
- Setting up RHACS Cloud Service with Kubernetes secured clusters
- Creating a RHACS Cloud Service instance for Kubernetes clusters
- Generating an init bundle for Kubernetes secured clusters
- Applying an init bundle for Kubernetes secured clusters
- Installing secured cluster services from RHACS Cloud Service on Kubernetes clusters
- Verifying installation of secured clusters
- Upgrading RHACS Cloud Service
- Architecture
- Installing
- High-level RHACS installation overview
- Default resource requirements for RHACS
- Recommended resource requirements for RHACS
- Installing RHACS on Red Hat OpenShift
- Installing Central services for RHACS on Red Hat OpenShift
- Configuring Central configuration options for RHACS using the Operator
- Generating and applying an init bundle for RHACS on Red Hat OpenShift
- Installing Secured Cluster services for RHACS on Red Hat OpenShift
- Configuring Secured Cluster services options for RHACS using the Operator
- Verifying installation of RHACS on Red Hat OpenShift
- Installing RHACS on other platforms
- Uninstalling Red Hat Advanced Cluster Security for Kubernetes
- Configuring
- Adding custom certificates
- Adding trusted certificate authorities
- Reissuing internal certificates
- Adding security notices
- Enabling offline mode
- Enabling alert data retention
- Exposing the RHACS portal over HTTP
- Configuring automatic upgrades for secured clusters
- Configuring automatic removal of nonactive clusters
- Configuring a proxy for external network access
- Generating a diagnostic bundle
- Configuring endpoints
- Monitoring
- Enabling audit logging
- Configuring API tokens
- Using declarative configuration
- Inviting users to your RHACS instance
- Managing preview features
- Operating
- Viewing the dashboard
- Using Compliance Operator with RHACS
- Managing compliance
- Evaluating security risks
- Using admission controller enforcement
- Managing security policies
- Managing network policies
- Build-time network policy tools
- Visualizing external entities
- Auditing listening endpoints
- Reviewing cluster configuration
- Examining images for vulnerabilities
- Verifying image signatures
- Managing vulnerabilities
- Responding to violations
- Using deployment collections
- Searching and filtering
- Managing user access
- Using the system health dashboard
- Using the administration events page
- Integrating
- Integrating with image registries
- Integrating with CI systems
- Integrating with PagerDuty
- Integrating with Slack
- Integrating by using generic webhooks
- Integrating with QRadar
- Integrating with ServiceNow
- Integrating with Sumo Logic
- Integrating with Google Cloud Storage
- Integrating by using the syslog protocol
- Integrating with Amazon S3
- Integrating with S3 API compatible services
- Integrating with Google Cloud Security Command Center
- Integrating with Splunk
- Integrating with image vulnerability scanners
- Integrating with Jira
- Integrating with email
- Integrating with cloud management platforms
- Integrating using short-lived tokens
- Integrating with Microsoft Sentinel notifier
- Backup and restore
- Upgrading
- roxctl CLI
- Troubleshooting Collector
- Troubleshooting Central
- Telemetry
- Support
- API reference
- Version v1
- AdministrationEventService
- AdministrationUsageService
- AlertService
- APITokenService
- AuthProviderService
- AuthService
- CentralHealthService
- CloudSourcesService
- ClusterCVEService
- ClusterInitService
- ClustersService
- CollectionService
- ComplianceManagementService
- ComplianceService
- ConfigService
- CredentialExpiryService
- DBService
- DebugService
- DeclarativeConfigHealthService
- DelegatedRegistryConfigService
- DeploymentService
- DetectionService
- DiscoveredClustersService
- ExternalBackupService
- FeatureFlagService
- GroupService
- GRPCPreferencesService
- ImageCVEService
- ImageIntegrationService
- ImageService
- IntegrationHealthService
- ListeningEndpointsService
- MetadataService
- MitreAttackService
- NamespaceService
- NetworkBaselineService
- NetworkGraphService
- NetworkPolicyService
- GetAllowedPeersFromCurrentPolicyForDeployment
- ApplyNetworkPolicy
- ApplyNetworkPolicyYamlForDeployment
- GetDiffFlowsBetweenPolicyAndBaselineForDeployment
- GetNetworkGraph
- GetBaselineGeneratedNetworkPolicyForDeployment
- GenerateNetworkPolicies
- GetNetworkPolicies
- GetNetworkGraphEpoch
- GetNetworkPolicy
- SendNetworkPolicyYAML
- SimulateNetworkGraph
- GetDiffFlowsFromUndoModificationForDeployment
- GetUndoModification
- GetUndoModificationForDeployment
- NodeCVEService
- NodeService
- NotifierService
- PingService
- PodService
- PolicyCategoryService
- PolicyService
- ProbeUploadService
- ProcessBaselineService
- ProcessService
- RbacService
- ReportConfigurationService
- ReportService
- RoleService
- ComputeEffectiveAccessScope
- GetMyPermissions
- ListPermissionSets
- DeletePermissionSet
- GetPermissionSet
- PutPermissionSet
- PostPermissionSet
- GetResources
- GetRoles
- DeleteRole
- GetRole
- CreateRole
- UpdateRole
- GetNamespacesForClusterAndPermissions
- GetClustersForPermissions
- ListSimpleAccessScopes
- DeleteSimpleAccessScope
- GetSimpleAccessScope
- PutSimpleAccessScope
- PostSimpleAccessScope
- SearchService
- SecretService
- SensorUpgradeService
- ServiceAccountService
- ServiceIdentityService
- SignatureIntegrationService
- SummaryService
- TelemetryService
- UserService
- VulnerabilityRequestService
- VulnMgmtService
- Version v2
- ComplianceIntegrationService
- ComplianceProfileService
- ComplianceResultsService
- ComplianceResultsStatsService
- ComplianceRuleService
- ComplianceScanConfigurationService
- ListComplianceScanConfigClusterProfiles
- ListComplianceScanConfigurations
- DeleteComplianceScanConfiguration
- GetComplianceScanConfiguration
- UpdateComplianceScanConfiguration
- GetReportHistory
- GetMyReportHistory
- RunComplianceScanConfiguration
- CreateComplianceScanConfiguration
- ListComplianceScanConfigProfiles
- DeleteReport
- RunReport
- ReportService
- VulnerabilityExceptionService
- Version v1
×
GetComplianceScanConfiguration
GET /v2/compliance/scan/configurations/{id}
GetComplianceScanConfiguration retrieves the specified compliance scan configurations
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
A successful response. |
|
0 |
An unexpected error response. |
Common object reference
ClusterScanStatusSuiteStatus
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
phase |
String |
||||
result |
String |
||||
errorMessage |
String |
||||
lastTransitionTime |
Date |
date-time |
RpcStatus
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
code |
Integer |
int32 |
|||
message |
String |
||||
details |
List of ProtobufAny |
V2BaseComplianceScanConfigurationSettings
Next available tag: 5
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
oneTimeScan |
Boolean |
||||
profiles |
List of |
||||
scanSchedule |
|||||
description |
String |
||||
notifiers |
List of V2NotifierConfiguration |
V2ClusterScanStatus
ClusterScanStatus holds status based on cluster in the event that a scan configuration was successfully applied to some clusters but not others. Next available tag: 5
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
clusterId |
String |
||||
errors |
List of |
||||
clusterName |
String |
||||
suiteStatus |
V2ComplianceScanConfigurationStatus
Next available tag: 9
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
id |
String |
||||
scanName |
String |
||||
scanConfig |
|||||
clusterStatus |
List of V2ClusterScanStatus |
||||
createdTime |
Date |
date-time |
|||
lastUpdatedTime |
Date |
date-time |
|||
modifiedBy |
|||||
lastExecutedTime |
Date |
date-time |
V2EmailNotifierConfiguration
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
notifierId |
String |
||||
mailingLists |
List of |
||||
customSubject |
String |
||||
customBody |
String |
V2NotifierConfiguration
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
emailConfig |
|||||
notifierName |
String |
V2Schedule
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
intervalType |
UNSET, WEEKLY, MONTHLY, DAILY, |
||||
hour |
Integer |
int32 |
|||
minute |
Integer |
int32 |
|||
daysOfWeek |
|||||
daysOfMonth |
V2ScheduleDaysOfMonth
1 for 1st, 2 for 2nd .... 31 for 31st
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
days |
List of |
int32 |