Red Hat Summit Red Hat SummitSupportConsoleDevelopersStart a trialContact

Chapter 11. ClustersService

11.1. GetClusterDefaultValues
Copy link

GET /v1/cluster-defaults

11.1.1. Description
Copy link

11.1.2. Parameters
Copy link

11.1.3. Return Type
Copy link

V1ClusterDefaultsResponse

11.1.4. Content Type
Copy link

  • application/json

11.1.5. Responses
Copy link

Expand
Table 11.1. HTTP Response Codes
CodeMessageDatatype

200

A successful response.

V1ClusterDefaultsResponse

0

An unexpected error response.

RuntimeError

11.1.6. Samples
Copy link

11.1.7. Common object reference
Copy link

11.1.7.1. ProtobufAny
Copy link

Any contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message.

Protobuf library provides support to pack/unpack Any values in the form of utility functions or additional generated methods of the Any type.

Example 1: Pack and unpack a message in C++. 

Foo foo = ...;
Any any;
any.PackFrom(foo);
...
if (any.UnpackTo(&foo)) {
  ...
}

Example 2: Pack and unpack a message in Java. 

Foo foo = ...;
Any any = Any.pack(foo);
...
if (any.is(Foo.class)) {
  foo = any.unpack(Foo.class);
}
// or ...
if (any.isSameTypeAs(Foo.getDefaultInstance())) {
  foo = any.unpack(Foo.getDefaultInstance());
}
 
Example 3: Pack and unpack a message in Python.
 
foo = Foo(...)
any = Any()
any.Pack(foo)
...
if any.Is(Foo.DESCRIPTOR):
  any.Unpack(foo)
  ...
 
Example 4: Pack and unpack a message in Go
 
foo := &pb.Foo{...}
any, err := anypb.New(foo)
if err != nil {
  ...
}
...
foo := &pb.Foo{}
if err := any.UnmarshalTo(foo); err != nil {
  ...
}

The pack methods provided by protobuf library will by default use 'type.googleapis.com/full.type.name' as the type URL and the unpack methods only use the fully qualified type name after the last '/' in the type URL, for example "foo.bar.com/x/y.z" will yield type name "y.z".

11.1.7.1.1. JSON representation
Copy link

The JSON representation of an Any value uses the regular representation of the deserialized, embedded message, with an additional field @type which contains the type URL. Example: 

package google.profile;
message Person {
  string first_name = 1;
  string last_name = 2;
}
 
{
  "@type": "type.googleapis.com/google.profile.Person",
  "firstName": <string>,
  "lastName": <string>
}

If the embedded message type is well-known and has a custom JSON representation, that representation will be embedded adding a field value which holds the custom JSON in addition to the @type field. Example (for message [google.protobuf.Duration][]): 

{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}
Expand
Field NameRequiredNullableTypeDescriptionFormat

typeUrl

  

String

A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one \"/\" character. The last segment of the URL’s path must represent the fully qualified name of the type (as in path/google.protobuf.Duration). The name should be in a canonical form (e.g., leading \".\" is not accepted). In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme http, https, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows: * If no scheme is provided, https is assumed. * An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error. * Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.) Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com. As of May 2023, there are no widely used type server implementations and no plans to implement one. Schemes other than http, https (or the empty scheme) might be used with implementation specific semantics.

 

value

  

byte[]

Must be a valid serialized protocol buffer of the above specified type.

byte

11.1.7.2. RuntimeError
Copy link

Expand
Field NameRequiredNullableTypeDescriptionFormat

error

  

String

  

code

  

Integer

 

int32

message

  

String

  

details

  

List of ProtobufAny

  

11.1.7.3. V1ClusterDefaultsResponse
Copy link

Expand
Field NameRequiredNullableTypeDescriptionFormat

mainImageRepository

  

String

  

collectorImageRepository

  

String

  

kernelSupportAvailable

  

Boolean

  

11.2. GetKernelSupportAvailable
Copy link

GET /v1/clusters-env/kernel-support-available

GetKernelSupportAvailable is deprecated in favor of GetClusterDefaultValues.

11.2.1. Description
Copy link

11.2.2. Parameters
Copy link

11.2.3. Return Type
Copy link

V1KernelSupportAvailableResponse

11.2.4. Content Type
Copy link

  • application/json

11.2.5. Responses
Copy link

Expand
Table 11.2. HTTP Response Codes
CodeMessageDatatype

200

A successful response.

V1KernelSupportAvailableResponse

0

An unexpected error response.

RuntimeError

11.2.6. Samples
Copy link

11.2.7. Common object reference
Copy link

11.2.7.1. ProtobufAny
Copy link

Any contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message.

Protobuf library provides support to pack/unpack Any values in the form of utility functions or additional generated methods of the Any type.

Example 1: Pack and unpack a message in C++. 

Foo foo = ...;
Any any;
any.PackFrom(foo);
...
if (any.UnpackTo(&foo)) {
  ...
}

Example 2: Pack and unpack a message in Java. 

Foo foo = ...;
Any any = Any.pack(foo);
...
if (any.is(Foo.class)) {
  foo = any.unpack(Foo.class);
}
// or ...
if (any.isSameTypeAs(Foo.getDefaultInstance())) {
  foo = any.unpack(Foo.getDefaultInstance());
}
 
Example 3: Pack and unpack a message in Python.
 
foo = Foo(...)
any = Any()
any.Pack(foo)
...
if any.Is(Foo.DESCRIPTOR):
  any.Unpack(foo)
  ...
 
Example 4: Pack and unpack a message in Go
 
foo := &pb.Foo{...}
any, err := anypb.New(foo)
if err != nil {
  ...
}
...
foo := &pb.Foo{}
if err := any.UnmarshalTo(foo); err != nil {
  ...
}

The pack methods provided by protobuf library will by default use 'type.googleapis.com/full.type.name' as the type URL and the unpack methods only use the fully qualified type name after the last '/' in the type URL, for example "foo.bar.com/x/y.z" will yield type name "y.z".

11.2.7.1.1. JSON representation
Copy link

The JSON representation of an Any value uses the regular representation of the deserialized, embedded message, with an additional field @type which contains the type URL. Example: 

package google.profile;
message Person {
  string first_name = 1;
  string last_name = 2;
}
 
{
  "@type": "type.googleapis.com/google.profile.Person",
  "firstName": <string>,
  "lastName": <string>
}

If the embedded message type is well-known and has a custom JSON representation, that representation will be embedded adding a field value which holds the custom JSON in addition to the @type field. Example (for message [google.protobuf.Duration][]): 

{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}
Expand
Field NameRequiredNullableTypeDescriptionFormat

typeUrl

  

String

A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one \"/\" character. The last segment of the URL’s path must represent the fully qualified name of the type (as in path/google.protobuf.Duration). The name should be in a canonical form (e.g., leading \".\" is not accepted). In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme http, https, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows: * If no scheme is provided, https is assumed. * An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error. * Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.) Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com. As of May 2023, there are no widely used type server implementations and no plans to implement one. Schemes other than http, https (or the empty scheme) might be used with implementation specific semantics.

 

value

  

byte[]

Must be a valid serialized protocol buffer of the above specified type.

byte

11.2.7.2. RuntimeError
Copy link

Expand
Field NameRequiredNullableTypeDescriptionFormat

error

  

String

  

code

  

Integer

 

int32

message

  

String

  

details

  

List of ProtobufAny

  

11.2.7.3. V1KernelSupportAvailableResponse
Copy link

Expand
Field NameRequiredNullableTypeDescriptionFormat

kernelSupportAvailable

  

Boolean

  

11.3. GetClusters
Copy link

GET /v1/clusters

11.3.1. Description
Copy link

11.3.2. Parameters
Copy link

11.3.2.1. Query Parameters
Copy link

Expand
NameDescriptionRequiredDefaultPattern

query

 

-

null

 

11.3.3. Return Type
Copy link

V1ClustersList

11.3.4. Content Type
Copy link

  • application/json

11.3.5. Responses
Copy link

Expand
Table 11.3. HTTP Response Codes
CodeMessageDatatype

200

A successful response.

V1ClustersList

0

An unexpected error response.

RuntimeError

11.3.6. Samples
Copy link

11.3.7. Common object reference
Copy link

11.3.7.1. ClusterHealthStatusHealthStatusLabel
Copy link

  • UNAVAILABLE: Only collector can have unavailable status
Expand
Enum Values

UNINITIALIZED

UNAVAILABLE

UNHEALTHY

DEGRADED

HEALTHY

11.3.7.2. ClusterUpgradeStatusUpgradability
Copy link

  • SENSOR_VERSION_HIGHER: SENSOR_VERSION_HIGHER occurs when we detect that the sensor is running a newer version than this Central. This is unexpected, but can occur depending on the patches a customer does. In this case, we will NOT automatically "upgrade" the sensor, since that would be a downgrade, even if the autoupgrade setting is on. The user will be allowed to manually trigger the upgrade, but they are strongly discouraged from doing so without upgrading Central first, since this is an unsupported configuration.
Expand
Enum Values

UNSET

UP_TO_DATE

MANUAL_UPGRADE_REQUIRED

AUTO_UPGRADE_POSSIBLE

SENSOR_VERSION_HIGHER

11.3.7.3. ClusterUpgradeStatusUpgradeProcessStatus
Copy link

Expand
Field NameRequiredNullableTypeDescriptionFormat

active

  

Boolean

  

id

  

String

  

targetVersion

  

String

  

upgraderImage

  

String

  

initiatedAt

  

Date

 

date-time

progress

  

StorageUpgradeProgress

  

type

  

UpgradeProcessStatusUpgradeProcessType

 

UPGRADE, CERT_ROTATION,

11.3.7.4. ProtobufAny
Copy link

Any contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message.

Protobuf library provides support to pack/unpack Any values in the form of utility functions or additional generated methods of the Any type.

Example 1: Pack and unpack a message in C++. 

Foo foo = ...;
Any any;
any.PackFrom(foo);
...
if (any.UnpackTo(&foo)) {
  ...
}

Example 2: Pack and unpack a message in Java. 

Foo foo = ...;
Any any = Any.pack(foo);
...
if (any.is(Foo.class)) {
  foo = any.unpack(Foo.class);
}
// or ...
if (any.isSameTypeAs(Foo.getDefaultInstance())) {
  foo = any.unpack(Foo.getDefaultInstance());
}
 
Example 3: Pack and unpack a message in Python.
 
foo = Foo(...)
any = Any()
any.Pack(foo)
...
if any.Is(Foo.DESCRIPTOR):
  any.Unpack(foo)
  ...
 
Example 4: Pack and unpack a message in Go
 
foo := &pb.Foo{...}
any, err := anypb.New(foo)
if err != nil {
  ...
}
...
foo := &pb.Foo{}
if err := any.UnmarshalTo(foo); err != nil {
  ...
}

The pack methods provided by protobuf library will by default use 'type.googleapis.com/full.type.name' as the type URL and the unpack methods only use the fully qualified type name after the last '/' in the type URL, for example "foo.bar.com/x/y.z" will yield type name "y.z".

11.3.7.4.1. JSON representation
Copy link

The JSON representation of an Any value uses the regular representation of the deserialized, embedded message, with an additional field @type which contains the type URL. Example: 

package google.profile;
message Person {
  string first_name = 1;
  string last_name = 2;
}
 
{
  "@type": "type.googleapis.com/google.profile.Person",
  "firstName": <string>,
  "lastName": <string>
}

