Home
Products
Red Hat Advanced Cluster Security for Kubernetes
4.5
API reference
Chapter 3. AlertService

Chapter 3. AlertService

3.1. CountAlerts
Copy link

GET /v1/alertscount

CountAlerts counts how many alerts match the get request.

3.1.2. Parameters
Copy link

3.1.2.1. Query Parameters
Copy link

Expand

Name	Required	Default
query	-	null
pagination.limit	-	null
pagination.offset	-	null
pagination.sortOption.field	-	null
pagination.sortOption.reversed	-	null
pagination.sortOption.aggregateBy.aggrFunc	-	UNSET
pagination.sortOption.aggregateBy.distinct	-	null

3.1.5. Responses
Copy link

Expand

Table 3.1. HTTP Response Codes
Code	Message	Datatype
200	A successful response.	V1CountAlertsResponse
0	An unexpected error response.	RuntimeError

3.1.7. Common object reference
Copy link

3.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".

3.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 Name	Required	Nullable	Type	Description	Format
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

3.1.7.2. RuntimeError
Copy link

Expand

Field Name	Type	Format
error	String
code	Integer	int32
message	String
details	List of ProtobufAny

3.1.7.3. V1CountAlertsResponse
Copy link

Expand

Field Name	Required	Nullable	Type	Description	Format
count			Integer		int32

3.2. DeleteAlerts
Copy link

DELETE /v1/alerts

3.2.1. Description
Copy link

3.2.2. Parameters
Copy link

3.2.2.1. Query Parameters
Copy link

Expand

Name	Required	Default
query.query	-	null
query.pagination.limit	-	null
query.pagination.offset	-	null
query.pagination.sortOption.field	-	null
query.pagination.sortOption.reversed	-	null
query.pagination.sortOption.aggregateBy.aggrFunc	-	UNSET
query.pagination.sortOption.aggregateBy.distinct	-	null
confirm	-	null

3.2.3. Return Type
Copy link

V1DeleteAlertsResponse

3.2.4. Content Type
Copy link

application/json

3.2.5. Responses
Copy link

Expand

Table 3.2. HTTP Response Codes
Code	Message	Datatype
200	A successful response.	V1DeleteAlertsResponse
0	An unexpected error response.	RuntimeError

3.2.6. Samples
Copy link

3.2.7. Common object reference
Copy link

3.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 {
  ...
}

3.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>
}

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

Expand

Field Name	Required	Nullable	Type	Description	Format
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

3.2.7.2. RuntimeError
Copy link

Expand

Field Name	Type	Format
error	String
code	Integer	int32
message	String
details	List of ProtobufAny

3.2.7.3. V1DeleteAlertsResponse
Copy link

Expand

Field Name	Required	Nullable	Type	Description	Format
numDeleted			Long		int64
dryRun			Boolean

3.3. ListAlerts
Copy link

GET /v1/alerts

List returns the slim list version of the alerts.

3.3.1. Description
Copy link

3.3.2. Parameters
Copy link

3.3.2.1. Query Parameters
Copy link

Expand

Name	Required	Default
query	-	null
pagination.limit	-	null
pagination.offset	-	null
pagination.sortOption.field	-	null
pagination.sortOption.reversed	-	null
pagination.sortOption.aggregateBy.aggrFunc	-	UNSET
pagination.sortOption.aggregateBy.distinct	-	null

3.3.3. Return Type
Copy link

V1ListAlertsResponse

3.3.4. Content Type
Copy link

application/json

3.3.5. Responses
Copy link

Expand

Table 3.3. HTTP Response Codes
Code	Message	Datatype
200	A successful response.	V1ListAlertsResponse
0	An unexpected error response.	RuntimeError

3.3.6. Samples
Copy link

3.3.7. Common object reference
Copy link

3.3.7.1. ListAlertCommonEntityInfo
Copy link

Fields common to all entities that an alert might belong to.

Expand

Field Name	Type	Format
clusterName	String
namespace	String
clusterId	String
namespaceId	String
resourceType	StorageListAlertResourceType	DEPLOYMENT, SECRETS, CONFIGMAPS, CLUSTER_ROLES, CLUSTER_ROLE_BINDINGS, NETWORK_POLICIES, SECURITY_CONTEXT_CONSTRAINTS, EGRESS_FIREWALLS,

3.3.7.2. ListAlertPolicyDevFields
Copy link

Expand

Field Name	Required	Nullable	Type	Description	Format
SORTName			String

3.3.7.3. ListAlertResourceEntity
Copy link

Expand

Field Name	Required	Nullable	Type	Description	Format
name			String

3.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 {
  ...
}

3.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>
}

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

Expand

Field Name	Required	Nullable	Type	Description	Format
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

3.3.7.5. RuntimeError
Copy link

Expand

Field Name	Type	Format
error	String
code	Integer	int32
message	String
details	List of ProtobufAny

3.3.7.6. StorageEnforcementAction
Copy link

FAIL_KUBE_REQUEST_ENFORCEMENT: FAIL_KUBE_REQUEST_ENFORCEMENT takes effect only if admission control webhook is enabled to listen on exec and port-forward events.
FAIL_DEPLOYMENT_CREATE_ENFORCEMENT: FAIL_DEPLOYMENT_CREATE_ENFORCEMENT takes effect only if admission control webhook is configured to enforce on object creates.
FAIL_DEPLOYMENT_UPDATE_ENFORCEMENT: FAIL_DEPLOYMENT_UPDATE_ENFORCEMENT takes effect only if admission control webhook is configured to enforce on object updates.

Expand

