Red Hat SummitChapter 50. ReportConfigurationService
50.1. CountReportConfigurations
GET /v1/report-configurations-count
CountReportConfigurations returns the number of report configurations.
50.1.1. Description
50.1.2. Parameters
50.1.2.1. Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| 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 |
50.1.3. Return Type
50.1.4. Content Type
- application/json
50.1.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
50.1.6. Samples
50.1.7. Common object reference
50.1.7.1. 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++.
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 Gofoo := &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".
50.1.7.1.1. 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 |
50.1.7.2. RuntimeError
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
| error | String | ||||
| code | Integer | int32 | |||
| message | String | ||||
| details | List of ProtobufAny |
50.1.7.3. V1CountReportConfigurationsResponse
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
| count | Integer | int32 |
50.2. GetReportConfigurations
GET /v1/report/configurations
50.2.1. Description
50.2.2. Parameters
50.2.2.1. Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| 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 |
50.2.3. Return Type
50.2.4. Content Type
- application/json
50.2.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
50.2.6. Samples
50.2.7. Common object reference
50.2.7.1. 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++.
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 Gofoo := &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".
50.2.7.1.1. 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 |
50.2.7.2. ReportConfigurationReportType
| Enum Values |
|---|
| VULNERABILITY |
50.2.7.3. ReportLastRunStatusRunStatus
| Enum Values |
|---|
| SUCCESS |
| FAILURE |
50.2.7.4. RuntimeError
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
| error | String | ||||
| code | Integer | int32 | |||
| message | String | ||||
| details | List of ProtobufAny |
50.2.7.5. ScheduleDaysOfMonth
1 for 1st, 2 for 2nd .... 31 for 31st| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
| days |
List of | int32 |
50.2.7.6. ScheduleDaysOfWeek
Sunday = 0, Monday = 1, .... Saturday = 6| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
| days |
List of | int32 |
50.2.7.7. ScheduleIntervalType
| Enum Values |
|---|
| UNSET |
| DAILY |
| WEEKLY |
| MONTHLY |
50.2.7.8. ScheduleWeeklyInterval
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
| day | Integer | int32 |
50.2.7.9. SimpleAccessScopeRules
Each element of any repeated field is an individual rule. Rules are joined by logical OR: if there exists a rule allowing resource x, x is in the access scope.
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
| includedClusters |
List of | ||||
| includedNamespaces | List of SimpleAccessScopeRulesNamespace | ||||
| clusterLabelSelectors | List of StorageSetBasedLabelSelector | ||||
| namespaceLabelSelectors | List of StorageSetBasedLabelSelector |
50.2.7.10. SimpleAccessScopeRulesNamespace
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
| clusterName | String | Both fields must be set. | |||
| namespaceName | String |
50.2.7.11. StorageEmailNotifierConfiguration
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
| notifierId | String | ||||
| mailingLists |
List of | ||||
| customSubject | String | ||||
| customBody | String |
50.2.7.12. StorageNotifierConfiguration
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
| emailConfig | |||||
| id | String |
50.2.7.13. StorageReportConfiguration
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
| id | String | ||||
| name | String | ||||
| description | String | ||||
| type | VULNERABILITY, | ||||
| vulnReportFilters | |||||
| scopeId | String | ||||
| emailConfig | |||||
| schedule | |||||
| lastRunStatus | |||||
| lastSuccessfulRunTime | Date | date-time | |||
| resourceScope | |||||
| notifiers | List of StorageNotifierConfiguration | ||||
| creator | |||||
| version | Integer | int32 |
50.2.7.14. StorageReportLastRunStatus
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
| reportStatus | SUCCESS, FAILURE, | ||||
| lastRunTime | Date | date-time | |||
| errorMsg | String |
50.2.7.15. StorageResourceScope
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
| collectionId | String |
50.2.7.16. StorageSchedule
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
| intervalType | UNSET, DAILY, WEEKLY, MONTHLY, | ||||
| hour | Integer | int32 | |||
| minute | Integer | int32 | |||
| weekly | |||||
| daysOfWeek | |||||
| daysOfMonth |
50.2.7.17. StorageSetBasedLabelSelector
SetBasedLabelSelector only allows set-based label requirements.
Next available tag: 3
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
| requirements |
50.2.7.18. StorageSetBasedLabelSelectorOperator
| Enum Values |
|---|
| UNKNOWN |
| IN |
| NOT_IN |
| EXISTS |
| NOT_EXISTS |
50.2.7.19. StorageSetBasedLabelSelectorRequirement
Next available tag: 4| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
| key | String | ||||
| op | UNKNOWN, IN, NOT_IN, EXISTS, NOT_EXISTS, | ||||
| values |
List of |
50.2.7.20. StorageSlimUser
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
| id | String | ||||
| name | String |
50.2.7.21. StorageVulnerabilityReportFilters
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
| fixability | BOTH, FIXABLE, NOT_FIXABLE, | ||||
| sinceLastReport | Boolean | ||||
| severities | List of StorageVulnerabilitySeverity | ||||
| imageTypes | |||||
| allVuln | Boolean | ||||
| sinceLastSentScheduledReport | Boolean | ||||
| sinceStartDate | Date | date-time | |||
| accessScopeRules | List of SimpleAccessScopeRules |
50.2.7.22. StorageVulnerabilitySeverity
| Enum Values |
|---|
| UNKNOWN_VULNERABILITY_SEVERITY |
| LOW_VULNERABILITY_SEVERITY |
| MODERATE_VULNERABILITY_SEVERITY |
| IMPORTANT_VULNERABILITY_SEVERITY |
| CRITICAL_VULNERABILITY_SEVERITY |
50.2.7.23. V1GetReportConfigurationsResponse
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
| reportConfigs | List of StorageReportConfiguration |
50.2.7.24. VulnerabilityReportFiltersFixability
| Enum Values |
|---|
| BOTH |
| FIXABLE |
| NOT_FIXABLE |
50.2.7.25. VulnerabilityReportFiltersImageType
| Enum Values |
|---|
| DEPLOYED |
| WATCHED |
50.3. DeleteReportConfiguration
DELETE /v1/report/configurations/{id}
DeleteReportConfiguration removes a report configuration given its id
50.3.1. Description
50.3.2. Parameters
50.3.2.1. Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| id | X | null |
50.3.3. Return Type
Object
50.3.4. Content Type
- application/json
50.3.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. |
|
| 0 | An unexpected error response. |
50.3.6. Samples
50.3.7. Common object reference
50.3.7.1. 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++.
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 Gofoo := &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".
50.3.7.1.1. 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 |
50.3.7.2. RuntimeError
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
| error | String | ||||
| code | Integer | int32 | |||
| message | String | ||||
| details | List of ProtobufAny |
50.4. GetReportConfiguration
GET /v1/report/configurations/{id}
50.4.1. Description
50.4.2. Parameters
50.4.2.1. Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| id | X | null |
50.4.3. Return Type
50.4.4. Content Type
- application/json
50.4.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
50.4.6. Samples
50.4.7. Common object reference
50.4.7.1. 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++.
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 Gofoo := &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".
50.4.7.1.1. 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 |
50.4.7.2. ReportConfigurationReportType
| Enum Values |
|---|
| VULNERABILITY |
50.4.7.3. ReportLastRunStatusRunStatus
| Enum Values |
|---|
| SUCCESS |
| FAILURE |
50.4.7.4. RuntimeError
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
| error | String | ||||
| code | Integer | int32 | |||
| message | String | ||||
| details | List of ProtobufAny |
50.4.7.5. ScheduleDaysOfMonth
1 for 1st, 2 for 2nd .... 31 for 31st| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
| days |
List of | int32 |
50.4.7.6. ScheduleDaysOfWeek
Sunday = 0, Monday = 1, .... Saturday = 6| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
| days |
List of | int32 |
50.4.7.7. ScheduleIntervalType
| Enum Values |
|---|
| UNSET |
| DAILY |
| WEEKLY |
| MONTHLY |
50.4.7.8. ScheduleWeeklyInterval
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
| day | Integer | int32 |
50.4.7.9. SimpleAccessScopeRules
Each element of any repeated field is an individual rule. Rules are joined by logical OR: if there exists a rule allowing resource x, x is in the access scope.
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
| includedClusters |
List of | ||||
| includedNamespaces | List of SimpleAccessScopeRulesNamespace | ||||
| clusterLabelSelectors | List of StorageSetBasedLabelSelector | ||||
| namespaceLabelSelectors | List of StorageSetBasedLabelSelector |
50.4.7.10. SimpleAccessScopeRulesNamespace
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
| clusterName | String | Both fields must be set. | |||
| namespaceName | String |
50.4.7.11. StorageEmailNotifierConfiguration
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
| notifierId | String | ||||
| mailingLists |
List of | ||||
| customSubject | String | ||||
| customBody | String |
50.4.7.12. StorageNotifierConfiguration
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
| emailConfig | |||||
| id | String |
50.4.7.13. StorageReportConfiguration
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
| id | String | ||||
| name | String | ||||
| description | String | ||||
| type | VULNERABILITY, | ||||
| vulnReportFilters | |||||
| scopeId | String | ||||
| emailConfig | |||||
| schedule | |||||
| lastRunStatus | |||||
| lastSuccessfulRunTime | Date | date-time | |||
| resourceScope | |||||
| notifiers | List of StorageNotifierConfiguration | ||||
| creator | |||||
| version | Integer | int32 |
50.4.7.14. StorageReportLastRunStatus
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
| reportStatus | SUCCESS, FAILURE, | ||||
| lastRunTime | Date | date-time | |||
| errorMsg | String |
50.4.7.15. StorageResourceScope
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
| collectionId | String |
50.4.7.16. StorageSchedule
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
| intervalType | UNSET, DAILY, WEEKLY, MONTHLY, | ||||
| hour | Integer | int32 | |||
| minute | Integer | int32 | |||
| weekly | |||||
| daysOfWeek | |||||
| daysOfMonth |
50.4.7.17. StorageSetBasedLabelSelector
SetBasedLabelSelector only allows set-based label requirements.
Next available tag: 3
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
| requirements |
50.4.7.18. StorageSetBasedLabelSelectorOperator
| Enum Values |
|---|
| UNKNOWN |
| IN |
| NOT_IN |
| EXISTS |
| NOT_EXISTS |
50.4.7.19. StorageSetBasedLabelSelectorRequirement
Next available tag: 4| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
| key | String | ||||
| op | UNKNOWN, IN, NOT_IN, EXISTS, NOT_EXISTS, | ||||
| values |
List of |
50.4.7.20. StorageSlimUser
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
| id | String | ||||
| name | String |
50.4.7.21. StorageVulnerabilityReportFilters
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
| fixability | BOTH, FIXABLE, NOT_FIXABLE, | ||||
| sinceLastReport | Boolean | ||||
| severities | List of StorageVulnerabilitySeverity | ||||
| imageTypes | |||||
| allVuln | Boolean | ||||
| sinceLastSentScheduledReport | Boolean | ||||
| sinceStartDate | Date | date-time | |||
| accessScopeRules | List of SimpleAccessScopeRules |
50.4.7.22. StorageVulnerabilitySeverity
| Enum Values |
|---|
| UNKNOWN_VULNERABILITY_SEVERITY |
| LOW_VULNERABILITY_SEVERITY |
| MODERATE_VULNERABILITY_SEVERITY |
| IMPORTANT_VULNERABILITY_SEVERITY |
| CRITICAL_VULNERABILITY_SEVERITY |
50.4.7.23. V1GetReportConfigurationResponse
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
| reportConfig |
50.4.7.24. VulnerabilityReportFiltersFixability
| Enum Values |
|---|
| BOTH |
| FIXABLE |
| NOT_FIXABLE |
50.4.7.25. VulnerabilityReportFiltersImageType
| Enum Values |
|---|
| DEPLOYED |
| WATCHED |
50.5. UpdateReportConfiguration
PUT /v1/report/configurations/{id}
UpdateReportConfiguration updates a report configuration
50.5.1. Description
50.5.2. Parameters
50.5.2.1. Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| id | X | null |
50.5.2.2. Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| body | X |
50.5.3. Return Type
Object
50.5.4. Content Type
- application/json
50.5.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. |
|
| 0 | An unexpected error response. |
50.5.6. Samples
50.5.7. Common object reference
50.5.7.1. 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++.
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 Gofoo := &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".
50.5.7.1.1. 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 |
50.5.7.2. ReportConfigurationReportType
| Enum Values |
|---|
| VULNERABILITY |
50.5.7.3. ReportLastRunStatusRunStatus
| Enum Values |
|---|
| SUCCESS |
| FAILURE |
50.5.7.4. RuntimeError
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
| error | String | ||||
| code | Integer | int32 | |||
| message | String | ||||
| details | List of ProtobufAny |
50.5.7.5. ScheduleDaysOfMonth
1 for 1st, 2 for 2nd .... 31 for 31st| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
| days |
List of | int32 |
50.5.7.6. ScheduleDaysOfWeek
Sunday = 0, Monday = 1, .... Saturday = 6| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
| days |
List of | int32 |
50.5.7.7. ScheduleIntervalType
| Enum Values |
|---|
| UNSET |
| DAILY |
| WEEKLY |
| MONTHLY |
50.5.7.8. ScheduleWeeklyInterval
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
| day | Integer | int32 |
50.5.7.9. SimpleAccessScopeRules
Each element of any repeated field is an individual rule. Rules are joined by logical OR: if there exists a rule allowing resource x, x is in the access scope.
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
| includedClusters |
List of | ||||
| includedNamespaces | List of SimpleAccessScopeRulesNamespace | ||||
| clusterLabelSelectors | List of StorageSetBasedLabelSelector | ||||
| namespaceLabelSelectors | List of StorageSetBasedLabelSelector |
50.5.7.10. SimpleAccessScopeRulesNamespace
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
| clusterName | String | Both fields must be set. | |||
| namespaceName | String |
50.5.7.11. StorageEmailNotifierConfiguration
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
| notifierId | String | ||||
| mailingLists |
List of | ||||
| customSubject | String | ||||
| customBody | String |
50.5.7.12. StorageNotifierConfiguration
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
| emailConfig | |||||
| id | String |
50.5.7.13. StorageReportConfiguration
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
| id | String | ||||
| name | String | ||||
| description | String | ||||
| type | VULNERABILITY, | ||||
| vulnReportFilters | |||||
| scopeId | String | ||||
| emailConfig | |||||
| schedule | |||||
| lastRunStatus | |||||
| lastSuccessfulRunTime | Date | date-time | |||
| resourceScope | |||||
| notifiers | List of StorageNotifierConfiguration | ||||
| creator | |||||
| version | Integer | int32 |
50.5.7.14. StorageReportLastRunStatus
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
| reportStatus | SUCCESS, FAILURE, | ||||
| lastRunTime | Date | date-time | |||
| errorMsg | String |
50.5.7.15. StorageResourceScope
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
| collectionId | String |
50.5.7.16. StorageSchedule
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
| intervalType | UNSET, DAILY, WEEKLY, MONTHLY, | ||||
| hour | Integer | int32 | |||
| minute | Integer | int32 | |||
| weekly | |||||
| daysOfWeek | |||||
| daysOfMonth |
50.5.7.17. StorageSetBasedLabelSelector
SetBasedLabelSelector only allows set-based label requirements.
Next available tag: 3
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
| requirements |
50.5.7.18. StorageSetBasedLabelSelectorOperator
| Enum Values |
|---|
| UNKNOWN |
| IN |
| NOT_IN |
| EXISTS |
| NOT_EXISTS |
50.5.7.19. StorageSetBasedLabelSelectorRequirement
Next available tag: 4| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
| key | String | ||||
| op | UNKNOWN, IN, NOT_IN, EXISTS, NOT_EXISTS, | ||||
| values |
List of |
50.5.7.20. StorageSlimUser
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
| id | String | ||||
| name | String |
50.5.7.21. StorageVulnerabilityReportFilters
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
| fixability | BOTH, FIXABLE, NOT_FIXABLE, | ||||
| sinceLastReport | Boolean | ||||
| severities | List of StorageVulnerabilitySeverity | ||||
| imageTypes | |||||
| allVuln | Boolean | ||||
| sinceLastSentScheduledReport | Boolean | ||||
| sinceStartDate | Date | date-time | |||
| accessScopeRules | List of SimpleAccessScopeRules |
50.5.7.22. StorageVulnerabilitySeverity
| Enum Values |
|---|
| UNKNOWN_VULNERABILITY_SEVERITY |
| LOW_VULNERABILITY_SEVERITY |
| MODERATE_VULNERABILITY_SEVERITY |
| IMPORTANT_VULNERABILITY_SEVERITY |
| CRITICAL_VULNERABILITY_SEVERITY |
50.5.7.23. V1UpdateReportConfigurationRequest
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
| id | String | ||||
| reportConfig |
50.5.7.24. VulnerabilityReportFiltersFixability
| Enum Values |
|---|
| BOTH |
| FIXABLE |
| NOT_FIXABLE |
50.5.7.25. VulnerabilityReportFiltersImageType
| Enum Values |
|---|
| DEPLOYED |
| WATCHED |
50.6. PostReportConfiguration
POST /v1/report/configurations
PostReportConfiguration creates a report configuration
50.6.1. Description
50.6.2. Parameters
50.6.2.1. Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| body | X |
50.6.3. Return Type
50.6.4. Content Type
- application/json
50.6.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
50.6.6. Samples
50.6.7. Common object reference
50.6.7.1. 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++.
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 Gofoo := &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".
50.6.7.1.1. 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 |
50.6.7.2. ReportConfigurationReportType
| Enum Values |
|---|
| VULNERABILITY |
50.6.7.3. ReportLastRunStatusRunStatus
| Enum Values |
|---|
| SUCCESS |
| FAILURE |
50.6.7.4. RuntimeError
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
| error | String | ||||
| code | Integer | int32 | |||
| message | String | ||||
| details | List of ProtobufAny |
50.6.7.5. ScheduleDaysOfMonth
1 for 1st, 2 for 2nd .... 31 for 31st| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
| days |
List of | int32 |
50.6.7.6. ScheduleDaysOfWeek
Sunday = 0, Monday = 1, .... Saturday = 6| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
| days |
List of | int32 |
50.6.7.7. ScheduleIntervalType
| Enum Values |
|---|
| UNSET |
| DAILY |
| WEEKLY |
| MONTHLY |
50.6.7.8. ScheduleWeeklyInterval
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
| day | Integer | int32 |
50.6.7.9. SimpleAccessScopeRules
Each element of any repeated field is an individual rule. Rules are joined by logical OR: if there exists a rule allowing resource x, x is in the access scope.
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
| includedClusters |
List of | ||||
| includedNamespaces | List of SimpleAccessScopeRulesNamespace | ||||
| clusterLabelSelectors | List of StorageSetBasedLabelSelector | ||||
| namespaceLabelSelectors | List of StorageSetBasedLabelSelector |
50.6.7.10. SimpleAccessScopeRulesNamespace
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
| clusterName | String | Both fields must be set. | |||
| namespaceName | String |
50.6.7.11. StorageEmailNotifierConfiguration
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
| notifierId | String | ||||
| mailingLists |
List of | ||||
| customSubject | String | ||||
| customBody | String |
50.6.7.12. StorageNotifierConfiguration
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
| emailConfig | |||||
| id | String |
50.6.7.13. StorageReportConfiguration
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
| id | String | ||||
| name | String | ||||
| description | String | ||||
| type | VULNERABILITY, | ||||
| vulnReportFilters | |||||
| scopeId | String | ||||
| emailConfig | |||||
| schedule | |||||
| lastRunStatus | |||||
| lastSuccessfulRunTime | Date | date-time | |||
| resourceScope | |||||
| notifiers | List of StorageNotifierConfiguration | ||||
| creator | |||||
| version | Integer | int32 |
50.6.7.14. StorageReportLastRunStatus
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
| reportStatus | SUCCESS, FAILURE, | ||||
| lastRunTime | Date | date-time | |||
| errorMsg | String |
50.6.7.15. StorageResourceScope
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
| collectionId | String |
50.6.7.16. StorageSchedule
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
| intervalType | UNSET, DAILY, WEEKLY, MONTHLY, | ||||
| hour | Integer | int32 | |||
| minute | Integer | int32 | |||
| weekly | |||||
| daysOfWeek | |||||
| daysOfMonth |
50.6.7.17. StorageSetBasedLabelSelector
SetBasedLabelSelector only allows set-based label requirements.
Next available tag: 3
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
| requirements |
50.6.7.18. StorageSetBasedLabelSelectorOperator
| Enum Values |
|---|
| UNKNOWN |
| IN |
| NOT_IN |
| EXISTS |
| NOT_EXISTS |
50.6.7.19. StorageSetBasedLabelSelectorRequirement
Next available tag: 4| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
| key | String | ||||
| op | UNKNOWN, IN, NOT_IN, EXISTS, NOT_EXISTS, | ||||
| values |
List of |
50.6.7.20. StorageSlimUser
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
| id | String | ||||
| name | String |
50.6.7.21. StorageVulnerabilityReportFilters
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
| fixability | BOTH, FIXABLE, NOT_FIXABLE, | ||||
| sinceLastReport | Boolean | ||||
| severities | List of StorageVulnerabilitySeverity | ||||
| imageTypes | |||||
| allVuln | Boolean | ||||
| sinceLastSentScheduledReport | Boolean | ||||
| sinceStartDate | Date | date-time | |||
| accessScopeRules | List of SimpleAccessScopeRules |
50.6.7.22. StorageVulnerabilitySeverity
| Enum Values |
|---|
| UNKNOWN_VULNERABILITY_SEVERITY |
| LOW_VULNERABILITY_SEVERITY |
| MODERATE_VULNERABILITY_SEVERITY |
| IMPORTANT_VULNERABILITY_SEVERITY |
| CRITICAL_VULNERABILITY_SEVERITY |
50.6.7.23. V1PostReportConfigurationRequest
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
| reportConfig |
50.6.7.24. V1PostReportConfigurationResponse
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
| reportConfig |
50.6.7.25. VulnerabilityReportFiltersFixability
| Enum Values |
|---|
| BOTH |
| FIXABLE |
| NOT_FIXABLE |
50.6.7.26. VulnerabilityReportFiltersImageType
| Enum Values |
|---|
| DEPLOYED |
| WATCHED |
'%20d='M201.5%20305.5c-13.8%200-24.9-11.1-24.9-24.6%200-13.8%2011.1-24.9%2024.9-24.9%2013.6%200%2024.6%2011.1%2024.6%2024.9%200%2013.6-11.1%2024.6-24.6%2024.6zM504%20256c0%20137-111%20248-248%20248S8%20393%208%20256%20119%208%20256%208s248%20111%20248%20248zm-132.3-41.2c-9.4%200-17.7%203.9-23.8%2010-22.4-15.5-52.6-25.5-86.1-26.6l17.4-78.3%2055.4%2012.5c0%2013.6%2011.1%2024.6%2024.6%2024.6%2013.8%200%2024.9-11.3%2024.9-24.9s-11.1-24.9-24.9-24.9c-9.7%200-18%205.8-22.1%2013.8l-61.2-13.6c-3-.8-6.1%201.4-6.9%204.4l-19.1%2086.4c-33.2%201.4-63.1%2011.3-85.5%2026.8-6.1-6.4-14.7-10.2-24.1-10.2-34.9%200-46.3%2046.9-14.4%2062.8-1.1%205-1.7%2010.2-1.7%2015.5%200%2052.6%2059.2%2095.2%20132%2095.2%2073.1%200%20132.3-42.6%20132.3-95.2%200-5.3-.6-10.8-1.9-15.8%2031.3-16%2019.8-62.5-14.9-62.5zM302.8%20331c-18.2%2018.2-76.1%2017.9-93.6%200-2.2-2.2-6.1-2.2-8.3%200-2.5%202.5-2.5%206.4%200%208.6%2022.8%2022.8%2087.3%2022.8%20110.2%200%202.5-2.2%202.5-6.1%200-8.6-2.2-2.2-6.1-2.2-8.3%200zm7.7-75c-13.6%200-24.6%2011.1-24.6%2024.9%200%2013.6%2011.1%2024.6%2024.6%2024.6%2013.8%200%2024.9-11.1%2024.9-24.6%200-13.8-11-24.9-24.9-24.9z'/%3e%3c/svg%3e){kind=small}