If the embedded message type is well-known and has a custom JSON representation, that representation will be embedded adding a field value which holds the custom JSON in addition to the @type field. Example (for message [google.protobuf.Duration][]): 

{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}
Expand
Field NameRequiredNullableTypeDescriptionFormat

typeUrl

  

String

A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one \"/\" character. The last segment of the URL’s path must represent the fully qualified name of the type (as in path/google.protobuf.Duration). The name should be in a canonical form (e.g., leading \".\" is not accepted). In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme http, https, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows: * If no scheme is provided, https is assumed. * An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error. * Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.) Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com. As of May 2023, there are no widely used type server implementations and no plans to implement one. Schemes other than http, https (or the empty scheme) might be used with implementation specific semantics.

 

value

  

byte[]

Must be a valid serialized protocol buffer of the above specified type.

byte

11.3.7.5. RuntimeError
Copy link

Expand
Field NameRequiredNullableTypeDescriptionFormat

error

  

String

  

code

  

Integer

 

int32

message

  

String

  

details

  

List of ProtobufAny

  

11.3.7.6. StorageAWSProviderMetadata
Copy link

Expand
Field NameRequiredNullableTypeDescriptionFormat

accountId

  

String

  

11.3.7.7. StorageAdmissionControlHealthInfo
Copy link

AdmissionControlHealthInfo carries data about admission control deployment but does not include admission control health status derived from this data. Aggregated admission control health status is not included because it is derived in central and not in the component that first reports AdmissionControlHealthInfo (sensor).

Expand
Field NameRequiredNullableTypeDescriptionFormat

totalDesiredPods

  

Integer

 

int32

totalReadyPods

  

Integer

 

int32

statusErrors

  

List of string

Collection of errors that occurred while trying to obtain admission control health info.

 

11.3.7.8. StorageAdmissionControllerConfig
Copy link

Expand
Field NameRequiredNullableTypeDescriptionFormat

enabled

  

Boolean

  

timeoutSeconds

  

Integer

 

int32

scanInline

  

Boolean

  

disableBypass

  

Boolean

  

enforceOnUpdates

  

Boolean

  

11.3.7.9. StorageAuditLogFileState
Copy link

AuditLogFileState tracks the last audit log event timestamp and ID that was collected by Compliance For internal use only
Expand
Field NameRequiredNullableTypeDescriptionFormat

collectLogsSince

  

Date

 

date-time

lastAuditId

  

String

  

11.3.7.10. StorageAzureProviderMetadata
Copy link

Expand
Field NameRequiredNullableTypeDescriptionFormat

subscriptionId

  

String

  

11.3.7.11. StorageCluster
Copy link

Expand
Field NameRequiredNullableTypeDescriptionFormat

id

  

String

  

name

  

String

  

type

  

StorageClusterType

 

GENERIC_CLUSTER, KUBERNETES_CLUSTER, OPENSHIFT_CLUSTER, OPENSHIFT4_CLUSTER,

labels

  

Map of string

  

mainImage

  

String

  

collectorImage

  

String

  

centralApiEndpoint

  

String

  

runtimeSupport

  

Boolean

  

collectionMethod

  

StorageCollectionMethod

 

UNSET_COLLECTION, NO_COLLECTION, KERNEL_MODULE, EBPF, CORE_BPF,

admissionController

  

Boolean

  

admissionControllerUpdates

  

Boolean

  

admissionControllerEvents

  

Boolean

  

status

  

StorageClusterStatus

  

dynamicConfig

  

StorageDynamicClusterConfig

  

tolerationsConfig

  

StorageTolerationsConfig

  

priority

  

String

 

int64

healthStatus

  

StorageClusterHealthStatus

  

slimCollector

  

Boolean

  

helmConfig

  

StorageCompleteClusterConfig

  

mostRecentSensorId

  

StorageSensorDeploymentIdentification

  

auditLogState

  

Map of StorageAuditLogFileState

For internal use only.

 

initBundleId

  

String

  

managedBy

  

StorageManagerType

 

MANAGER_TYPE_UNKNOWN, MANAGER_TYPE_MANUAL, MANAGER_TYPE_HELM_CHART, MANAGER_TYPE_KUBERNETES_OPERATOR,

11.3.7.12. StorageClusterCertExpiryStatus
Copy link

Expand
Field NameRequiredNullableTypeDescriptionFormat

sensorCertExpiry

  

Date

 

date-time

sensorCertNotBefore

  

Date

 

date-time

11.3.7.13. StorageClusterHealthStatus
Copy link

Expand
Field NameRequiredNullableTypeDescriptionFormat

id

  

String

  

collectorHealthInfo

  

StorageCollectorHealthInfo

  

admissionControlHealthInfo

  

StorageAdmissionControlHealthInfo

  

scannerHealthInfo

  

StorageScannerHealthInfo

  

sensorHealthStatus

  

ClusterHealthStatusHealthStatusLabel

 

UNINITIALIZED, UNAVAILABLE, UNHEALTHY, DEGRADED, HEALTHY,

collectorHealthStatus

  

ClusterHealthStatusHealthStatusLabel

 

UNINITIALIZED, UNAVAILABLE, UNHEALTHY, DEGRADED, HEALTHY,

overallHealthStatus

  

ClusterHealthStatusHealthStatusLabel

 

UNINITIALIZED, UNAVAILABLE, UNHEALTHY, DEGRADED, HEALTHY,

admissionControlHealthStatus

  

ClusterHealthStatusHealthStatusLabel

 

UNINITIALIZED, UNAVAILABLE, UNHEALTHY, DEGRADED, HEALTHY,

scannerHealthStatus

  

ClusterHealthStatusHealthStatusLabel

 

UNINITIALIZED, UNAVAILABLE, UNHEALTHY, DEGRADED, HEALTHY,

lastContact

  

Date

 

date-time

healthInfoComplete

  

Boolean

  

11.3.7.14. StorageClusterMetadata
Copy link

ClusterMetadata contains metadata information about the cluster infrastructure.

Expand
Field NameRequiredNullableTypeDescriptionFormat

type

  

StorageClusterMetadataType

 

UNSPECIFIED, AKS, ARO, EKS, GKE, OCP, OSD, ROSA,

name

  

String

Name represents the name under which the cluster is registered with the cloud provider. In case of self managed OpenShift it is the name chosen by the OpenShift installer.

 

id

  

String

Id represents a unique ID under which the cluster is registered with the cloud provider. Not all cluster types have an id. For all OpenShift clusters, this is the Red Hat cluster_id registered with OCM.

 

11.3.7.15. StorageClusterMetadataType
Copy link

Expand
Enum Values

UNSPECIFIED

AKS

ARO

EKS

GKE

OCP

OSD

ROSA

11.3.7.16. StorageClusterStatus
Copy link

Expand
Field NameRequiredNullableTypeDescriptionFormat

sensorVersion

  

String

  

DEPRECATEDLastContact

  

Date

This field has been deprecated starting release 49.0. Use healthStatus.lastContact instead.

date-time

providerMetadata

  

StorageProviderMetadata

  

orchestratorMetadata

  

StorageOrchestratorMetadata

  

upgradeStatus

  

StorageClusterUpgradeStatus

  

certExpiryStatus

  

StorageClusterCertExpiryStatus

  

11.3.7.17. StorageClusterType
Copy link

Expand
Enum Values

GENERIC_CLUSTER

KUBERNETES_CLUSTER

OPENSHIFT_CLUSTER

OPENSHIFT4_CLUSTER

11.3.7.18. StorageClusterUpgradeStatus
Copy link

Expand
Field NameRequiredNullableTypeDescriptionFormat

upgradability

  

ClusterUpgradeStatusUpgradability

 

UNSET, UP_TO_DATE, MANUAL_UPGRADE_REQUIRED, AUTO_UPGRADE_POSSIBLE, SENSOR_VERSION_HIGHER,

upgradabilityStatusReason

  

String

  

mostRecentProcess

  

ClusterUpgradeStatusUpgradeProcessStatus

  

11.3.7.19. StorageCollectionMethod
Copy link

Expand
Enum Values

UNSET_COLLECTION

NO_COLLECTION

KERNEL_MODULE

EBPF

CORE_BPF

11.3.7.20. StorageCollectorHealthInfo
Copy link

CollectorHealthInfo carries data about collector deployment but does not include collector health status derived from this data. Aggregated collector health status is not included because it is derived in central and not in the component that first reports CollectorHealthInfo (sensor).

Expand
Field NameRequiredNullableTypeDescriptionFormat

version

  

String

  

totalDesiredPods

  

Integer

 

int32

totalReadyPods

  

Integer

 

int32

totalRegisteredNodes

  

Integer

 

int32

statusErrors

  

List of string

Collection of errors that occurred while trying to obtain collector health info.

 

11.3.7.21. StorageCompleteClusterConfig
Copy link

Encodes a complete cluster configuration minus ID/Name identifiers including static and dynamic settings.

Expand
Field NameRequiredNullableTypeDescriptionFormat

dynamicConfig

  

StorageDynamicClusterConfig

  

staticConfig

  

StorageStaticClusterConfig

  

configFingerprint

  

String

  

clusterLabels

  

Map of string

  

11.3.7.22. StorageDynamicClusterConfig
Copy link

The difference between Static and Dynamic cluster config is that Dynamic values are sent over the Central to Sensor gRPC connection. This has the benefit of allowing for "hot reloading" of values without restarting Secured cluster components.

Expand
Field NameRequiredNullableTypeDescriptionFormat

admissionControllerConfig

  

StorageAdmissionControllerConfig

  

registryOverride

  

String

  

disableAuditLogs

  

Boolean

  

11.3.7.23. StorageGoogleProviderMetadata
Copy link

Expand
Field NameRequiredNullableTypeDescriptionFormat

project

  

String

  

clusterName

  

String

Deprecated in favor of providerMetadata.cluster.name.

 

11.3.7.24. StorageManagerType
Copy link

Expand
Enum Values

MANAGER_TYPE_UNKNOWN

MANAGER_TYPE_MANUAL

MANAGER_TYPE_HELM_CHART

MANAGER_TYPE_KUBERNETES_OPERATOR

11.3.7.25. StorageOrchestratorMetadata
Copy link

Expand
Field NameRequiredNullableTypeDescriptionFormat

version

  

String

  

openshiftVersion

  

String

  

buildDate

  

Date

 

date-time

apiVersions

  

List of string

  

11.3.7.26. StorageProviderMetadata
Copy link

Expand
Field NameRequiredNullableTypeDescriptionFormat

region

  

String

  

zone

  

String

  

google

  

StorageGoogleProviderMetadata

  

aws

  

StorageAWSProviderMetadata

  

azure

  

StorageAzureProviderMetadata

  

verified

  

Boolean

  

cluster

  

StorageClusterMetadata

  

11.3.7.27. StorageScannerHealthInfo
Copy link

ScannerHealthInfo represents health info of a scanner instance that is deployed on a secured cluster (so called "local scanner"). When the scanner is deployed on a central cluster, the following message is NOT used. ScannerHealthInfo carries data about scanner deployment but does not include scanner health status derived from this data. Aggregated scanner health status is not included because it is derived in central and not in the component that first reports ScannerHealthInfo (sensor).

Expand
Field NameRequiredNullableTypeDescriptionFormat

totalDesiredAnalyzerPods

  

Integer

 

int32

totalReadyAnalyzerPods

  

Integer

 

int32

totalDesiredDbPods

  

Integer

 

int32

totalReadyDbPods

  

Integer

 

int32

statusErrors

  

List of string

Collection of errors that occurred while trying to obtain scanner health info.

 