Enum Values
UNSET_ENFORCEMENT
SCALE_TO_ZERO_ENFORCEMENT
UNSATISFIABLE_NODE_CONSTRAINT_ENFORCEMENT
KILL_POD_ENFORCEMENT
FAIL_BUILD_ENFORCEMENT
FAIL_KUBE_REQUEST_ENFORCEMENT
FAIL_DEPLOYMENT_CREATE_ENFORCEMENT
FAIL_DEPLOYMENT_UPDATE_ENFORCEMENT

3.3.7.7. StorageLifecycleStage
Copy link

Expand

Enum Values
DEPLOY
BUILD
RUNTIME

3.3.7.8. StorageListAlert
Copy link

Expand

Field Name	Type	Format
id	String
lifecycleStage	StorageLifecycleStage	DEPLOY, BUILD, RUNTIME,
time	Date	date-time
policy	StorageListAlertPolicy
state	StorageViolationState	ACTIVE, SNOOZED, RESOLVED, ATTEMPTED,
enforcementCount	Integer	int32
enforcementAction	StorageEnforcementAction	UNSET_ENFORCEMENT, SCALE_TO_ZERO_ENFORCEMENT, UNSATISFIABLE_NODE_CONSTRAINT_ENFORCEMENT, KILL_POD_ENFORCEMENT, FAIL_BUILD_ENFORCEMENT, FAIL_KUBE_REQUEST_ENFORCEMENT, FAIL_DEPLOYMENT_CREATE_ENFORCEMENT, FAIL_DEPLOYMENT_UPDATE_ENFORCEMENT,
commonEntityInfo	ListAlertCommonEntityInfo
deployment	StorageListAlertDeployment
resource	ListAlertResourceEntity

3.3.7.9. StorageListAlertDeployment
Copy link

Expand

Field Name	Type	Description
id	String
name	String
clusterName	String	This field is deprecated and can be found in CommonEntityInfo. It will be removed from here in a future release.
namespace	String	This field is deprecated and can be found in CommonEntityInfo. It will be removed from here in a future release.
clusterId	String	This field is deprecated and can be found in CommonEntityInfo. It will be removed from here in a future release.
inactive	Boolean
namespaceId	String	This field is deprecated and can be found in CommonEntityInfo. It will be removed from here in a future release.

3.3.7.10. StorageListAlertPolicy
Copy link

Expand

Field Name	Type	Format
id	String
name	String
severity	StorageSeverity	UNSET_SEVERITY, LOW_SEVERITY, MEDIUM_SEVERITY, HIGH_SEVERITY, CRITICAL_SEVERITY,
description	String
categories	List of `string`
developerInternalFields	ListAlertPolicyDevFields

3.3.7.11. StorageListAlertResourceType
Copy link

A special ListAlert-only enumeration of all resource types. Unlike Alert.Resource.ResourceType this also includes deployment as a type This must be kept in sync with Alert.Resource.ResourceType (excluding the deployment value)

Expand

Enum Values
DEPLOYMENT
SECRETS
CONFIGMAPS
CLUSTER_ROLES
CLUSTER_ROLE_BINDINGS
NETWORK_POLICIES
SECURITY_CONTEXT_CONSTRAINTS
EGRESS_FIREWALLS

3.3.7.12. StorageSeverity
Copy link

Expand

Enum Values
UNSET_SEVERITY
LOW_SEVERITY
MEDIUM_SEVERITY
HIGH_SEVERITY
CRITICAL_SEVERITY

3.3.7.13. StorageViolationState
Copy link

Expand

Enum Values
ACTIVE
SNOOZED
RESOLVED
ATTEMPTED

3.3.7.14. V1ListAlertsResponse
Copy link

Expand

Field Name	Required	Nullable	Type	Description	Format
alerts			List of StorageListAlert

3.4. GetAlert
Copy link

GET /v1/alerts/{id}

GetAlert returns the alert given its id.

3.4.1. Description
Copy link

3.4.2. Parameters
Copy link

3.4.2.1. Path Parameters
Copy link

Expand

Name	Description	Required	Default	Pattern
id		X	null

3.4.3. Return Type
Copy link

StorageAlert

3.4.4. Content Type
Copy link

application/json

3.4.5. Responses
Copy link

Expand

Table 3.4. HTTP Response Codes
Code	Message	Datatype
200	A successful response.	StorageAlert
0	An unexpected error response.	RuntimeError

3.4.6. Samples
Copy link

3.4.7. Common object reference
Copy link

3.4.7.1. AlertDeploymentContainer
Copy link

Expand

Field Name	Required	Nullable	Type	Description	Format
image			StorageContainerImage
name			String

3.4.7.2. AlertEnforcement
Copy link

Expand

Field Name	Required	Nullable	Type	Description	Format
action			StorageEnforcementAction		UNSET_ENFORCEMENT, SCALE_TO_ZERO_ENFORCEMENT, UNSATISFIABLE_NODE_CONSTRAINT_ENFORCEMENT, KILL_POD_ENFORCEMENT, FAIL_BUILD_ENFORCEMENT, FAIL_KUBE_REQUEST_ENFORCEMENT, FAIL_DEPLOYMENT_CREATE_ENFORCEMENT, FAIL_DEPLOYMENT_UPDATE_ENFORCEMENT,
message			String

3.4.7.3. AlertProcessViolation
Copy link

Expand

Field Name	Required	Nullable	Type	Description	Format
message			String
processes			List of StorageProcessIndicator

3.4.7.4. AlertResourceResourceType
Copy link

Expand

