Foo foo = ...; Any any; any.PackFrom(foo); ... if (any.UnpackTo(&foo)) { ... }
DELETE /v1/alerts
Name | Description | Required | Default | Pattern |
---|---|---|---|---|
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 |
GET /v1/alerts/summary/counts
GetAlertsCounts returns the number of alerts in the requested cluster or category.
Name | Description | Required | Default | Pattern |
---|---|---|---|---|
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 |
Field Name | Required | Nullable | Type | Description | Format |
---|---|---|---|---|---|
action |
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 |
Field Name | Required | Nullable | Type | Description | Format |
---|---|---|---|---|---|
severity |
UNSET_SEVERITY, LOW_SEVERITY, MEDIUM_SEVERITY, HIGH_SEVERITY, CRITICAL_SEVERITY, |
||||
count |
String |
int64 |
Field Name | Required | Nullable | Type | Description | Format |
---|---|---|---|---|---|
message |
String |
||||
processes |
List of StorageProcessIndicator |
Enum Values |
---|
UNKNOWN |
SECRETS |
CONFIGMAPS |
CLUSTER_ROLES |
CLUSTER_ROLE_BINDINGS |
NETWORK_POLICIES |
SECURITY_CONTEXT_CONSTRAINTS |
EGRESS_FIREWALLS |
Field Name | Required | Nullable | Type | Description | Format |
---|---|---|---|---|---|
message |
String |
||||
keyValueAttrs |
|||||
networkFlowInfo |
|||||
type |
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 |
Field Name | Required | Nullable | Type | Description | Format |
---|---|---|---|---|---|
severity |
UNSET_SEVERITY, LOW_SEVERITY, MEDIUM_SEVERITY, HIGH_SEVERITY, CRITICAL_SEVERITY, |
||||
events |
List of V1AlertEvent |
Field Name | Required | Nullable | Type | Description | Format |
---|---|---|---|---|---|
cluster |
String |
||||
severities |
List of ClusterAlertsAlertEvents |
Field Name | Required | Nullable | Type | Description | Format |
---|---|---|---|---|---|
group |
String |
||||
counts |
List of AlertGroupAlertCounts |
Field Name | Required | Nullable | Type | Description | Format |
---|---|---|---|---|---|
key |
String |
||||
value |
String |
Fields common to all entities that an alert might belong to.
Field Name | Required | Nullable | Type | Description | Format |
---|---|---|---|---|---|
clusterName |
String |
||||
namespace |
String |
||||
clusterId |
String |
||||
namespaceId |
String |
||||
resourceType |
DEPLOYMENT, SECRETS, CONFIGMAPS, CLUSTER_ROLES, CLUSTER_ROLE_BINDINGS, NETWORK_POLICIES, SECURITY_CONTEXT_CONSTRAINTS, EGRESS_FIREWALLS, |
Field Name | Required | Nullable | Type | Description | Format |
---|---|---|---|---|---|
name |
String |
||||
entityType |
UNKNOWN_TYPE, DEPLOYMENT, INTERNET, LISTEN_ENDPOINT, EXTERNAL_SOURCE, INTERNAL_ENTITIES, |
||||
deploymentNamespace |
String |
||||
deploymentType |
String |
||||
port |
Integer |
int32 |
Field Name | Required | Nullable | Type | Description | Format |
---|---|---|---|---|---|
tactic |
String |
||||
techniques |
List of |
Field Name | Required | Nullable | Type | Description | Format |
---|---|---|---|---|---|
parentUid |
Long |
int64 |
|||
parentExecFilePath |
String |
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".
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" }
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 |
|||
value |
byte[] |
Must be a valid serialized protocol buffer of the above specified type. |
byte |
Field Name | Required | Nullable | Type | Description | Format |
---|---|---|---|---|---|
error |
String |
||||
code |
Integer |
int32 |
|||
message |
String |
||||
details |
List of ProtobufAny |
Field Name | Required | Nullable | Type | Description | Format |
---|---|---|---|---|---|
id |
String |
||||
policy |
|||||
lifecycleStage |
DEPLOY, BUILD, RUNTIME, |
||||
clusterId |
String |
||||
clusterName |
String |
||||
namespace |
String |
||||
namespaceId |
String |
||||
deployment |
|||||
image |
|||||
resource |
|||||
violations |
List of AlertViolation |
For run-time phase alert, a maximum of 40 violations are retained. |
|||
processViolation |
|||||
enforcement |
|||||
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 |
ACTIVE, SNOOZED, RESOLVED, ATTEMPTED, |
||||
snoozeTill |
Date |
date-time |
Field Name | Required | Nullable | Type | Description | Format |
---|---|---|---|---|---|
id |
String |
||||
name |
String |
||||
type |
String |
||||
namespace |
String |
||||
namespaceId |
String |
||||
labels |
Map of |
||||
clusterId |
String |
||||
clusterName |
String |
||||
containers |
List of AlertDeploymentContainer |
||||
annotations |
Map of |
||||
inactive |
Boolean |
Represents an alert on a kubernetes resource other than a deployment (configmaps, secrets, etc.)
Field Name | Required | Nullable | Type | Description | Format |
---|---|---|---|---|---|
resourceType |
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 |
Next tag: 12
Field Name | Required | Nullable | Type | Description | Format |
---|---|---|---|---|---|
id |
String |
||||
name |
|||||
notPullable |
Boolean |
||||
isClusterLocal |
Boolean |
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.
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 |
Field Name | Required | Nullable | Type | Description | Format |
---|---|---|---|---|---|
name |
String |
||||
deployment |
|||||
image |
|||||
expiration |
Date |
date-time |
Field Name | Required | Nullable | Type | Description | Format |
---|---|---|---|---|---|
registry |
String |
||||
remote |
String |
||||
tag |
String |
||||
fullName |
String |
Enum Values |
---|
L4_PROTOCOL_UNKNOWN |
L4_PROTOCOL_TCP |
L4_PROTOCOL_UDP |
L4_PROTOCOL_ICMP |
L4_PROTOCOL_RAW |
L4_PROTOCOL_SCTP |
L4_PROTOCOL_ANY |
Field Name | Required | Nullable | Type | Description | Format |
---|---|---|---|---|---|
id |
String |
||||
lifecycleStage |
DEPLOY, BUILD, RUNTIME, |
||||
time |
Date |
date-time |
|||
policy |
|||||
state |
ACTIVE, SNOOZED, RESOLVED, ATTEMPTED, |
||||
enforcementCount |
Integer |
int32 |
|||
enforcementAction |
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 |
|||||
deployment |
|||||
resource |
Field Name | Required | Nullable | Type | Description | Format |
---|---|---|---|---|---|
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. |
Field Name | Required | Nullable | Type | Description | Format |
---|---|---|---|---|---|
id |
String |
||||
name |
String |
||||
severity |
UNSET_SEVERITY, LOW_SEVERITY, MEDIUM_SEVERITY, HIGH_SEVERITY, CRITICAL_SEVERITY, |
||||
description |
String |
||||
categories |
List of |
||||
developerInternalFields |
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)
Enum Values |
---|
DEPLOYMENT |
SECRETS |
CONFIGMAPS |
CLUSTER_ROLES |
CLUSTER_ROLE_BINDINGS |
NETWORK_POLICIES |
SECURITY_CONTEXT_CONSTRAINTS |
EGRESS_FIREWALLS |
INTERNAL_ENTITIES: INTERNAL_ENTITIES is for grouping all internal entities under a single network graph node
Enum Values |
---|
UNKNOWN_TYPE |
DEPLOYMENT |
INTERNET |
LISTEN_ENDPOINT |
EXTERNAL_SOURCE |
INTERNAL_ENTITIES |
Field Name | Required | Nullable | Type | Description | Format |
---|---|---|---|---|---|
id |
String |
||||
name |
String |
||||
description |
String |
||||
rationale |
String |
||||
remediation |
String |
||||
disabled |
Boolean |
||||
categories |
List of |
||||
lifecycleStages |
List of StorageLifecycleStage |
||||
eventSource |
NOT_APPLICABLE, DEPLOYMENT_EVENT, AUDIT_LOG_EVENT, |
||||
exclusions |
List of StorageExclusion |
||||
scope |
List of StorageScope |
||||
severity |
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 |
||||
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. |
Field Name | Required | Nullable | Type | Description | Format |
---|---|---|---|---|---|
fieldName |
String |
||||
booleanOperator |
OR, AND, |
||||
negate |
Boolean |
||||
values |
List of StoragePolicyValue |
Field Name | Required | Nullable | Type | Description | Format |
---|---|---|---|---|---|
sectionName |
String |
||||
policyGroups |
List of StoragePolicyGroup |
Next available tag: 13
Field Name | Required | Nullable | Type | Description | Format |
---|---|---|---|---|---|
id |
String |
||||
deploymentId |
String |
||||
containerName |
String |
||||
podId |
String |
||||
podUid |
String |
||||
signal |
|||||
clusterId |
String |
||||
namespace |
String |
||||
containerStartTime |
Date |
date-time |
|||
imageId |
String |
Field Name | Required | Nullable | 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 |
||||
scraped |
Boolean |
||||
lineageInfo |
List of ProcessSignalLineageInfo |
Field Name | Required | Nullable | Type | Description | Format |
---|---|---|---|---|---|
cluster |
String |
||||
namespace |
String |
||||
label |
Enum Values |
---|
UNSET_SEVERITY |
LOW_SEVERITY |
MEDIUM_SEVERITY |
HIGH_SEVERITY |
CRITICAL_SEVERITY |
Field Name | Required | Nullable | Type | Description | Format |
---|---|---|---|---|---|
time |
String |
int64 |
|||
type |
CREATED, REMOVED, |
||||
id |
String |
Field Name | Required | Nullable | Type | Description | Format |
---|---|---|---|---|---|
numDeleted |
Long |
int64 |
|||
dryRun |
Boolean |
Field Name | Required | Nullable | Type | Description | Format |
---|---|---|---|---|---|
policy |
|||||
numAlerts |
String |
int64 |
Field Name | Required | Nullable | Type | Description | Format |
---|---|---|---|---|---|
alerts |
List of StorageListAlert |
Field Name | Required | Nullable | Type | Description | Format |
---|---|---|---|---|---|
id |
String |
||||
whitelist |
Boolean |
||||
addToBaseline |
Boolean |
Field Name | Required | Nullable | Type | Description | Format |
---|---|---|---|---|---|
id |
String |
||||
snoozeTill |
Date |
date-time |
Field Name | Required | Nullable | Type | Description | Format |
---|---|---|---|---|---|
attrs |
List of KeyValueAttrsKeyValueAttr |