11.3.7.28. StorageSensorDeploymentIdentification
Copy link

StackRoxDeploymentIdentification aims at uniquely identifying a StackRox Sensor deployment. It is used to determine whether a sensor connection comes from a sensor pod that has restarted or was recreated (possibly after a network partition), or from a deployment in a different namespace or cluster.

Expand
Field NameRequiredNullableTypeDescriptionFormat

systemNamespaceId

  

String

  

defaultNamespaceId

  

String

  

appNamespace

  

String

  

appNamespaceId

  

String

  

appServiceaccountId

  

String

  

k8sNodeName

  

String

  

11.3.7.29. StorageStaticClusterConfig
Copy link

The difference between Static and Dynamic cluster config is that Static values are not sent over the Central to Sensor gRPC connection. They are used, for example, to generate manifests that can be used to set up the Secured Cluster’s k8s components. They are not dynamically reloaded.

Expand
Field NameRequiredNullableTypeDescriptionFormat

type

  

StorageClusterType

 

GENERIC_CLUSTER, KUBERNETES_CLUSTER, OPENSHIFT_CLUSTER, OPENSHIFT4_CLUSTER,

mainImage

  

String

  

centralApiEndpoint

  

String

  

collectionMethod

  

StorageCollectionMethod

 

UNSET_COLLECTION, NO_COLLECTION, KERNEL_MODULE, EBPF, CORE_BPF,

collectorImage

  

String

  

admissionController

  

Boolean

  

admissionControllerUpdates

  

Boolean

  

tolerationsConfig

  

StorageTolerationsConfig

  

slimCollector

  

Boolean

  

admissionControllerEvents

  

Boolean

  

11.3.7.30. StorageTolerationsConfig
Copy link

Expand
Field NameRequiredNullableTypeDescriptionFormat

disabled

  

Boolean

  

11.3.7.31. StorageUpgradeProgress
Copy link

Expand
Field NameRequiredNullableTypeDescriptionFormat

upgradeState

  

UpgradeProgressUpgradeState

 

UPGRADE_INITIALIZING, UPGRADER_LAUNCHING, UPGRADER_LAUNCHED, PRE_FLIGHT_CHECKS_COMPLETE, UPGRADE_OPERATIONS_DONE, UPGRADE_COMPLETE, UPGRADE_INITIALIZATION_ERROR, PRE_FLIGHT_CHECKS_FAILED, UPGRADE_ERROR_ROLLING_BACK, UPGRADE_ERROR_ROLLED_BACK, UPGRADE_ERROR_ROLLBACK_FAILED, UPGRADE_ERROR_UNKNOWN, UPGRADE_TIMED_OUT,

upgradeStatusDetail

  

String

  

since

  

Date

 

date-time

11.3.7.32. UpgradeProcessStatusUpgradeProcessType
Copy link

  • UPGRADE: UPGRADE represents a sensor version upgrade.
  • CERT_ROTATION: CERT_ROTATION represents an upgrade process that only rotates the TLS certs used by the cluster, without changing anything else.
Expand
Enum Values

UPGRADE

CERT_ROTATION

11.3.7.33. UpgradeProgressUpgradeState
Copy link

  • UPGRADER_LAUNCHING: In-progress states.
  • UPGRADE_COMPLETE: The success state. PLEASE NUMBER ALL IN-PROGRESS STATES ABOVE THIS AND ALL ERROR STATES BELOW THIS.
  • UPGRADE_INITIALIZATION_ERROR: Error states.
Expand
Enum Values

UPGRADE_INITIALIZING

UPGRADER_LAUNCHING

UPGRADER_LAUNCHED

PRE_FLIGHT_CHECKS_COMPLETE

UPGRADE_OPERATIONS_DONE

UPGRADE_COMPLETE

UPGRADE_INITIALIZATION_ERROR

PRE_FLIGHT_CHECKS_FAILED

UPGRADE_ERROR_ROLLING_BACK

UPGRADE_ERROR_ROLLED_BACK

UPGRADE_ERROR_ROLLBACK_FAILED

UPGRADE_ERROR_UNKNOWN

UPGRADE_TIMED_OUT

11.3.7.34. V1ClustersList
Copy link

Expand
Field NameRequiredNullableTypeDescriptionFormat

clusters

  

List of StorageCluster

  

clusterIdToRetentionInfo

  

Map of V1DecommissionedClusterRetentionInfo

  

11.3.7.35. V1DecommissionedClusterRetentionInfo
Copy link

next available tag: 3
Expand
Field NameRequiredNullableTypeDescriptionFormat

isExcluded

  

Boolean

  

daysUntilDeletion

  

Integer

 

int32

11.4. DeleteCluster
Copy link

DELETE /v1/clusters/{id}

11.4.1. Description
Copy link

11.4.2. Parameters
Copy link

11.4.2.1. Path Parameters
Copy link

Expand
NameDescriptionRequiredDefaultPattern

id

 

X

null

 

11.4.3. Return Type
Copy link

Object

11.4.4. Content Type
Copy link

  • application/json

11.4.5. Responses
Copy link

Expand
Table 11.4. HTTP Response Codes
CodeMessageDatatype

200

A successful response.

Object

0

An unexpected error response.

RuntimeError

11.4.6. Samples
Copy link

11.4.7. Common object reference
Copy link

11.4.7.1. ProtobufAny
Copy link

Any contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message.

Protobuf library provides support to pack/unpack Any values in the form of utility functions or additional generated methods of the Any type.

Example 1: Pack and unpack a message in C++. 

Foo foo = ...;
Any any;
any.PackFrom(foo);
...
if (any.UnpackTo(&foo)) {
  ...
}

Example 2: Pack and unpack a message in Java. 

Foo foo = ...;
Any any = Any.pack(foo);
...
if (any.is(Foo.class)) {
  foo = any.unpack(Foo.class);
}
// or ...
if (any.isSameTypeAs(Foo.getDefaultInstance())) {
  foo = any.unpack(Foo.getDefaultInstance());
}
 
Example 3: Pack and unpack a message in Python.
 
foo = Foo(...)
any = Any()
any.Pack(foo)
...
if any.Is(Foo.DESCRIPTOR):
  any.Unpack(foo)
  ...
 
Example 4: Pack and unpack a message in Go
 
foo := &pb.Foo{...}
any, err := anypb.New(foo)
if err != nil {
  ...
}
...
foo := &pb.Foo{}
if err := any.UnmarshalTo(foo); err != nil {
  ...
}

The pack methods provided by protobuf library will by default use 'type.googleapis.com/full.type.name' as the type URL and the unpack methods only use the fully qualified type name after the last '/' in the type URL, for example "foo.bar.com/x/y.z" will yield type name "y.z".

11.4.7.1.1. JSON representation
Copy link

The JSON representation of an Any value uses the regular representation of the deserialized, embedded message, with an additional field @type which contains the type URL. Example: 

package google.profile;
message Person {
  string first_name = 1;
  string last_name = 2;
}
 
{
  "@type": "type.googleapis.com/google.profile.Person",
  "firstName": <string>,
  "lastName": <string>
}

If the embedded message type is well-known and has a custom JSON representation, that representation will be embedded adding a field value which holds the custom JSON in addition to the @type field. Example (for message [google.protobuf.Duration][]): 

{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}
Expand
Field NameRequiredNullableTypeDescriptionFormat

typeUrl

  

String

A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one \"/\" character. The last segment of the URL’s path must represent the fully qualified name of the type (as in path/google.protobuf.Duration). The name should be in a canonical form (e.g., leading \".\" is not accepted). In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme http, https, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows: * If no scheme is provided, https is assumed. * An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error. * Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.) Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com. As of May 2023, there are no widely used type server implementations and no plans to implement one. Schemes other than http, https (or the empty scheme) might be used with implementation specific semantics.

 

value

  

byte[]

Must be a valid serialized protocol buffer of the above specified type.

byte

11.4.7.2. RuntimeError
Copy link

Expand
Field NameRequiredNullableTypeDescriptionFormat

error

  

String

  

code

  

Integer

 

int32

message

  

String

  

details

  

List of ProtobufAny

  

11.5. GetCluster
Copy link

GET /v1/clusters/{id}

11.5.1. Description
Copy link

11.5.2. Parameters
Copy link

11.5.2.1. Path Parameters
Copy link

Expand
NameDescriptionRequiredDefaultPattern

id

 

X

null

 

11.5.3. Return Type
Copy link

V1ClusterResponse

11.5.4. Content Type
Copy link

  • application/json

11.5.5. Responses
Copy link

Expand
Table 11.5. HTTP Response Codes
CodeMessageDatatype

200

A successful response.

V1ClusterResponse

0

An unexpected error response.

RuntimeError

11.5.6. Samples
Copy link

11.5.7. Common object reference
Copy link

11.5.7.1. ClusterHealthStatusHealthStatusLabel
Copy link

  • UNAVAILABLE: Only collector can have unavailable status
Expand
Enum Values

UNINITIALIZED

UNAVAILABLE

UNHEALTHY

DEGRADED

HEALTHY

11.5.7.2. ClusterUpgradeStatusUpgradability
Copy link

  • SENSOR_VERSION_HIGHER: SENSOR_VERSION_HIGHER occurs when we detect that the sensor is running a newer version than this Central. This is unexpected, but can occur depending on the patches a customer does. In this case, we will NOT automatically "upgrade" the sensor, since that would be a downgrade, even if the autoupgrade setting is on. The user will be allowed to manually trigger the upgrade, but they are strongly discouraged from doing so without upgrading Central first, since this is an unsupported configuration.
Expand
Enum Values

UNSET

UP_TO_DATE

MANUAL_UPGRADE_REQUIRED

AUTO_UPGRADE_POSSIBLE

SENSOR_VERSION_HIGHER

11.5.7.3. ClusterUpgradeStatusUpgradeProcessStatus
Copy link

Expand
Field NameRequiredNullableTypeDescriptionFormat

active

  

Boolean

  

id

  

String

  

targetVersion

  

String

  

upgraderImage

  

String

  

initiatedAt

  

Date

 

date-time

progress

  

StorageUpgradeProgress

  

type

  

UpgradeProcessStatusUpgradeProcessType

 

UPGRADE, CERT_ROTATION,

11.5.7.4. ProtobufAny
Copy link

Any contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message.

Protobuf library provides support to pack/unpack Any values in the form of utility functions or additional generated methods of the Any type.

Example 1: Pack and unpack a message in C++. 

Foo foo = ...;
Any any;
any.PackFrom(foo);
...
if (any.UnpackTo(&foo)) {
  ...
}

Example 2: Pack and unpack a message in Java. 

Foo foo = ...;
Any any = Any.pack(foo);
...
if (any.is(Foo.class)) {
  foo = any.unpack(Foo.class);
}
// or ...
if (any.isSameTypeAs(Foo.getDefaultInstance())) {
  foo = any.unpack(Foo.getDefaultInstance());
}
 
Example 3: Pack and unpack a message in Python.
 
foo = Foo(...)
any = Any()
any.Pack(foo)
...
if any.Is(Foo.DESCRIPTOR):
  any.Unpack(foo)
  ...
 
Example 4: Pack and unpack a message in Go
 
foo := &pb.Foo{...}
any, err := anypb.New(foo)
if err != nil {
  ...
}
...
foo := &pb.Foo{}
if err := any.UnmarshalTo(foo); err != nil {
  ...
}