Enum Values
UNKNOWN
SECRETS
CONFIGMAPS
CLUSTER_ROLES
CLUSTER_ROLE_BINDINGS
NETWORK_POLICIES
SECURITY_CONTEXT_CONSTRAINTS
EGRESS_FIREWALLS

3.4.7.5. AlertViolation
Copy link

Expand

Field Name	Type	Description	Format
message	String
keyValueAttrs	ViolationKeyValueAttrs
networkFlowInfo	ViolationNetworkFlowInfo
type	AlertViolationType		GENERIC, K8S_EVENT, NETWORK_FLOW, NETWORK_POLICY,
time	Date	Indicates violation time. This field differs from top-level field 'time' which represents last time the alert occurred in case of multiple occurrences of the policy alert. As of 55.0, this field is set only for kubernetes event violations, but may not be limited to it in future.	date-time

3.4.7.6. AlertViolationType
Copy link

Expand

Enum Values
GENERIC
K8S_EVENT
NETWORK_FLOW
NETWORK_POLICY

3.4.7.7. KeyValueAttrsKeyValueAttr
Copy link

Expand

Field Name	Required	Nullable	Type	Description	Format
key			String
value			String

3.4.7.8. NetworkFlowInfoEntity
Copy link

Expand

Field Name	Type	Format
name	String
entityType	StorageNetworkEntityInfoType	UNKNOWN_TYPE, DEPLOYMENT, INTERNET, LISTEN_ENDPOINT, EXTERNAL_SOURCE, INTERNAL_ENTITIES,
deploymentNamespace	String
deploymentType	String
port	Integer	int32

3.4.7.9. PolicyMitreAttackVectors
Copy link

Expand

Field Name	Required	Nullable	Type	Description	Format
tactic			String
techniques			List of `string`

3.4.7.10. ProcessSignalLineageInfo
Copy link

Expand

Field Name	Required	Nullable	Type	Description	Format
parentUid			Long		int64
parentExecFilePath			String

3.4.7.11. 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 {
  ...
}

3.4.7.11.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>
}

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

Expand

Field Name	Required	Nullable	Type	Description	Format
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

3.4.7.12. RuntimeError
Copy link

Expand

Field Name	Type	Format
error	String
code	Integer	int32
message	String
details	List of ProtobufAny

3.4.7.13. StorageAlert
Copy link

Expand

Field Name	Type	Description	Format
id	String
policy	StoragePolicy
lifecycleStage	StorageLifecycleStage		DEPLOY, BUILD, RUNTIME,
clusterId	String
clusterName	String
namespace	String
namespaceId	String
deployment	StorageAlertDeployment
image	StorageContainerImage
resource	StorageAlertResource
violations	List of AlertViolation	For run-time phase alert, a maximum of 40 violations are retained.
processViolation	AlertProcessViolation
enforcement	AlertEnforcement
time	Date		date-time
firstOccurred	Date		date-time
resolvedAt	Date	The time at which the alert was resolved. Only set if ViolationState is RESOLVED.	date-time
state	StorageViolationState		ACTIVE, SNOOZED, RESOLVED, ATTEMPTED,
snoozeTill	Date		date-time

3.4.7.14. StorageAlertDeployment
Copy link

Expand

Field Name	Required	Nullable	Type	Description	Format
id			String
name			String
type			String
namespace			String
namespaceId			String
labels			Map of `string`
clusterId			String
clusterName			String
containers			List of AlertDeploymentContainer
annotations			Map of `string`
inactive			Boolean

3.4.7.15. StorageAlertResource
Copy link

Represents an alert on a kubernetes resource other than a deployment (configmaps, secrets, etc.)

Expand

Field Name	Type	Format
resourceType	AlertResourceResourceType	UNKNOWN, SECRETS, CONFIGMAPS, CLUSTER_ROLES, CLUSTER_ROLE_BINDINGS, NETWORK_POLICIES, SECURITY_CONTEXT_CONSTRAINTS, EGRESS_FIREWALLS,
name	String
clusterId	String
clusterName	String
namespace	String
namespaceId	String

3.4.7.16. StorageBooleanOperator
Copy link

Expand

Enum Values
OR
AND

3.4.7.17. StorageContainerImage
Copy link

Next tag: 12

Expand

Field Name	Required	Nullable	Type	Description	Format
id			String
name			StorageImageName
notPullable			Boolean
isClusterLocal			Boolean

3.4.7.18. StorageEnforcementAction
Copy link

FAIL_KUBE_REQUEST_ENFORCEMENT: FAIL_KUBE_REQUEST_ENFORCEMENT takes effect only if admission control webhook is enabled to listen on exec and port-forward events.
FAIL_DEPLOYMENT_CREATE_ENFORCEMENT: FAIL_DEPLOYMENT_CREATE_ENFORCEMENT takes effect only if admission control webhook is configured to enforce on object creates.
FAIL_DEPLOYMENT_UPDATE_ENFORCEMENT: FAIL_DEPLOYMENT_UPDATE_ENFORCEMENT takes effect only if admission control webhook is configured to enforce on object updates.

Expand

Enum Values
UNSET_ENFORCEMENT
SCALE_TO_ZERO_ENFORCEMENT
UNSATISFIABLE_NODE_CONSTRAINT_ENFORCEMENT
KILL_POD_ENFORCEMENT
FAIL_BUILD_ENFORCEMENT
FAIL_KUBE_REQUEST_ENFORCEMENT
FAIL_DEPLOYMENT_CREATE_ENFORCEMENT
FAIL_DEPLOYMENT_UPDATE_ENFORCEMENT

