Foo foo = ...;
Any any;
any.PackFrom(foo);
...
if (any.UnpackTo(&foo)) {
...
}
×
exportPolicies
POST /v1/policies/export
exportPolicies takes a list of policy IDs and returns either the entire list of policies or an error message
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
A successful response. |
|
0 |
An unexpected error response. |
Common object reference
PolicyMitreAttackVectors
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
tactic |
String |
||||
techniques |
List of |
ProtobufAny
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++.
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".
JSON representation
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 |
Runtimeerror
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
error |
String |
||||
code |
Integer |
int32 |
|||
message |
String |
||||
details |
List of ProtobufAny |
StorageenforcementAction
-
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 |
Storageexclusion
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
name |
String |
||||
deployment |
|||||
image |
|||||
expiration |
Date |
date-time |
StorageexportPoliciesResponse
exportPoliciesResponse is used by the API but it is defined in storage because we expect customers to store them. We do backwards-compatibility checks on objects in the storge folder and those checks should be applied to this object
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
policies |
List of StoragePolicy |
StoragePolicy
| 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. |
StoragePolicyGroup
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
fieldName |
String |
||||
booleanOperator |
OR, AND, |
||||
negate |
Boolean |
||||
values |
List of StoragePolicyValue |
StoragePolicySection
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
sectionName |
String |
||||
policyGroups |
List of StoragePolicyGroup |
StorageScope
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
cluster |
String |
||||
namespace |
String |
||||
label |