The pack methods provided by protobuf library will by default use 'type.googleapis.com/full.type.name' as the type URL and the unpack methods only use the fully qualified type name after the last '/' in the type URL, for example "foo.bar.com/x/y.z" will yield type name "y.z".

11.5.7.4.1. JSON representation
Copy link

The JSON representation of an Any value uses the regular representation of the deserialized, embedded message, with an additional field @type which contains the type URL. Example: 

package google.profile;
message Person {
  string first_name = 1;
  string last_name = 2;
}
 
{
  "@type": "type.googleapis.com/google.profile.Person",
  "firstName": <string>,
  "lastName": <string>
}

If the embedded message type is well-known and has a custom JSON representation, that representation will be embedded adding a field value which holds the custom JSON in addition to the @type field. Example (for message [google.protobuf.Duration][]): 

{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}
Expand
Field NameRequiredNullableTypeDescriptionFormat

typeUrl

  

String

A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one \"/\" character. The last segment of the URL’s path must represent the fully qualified name of the type (as in path/google.protobuf.Duration). The name should be in a canonical form (e.g., leading \".\" is not accepted). In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme http, https, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows: * If no scheme is provided, https is assumed. * An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error. * Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.) Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com. As of May 2023, there are no widely used type server implementations and no plans to implement one. Schemes other than http, https (or the empty scheme) might be used with implementation specific semantics.

 

value

  

byte[]

Must be a valid serialized protocol buffer of the above specified type.

byte

11.5.7.5. RuntimeError
Copy link

Expand
Field NameRequiredNullableTypeDescriptionFormat

error

  

String

  

code

  

Integer

 

int32

message

  

String

  

details

  

List of ProtobufAny

  

11.5.7.6. StorageAWSProviderMetadata
Copy link

Expand
Field NameRequiredNullableTypeDescriptionFormat

accountId

  

String

  

11.5.7.7. StorageAdmissionControlHealthInfo
Copy link

AdmissionControlHealthInfo carries data about admission control deployment but does not include admission control health status derived from this data. Aggregated admission control health status is not included because it is derived in central and not in the component that first reports AdmissionControlHealthInfo (sensor).

Expand
Field NameRequiredNullableTypeDescriptionFormat

totalDesiredPods

  

Integer

 

int32

totalReadyPods

  

Integer

 

int32

statusErrors

  

List of string

Collection of errors that occurred while trying to obtain admission control health info.

 

11.5.7.8. StorageAdmissionControllerConfig
Copy link

Expand
Field NameRequiredNullableTypeDescriptionFormat

enabled

  

Boolean

  

timeoutSeconds

  

Integer

 

int32

scanInline

  

Boolean

  

disableBypass

  

Boolean

  

enforceOnUpdates

  

Boolean

  

11.5.7.9. StorageAuditLogFileState
Copy link

AuditLogFileState tracks the last audit log event timestamp and ID that was collected by Compliance For internal use only
Expand
Field NameRequiredNullableTypeDescriptionFormat

collectLogsSince

  

Date

 

date-time

lastAuditId

  

String

  

11.5.7.10. StorageAzureProviderMetadata
Copy link

Expand
Field NameRequiredNullableTypeDescriptionFormat

subscriptionId

  

String

  

11.5.7.11. StorageCluster
Copy link

Expand
Field NameRequiredNullableTypeDescriptionFormat

id

  

String

  

name

  

String

  

type

  

StorageClusterType

 

GENERIC_CLUSTER, KUBERNETES_CLUSTER, OPENSHIFT_CLUSTER, OPENSHIFT4_CLUSTER,

labels

  

Map of string

  

mainImage

  

String

  

collectorImage

  

String

  

centralApiEndpoint

  

String

  

runtimeSupport

  

Boolean

  

collectionMethod

  

StorageCollectionMethod

 

UNSET_COLLECTION, NO_COLLECTION, KERNEL_MODULE, EBPF, CORE_BPF,

admissionController

  

Boolean

  

admissionControllerUpdates

  

Boolean

  

admissionControllerEvents

  

Boolean

  

status

  

StorageClusterStatus

  

dynamicConfig

  

StorageDynamicClusterConfig

  

tolerationsConfig

  

StorageTolerationsConfig

  

priority

  

String

 

int64

healthStatus

  

StorageClusterHealthStatus

  

slimCollector

  

Boolean

  

helmConfig

  

StorageCompleteClusterConfig

  

mostRecentSensorId

  

StorageSensorDeploymentIdentification

  

auditLogState

  

Map of StorageAuditLogFileState

For internal use only.

 

initBundleId

  

String

  

managedBy

  

StorageManagerType

 

MANAGER_TYPE_UNKNOWN, MANAGER_TYPE_MANUAL, MANAGER_TYPE_HELM_CHART, MANAGER_TYPE_KUBERNETES_OPERATOR,

11.5.7.12. StorageClusterCertExpiryStatus
Copy link

Expand
Field NameRequiredNullableTypeDescriptionFormat

sensorCertExpiry

  

Date

 

date-time

sensorCertNotBefore

  

Date

 

date-time

11.5.7.13. StorageClusterHealthStatus
Copy link

Expand
Field NameRequiredNullableTypeDescriptionFormat

id

  

String

  

collectorHealthInfo

  

StorageCollectorHealthInfo

  

admissionControlHealthInfo

  

StorageAdmissionControlHealthInfo

  

scannerHealthInfo

  

StorageScannerHealthInfo

  

sensorHealthStatus

  

ClusterHealthStatusHealthStatusLabel

 

UNINITIALIZED, UNAVAILABLE, UNHEALTHY, DEGRADED, HEALTHY,

collectorHealthStatus

  

ClusterHealthStatusHealthStatusLabel

 

UNINITIALIZED, UNAVAILABLE, UNHEALTHY, DEGRADED, HEALTHY,

overallHealthStatus

  

ClusterHealthStatusHealthStatusLabel

 

UNINITIALIZED, UNAVAILABLE, UNHEALTHY, DEGRADED, HEALTHY,

admissionControlHealthStatus

  

ClusterHealthStatusHealthStatusLabel

 

UNINITIALIZED, UNAVAILABLE, UNHEALTHY, DEGRADED, HEALTHY,

scannerHealthStatus

  

ClusterHealthStatusHealthStatusLabel

 

UNINITIALIZED, UNAVAILABLE, UNHEALTHY, DEGRADED, HEALTHY,

lastContact

  

Date

 

date-time

healthInfoComplete

  

Boolean

  

11.5.7.14. StorageClusterMetadata
Copy link

ClusterMetadata contains metadata information about the cluster infrastructure.

Expand
Field NameRequiredNullableTypeDescriptionFormat

type

  

StorageClusterMetadataType

 

UNSPECIFIED, AKS, ARO, EKS, GKE, OCP, OSD, ROSA,

name

  

String

Name represents the name under which the cluster is registered with the cloud provider. In case of self managed OpenShift it is the name chosen by the OpenShift installer.

 

id

  

String

Id represents a unique ID under which the cluster is registered with the cloud provider. Not all cluster types have an id. For all OpenShift clusters, this is the Red Hat cluster_id registered with OCM.

 

11.5.7.15. StorageClusterMetadataType
Copy link

Expand
Enum Values

UNSPECIFIED

AKS

ARO

EKS

GKE

OCP

OSD

ROSA

11.5.7.16. StorageClusterStatus
Copy link

Expand
Field NameRequiredNullableTypeDescriptionFormat

sensorVersion

  

String

  

DEPRECATEDLastContact

  

Date

This field has been deprecated starting release 49.0. Use healthStatus.lastContact instead.

date-time

providerMetadata

  

StorageProviderMetadata

  

orchestratorMetadata

  

StorageOrchestratorMetadata

  

upgradeStatus

  

StorageClusterUpgradeStatus

  

certExpiryStatus

  

StorageClusterCertExpiryStatus

  

11.5.7.17. StorageClusterType
Copy link

Expand
Enum Values

GENERIC_CLUSTER

KUBERNETES_CLUSTER

OPENSHIFT_CLUSTER

OPENSHIFT4_CLUSTER

11.5.7.18. StorageClusterUpgradeStatus
Copy link

Expand
Field NameRequiredNullableTypeDescriptionFormat

upgradability

  

ClusterUpgradeStatusUpgradability

 

UNSET, UP_TO_DATE, MANUAL_UPGRADE_REQUIRED, AUTO_UPGRADE_POSSIBLE, SENSOR_VERSION_HIGHER,

upgradabilityStatusReason

  

String

  

mostRecentProcess

  

ClusterUpgradeStatusUpgradeProcessStatus

  

11.5.7.19. StorageCollectionMethod
Copy link

Expand
Enum Values

UNSET_COLLECTION

NO_COLLECTION

KERNEL_MODULE

EBPF

CORE_BPF

11.5.7.20. StorageCollectorHealthInfo
Copy link

CollectorHealthInfo carries data about collector deployment but does not include collector health status derived from this data. Aggregated collector health status is not included because it is derived in central and not in the component that first reports CollectorHealthInfo (sensor).

Expand
Field NameRequiredNullableTypeDescriptionFormat

version

  

String

  

totalDesiredPods

  

Integer

 

int32

totalReadyPods

  

Integer

 

int32

totalRegisteredNodes

  

Integer

 

int32

statusErrors

  

List of string

Collection of errors that occurred while trying to obtain collector health info.

 

11.5.7.21. StorageCompleteClusterConfig
Copy link

Encodes a complete cluster configuration minus ID/Name identifiers including static and dynamic settings.

Expand
Field NameRequiredNullableTypeDescriptionFormat

dynamicConfig

  

StorageDynamicClusterConfig

  

staticConfig

  

StorageStaticClusterConfig

  

configFingerprint

  

String

  

clusterLabels

  

Map of string

  

11.5.7.22. StorageDynamicClusterConfig
Copy link

The difference between Static and Dynamic cluster config is that Dynamic values are sent over the Central to Sensor gRPC connection. This has the benefit of allowing for "hot reloading" of values without restarting Secured cluster components.

Expand
Field NameRequiredNullableTypeDescriptionFormat

admissionControllerConfig

  

StorageAdmissionControllerConfig

  

registryOverride

  

String

  

disableAuditLogs

  

Boolean

  

11.5.7.23. StorageGoogleProviderMetadata
Copy link

Expand
Field NameRequiredNullableTypeDescriptionFormat

project

  

String

  

clusterName

  

String

Deprecated in favor of providerMetadata.cluster.name.

 

11.5.7.24. StorageManagerType
Copy link

Expand
Enum Values

MANAGER_TYPE_UNKNOWN

MANAGER_TYPE_MANUAL

MANAGER_TYPE_HELM_CHART

MANAGER_TYPE_KUBERNETES_OPERATOR

11.5.7.25. StorageOrchestratorMetadata
Copy link

Expand
Field NameRequiredNullableTypeDescriptionFormat

version

  

String

  

openshiftVersion

  

String

  

buildDate

  

Date

 

date-time

apiVersions

  

List of string

  

11.5.7.26. StorageProviderMetadata
Copy link

Expand
Field NameRequiredNullableTypeDescriptionFormat

region

  

String

  

zone

  

String

  

google

  

StorageGoogleProviderMetadata

  

aws

  

StorageAWSProviderMetadata

  

azure

  

StorageAzureProviderMetadata

  

verified

  

Boolean

  

cluster

  

StorageClusterMetadata

  

11.5.7.27. StorageScannerHealthInfo
Copy link