3.4.7.19. StorageEventSource
Copy link

Expand

Enum Values
NOT_APPLICABLE
DEPLOYMENT_EVENT
AUDIT_LOG_EVENT

3.4.7.20. StorageExclusion
Copy link

Expand

Field Name	Type	Format
name	String
deployment	StorageExclusionDeployment
image	StorageExclusionImage
expiration	Date	date-time

3.4.7.21. StorageExclusionDeployment
Copy link

Expand

Field Name	Required	Nullable	Type	Description	Format
name			String
scope			StorageScope

3.4.7.22. StorageExclusionImage
Copy link

Expand

Field Name	Required	Nullable	Type	Description	Format
name			String

3.4.7.23. StorageImageName
Copy link

Expand

Field Name	Required	Nullable	Type	Description	Format
registry			String
remote			String
tag			String
fullName			String

3.4.7.24. StorageL4Protocol
Copy link

Expand

Enum Values
L4_PROTOCOL_UNKNOWN
L4_PROTOCOL_TCP
L4_PROTOCOL_UDP
L4_PROTOCOL_ICMP
L4_PROTOCOL_RAW
L4_PROTOCOL_SCTP
L4_PROTOCOL_ANY

3.4.7.25. StorageLifecycleStage
Copy link

Expand

Enum Values
DEPLOY
BUILD
RUNTIME

3.4.7.26. StorageNetworkEntityInfoType
Copy link

INTERNAL_ENTITIES: INTERNAL_ENTITIES is for grouping all internal entities under a single network graph node

Expand

Enum Values
UNKNOWN_TYPE
DEPLOYMENT
INTERNET
LISTEN_ENDPOINT
EXTERNAL_SOURCE
INTERNAL_ENTITIES

3.4.7.27. StoragePolicy
Copy link

Expand

Field Name	Type	Description	Format
id	String
name	String
description	String
rationale	String
remediation	String
disabled	Boolean
categories	List of `string`
lifecycleStages	List of StorageLifecycleStage
eventSource	StorageEventSource		NOT_APPLICABLE, DEPLOYMENT_EVENT, AUDIT_LOG_EVENT,
exclusions	List of StorageExclusion
scope	List of StorageScope
severity	StorageSeverity		UNSET_SEVERITY, LOW_SEVERITY, MEDIUM_SEVERITY, HIGH_SEVERITY, CRITICAL_SEVERITY,
enforcementActions	List of StorageEnforcementAction	FAIL_DEPLOYMENT_CREATE_ENFORCEMENT takes effect only if admission control webhook is configured to enforce on object creates/updates. FAIL_KUBE_REQUEST_ENFORCEMENT takes effect only if admission control webhook is enabled to listen on exec and port-forward events. FAIL_DEPLOYMENT_UPDATE_ENFORCEMENT takes effect only if admission control webhook is configured to enforce on object updates.
notifiers	List of `string`
lastUpdated	Date		date-time
SORTName	String	For internal use only.
SORTLifecycleStage	String	For internal use only.
SORTEnforcement	Boolean	For internal use only.
policyVersion	String
policySections	List of StoragePolicySection
mitreAttackVectors	List of PolicyMitreAttackVectors
criteriaLocked	Boolean	Read-only field. If true, the policy’s criteria fields are rendered read-only.
mitreVectorsLocked	Boolean	Read-only field. If true, the policy’s MITRE ATT&CK fields are rendered read-only.
isDefault	Boolean	Read-only field. Indicates the policy is a default policy if true and a custom policy if false.

3.4.7.28. StoragePolicyGroup
Copy link

Expand

Field Name	Type	Format
fieldName	String
booleanOperator	StorageBooleanOperator	OR, AND,
negate	Boolean
values	List of StoragePolicyValue

3.4.7.29. StoragePolicySection
Copy link

Expand

Field Name	Required	Nullable	Type	Description	Format
sectionName			String
policyGroups			List of StoragePolicyGroup

3.4.7.30. StoragePolicyValue
Copy link

Expand

Field Name	Required	Nullable	Type	Description	Format
value			String

3.4.7.31. StorageProcessIndicator
Copy link

Next available tag: 13

Expand

Field Name	Type	Format
id	String
deploymentId	String
containerName	String
podId	String
podUid	String
signal	StorageProcessSignal
clusterId	String
namespace	String
containerStartTime	Date	date-time
imageId	String

3.4.7.32. StorageProcessSignal
Copy link

Expand

Field Name	Type	Description	Format
id	String	A unique UUID for identifying the message We have this here instead of at the top level because we want to have each message to be self contained.
containerId	String
time	Date		date-time
name	String
args	String
execFilePath	String
pid	Long		int64
uid	Long		int64
gid	Long		int64
lineage	List of `string`
scraped	Boolean
lineageInfo	List of ProcessSignalLineageInfo

3.4.7.33. StorageScope
Copy link

Expand

Field Name	Required	Nullable	Type	Description	Format
cluster			String
namespace			String
label			StorageScopeLabel

3.4.7.34. StorageScopeLabel
Copy link

Expand

Field Name	Required	Nullable	Type	Description	Format
key			String
value			String

3.4.7.35. StorageSeverity
Copy link

Expand

Enum Values
UNSET_SEVERITY
LOW_SEVERITY
MEDIUM_SEVERITY
HIGH_SEVERITY
CRITICAL_SEVERITY

3.4.7.36. StorageViolationState
Copy link

Expand

Enum Values
ACTIVE
SNOOZED
RESOLVED
ATTEMPTED