ScannerHealthInfo represents health info of a scanner instance that is deployed on a secured cluster (so called "local scanner"). When the scanner is deployed on a central cluster, the following message is NOT used. ScannerHealthInfo carries data about scanner deployment but does not include scanner health status derived from this data. Aggregated scanner health status is not included because it is derived in central and not in the component that first reports ScannerHealthInfo (sensor).

Expand
Field NameRequiredNullableTypeDescriptionFormat

totalDesiredAnalyzerPods

  

Integer

 

int32

totalReadyAnalyzerPods

  

Integer

 

int32

totalDesiredDbPods

  

Integer

 

int32

totalReadyDbPods

  

Integer

 

int32

statusErrors

  

List of string

Collection of errors that occurred while trying to obtain scanner health info.

 

11.5.7.28. StorageSensorDeploymentIdentification
Copy link

StackRoxDeploymentIdentification aims at uniquely identifying a StackRox Sensor deployment. It is used to determine whether a sensor connection comes from a sensor pod that has restarted or was recreated (possibly after a network partition), or from a deployment in a different namespace or cluster.

Expand
Field NameRequiredNullableTypeDescriptionFormat

systemNamespaceId

  

String

  

defaultNamespaceId

  

String

  

appNamespace

  

String

  

appNamespaceId

  

String

  

appServiceaccountId

  

String

  

k8sNodeName

  

String

  

11.5.7.29. StorageStaticClusterConfig
Copy link

The difference between Static and Dynamic cluster config is that Static values are not sent over the Central to Sensor gRPC connection. They are used, for example, to generate manifests that can be used to set up the Secured Cluster’s k8s components. They are not dynamically reloaded.

Expand
Field NameRequiredNullableTypeDescriptionFormat

type

  

StorageClusterType

 

GENERIC_CLUSTER, KUBERNETES_CLUSTER, OPENSHIFT_CLUSTER, OPENSHIFT4_CLUSTER,

mainImage

  

String

  

centralApiEndpoint

  

String

  

collectionMethod

  

StorageCollectionMethod

 

UNSET_COLLECTION, NO_COLLECTION, KERNEL_MODULE, EBPF, CORE_BPF,

collectorImage

  

String

  

admissionController

  

Boolean

  

admissionControllerUpdates

  

Boolean

  

tolerationsConfig

  

StorageTolerationsConfig

  

slimCollector

  

Boolean

  

admissionControllerEvents

  

Boolean

  

11.5.7.30. StorageTolerationsConfig
Copy link

Expand
Field NameRequiredNullableTypeDescriptionFormat

disabled

  

Boolean

  

11.5.7.31. StorageUpgradeProgress
Copy link

Expand
Field NameRequiredNullableTypeDescriptionFormat

upgradeState

  

UpgradeProgressUpgradeState

 

UPGRADE_INITIALIZING, UPGRADER_LAUNCHING, UPGRADER_LAUNCHED, PRE_FLIGHT_CHECKS_COMPLETE, UPGRADE_OPERATIONS_DONE, UPGRADE_COMPLETE, UPGRADE_INITIALIZATION_ERROR, PRE_FLIGHT_CHECKS_FAILED, UPGRADE_ERROR_ROLLING_BACK, UPGRADE_ERROR_ROLLED_BACK, UPGRADE_ERROR_ROLLBACK_FAILED, UPGRADE_ERROR_UNKNOWN, UPGRADE_TIMED_OUT,

upgradeStatusDetail

  

String

  

since

  

Date

 

date-time

11.5.7.32. UpgradeProcessStatusUpgradeProcessType
Copy link

  • UPGRADE: UPGRADE represents a sensor version upgrade.
  • CERT_ROTATION: CERT_ROTATION represents an upgrade process that only rotates the TLS certs used by the cluster, without changing anything else.
Expand
Enum Values

UPGRADE

CERT_ROTATION

11.5.7.33. UpgradeProgressUpgradeState
Copy link

  • UPGRADER_LAUNCHING: In-progress states.
  • UPGRADE_COMPLETE: The success state. PLEASE NUMBER ALL IN-PROGRESS STATES ABOVE THIS AND ALL ERROR STATES BELOW THIS.
  • UPGRADE_INITIALIZATION_ERROR: Error states.
Expand
Enum Values

UPGRADE_INITIALIZING

UPGRADER_LAUNCHING

UPGRADER_LAUNCHED

PRE_FLIGHT_CHECKS_COMPLETE

UPGRADE_OPERATIONS_DONE

UPGRADE_COMPLETE

UPGRADE_INITIALIZATION_ERROR

PRE_FLIGHT_CHECKS_FAILED

UPGRADE_ERROR_ROLLING_BACK

UPGRADE_ERROR_ROLLED_BACK

UPGRADE_ERROR_ROLLBACK_FAILED

UPGRADE_ERROR_UNKNOWN

UPGRADE_TIMED_OUT

11.5.7.34. V1ClusterResponse
Copy link

Expand
Field NameRequiredNullableTypeDescriptionFormat

cluster

  

StorageCluster

  

clusterRetentionInfo

  

V1DecommissionedClusterRetentionInfo

  

11.5.7.35. V1DecommissionedClusterRetentionInfo
Copy link

next available tag: 3
Expand
Field NameRequiredNullableTypeDescriptionFormat

isExcluded

  

Boolean

  

daysUntilDeletion

  

Integer

 

int32

11.6. PutCluster
Copy link

PUT /v1/clusters/{id}

11.6.1. Description
Copy link

11.6.2. Parameters
Copy link

11.6.2.1. Path Parameters
Copy link

Expand
NameDescriptionRequiredDefaultPattern

id

 

X

null

 

11.6.2.2. Body Parameter
Copy link

Expand
NameDescriptionRequiredDefaultPattern

body

StorageCluster

X

  

11.6.3. Return Type
Copy link

V1ClusterResponse

11.6.4. Content Type
Copy link

  • application/json

11.6.5. Responses
Copy link

Expand
Table 11.6. HTTP Response Codes
CodeMessageDatatype

200

A successful response.

V1ClusterResponse

0

An unexpected error response.

RuntimeError

11.6.6. Samples
Copy link

11.6.7. Common object reference
Copy link

11.6.7.1. ClusterHealthStatusHealthStatusLabel
Copy link

  • UNAVAILABLE: Only collector can have unavailable status
Expand
Enum Values

UNINITIALIZED

UNAVAILABLE

UNHEALTHY

DEGRADED

HEALTHY

11.6.7.2. ClusterUpgradeStatusUpgradability
Copy link

  • SENSOR_VERSION_HIGHER: SENSOR_VERSION_HIGHER occurs when we detect that the sensor is running a newer version than this Central. This is unexpected, but can occur depending on the patches a customer does. In this case, we will NOT automatically "upgrade" the sensor, since that would be a downgrade, even if the autoupgrade setting is on. The user will be allowed to manually trigger the upgrade, but they are strongly discouraged from doing so without upgrading Central first, since this is an unsupported configuration.
Expand
Enum Values

UNSET

UP_TO_DATE

MANUAL_UPGRADE_REQUIRED

AUTO_UPGRADE_POSSIBLE

SENSOR_VERSION_HIGHER

11.6.7.3. ClusterUpgradeStatusUpgradeProcessStatus
Copy link

Expand
Field NameRequiredNullableTypeDescriptionFormat

active

  

Boolean

  

id

  

String

  

targetVersion

  

String

  

upgraderImage

  

String

  

initiatedAt

  

Date

 

date-time

progress

  

StorageUpgradeProgress

  

type

  

UpgradeProcessStatusUpgradeProcessType

 

UPGRADE, CERT_ROTATION,

11.6.7.4. ProtobufAny
Copy link

Any contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message.

Protobuf library provides support to pack/unpack Any values in the form of utility functions or additional generated methods of the Any type.

Example 1: Pack and unpack a message in C++. 

Foo foo = ...;
Any any;
any.PackFrom(foo);
...
if (any.UnpackTo(&foo)) {
  ...
}

Example 2: Pack and unpack a message in Java. 

Foo foo = ...;
Any any = Any.pack(foo);
...
if (any.is(Foo.class)) {
  foo = any.unpack(Foo.class);
}
// or ...
if (any.isSameTypeAs(Foo.getDefaultInstance())) {
  foo = any.unpack(Foo.getDefaultInstance());
}
 
Example 3: Pack and unpack a message in Python.
 
foo = Foo(...)
any = Any()
any.Pack(foo)
...
if any.Is(Foo.DESCRIPTOR):
  any.Unpack(foo)
  ...
 
Example 4: Pack and unpack a message in Go
 
foo := &pb.Foo{...}
any, err := anypb.New(foo)
if err != nil {
  ...
}
...
foo := &pb.Foo{}
if err := any.UnmarshalTo(foo); err != nil {
  ...
}

The pack methods provided by protobuf library will by default use 'type.googleapis.com/full.type.name' as the type URL and the unpack methods only use the fully qualified type name after the last '/' in the type URL, for example "foo.bar.com/x/y.z" will yield type name "y.z".

11.6.7.4.1. JSON representation
Copy link

The JSON representation of an Any value uses the regular representation of the deserialized, embedded message, with an additional field @type which contains the type URL. Example: 

package google.profile;
message Person {
  string first_name = 1;
  string last_name = 2;
}
 
{
  "@type": "type.googleapis.com/google.profile.Person",
  "firstName": <string>,
  "lastName": <string>
}

If the embedded message type is well-known and has a custom JSON representation, that representation will be embedded adding a field value which holds the custom JSON in addition to the @type field. Example (for message [google.protobuf.Duration][]): 

{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}
Expand
Field NameRequiredNullableTypeDescriptionFormat

typeUrl

  

String

A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one \"/\" character. The last segment of the URL’s path must represent the fully qualified name of the type (as in path/google.protobuf.Duration). The name should be in a canonical form (e.g., leading \".\" is not accepted). In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme http, https, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows: * If no scheme is provided, https is assumed. * An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error. * Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.) Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com. As of May 2023, there are no widely used type server implementations and no plans to implement one. Schemes other than http, https (or the empty scheme) might be used with implementation specific semantics.

 

value

  

byte[]

Must be a valid serialized protocol buffer of the above specified type.

byte

11.6.7.5. RuntimeError
Copy link

Expand
Field NameRequiredNullableTypeDescriptionFormat

error

  

String

  

code

  

Integer

 

int32

message

  

String

  

details

  

List of ProtobufAny

  

11.6.7.6. StorageAWSProviderMetadata
Copy link

Expand
Field NameRequiredNullableTypeDescriptionFormat

accountId

  

String

  

11.6.7.7. StorageAdmissionControlHealthInfo
Copy link

AdmissionControlHealthInfo carries data about admission control deployment but does not include admission control health status derived from this data. Aggregated admission control health status is not included because it is derived in central and not in the component that first reports AdmissionControlHealthInfo (sensor).

Expand
Field NameRequiredNullableTypeDescriptionFormat

totalDesiredPods

  

Integer

 

int32

totalReadyPods

  

Integer

 

int32

statusErrors

  

List of string

Collection of errors that occurred while trying to obtain admission control health info.

 

11.6.7.8. StorageAdmissionControllerConfig
Copy link

Expand
Field NameRequiredNullableTypeDescriptionFormat

enabled

  

Boolean

  

timeoutSeconds

  

Integer

 

int32

scanInline

  

Boolean

  

disableBypass

  

Boolean

  

enforceOnUpdates

  

Boolean

  

11.6.7.9. StorageAuditLogFileState
Copy link

AuditLogFileState tracks the last audit log event timestamp and ID that was collected by Compliance For internal use only
Expand
Field NameRequiredNullableTypeDescriptionFormat

collectLogsSince

  

Date

 

date-time

lastAuditId

  

String

  

11.6.7.10. StorageAzureProviderMetadata
Copy link

Expand
Field NameRequiredNullableTypeDescriptionFormat

subscriptionId

  

String

  

11.6.7.11. StorageCluster
Copy link

Expand
Field NameRequiredNullableTypeDescriptionFormat

id

  

String

  

name

  

String

  

type

  

StorageClusterType

 

GENERIC_CLUSTER, KUBERNETES_CLUSTER, OPENSHIFT_CLUSTER, OPENSHIFT4_CLUSTER,

labels

  

Map of string

  

mainImage

  

String

  

collectorImage

  

String

  

centralApiEndpoint

  

String

  

runtimeSupport

  

Boolean

  

collectionMethod

  

StorageCollectionMethod

 

UNSET_COLLECTION, NO_COLLECTION, KERNEL_MODULE, EBPF, CORE_BPF,

admissionController

  

Boolean

  

admissionControllerUpdates

  

Boolean

  

admissionControllerEvents

  

Boolean

  

status

  

StorageClusterStatus

  

dynamicConfig

  

StorageDynamicClusterConfig

  

tolerationsConfig

  

StorageTolerationsConfig

  

priority

  

String

 

int64

healthStatus

  

StorageClusterHealthStatus

  

slimCollector

  

Boolean

  

helmConfig

  

StorageCompleteClusterConfig

  

mostRecentSensorId

  

StorageSensorDeploymentIdentification

  

auditLogState

  

Map of StorageAuditLogFileState

For internal use only.

 

initBundleId

  

String

  

managedBy

  

StorageManagerType

 

MANAGER_TYPE_UNKNOWN, MANAGER_TYPE_MANUAL, MANAGER_TYPE_HELM_CHART, MANAGER_TYPE_KUBERNETES_OPERATOR,

11.6.7.12. StorageClusterCertExpiryStatus
Copy link

Expand
Field NameRequiredNullableTypeDescriptionFormat

sensorCertExpiry

  

Date

 

date-time

sensorCertNotBefore

  

Date

 

date-time

11.6.7.13. StorageClusterHealthStatus
Copy link

Expand
Field NameRequiredNullableTypeDescriptionFormat

id

  

String

  

collectorHealthInfo

  

StorageCollectorHealthInfo

  

admissionControlHealthInfo

  

StorageAdmissionControlHealthInfo

  

scannerHealthInfo

  

StorageScannerHealthInfo

  

sensorHealthStatus

  

ClusterHealthStatusHealthStatusLabel

 

UNINITIALIZED, UNAVAILABLE, UNHEALTHY, DEGRADED, HEALTHY,

collectorHealthStatus

  

ClusterHealthStatusHealthStatusLabel

 

UNINITIALIZED, UNAVAILABLE, UNHEALTHY, DEGRADED, HEALTHY,

overallHealthStatus

  

ClusterHealthStatusHealthStatusLabel

 

UNINITIALIZED, UNAVAILABLE, UNHEALTHY, DEGRADED, HEALTHY,

admissionControlHealthStatus

  

ClusterHealthStatusHealthStatusLabel

 

UNINITIALIZED, UNAVAILABLE, UNHEALTHY, DEGRADED, HEALTHY,

scannerHealthStatus

  

ClusterHealthStatusHealthStatusLabel

 

UNINITIALIZED, UNAVAILABLE, UNHEALTHY, DEGRADED, HEALTHY,

lastContact

  

Date

 

date-time

healthInfoComplete

  

Boolean

  

11.6.7.14. StorageClusterMetadata
Copy link

ClusterMetadata contains metadata information about the cluster infrastructure.

Expand
Field NameRequiredNullableTypeDescriptionFormat

type

  

StorageClusterMetadataType

 

UNSPECIFIED, AKS, ARO, EKS, GKE, OCP, OSD, ROSA,

name

  

String

Name represents the name under which the cluster is registered with the cloud provider. In case of self managed OpenShift it is the name chosen by the OpenShift installer.

 

id

  

String

Id represents a unique ID under which the cluster is registered with the cloud provider. Not all cluster types have an id. For all OpenShift clusters, this is the Red Hat cluster_id registered with OCM.

 

11.6.7.15. StorageClusterMetadataType
Copy link

Expand
Enum Values

UNSPECIFIED

AKS

ARO

EKS

GKE

OCP

OSD

ROSA

11.6.7.16. StorageClusterStatus
Copy link

Expand
Field NameRequiredNullableTypeDescriptionFormat

sensorVersion

  

String

  

DEPRECATEDLastContact

  

Date

This field has been deprecated starting release 49.0. Use healthStatus.lastContact instead.

date-time

providerMetadata

  

StorageProviderMetadata

  

orchestratorMetadata

  

StorageOrchestratorMetadata

  

upgradeStatus

  

StorageClusterUpgradeStatus

  

certExpiryStatus

  

StorageClusterCertExpiryStatus

  

11.6.7.17. StorageClusterType
Copy link

Expand
Enum Values

GENERIC_CLUSTER

KUBERNETES_CLUSTER

OPENSHIFT_CLUSTER

OPENSHIFT4_CLUSTER

11.6.7.18. StorageClusterUpgradeStatus
Copy link

Expand
Field NameRequiredNullableTypeDescriptionFormat

upgradability

  

ClusterUpgradeStatusUpgradability

 

UNSET, UP_TO_DATE, MANUAL_UPGRADE_REQUIRED, AUTO_UPGRADE_POSSIBLE, SENSOR_VERSION_HIGHER,

upgradabilityStatusReason

  

String

  

mostRecentProcess

  

ClusterUpgradeStatusUpgradeProcessStatus

  

11.6.7.19. StorageCollectionMethod
Copy link

Expand
Enum Values

UNSET_COLLECTION

NO_COLLECTION

KERNEL_MODULE

EBPF

CORE_BPF

11.6.7.20. StorageCollectorHealthInfo
Copy link

CollectorHealthInfo carries data about collector deployment but does not include collector health status derived from this data. Aggregated collector health status is not included because it is derived in central and not in the component that first reports CollectorHealthInfo (sensor).

Expand
Field NameRequiredNullableTypeDescriptionFormat

version

  

String

  

totalDesiredPods

  

Integer

 

int32

totalReadyPods

  

Integer

 

int32

totalRegisteredNodes

  

Integer

 

int32

statusErrors

  

List of string

Collection of errors that occurred while trying to obtain collector health info.

 

11.6.7.21. StorageCompleteClusterConfig
Copy link

Encodes a complete cluster configuration minus ID/Name identifiers including static and dynamic settings.

Expand
Field NameRequiredNullableTypeDescriptionFormat

dynamicConfig

  

StorageDynamicClusterConfig

  

staticConfig

  

StorageStaticClusterConfig

  

configFingerprint

  

String

  

clusterLabels

  

Map of string

  

11.6.7.22. StorageDynamicClusterConfig
Copy link

The difference between Static and Dynamic cluster config is that Dynamic values are sent over the Central to Sensor gRPC connection. This has the benefit of allowing for "hot reloading" of values without restarting Secured cluster components.

Expand
Field NameRequiredNullableTypeDescriptionFormat

admissionControllerConfig

  

StorageAdmissionControllerConfig

  

registryOverride

  

String

  

disableAuditLogs

  

Boolean

  

11.6.7.23. StorageGoogleProviderMetadata
Copy link

Expand
Field NameRequiredNullableTypeDescriptionFormat

project

  

String

  

clusterName

  

String

Deprecated in favor of providerMetadata.cluster.name.

 

11.6.7.24. StorageManagerType
Copy link

Expand
Enum Values

MANAGER_TYPE_UNKNOWN

MANAGER_TYPE_MANUAL

MANAGER_TYPE_HELM_CHART

MANAGER_TYPE_KUBERNETES_OPERATOR

11.6.7.25. StorageOrchestratorMetadata
Copy link

Expand
Field NameRequiredNullableTypeDescriptionFormat

version

  

String

  

openshiftVersion

  

String

  

buildDate

  

Date

 

date-time

apiVersions

  

List of string

  

11.6.7.26. StorageProviderMetadata
Copy link

Expand
Field NameRequiredNullableTypeDescriptionFormat

region

  

String

  

zone

  

String

  

google

  

StorageGoogleProviderMetadata

  

aws

  

StorageAWSProviderMetadata

  

azure

  

StorageAzureProviderMetadata

  

verified

  

Boolean

  

cluster

  

StorageClusterMetadata

  

11.6.7.27. StorageScannerHealthInfo
Copy link

ScannerHealthInfo represents health info of a scanner instance that is deployed on a secured cluster (so called "local scanner"). When the scanner is deployed on a central cluster, the following message is NOT used. ScannerHealthInfo carries data about scanner deployment but does not include scanner health status derived from this data. Aggregated scanner health status is not included because it is derived in central and not in the component that first reports ScannerHealthInfo (sensor).

Expand
Field NameRequiredNullableTypeDescriptionFormat

totalDesiredAnalyzerPods

  

Integer

 

int32

totalReadyAnalyzerPods

  

Integer

 

int32

totalDesiredDbPods

  

Integer

 

int32

totalReadyDbPods

  

Integer

 

int32

statusErrors

  

List of string

Collection of errors that occurred while trying to obtain scanner health info.

 

11.6.7.28. StorageSensorDeploymentIdentification
Copy link

StackRoxDeploymentIdentification aims at uniquely identifying a StackRox Sensor deployment. It is used to determine whether a sensor connection comes from a sensor pod that has restarted or was recreated (possibly after a network partition), or from a deployment in a different namespace or cluster.

Expand
Field NameRequiredNullableTypeDescriptionFormat

systemNamespaceId

  

String

  

defaultNamespaceId

  

String

  

appNamespace

  

String

  

appNamespaceId

  

String

  

appServiceaccountId

  

String

  

k8sNodeName

  

String

  

11.6.7.29. StorageStaticClusterConfig
Copy link

The difference between Static and Dynamic cluster config is that Static values are not sent over the Central to Sensor gRPC connection. They are used, for example, to generate manifests that can be used to set up the Secured Cluster’s k8s components. They are not dynamically reloaded.

Expand
Field NameRequiredNullableTypeDescriptionFormat

type

  

StorageClusterType

 

GENERIC_CLUSTER, KUBERNETES_CLUSTER, OPENSHIFT_CLUSTER, OPENSHIFT4_CLUSTER,

mainImage

  

String

  

centralApiEndpoint

  

String

  

collectionMethod

  

StorageCollectionMethod

 

UNSET_COLLECTION, NO_COLLECTION, KERNEL_MODULE, EBPF, CORE_BPF,

collectorImage

  

String

  

admissionController

  

Boolean

  

admissionControllerUpdates

  

Boolean

  

tolerationsConfig

  

StorageTolerationsConfig

  

slimCollector

  

Boolean

  

admissionControllerEvents

  

Boolean

  

11.6.7.30. StorageTolerationsConfig
Copy link

Expand
Field NameRequiredNullableTypeDescriptionFormat

disabled

  

Boolean

  

11.6.7.31. StorageUpgradeProgress
Copy link

Expand
Field NameRequiredNullableTypeDescriptionFormat

upgradeState

  

UpgradeProgressUpgradeState

 