3.4.7.37. ViolationKeyValueAttrs
Copy link

Expand

Field Name	Required	Nullable	Type	Description	Format
attrs			List of KeyValueAttrsKeyValueAttr

3.4.7.38. ViolationNetworkFlowInfo
Copy link

Expand

Field Name	Type	Format
protocol	StorageL4Protocol	L4_PROTOCOL_UNKNOWN, L4_PROTOCOL_TCP, L4_PROTOCOL_UDP, L4_PROTOCOL_ICMP, L4_PROTOCOL_RAW, L4_PROTOCOL_SCTP, L4_PROTOCOL_ANY,
source	NetworkFlowInfoEntity
destination	NetworkFlowInfoEntity

3.5. ResolveAlert
Copy link

PATCH /v1/alerts/{id}/resolve

ResolveAlert marks the given alert (by ID) as resolved.

3.5.1. Description
Copy link

3.5.2. Parameters
Copy link

3.5.2.1. Path Parameters
Copy link

Expand

Name	Description	Required	Default	Pattern
id		X	null

3.5.2.2. Body Parameter
Copy link

Expand

Name	Description	Required	Default	Pattern
body	V1ResolveAlertRequest	X

3.5.3. Return Type
Copy link

Object

3.5.4. Content Type
Copy link

application/json

3.5.5. Responses
Copy link

Expand

Table 3.5. HTTP Response Codes
Code	Message	Datatype
200	A successful response.	`Object`
0	An unexpected error response.	RuntimeError

3.5.6. Samples
Copy link

3.5.7. Common object reference
Copy link

3.5.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 {
  ...
}

3.5.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>
}

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

Expand

Field Name	Required	Nullable	Type	Description	Format
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

3.5.7.2. RuntimeError
Copy link

Expand

Field Name	Type	Format
error	String
code	Integer	int32
message	String
details	List of ProtobufAny

3.5.7.3. V1ResolveAlertRequest
Copy link

Expand

Field Name	Required	Nullable	Type	Description	Format
id			String
whitelist			Boolean
addToBaseline			Boolean

3.6. SnoozeAlert
Copy link

PATCH /v1/alerts/{id}/snooze

SnoozeAlert is deprecated.

3.6.1. Description
Copy link

3.6.2. Parameters
Copy link

3.6.2.1. Path Parameters
Copy link

Expand

Name	Description	Required	Default	Pattern
id		X	null

3.6.2.2. Body Parameter
Copy link

Expand

Name	Description	Required	Default	Pattern
body	V1SnoozeAlertRequest	X

3.6.3. Return Type
Copy link

Object

3.6.4. Content Type
Copy link

application/json

3.6.5. Responses
Copy link

Expand

Table 3.6. HTTP Response Codes
Code	Message	Datatype
200	A successful response.	`Object`
0	An unexpected error response.	RuntimeError

3.6.6. Samples
Copy link

3.6.7. Common object reference
Copy link

3.6.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 {
  ...
}

3.6.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>
}

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

Expand

Field Name	Required	Nullable	Type	Description	Format
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

3.6.7.2. RuntimeError
Copy link

Expand

Field Name	Type	Format
error	String
code	Integer	int32
message	String
details	List of ProtobufAny

3.6.7.3. V1SnoozeAlertRequest
Copy link

Expand

Field Name	Required	Nullable	Type	Description	Format
id			String
snoozeTill			Date		date-time

3.7. ResolveAlerts
Copy link

PATCH /v1/alerts/resolve

ResolveAlertsByQuery marks alerts matching search query as resolved.

3.7.1. Description
Copy link

3.7.2. Parameters
Copy link

3.7.2.1. Body Parameter
Copy link

Expand

Name	Description	Required	Default	Pattern
body	V1ResolveAlertsRequest	X

3.7.3. Return Type
Copy link

Object

3.7.4. Content Type
Copy link

application/json

3.7.5. Responses
Copy link

Expand

Table 3.7. HTTP Response Codes
Code	Message	Datatype
200	A successful response.	`Object`
0	An unexpected error response.	RuntimeError

3.7.6. Samples
Copy link

3.7.7. Common object reference
Copy link

3.7.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 {
  ...
}

3.7.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>
}

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

Expand

Field Name	Required	Nullable	Type	Description	Format
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

3.7.7.2. RuntimeError
Copy link

Expand

Field Name	Type	Format
error	String
code	Integer	int32
message	String
details	List of ProtobufAny

3.7.7.3. V1ResolveAlertsRequest
Copy link

Expand

Field Name	Required	Nullable	Type	Description	Format
query			String

3.8. GetAlertsCounts
Copy link

GET /v1/alerts/summary/counts

GetAlertsCounts returns the number of alerts in the requested cluster or category.

3.8.1. Description
Copy link

3.8.2. Parameters
Copy link

3.8.2.1. Query Parameters
Copy link

Expand

Name	Required	Default
request.query	-	null
request.pagination.limit	-	null
request.pagination.offset	-	null
request.pagination.sortOption.field	-	null
request.pagination.sortOption.reversed	-	null
request.pagination.sortOption.aggregateBy.aggrFunc	-	UNSET
request.pagination.sortOption.aggregateBy.distinct	-	null
groupBy	-	UNSET

3.8.3. Return Type
Copy link

V1GetAlertsCountsResponse

3.8.4. Content Type
Copy link

application/json

3.8.5. Responses
Copy link

Expand

Table 3.8. HTTP Response Codes
Code	Message	Datatype
200	A successful response.	V1GetAlertsCountsResponse
0	An unexpected error response.	RuntimeError

3.8.6. Samples
Copy link

3.8.7. Common object reference
Copy link

3.8.7.1. AlertGroupAlertCounts
Copy link

Expand

Field Name	Required	Nullable	Type	Description	Format
severity			StorageSeverity		UNSET_SEVERITY, LOW_SEVERITY, MEDIUM_SEVERITY, HIGH_SEVERITY, CRITICAL_SEVERITY,
count			String		int64

3.8.7.2. GetAlertsCountsResponseAlertGroup
Copy link

Expand

Field Name	Required	Nullable	Type	Description	Format
group			String
counts			List of AlertGroupAlertCounts

3.8.7.3. 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 {
  ...
}

3.8.7.3.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>
}

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

Expand

Field Name	Required	Nullable	Type	Description	Format
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

3.8.7.4. RuntimeError
Copy link

Expand

Field Name	Type	Format
error	String
code	Integer	int32
message	String
details	List of ProtobufAny

3.8.7.5. StorageSeverity
Copy link

Expand

Enum Values
UNSET_SEVERITY
LOW_SEVERITY
MEDIUM_SEVERITY
HIGH_SEVERITY
CRITICAL_SEVERITY

3.8.7.6. V1GetAlertsCountsResponse
Copy link

Expand

Field Name	Required	Nullable	Type	Description	Format
groups			List of GetAlertsCountsResponseAlertGroup

3.9. GetAlertsGroup
Copy link

GET /v1/alerts/summary/groups

GetAlertsGroup returns alerts grouped by policy.

3.9.1. Description
Copy link

3.9.2. Parameters
Copy link

3.9.2.1. Query Parameters
Copy link

Expand

Name	Required	Default
query	-	null
pagination.limit	-	null
pagination.offset	-	null
pagination.sortOption.field	-	null
pagination.sortOption.reversed	-	null
pagination.sortOption.aggregateBy.aggrFunc	-	UNSET
pagination.sortOption.aggregateBy.distinct	-	null

3.9.3. Return Type
Copy link

V1GetAlertsGroupResponse

3.9.4. Content Type
Copy link

application/json

3.9.5. Responses
Copy link

Expand

Table 3.9. HTTP Response Codes
Code	Message	Datatype
200	A successful response.	V1GetAlertsGroupResponse
0	An unexpected error response.	RuntimeError

3.9.6. Samples
Copy link

3.9.7. Common object reference
Copy link

3.9.7.1. ListAlertPolicyDevFields
Copy link

Expand

Field Name	Required	Nullable	Type	Description	Format
SORTName			String

3.9.7.2. 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 {
  ...
}

3.9.7.2.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>
}

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

Expand

Field Name	Required	Nullable	Type	Description	Format
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

3.9.7.3. RuntimeError
Copy link

Expand

Field Name	Type	Format
error	String
code	Integer	int32
message	String
details	List of ProtobufAny

3.9.7.4. StorageListAlertPolicy
Copy link

Expand

Field Name	Type	Format
id	String
name	String
severity	StorageSeverity	UNSET_SEVERITY, LOW_SEVERITY, MEDIUM_SEVERITY, HIGH_SEVERITY, CRITICAL_SEVERITY,
description	String
categories	List of `string`
developerInternalFields	ListAlertPolicyDevFields

3.9.7.5. StorageSeverity
Copy link

Expand

Enum Values
UNSET_SEVERITY
LOW_SEVERITY
MEDIUM_SEVERITY
HIGH_SEVERITY
CRITICAL_SEVERITY

3.9.7.6. V1GetAlertsGroupResponse
Copy link

Expand

Field Name	Required	Nullable	Type	Description	Format
alertsByPolicies			List of V1GetAlertsGroupResponsePolicyGroup

3.9.7.7. V1GetAlertsGroupResponsePolicyGroup
Copy link

Expand

Field Name	Required	Nullable	Type	Description	Format
policy			StorageListAlertPolicy
numAlerts			String		int64

3.10. GetAlertTimeseries
Copy link

GET /v1/alerts/summary/timeseries

GetAlertTimeseries returns the alerts sorted by time.

3.10.1. Description
Copy link

3.10.2. Parameters
Copy link

3.10.2.1. Query Parameters
Copy link

Expand

Name	Required	Default
query	-	null
pagination.limit	-	null
pagination.offset	-	null
pagination.sortOption.field	-	null
pagination.sortOption.reversed	-	null
pagination.sortOption.aggregateBy.aggrFunc	-	UNSET
pagination.sortOption.aggregateBy.distinct	-	null

3.10.3. Return Type
Copy link

V1GetAlertTimeseriesResponse

3.10.4. Content Type
Copy link

application/json

3.10.5. Responses
Copy link

Expand

Table 3.10. HTTP Response Codes
Code	Message	Datatype
200	A successful response.	V1GetAlertTimeseriesResponse
0	An unexpected error response.	RuntimeError

3.10.6. Samples
Copy link

3.10.7. Common object reference
Copy link

3.10.7.1. ClusterAlertsAlertEvents
Copy link

Expand

Field Name	Required	Nullable	Type	Description	Format
severity			StorageSeverity		UNSET_SEVERITY, LOW_SEVERITY, MEDIUM_SEVERITY, HIGH_SEVERITY, CRITICAL_SEVERITY,
events			List of V1AlertEvent

3.10.7.2. GetAlertTimeseriesResponseClusterAlerts
Copy link

Expand

Field Name	Required	Nullable	Type	Description	Format
cluster			String
severities			List of ClusterAlertsAlertEvents

3.10.7.3. 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 {
  ...
}