UPGRADE_INITIALIZING, UPGRADER_LAUNCHING, UPGRADER_LAUNCHED, PRE_FLIGHT_CHECKS_COMPLETE, UPGRADE_OPERATIONS_DONE, UPGRADE_COMPLETE, UPGRADE_INITIALIZATION_ERROR, PRE_FLIGHT_CHECKS_FAILED, UPGRADE_ERROR_ROLLING_BACK, UPGRADE_ERROR_ROLLED_BACK, UPGRADE_ERROR_ROLLBACK_FAILED, UPGRADE_ERROR_UNKNOWN, UPGRADE_TIMED_OUT,

upgradeStatusDetail

  

String

  

since

  

Date

 

date-time

11.6.7.32. UpgradeProcessStatusUpgradeProcessType
Copy link

  • UPGRADE: UPGRADE represents a sensor version upgrade.
  • CERT_ROTATION: CERT_ROTATION represents an upgrade process that only rotates the TLS certs used by the cluster, without changing anything else.
Expand
Enum Values

UPGRADE

CERT_ROTATION

11.6.7.33. UpgradeProgressUpgradeState
Copy link

  • UPGRADER_LAUNCHING: In-progress states.
  • UPGRADE_COMPLETE: The success state. PLEASE NUMBER ALL IN-PROGRESS STATES ABOVE THIS AND ALL ERROR STATES BELOW THIS.
  • UPGRADE_INITIALIZATION_ERROR: Error states.
Expand
Enum Values

UPGRADE_INITIALIZING

UPGRADER_LAUNCHING

UPGRADER_LAUNCHED

PRE_FLIGHT_CHECKS_COMPLETE

UPGRADE_OPERATIONS_DONE

UPGRADE_COMPLETE

UPGRADE_INITIALIZATION_ERROR

PRE_FLIGHT_CHECKS_FAILED

UPGRADE_ERROR_ROLLING_BACK

UPGRADE_ERROR_ROLLED_BACK

UPGRADE_ERROR_ROLLBACK_FAILED

UPGRADE_ERROR_UNKNOWN

UPGRADE_TIMED_OUT

11.6.7.34. V1ClusterResponse
Copy link

Expand
Field NameRequiredNullableTypeDescriptionFormat

cluster

  

StorageCluster

  

clusterRetentionInfo

  

V1DecommissionedClusterRetentionInfo

  

11.6.7.35. V1DecommissionedClusterRetentionInfo
Copy link

next available tag: 3
Expand
Field NameRequiredNullableTypeDescriptionFormat

isExcluded

  

Boolean

  

daysUntilDeletion

  

Integer

 

int32

11.7. PostCluster
Copy link

POST /v1/clusters

11.7.1. Description
Copy link

11.7.2. Parameters
Copy link

11.7.2.1. Body Parameter
Copy link

Expand
NameDescriptionRequiredDefaultPattern

body

StorageCluster

X

  

11.7.3. Return Type
Copy link

V1ClusterResponse

11.7.4. Content Type
Copy link

  • application/json

11.7.5. Responses
Copy link

Expand
Table 11.7. HTTP Response Codes
CodeMessageDatatype

200

A successful response.

V1ClusterResponse

0

An unexpected error response.

RuntimeError

11.7.6. Samples
Copy link

11.7.7. Common object reference
Copy link

11.7.7.1. ClusterHealthStatusHealthStatusLabel
Copy link

  • UNAVAILABLE: Only collector can have unavailable status
Expand
Enum Values

UNINITIALIZED

UNAVAILABLE

UNHEALTHY

DEGRADED

HEALTHY

11.7.7.2. ClusterUpgradeStatusUpgradability
Copy link

  • SENSOR_VERSION_HIGHER: SENSOR_VERSION_HIGHER occurs when we detect that the sensor is running a newer version than this Central. This is unexpected, but can occur depending on the patches a customer does. In this case, we will NOT automatically "upgrade" the sensor, since that would be a downgrade, even if the autoupgrade setting is on. The user will be allowed to manually trigger the upgrade, but they are strongly discouraged from doing so without upgrading Central first, since this is an unsupported configuration.
Expand
Enum Values

UNSET

UP_TO_DATE

MANUAL_UPGRADE_REQUIRED

AUTO_UPGRADE_POSSIBLE

SENSOR_VERSION_HIGHER

11.7.7.3. ClusterUpgradeStatusUpgradeProcessStatus
Copy link

Expand
Field NameRequiredNullableTypeDescriptionFormat

active

  

Boolean

  

id

  

String

  

targetVersion

  

String

  

upgraderImage

  

String

  

initiatedAt

  

Date

 

date-time

progress

  

StorageUpgradeProgress

  

type

  

UpgradeProcessStatusUpgradeProcessType

 

UPGRADE, CERT_ROTATION,

11.7.7.4. ProtobufAny
Copy link

Any contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message.

Protobuf library provides support to pack/unpack Any values in the form of utility functions or additional generated methods of the Any type.

Example 1: Pack and unpack a message in C++. 

Foo foo = ...;
Any any;
any.PackFrom(foo);
...
if (any.UnpackTo(&foo)) {
  ...
}

Example 2: Pack and unpack a message in Java. 

Foo foo = ...;
Any any = Any.pack(foo);
...
if (any.is(Foo.class)) {
  foo = any.unpack(Foo.class);
}
// or ...
if (any.isSameTypeAs(Foo.getDefaultInstance())) {
  foo = any.unpack(Foo.getDefaultInstance());
}
 
Example 3: Pack and unpack a message in Python.
 
foo = Foo(...)
any = Any()
any.Pack(foo)
...
if any.Is(Foo.DESCRIPTOR):
  any.Unpack(foo)
  ...
 
Example 4: Pack and unpack a message in Go
 
foo := &pb.Foo{...}
any, err := anypb.New(foo)
if err != nil {
  ...
}
...
foo := &pb.Foo{}
if err := any.UnmarshalTo(foo); err != nil {
  ...
}

The pack methods provided by protobuf library will by default use 'type.googleapis.com/full.type.name' as the type URL and the unpack methods only use the fully qualified type name after the last '/' in the type URL, for example "foo.bar.com/x/y.z" will yield type name "y.z".

11.7.7.4.1. JSON representation
Copy link

The JSON representation of an Any value uses the regular representation of the deserialized, embedded message, with an additional field @type which contains the type URL. Example: 

package google.profile;
message Person {
  string first_name = 1;
  string last_name = 2;
}
 
{
  "@type": "type.googleapis.com/google.profile.Person",
  "firstName": <string>,
  "lastName": <string>
}

If the embedded message type is well-known and has a custom JSON representation, that representation will be embedded adding a field value which holds the custom JSON in addition to the @type field. Example (for message [google.protobuf.Duration][]): 

{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}
Expand
Field NameRequiredNullableTypeDescriptionFormat

typeUrl

  

String

A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one \"/\" character. The last segment of the URL’s path must represent the fully qualified name of the type (as in path/google.protobuf.Duration). The name should be in a canonical form (e.g., leading \".\" is not accepted). In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme http, https, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows: * If no scheme is provided, https is assumed. * An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error. * Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.) Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com. As of May 2023, there are no widely used type server implementations and no plans to implement one. Schemes other than http, https (or the empty scheme) might be used with implementation specific semantics.

 

value

  

byte[]

Must be a valid serialized protocol buffer of the above specified type.

byte

11.7.7.5. RuntimeError
Copy link

Expand
Field NameRequiredNullableTypeDescriptionFormat

error

  

String

  

code

  

Integer

 

int32

message

  

String

  

details

  

List of ProtobufAny

  

11.7.7.6. StorageAWSProviderMetadata
Copy link

Expand
Field NameRequiredNullableTypeDescriptionFormat

accountId

  

String

  

11.7.7.7. StorageAdmissionControlHealthInfo
Copy link

AdmissionControlHealthInfo carries data about admission control deployment but does not include admission control health status derived from this data. Aggregated admission control health status is not included because it is derived in central and not in the component that first reports AdmissionControlHealthInfo (sensor).

Expand
Field NameRequiredNullableTypeDescriptionFormat

totalDesiredPods

  

Integer

 

int32

totalReadyPods

  

Integer

 

int32

statusErrors

  

List of string

Collection of errors that occurred while trying to obtain admission control health info.

 

11.7.7.8. StorageAdmissionControllerConfig
Copy link

Expand
Field NameRequiredNullableTypeDescriptionFormat

enabled

  

Boolean

  

timeoutSeconds

  

Integer

 

int32

scanInline

  

Boolean

  

disableBypass

  

Boolean

  

enforceOnUpdates

  

Boolean

  

11.7.7.9. StorageAuditLogFileState
Copy link

AuditLogFileState tracks the last audit log event timestamp and ID that was collected by Compliance For internal use only
Expand
Field NameRequiredNullableTypeDescriptionFormat

collectLogsSince

  

Date

 

date-time

lastAuditId

  

String

  

11.7.7.10. StorageAzureProviderMetadata
Copy link

Expand
Field NameRequiredNullableTypeDescriptionFormat

subscriptionId

  

String

  

11.7.7.11. StorageCluster
Copy link

Expand
Field NameRequiredNullableTypeDescriptionFormat

id

  

String

  

name

  

String

  

type

  

StorageClusterType

 

GENERIC_CLUSTER, KUBERNETES_CLUSTER, OPENSHIFT_CLUSTER, OPENSHIFT4_CLUSTER,

labels

  

Map of string

  

mainImage

  

String

  

collectorImage

  

String

  

centralApiEndpoint

  

String

  

runtimeSupport

  

Boolean

  

collectionMethod

  

StorageCollectionMethod

 

UNSET_COLLECTION, NO_COLLECTION, KERNEL_MODULE, EBPF, CORE_BPF,

admissionController

  

Boolean

  

admissionControllerUpdates

  

Boolean

  

admissionControllerEvents

  

Boolean

  

status

  

StorageClusterStatus

  

dynamicConfig

  

StorageDynamicClusterConfig

  

tolerationsConfig

  

StorageTolerationsConfig

  

priority

  

String

 

int64

healthStatus

  

StorageClusterHealthStatus

  

slimCollector

  

Boolean

  

helmConfig

  

StorageCompleteClusterConfig

  

mostRecentSensorId

  

StorageSensorDeploymentIdentification

  

auditLogState

  

Map of StorageAuditLogFileState

For internal use only.

 

initBundleId

  

String

  

managedBy

  

StorageManagerType

 

MANAGER_TYPE_UNKNOWN, MANAGER_TYPE_MANUAL, MANAGER_TYPE_HELM_CHART, MANAGER_TYPE_KUBERNETES_OPERATOR,

11.7.7.12. StorageClusterCertExpiryStatus
Copy link

Expand
Field NameRequiredNullableTypeDescriptionFormat

sensorCertExpiry

  

Date

 

date-time

sensorCertNotBefore

  

Date

 

date-time

11.7.7.13. StorageClusterHealthStatus
Copy link

Expand
Field NameRequiredNullableTypeDescriptionFormat

id

  

String

  

collectorHealthInfo

  

StorageCollectorHealthInfo

  

admissionControlHealthInfo

  

StorageAdmissionControlHealthInfo

  

scannerHealthInfo

  

StorageScannerHealthInfo

  

sensorHealthStatus

  

ClusterHealthStatusHealthStatusLabel

 

UNINITIALIZED, UNAVAILABLE, UNHEALTHY, DEGRADED, HEALTHY,

collectorHealthStatus

  

ClusterHealthStatusHealthStatusLabel

 

UNINITIALIZED, UNAVAILABLE, UNHEALTHY, DEGRADED, HEALTHY,

overallHealthStatus

  

ClusterHealthStatusHealthStatusLabel

 