3.10.7.3.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>
}

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

Expand

Field Name	Required	Nullable	Type	Description	Format
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

3.10.7.4. RuntimeError
Copy link

Expand

Field Name	Type	Format
error	String
code	Integer	int32
message	String
details	List of ProtobufAny

3.10.7.5. StorageSeverity
Copy link

Expand

Enum Values
UNSET_SEVERITY
LOW_SEVERITY
MEDIUM_SEVERITY
HIGH_SEVERITY
CRITICAL_SEVERITY

3.10.7.6. V1AlertEvent
Copy link

Expand

Field Name	Type	Format
time	String	int64
type	V1Type	CREATED, REMOVED,
id	String

3.10.7.7. V1GetAlertTimeseriesResponse
Copy link

Expand

Field Name	Required	Nullable	Type	Description	Format
clusters			List of GetAlertTimeseriesResponseClusterAlerts

3.10.7.8. V1Type
Copy link

Expand

Enum Values
CREATED
REMOVED

Chapter 3. AlertService

3.1. CountAlertsCopy linkLink copied to clipboard!

3.1.1. DescriptionCopy linkLink copied to clipboard!

3.1.2. ParametersCopy linkLink copied to clipboard!

3.1.2.1. Query ParametersCopy linkLink copied to clipboard!

3.1.3. Return TypeCopy linkLink copied to clipboard!

3.1.4. Content TypeCopy linkLink copied to clipboard!

3.1.5. ResponsesCopy linkLink copied to clipboard!

3.1.6. SamplesCopy linkLink copied to clipboard!

3.1.7. Common object referenceCopy linkLink copied to clipboard!

3.1.7.1. ProtobufAnyCopy linkLink copied to clipboard!

3.1.7.1.1. JSON representationCopy linkLink copied to clipboard!

3.1.7.2. RuntimeErrorCopy linkLink copied to clipboard!

3.1.7.3. V1CountAlertsResponseCopy linkLink copied to clipboard!

3.2. DeleteAlertsCopy linkLink copied to clipboard!

3.2.1. DescriptionCopy linkLink copied to clipboard!

3.2.2. ParametersCopy linkLink copied to clipboard!

3.2.2.1. Query ParametersCopy linkLink copied to clipboard!

3.2.3. Return TypeCopy linkLink copied to clipboard!

3.2.4. Content TypeCopy linkLink copied to clipboard!

3.2.5. ResponsesCopy linkLink copied to clipboard!

3.2.6. SamplesCopy linkLink copied to clipboard!

3.2.7. Common object referenceCopy linkLink copied to clipboard!

3.2.7.1. ProtobufAnyCopy linkLink copied to clipboard!

3.2.7.1.1. JSON representationCopy linkLink copied to clipboard!

3.2.7.2. RuntimeErrorCopy linkLink copied to clipboard!

3.2.7.3. V1DeleteAlertsResponseCopy linkLink copied to clipboard!

3.3. ListAlertsCopy linkLink copied to clipboard!

3.3.1. DescriptionCopy linkLink copied to clipboard!

3.3.2. ParametersCopy linkLink copied to clipboard!

3.3.2.1. Query ParametersCopy linkLink copied to clipboard!

3.3.3. Return TypeCopy linkLink copied to clipboard!

3.3.4. Content TypeCopy linkLink copied to clipboard!

3.3.5. ResponsesCopy linkLink copied to clipboard!

3.3.6. SamplesCopy linkLink copied to clipboard!

3.3.7. Common object referenceCopy linkLink copied to clipboard!

3.3.7.1. ListAlertCommonEntityInfoCopy linkLink copied to clipboard!

3.3.7.2. ListAlertPolicyDevFieldsCopy linkLink copied to clipboard!

3.3.7.3. ListAlertResourceEntityCopy linkLink copied to clipboard!

3.3.7.4. ProtobufAnyCopy linkLink copied to clipboard!

3.3.7.4.1. JSON representationCopy linkLink copied to clipboard!

3.3.7.5. RuntimeErrorCopy linkLink copied to clipboard!

3.3.7.6. StorageEnforcementActionCopy linkLink copied to clipboard!

3.3.7.7. StorageLifecycleStageCopy linkLink copied to clipboard!

3.3.7.8. StorageListAlertCopy linkLink copied to clipboard!

3.3.7.9. StorageListAlertDeploymentCopy linkLink copied to clipboard!

3.3.7.10. StorageListAlertPolicyCopy linkLink copied to clipboard!

3.3.7.11. StorageListAlertResourceTypeCopy linkLink copied to clipboard!

3.3.7.12. StorageSeverityCopy linkLink copied to clipboard!

3.3.7.13. StorageViolationStateCopy linkLink copied to clipboard!

3.3.7.14. V1ListAlertsResponseCopy linkLink copied to clipboard!

3.4. GetAlertCopy linkLink copied to clipboard!

3.4.1. DescriptionCopy linkLink copied to clipboard!

3.4.2. ParametersCopy linkLink copied to clipboard!

3.4.2.1. Path ParametersCopy linkLink copied to clipboard!

3.4.3. Return TypeCopy linkLink copied to clipboard!

3.4.4. Content TypeCopy linkLink copied to clipboard!

3.4.5. ResponsesCopy linkLink copied to clipboard!

3.4.6. SamplesCopy linkLink copied to clipboard!

3.4.7. Common object referenceCopy linkLink copied to clipboard!

3.4.7.1. AlertDeploymentContainerCopy linkLink copied to clipboard!

3.4.7.2. AlertEnforcementCopy linkLink copied to clipboard!