UNINITIALIZED, UNAVAILABLE, UNHEALTHY, DEGRADED, HEALTHY,

admissionControlHealthStatus

  

ClusterHealthStatusHealthStatusLabel

 

UNINITIALIZED, UNAVAILABLE, UNHEALTHY, DEGRADED, HEALTHY,

scannerHealthStatus

  

ClusterHealthStatusHealthStatusLabel

 

UNINITIALIZED, UNAVAILABLE, UNHEALTHY, DEGRADED, HEALTHY,

lastContact

  

Date

 

date-time

healthInfoComplete

  

Boolean

  

11.7.7.14. StorageClusterMetadata
Copy link

ClusterMetadata contains metadata information about the cluster infrastructure.

Expand
Field NameRequiredNullableTypeDescriptionFormat

type

  

StorageClusterMetadataType

 

UNSPECIFIED, AKS, ARO, EKS, GKE, OCP, OSD, ROSA,

name

  

String

Name represents the name under which the cluster is registered with the cloud provider. In case of self managed OpenShift it is the name chosen by the OpenShift installer.

 

id

  

String

Id represents a unique ID under which the cluster is registered with the cloud provider. Not all cluster types have an id. For all OpenShift clusters, this is the Red Hat cluster_id registered with OCM.

 

11.7.7.15. StorageClusterMetadataType
Copy link

Expand
Enum Values

UNSPECIFIED

AKS

ARO

EKS

GKE

OCP

OSD

ROSA

11.7.7.16. StorageClusterStatus
Copy link

Expand
Field NameRequiredNullableTypeDescriptionFormat

sensorVersion

  

String

  

DEPRECATEDLastContact

  

Date

This field has been deprecated starting release 49.0. Use healthStatus.lastContact instead.

date-time

providerMetadata

  

StorageProviderMetadata

  

orchestratorMetadata

  

StorageOrchestratorMetadata

  

upgradeStatus

  

StorageClusterUpgradeStatus

  

certExpiryStatus

  

StorageClusterCertExpiryStatus

  

11.7.7.17. StorageClusterType
Copy link

Expand
Enum Values

GENERIC_CLUSTER

KUBERNETES_CLUSTER

OPENSHIFT_CLUSTER

OPENSHIFT4_CLUSTER

11.7.7.18. StorageClusterUpgradeStatus
Copy link

Expand
Field NameRequiredNullableTypeDescriptionFormat

upgradability

  

ClusterUpgradeStatusUpgradability

 

UNSET, UP_TO_DATE, MANUAL_UPGRADE_REQUIRED, AUTO_UPGRADE_POSSIBLE, SENSOR_VERSION_HIGHER,

upgradabilityStatusReason

  

String

  

mostRecentProcess

  

ClusterUpgradeStatusUpgradeProcessStatus

  

11.7.7.19. StorageCollectionMethod
Copy link

Expand
Enum Values

UNSET_COLLECTION

NO_COLLECTION

KERNEL_MODULE

EBPF

CORE_BPF

11.7.7.20. StorageCollectorHealthInfo
Copy link

CollectorHealthInfo carries data about collector deployment but does not include collector health status derived from this data. Aggregated collector health status is not included because it is derived in central and not in the component that first reports CollectorHealthInfo (sensor).

Expand
Field NameRequiredNullableTypeDescriptionFormat

version

  

String

  

totalDesiredPods

  

Integer

 

int32

totalReadyPods

  

Integer

 

int32

totalRegisteredNodes

  

Integer

 

int32

statusErrors

  

List of string

Collection of errors that occurred while trying to obtain collector health info.

 

11.7.7.21. StorageCompleteClusterConfig
Copy link

Encodes a complete cluster configuration minus ID/Name identifiers including static and dynamic settings.

Expand
Field NameRequiredNullableTypeDescriptionFormat

dynamicConfig

  

StorageDynamicClusterConfig

  

staticConfig

  

StorageStaticClusterConfig

  

configFingerprint

  

String

  

clusterLabels

  

Map of string

  

11.7.7.22. StorageDynamicClusterConfig
Copy link

The difference between Static and Dynamic cluster config is that Dynamic values are sent over the Central to Sensor gRPC connection. This has the benefit of allowing for "hot reloading" of values without restarting Secured cluster components.

Expand
Field NameRequiredNullableTypeDescriptionFormat

admissionControllerConfig

  

StorageAdmissionControllerConfig

  

registryOverride

  

String

  

disableAuditLogs

  

Boolean

  

11.7.7.23. StorageGoogleProviderMetadata
Copy link

Expand
Field NameRequiredNullableTypeDescriptionFormat

project

  

String

  

clusterName

  

String

Deprecated in favor of providerMetadata.cluster.name.

 

11.7.7.24. StorageManagerType
Copy link

Expand
Enum Values

MANAGER_TYPE_UNKNOWN

MANAGER_TYPE_MANUAL

MANAGER_TYPE_HELM_CHART

MANAGER_TYPE_KUBERNETES_OPERATOR

11.7.7.25. StorageOrchestratorMetadata
Copy link

Expand
Field NameRequiredNullableTypeDescriptionFormat

version

  

String

  

openshiftVersion

  

String

  

buildDate

  

Date

 

date-time

apiVersions

  

List of string

  

11.7.7.26. StorageProviderMetadata
Copy link

Expand
Field NameRequiredNullableTypeDescriptionFormat

region

  

String

  

zone

  

String

  

google

  

StorageGoogleProviderMetadata

  

aws

  

StorageAWSProviderMetadata

  

azure

  

StorageAzureProviderMetadata

  

verified

  

Boolean

  

cluster

  

StorageClusterMetadata

  

11.7.7.27. StorageScannerHealthInfo
Copy link

ScannerHealthInfo represents health info of a scanner instance that is deployed on a secured cluster (so called "local scanner"). When the scanner is deployed on a central cluster, the following message is NOT used. ScannerHealthInfo carries data about scanner deployment but does not include scanner health status derived from this data. Aggregated scanner health status is not included because it is derived in central and not in the component that first reports ScannerHealthInfo (sensor).

Expand
Field NameRequiredNullableTypeDescriptionFormat

totalDesiredAnalyzerPods

  

Integer

 

int32

totalReadyAnalyzerPods

  

Integer

 

int32

totalDesiredDbPods

  

Integer

 

int32

totalReadyDbPods

  

Integer

 

int32

statusErrors

  

List of string

Collection of errors that occurred while trying to obtain scanner health info.

 

11.7.7.28. StorageSensorDeploymentIdentification
Copy link

StackRoxDeploymentIdentification aims at uniquely identifying a StackRox Sensor deployment. It is used to determine whether a sensor connection comes from a sensor pod that has restarted or was recreated (possibly after a network partition), or from a deployment in a different namespace or cluster.

Expand
Field NameRequiredNullableTypeDescriptionFormat

systemNamespaceId

  

String

  

defaultNamespaceId

  

String

  

appNamespace

  

String

  

appNamespaceId

  

String

  

appServiceaccountId

  

String

  

k8sNodeName

  

String

  

11.7.7.29. StorageStaticClusterConfig
Copy link

The difference between Static and Dynamic cluster config is that Static values are not sent over the Central to Sensor gRPC connection. They are used, for example, to generate manifests that can be used to set up the Secured Cluster’s k8s components. They are not dynamically reloaded.

Expand
Field NameRequiredNullableTypeDescriptionFormat

type

  

StorageClusterType

 

GENERIC_CLUSTER, KUBERNETES_CLUSTER, OPENSHIFT_CLUSTER, OPENSHIFT4_CLUSTER,

mainImage

  

String

  

centralApiEndpoint

  

String

  

collectionMethod

  

StorageCollectionMethod

 

UNSET_COLLECTION, NO_COLLECTION, KERNEL_MODULE, EBPF, CORE_BPF,

collectorImage

  

String

  

admissionController

  

Boolean

  

admissionControllerUpdates

  

Boolean

  

tolerationsConfig

  

StorageTolerationsConfig

  

slimCollector

  

Boolean

  

admissionControllerEvents

  

Boolean

  

11.7.7.30. StorageTolerationsConfig
Copy link

Expand
Field NameRequiredNullableTypeDescriptionFormat

disabled

  

Boolean

  

11.7.7.31. StorageUpgradeProgress
Copy link

Expand
Field NameRequiredNullableTypeDescriptionFormat

upgradeState

  

UpgradeProgressUpgradeState

 

UPGRADE_INITIALIZING, UPGRADER_LAUNCHING, UPGRADER_LAUNCHED, PRE_FLIGHT_CHECKS_COMPLETE, UPGRADE_OPERATIONS_DONE, UPGRADE_COMPLETE, UPGRADE_INITIALIZATION_ERROR, PRE_FLIGHT_CHECKS_FAILED, UPGRADE_ERROR_ROLLING_BACK, UPGRADE_ERROR_ROLLED_BACK, UPGRADE_ERROR_ROLLBACK_FAILED, UPGRADE_ERROR_UNKNOWN, UPGRADE_TIMED_OUT,

upgradeStatusDetail

  

String

  

since

  

Date

 

date-time

11.7.7.32. UpgradeProcessStatusUpgradeProcessType
Copy link

  • UPGRADE: UPGRADE represents a sensor version upgrade.
  • CERT_ROTATION: CERT_ROTATION represents an upgrade process that only rotates the TLS certs used by the cluster, without changing anything else.
Expand
Enum Values

UPGRADE

CERT_ROTATION

11.7.7.33. UpgradeProgressUpgradeState
Copy link

  • UPGRADER_LAUNCHING: In-progress states.
  • UPGRADE_COMPLETE: The success state. PLEASE NUMBER ALL IN-PROGRESS STATES ABOVE THIS AND ALL ERROR STATES BELOW THIS.
  • UPGRADE_INITIALIZATION_ERROR: Error states.
Expand
Enum Values

UPGRADE_INITIALIZING

UPGRADER_LAUNCHING

UPGRADER_LAUNCHED

PRE_FLIGHT_CHECKS_COMPLETE

UPGRADE_OPERATIONS_DONE

UPGRADE_COMPLETE

UPGRADE_INITIALIZATION_ERROR

PRE_FLIGHT_CHECKS_FAILED

UPGRADE_ERROR_ROLLING_BACK

UPGRADE_ERROR_ROLLED_BACK

UPGRADE_ERROR_ROLLBACK_FAILED

UPGRADE_ERROR_UNKNOWN

UPGRADE_TIMED_OUT

11.7.7.34. V1ClusterResponse
Copy link

Expand
Field NameRequiredNullableTypeDescriptionFormat

cluster

  

StorageCluster

  

clusterRetentionInfo

  

V1DecommissionedClusterRetentionInfo

  

11.7.7.35. V1DecommissionedClusterRetentionInfo
Copy link

next available tag: 3
Expand
Field NameRequiredNullableTypeDescriptionFormat

isExcluded

  

Boolean

  

daysUntilDeletion

  

Integer

 

int32

Red Hat logoGithubredditYoutubeTwitter

Learn

Try, buy, & sell

Communities

About Red Hat

We deliver hardened solutions that make it easier for enterprises to work across platforms and environments, from the core datacenter to the network edge.

Making open source more inclusive

Red Hat is committed to replacing problematic language in our code, documentation, and web properties. For more details, see the Red Hat Blog.

About Red Hat Documentation

We help Red Hat users innovate and achieve their goals with our products and services with content they can trust. Explore our recent updates.

Legal Notice

Theme

© 2026 Red HatBack to top