3.4.7.3. AlertProcessViolationCopy linkLink copied to clipboard!

3.4.7.4. AlertResourceResourceTypeCopy linkLink copied to clipboard!

3.4.7.5. AlertViolationCopy linkLink copied to clipboard!

3.4.7.6. AlertViolationTypeCopy linkLink copied to clipboard!

3.4.7.7. KeyValueAttrsKeyValueAttrCopy linkLink copied to clipboard!

3.4.7.8. NetworkFlowInfoEntityCopy linkLink copied to clipboard!

3.4.7.9. PolicyMitreAttackVectorsCopy linkLink copied to clipboard!

3.4.7.10. ProcessSignalLineageInfoCopy linkLink copied to clipboard!

3.4.7.11. ProtobufAnyCopy linkLink copied to clipboard!

3.4.7.11.1. JSON representationCopy linkLink copied to clipboard!

3.4.7.12. RuntimeErrorCopy linkLink copied to clipboard!

3.4.7.13. StorageAlertCopy linkLink copied to clipboard!

3.4.7.14. StorageAlertDeploymentCopy linkLink copied to clipboard!

3.4.7.15. StorageAlertResourceCopy linkLink copied to clipboard!

3.4.7.16. StorageBooleanOperatorCopy linkLink copied to clipboard!

3.4.7.17. StorageContainerImageCopy linkLink copied to clipboard!

3.4.7.18. StorageEnforcementActionCopy linkLink copied to clipboard!

3.4.7.19. StorageEventSourceCopy linkLink copied to clipboard!

3.1. CountAlerts
Copy link

3.1.1. Description
Copy link

3.1.2. Parameters
Copy link

3.1.2.1. Query Parameters
Copy link

3.1.3. Return Type
Copy link

3.1.4. Content Type
Copy link

3.1.5. Responses
Copy link

3.1.6. Samples
Copy link

3.1.7. Common object reference
Copy link

3.1.7.1. ProtobufAny
Copy link

3.1.7.1.1. JSON representation
Copy link

3.1.7.2. RuntimeError
Copy link

3.1.7.3. V1CountAlertsResponse
Copy link

3.2. DeleteAlerts
Copy link

3.2.1. Description
Copy link

3.2.2. Parameters
Copy link

3.2.2.1. Query Parameters
Copy link

3.2.3. Return Type
Copy link

3.2.4. Content Type
Copy link

3.2.5. Responses
Copy link

3.2.6. Samples
Copy link

3.2.7. Common object reference
Copy link

3.2.7.1. ProtobufAny
Copy link

3.2.7.1.1. JSON representation
Copy link

3.2.7.2. RuntimeError
Copy link

3.2.7.3. V1DeleteAlertsResponse
Copy link

3.3. ListAlerts
Copy link

3.3.1. Description
Copy link

3.3.2. Parameters
Copy link

3.3.2.1. Query Parameters
Copy link

3.3.3. Return Type
Copy link

3.3.4. Content Type
Copy link

3.3.5. Responses
Copy link

3.3.6. Samples
Copy link

3.3.7. Common object reference
Copy link

3.3.7.1. ListAlertCommonEntityInfo
Copy link

3.3.7.2. ListAlertPolicyDevFields
Copy link

3.3.7.3. ListAlertResourceEntity
Copy link

3.3.7.4. ProtobufAny
Copy link

3.3.7.4.1. JSON representation
Copy link

3.3.7.5. RuntimeError
Copy link

3.3.7.6. StorageEnforcementAction
Copy link

3.3.7.7. StorageLifecycleStage
Copy link

3.3.7.8. StorageListAlert
Copy link

3.3.7.9. StorageListAlertDeployment
Copy link

3.3.7.10. StorageListAlertPolicy
Copy link

3.3.7.11. StorageListAlertResourceType
Copy link

3.3.7.12. StorageSeverity
Copy link

3.3.7.13. StorageViolationState
Copy link

3.3.7.14. V1ListAlertsResponse
Copy link

3.4. GetAlert
Copy link

3.4.1. Description
Copy link

3.4.2. Parameters
Copy link

3.4.2.1. Path Parameters
Copy link

3.4.3. Return Type
Copy link

3.4.4. Content Type
Copy link

3.4.5. Responses
Copy link

3.4.6. Samples
Copy link

3.4.7. Common object reference
Copy link

3.4.7.1. AlertDeploymentContainer
Copy link

3.4.7.2. AlertEnforcement
Copy link

3.4.7.3. AlertProcessViolation
Copy link

3.4.7.4. AlertResourceResourceType
Copy link

3.4.7.5. AlertViolation
Copy link

3.4.7.6. AlertViolationType
Copy link

3.4.7.7. KeyValueAttrsKeyValueAttr
Copy link

3.4.7.8. NetworkFlowInfoEntity
Copy link

3.4.7.9. PolicyMitreAttackVectors
Copy link

3.4.7.10. ProcessSignalLineageInfo
Copy link

3.4.7.11. ProtobufAny
Copy link

3.4.7.11.1. JSON representation
Copy link

3.4.7.12. RuntimeError
Copy link

3.4.7.13. StorageAlert
Copy link

3.4.7.14. StorageAlertDeployment
Copy link

3.4.7.15. StorageAlertResource
Copy link

3.4.7.16. StorageBooleanOperator
Copy link

3.4.7.17. StorageContainerImage
Copy link

3.4.7.18. StorageEnforcementAction
Copy link

3.4.7.19. StorageEventSource
Copy link

3.4.7.20. StorageExclusion
Copy link