Documentation
¶
Overview ¶
Package v1alpha1 provides primitives to interact with the openapi HTTP API.
Code generated by github.com/oapi-codegen/oapi-codegen/v2 version v2.5.1 DO NOT EDIT.
Package v1alpha1 provides primitives to interact with the openapi HTTP API.
Code generated by github.com/oapi-codegen/oapi-codegen/v2 version v2.5.1 DO NOT EDIT.
Index ¶
- Constants
- func GetSwagger() (swagger *openapi3.T, err error)
- func PathToRawSpec(pathToFile string) map[string]func() ([]byte, error)
- type AffectedFleet
- type ApiVersion
- type Catalog
- type CatalogItem
- type CatalogItemArtifact
- type CatalogItemArtifactType
- type CatalogItemCategory
- type CatalogItemConfigurable
- type CatalogItemDeprecation
- type CatalogItemList
- type CatalogItemMeta
- type CatalogItemSpec
- type CatalogItemType
- type CatalogItemVersion
- type CatalogList
- type CatalogSpec
- type CatalogStatus
- type CreateCatalogItemJSONRequestBody
- type CreateCatalogJSONRequestBody
- type CveCountsBySeverity
- type DeviceCountsBySeverity
- type DeviceVulnerabilitySummaryResponse
- type FleetVulnerabilitySummary
- type FleetVulnerabilitySummaryResponse
- type GetDeviceVulnerabilitiesParams
- type GetDeviceVulnerabilitiesParamsOrder
- type GetDeviceVulnerabilitiesParamsSortBy
- type GetDeviceVulnerabilitySummaryParams
- type GetFleetVulnerabilitiesParams
- type GetFleetVulnerabilitiesParamsOrder
- type GetFleetVulnerabilitiesParamsSortBy
- type GetFleetVulnerabilitySummaryParams
- type GetVulnerabilityImpactParams
- type GetVulnerabilityImpactParamsOrder
- type GetVulnerabilityImpactParamsSortBy
- type ListAllCatalogItemsParams
- type ListCatalogItemsParams
- type ListCatalogsParams
- type ListVulnerabilitiesParams
- type ListVulnerabilitiesParamsOrder
- type ListVulnerabilitiesParamsSortBy
- type PatchCatalogApplicationJSONPatchPlusJSONRequestBody
- type PatchCatalogItemApplicationJSONPatchPlusJSONRequestBody
- type PatchCatalogStatusApplicationJSONPatchPlusJSONRequestBody
- type ReplaceCatalogItemJSONRequestBody
- type ReplaceCatalogJSONRequestBody
- type ReplaceCatalogStatusJSONRequestBody
- type SemVer
- type SemVerRange
- type Status
- type Vulnerability
- type VulnerabilityGroup
- type VulnerabilityGroupItem
- type VulnerabilityGroupItemSeverity
- type VulnerabilityGroupList
- type VulnerabilityGroupSeverity
- type VulnerabilityImageRef
- type VulnerabilityImpact
- type VulnerabilityImpactSeverity
- type VulnerabilityList
- type VulnerabilitySeverity
- type VulnerabilitySeveritySummary
- type VulnerabilitySummaryResponse
Constants ¶
const ( StatusKind = "Status" CatalogAPIVersion = "v1alpha1" CatalogKind = "Catalog" CatalogListKind = "CatalogList" CatalogItemKind = "CatalogItem" CatalogItemListKind = "CatalogItemList" VulnerabilityKind = "Vulnerability" VulnerabilityListKind = "VulnerabilityList" VulnerabilityGroupKind = "VulnerabilityGroup" VulnerabilityGroupListKind = "VulnerabilityGroupList" FleetVulnerabilityGroupKind = "FleetVulnerabilityGroup" VulnerabilityImpactKind = "VulnerabilityImpact" VulnerabilitySummaryKind = "VulnerabilitySummary" DeviceVulnerabilitySummaryKind = "DeviceVulnerabilitySummary" FleetVulnerabilitySummaryKind = "FleetVulnerabilitySummary" )
Variables ¶
This section is empty.
Functions ¶
func GetSwagger ¶
GetSwagger returns the Swagger specification corresponding to the generated code in this file. The external references of Swagger specification are resolved. The logic of resolving external references is tightly connected to "import-mapping" feature. Externally referenced files must be embedded in the corresponding golang packages. Urls can be supported but this task was out of the scope.
Types ¶
type AffectedFleet ¶ added in v1.2.0
type AffectedFleet struct {
// AffectedDevices Devices in this fleet or fleetless group affected by the CVE.
AffectedDevices int64 `json:"affectedDevices"`
// Findings Per-digest findings within this fleet or fleetless group.
Findings []VulnerabilityGroupItem `json:"findings"`
// FleetName Fleet metadata.name, empty for the fleetless aggregate.
FleetName string `json:"fleetName"`
// Fleetless True when this row represents devices not owned by a fleet.
Fleetless bool `json:"fleetless"`
}
AffectedFleet One fleet or the fleetless aggregate with device and image counts for a CVE.
type ApiVersion ¶
type ApiVersion = string
ApiVersion APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources.
type Catalog ¶
type Catalog struct {
// ApiVersion APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources.
ApiVersion ApiVersion `json:"apiVersion"`
// Kind Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds.
Kind string `json:"kind"`
// Metadata ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
Metadata externalRef0.ObjectMeta `json:"metadata"`
// Spec CatalogSpec describes the configuration of a catalog. Catalogs are containers for locally-managed CatalogItems.
Spec CatalogSpec `json:"spec"`
// Status CatalogStatus represents the current status of a catalog source.
Status *CatalogStatus `json:"status,omitempty"`
}
Catalog defines model for Catalog.
func (*Catalog) ValidateUpdate ¶
ValidateUpdate ensures immutable fields are unchanged for Catalog.
type CatalogItem ¶
type CatalogItem struct {
// ApiVersion APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources.
ApiVersion ApiVersion `json:"apiVersion"`
// Kind Kind is a string value representing the REST resource this object represents.
Kind string `json:"kind"`
// Metadata Metadata for CatalogItem resources. Extends ObjectMeta with catalog scoping.
Metadata CatalogItemMeta `json:"metadata"`
// Spec CatalogItemSpec defines the configuration for a catalog item.
Spec CatalogItemSpec `json:"spec"`
}
CatalogItem CatalogItem represents an application template from a catalog. It provides default configuration values that can be customized when adding the application to a fleet.
func (CatalogItem) Validate ¶
func (ci CatalogItem) Validate() []error
func (*CatalogItem) ValidateUpdate ¶
func (c *CatalogItem) ValidateUpdate(newObj *CatalogItem) []error
ValidateUpdate ensures immutable fields are unchanged for CatalogItem.
type CatalogItemArtifact ¶
type CatalogItemArtifact struct {
// Name Optional human-readable display name for this artifact.
Name *string `json:"name,omitempty"`
// Type Artifact format discriminator. Must be unique within the artifacts list. Includes bootc-image-builder output formats.
Type CatalogItemArtifactType `json:"type"`
// Uri Artifact URI without version qualifier. The version reference (tag or digest) is applied at resolution time.
Uri string `json:"uri"`
}
CatalogItemArtifact An artifact reference. The type field is the discriminator and must be unique within the artifacts list.
type CatalogItemArtifactType ¶
type CatalogItemArtifactType string
CatalogItemArtifactType Artifact format discriminator. Must be unique within the artifacts list. Includes bootc-image-builder output formats.
const ( CatalogItemArtifactTypeAmi CatalogItemArtifactType = "ami" CatalogItemArtifactTypeAnacondaIso CatalogItemArtifactType = "anaconda-iso" CatalogItemArtifactTypeContainer CatalogItemArtifactType = "container" CatalogItemArtifactTypeGce CatalogItemArtifactType = "gce" CatalogItemArtifactTypeIso CatalogItemArtifactType = "iso" CatalogItemArtifactTypeQcow2 CatalogItemArtifactType = "qcow2" CatalogItemArtifactTypeQcow2DiskContainer CatalogItemArtifactType = "qcow2-disk-container" CatalogItemArtifactTypeRaw CatalogItemArtifactType = "raw" CatalogItemArtifactTypeVhd CatalogItemArtifactType = "vhd" CatalogItemArtifactTypeVmdk CatalogItemArtifactType = "vmdk" )
Defines values for CatalogItemArtifactType.
type CatalogItemCategory ¶
type CatalogItemCategory string
CatalogItemCategory Category of a catalog item.
const ( CatalogItemCategoryApplication CatalogItemCategory = "application" CatalogItemCategorySystem CatalogItemCategory = "system" )
Defines values for CatalogItemCategory.
type CatalogItemConfigurable ¶
type CatalogItemConfigurable struct {
// Config Configuration values (envVars, ports, volumes, resources, etc.).
Config *map[string]interface{} `json:"config,omitempty"`
// ConfigSchema JSON Schema defining configurable parameters and their validation.
ConfigSchema *map[string]interface{} `json:"configSchema,omitempty"`
// Readme Detailed documentation, preferably in markdown format.
Readme *string `json:"readme,omitempty"`
}
CatalogItemConfigurable Configuration fields that can be specified at item level (as defaults) and overridden at version level. Version-level values fully replace item-level values (not merged).
type CatalogItemDeprecation ¶
type CatalogItemDeprecation struct {
// Message Required message explaining why this is deprecated and what to do instead.
Message string `json:"message"`
// Replacement Optional name of the replacement catalog item (item-level only).
Replacement *string `json:"replacement,omitempty"`
}
CatalogItemDeprecation Deprecation information for a catalog item or version. Presence indicates deprecated status.
type CatalogItemList ¶
type CatalogItemList struct {
// ApiVersion APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources.
ApiVersion ApiVersion `json:"apiVersion"`
// Items List of CatalogItems.
Items []CatalogItem `json:"items"`
// Kind Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds.
Kind string `json:"kind"`
// Metadata ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}.
Metadata externalRef0.ListMeta `json:"metadata"`
}
CatalogItemList CatalogItemList is a list of CatalogItems.
type CatalogItemMeta ¶
type CatalogItemMeta struct {
// Annotations Properties set by the service.
Annotations *map[string]string `json:"annotations,omitempty"`
// Catalog The catalog this item belongs to. Similar to namespace in Kubernetes.
Catalog string `json:"catalog"`
// CreationTimestamp The time the object was created.
CreationTimestamp *time.Time `json:"creationTimestamp,omitempty"`
// DeletionTimestamp The time the object will be deleted.
DeletionTimestamp *time.Time `json:"deletionTimestamp,omitempty"`
// Generation A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.
Generation *int64 `json:"generation,omitempty"`
// Labels Map of string keys and values that can be used to organize and categorize (scope and select) objects.
Labels *map[string]string `json:"labels,omitempty"`
// Name The name of the object.
Name *string `json:"name,omitempty"`
// Owner A resource that owns this resource, in "kind/name" format.
Owner *string `json:"owner,omitempty"`
// ResourceVersion An opaque string that identifies the server's internal version of an object.
ResourceVersion *string `json:"resourceVersion,omitempty"`
}
CatalogItemMeta defines model for CatalogItemMeta.
type CatalogItemSpec ¶
type CatalogItemSpec struct {
// Artifacts Artifact definitions for this catalog item. Defined once; version references resolve each artifact independently. Type must be unique within the list.
Artifacts []CatalogItemArtifact `json:"artifacts"`
// Category Category of a catalog item.
Category *CatalogItemCategory `json:"category,omitempty"`
// Defaults Configuration fields that can be specified at item level (as defaults) and overridden at version level. Version-level values fully replace item-level values (not merged).
Defaults *CatalogItemConfigurable `json:"defaults,omitempty"`
// Deprecation Deprecation information for a catalog item or version. Presence indicates deprecated status.
Deprecation *CatalogItemDeprecation `json:"deprecation,omitempty"`
// DisplayName Human-readable display name shown in catalog listings.
DisplayName *string `json:"displayName,omitempty"`
// DocumentationUrl Link to external documentation.
DocumentationUrl *string `json:"documentationUrl,omitempty"`
// Homepage The homepage URL for the catalog item project.
Homepage *string `json:"homepage,omitempty"`
// Icon URL or data URI of the catalog item icon for display in UI.
Icon *string `json:"icon,omitempty"`
// Provider Provider or publisher of the catalog item (company or team name).
Provider *string `json:"provider,omitempty"`
// ShortDescription A brief one-line description of the catalog item.
ShortDescription *string `json:"shortDescription,omitempty"`
// Support Link to support resources or documentation for getting help.
Support *string `json:"support,omitempty"`
// Type Type of catalog item within its category.
Type CatalogItemType `json:"type"`
// Versions Available versions using Cincinnati model. Use replaces for primary edge, skips when stable channel skips intermediate versions.
Versions []CatalogItemVersion `json:"versions"`
}
CatalogItemSpec CatalogItemSpec defines the configuration for a catalog item.
type CatalogItemType ¶
type CatalogItemType string
CatalogItemType Type of catalog item within its category.
const ( CatalogItemTypeCompose CatalogItemType = "compose" CatalogItemTypeContainer CatalogItemType = "container" CatalogItemTypeData CatalogItemType = "data" CatalogItemTypeDriver CatalogItemType = "driver" CatalogItemTypeFirmware CatalogItemType = "firmware" CatalogItemTypeHelm CatalogItemType = "helm" CatalogItemTypeOS CatalogItemType = "os" CatalogItemTypeQuadlet CatalogItemType = "quadlet" )
Defines values for CatalogItemType.
type CatalogItemVersion ¶
type CatalogItemVersion struct {
// Channels Channels this version belongs to.
Channels []string `json:"channels"`
// Config Configuration values (envVars, ports, volumes, resources, etc.).
Config *map[string]interface{} `json:"config,omitempty"`
// ConfigSchema JSON Schema defining configurable parameters and their validation.
ConfigSchema *map[string]interface{} `json:"configSchema,omitempty"`
// Deprecation Deprecation information for a catalog item or version. Presence indicates deprecated status.
Deprecation *CatalogItemDeprecation `json:"deprecation,omitempty"`
// Readme Detailed documentation, preferably in markdown format.
Readme *string `json:"readme,omitempty"`
// References Map of artifact type to image tag or digest. Keys must match a type in spec.artifacts. Only keyed artifacts are available for this version.
References map[string]string `json:"references"`
// Replaces The single version this one replaces, defining the primary upgrade edge.
Replaces *SemVer `json:"replaces,omitempty"`
// SkipRange Semver range of versions that can upgrade directly to this one. Use for z-stream updates or hotfixes.
SkipRange *SemVerRange `json:"skipRange,omitempty"`
// Skips Additional versions that can upgrade directly to this one. Use when stable channel skips intermediate fast-only versions.
Skips *[]SemVer `json:"skips,omitempty"`
// Version Semantic version identifier (e.g., 1.2.3, 2.0.0-rc1). Required for version ordering and upgrade graph.
Version SemVer `json:"version"`
}
CatalogItemVersion defines model for CatalogItemVersion.
type CatalogList ¶
type CatalogList struct {
// ApiVersion APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources.
ApiVersion ApiVersion `json:"apiVersion"`
// Items List of Catalogs.
Items []Catalog `json:"items"`
// Kind Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds.
Kind string `json:"kind"`
// Metadata ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}.
Metadata externalRef0.ListMeta `json:"metadata"`
}
CatalogList CatalogList is a list of Catalogs.
type CatalogSpec ¶
type CatalogSpec struct {
// DisplayName Human-readable display name shown in catalog listings.
DisplayName *string `json:"displayName,omitempty"`
// Icon URL or data URI of the catalog icon for display in UI.
Icon *string `json:"icon,omitempty"`
// Provider Provider or publisher of the catalog (company or team name).
Provider *string `json:"provider,omitempty"`
// ShortDescription A brief one-line description of the catalog.
ShortDescription *string `json:"shortDescription,omitempty"`
// Support Link to support resources or documentation for getting help.
Support *string `json:"support,omitempty"`
}
CatalogSpec CatalogSpec describes the configuration of a catalog. Catalogs are containers for locally-managed CatalogItems.
type CatalogStatus ¶
type CatalogStatus struct {
// Conditions Current state of the catalog source.
Conditions []externalRef0.Condition `json:"conditions"`
}
CatalogStatus CatalogStatus represents the current status of a catalog source.
type CreateCatalogItemJSONRequestBody ¶
type CreateCatalogItemJSONRequestBody = CatalogItem
CreateCatalogItemJSONRequestBody defines body for CreateCatalogItem for application/json ContentType.
type CreateCatalogJSONRequestBody ¶
type CreateCatalogJSONRequestBody = Catalog
CreateCatalogJSONRequestBody defines body for CreateCatalog for application/json ContentType.
type CveCountsBySeverity ¶ added in v1.2.0
type CveCountsBySeverity struct {
// Critical Count of distinct Critical CVEs.
Critical int64 `json:"critical"`
// High Count of distinct High CVEs.
High int64 `json:"high"`
// Low Count of distinct Low CVEs.
Low int64 `json:"low"`
// Medium Count of distinct Medium CVEs.
Medium int64 `json:"medium"`
// None Count of distinct CVEs with no exploitable impact (CVSS score 0).
None int64 `json:"none"`
// Total Total distinct CVEs across the organization.
Total int64 `json:"total"`
// Unknown Count of distinct CVEs with unknown or unscored severity.
Unknown int64 `json:"unknown"`
}
CveCountsBySeverity Counts of distinct CVEs in the organization by highest severity.
type DeviceCountsBySeverity ¶ added in v1.2.0
type DeviceCountsBySeverity struct {
// Critical Number of devices whose highest severity finding is critical.
Critical int64 `json:"critical"`
// High Number of devices whose highest severity finding is high.
High int64 `json:"high"`
// Low Number of devices whose highest severity finding is low.
Low int64 `json:"low"`
// Medium Number of devices whose highest severity finding is medium.
Medium int64 `json:"medium"`
// None Number of devices whose highest severity finding is none.
None int64 `json:"none"`
// Total Number of distinct devices with at least one vulnerability finding in the organization.
Total int64 `json:"total"`
// Unknown Number of devices whose highest severity finding is unknown.
Unknown int64 `json:"unknown"`
}
DeviceCountsBySeverity Counts of distinct devices affected in the organization, grouped by vulnerability severity.
type DeviceVulnerabilitySummaryResponse ¶ added in v1.2.0
type DeviceVulnerabilitySummaryResponse struct {
// ApiVersion APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources.
ApiVersion ApiVersion `json:"apiVersion"`
// Image Image reference from device status. Absent when the device has no rendered OS image.
Image *string `json:"image,omitempty"`
// ImageDigest Image digest from device status. Absent when the device has no rendered OS image.
ImageDigest *string `json:"imageDigest,omitempty"`
// Kind Resource kind; always DeviceVulnerabilitySummary.
Kind string `json:"kind"`
// Summary Total vulnerability counts by severity for the full result set (not only the current page).
Summary VulnerabilitySeveritySummary `json:"summary"`
}
DeviceVulnerabilitySummaryResponse Severity summary for a single device.
type FleetVulnerabilitySummary ¶ added in v1.2.0
type FleetVulnerabilitySummary struct {
// Critical Count of Critical severity findings in the full result set.
Critical int64 `json:"critical"`
// High Count of High severity findings in the full result set.
High int64 `json:"high"`
// Low Count of Low severity findings in the full result set.
Low int64 `json:"low"`
// Medium Count of Medium severity findings in the full result set.
Medium int64 `json:"medium"`
// None Count of findings with no exploitable impact (CVSS score 0).
None int64 `json:"none"`
// Total Total vulnerabilities across all severities for the full result set.
Total int64 `json:"total"`
// UniqueDigests Distinct image digests observed in the fleet.
UniqueDigests int64 `json:"uniqueDigests"`
// Unknown Count of findings with unknown or unscored severity.
Unknown int64 `json:"unknown"`
}
FleetVulnerabilitySummary defines model for FleetVulnerabilitySummary.
type FleetVulnerabilitySummaryResponse ¶ added in v1.2.0
type FleetVulnerabilitySummaryResponse struct {
// ApiVersion APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources.
ApiVersion ApiVersion `json:"apiVersion"`
// Kind Resource kind; always FleetVulnerabilitySummary.
Kind string `json:"kind"`
// Summary Fleet vulnerability totals including unique digest count.
Summary FleetVulnerabilitySummary `json:"summary"`
}
FleetVulnerabilitySummaryResponse Severity summary for a single fleet.
type GetDeviceVulnerabilitiesParams ¶ added in v1.2.0
type GetDeviceVulnerabilitiesParams struct {
// Continue An optional parameter to query more results from the server. The value of the parameter must match the value of the 'continue' field in the previous list response.
Continue *string `form:"continue,omitempty" json:"continue,omitempty"`
// FieldSelector A selector to restrict the list of returned objects by their fields, supporting operators like '=', '==', and '!=' (e.g., "key1=value1,key2!=value2").
FieldSelector *string `form:"fieldSelector,omitempty" json:"fieldSelector,omitempty"`
// SortBy Field to sort vulnerability list results by.
SortBy *GetDeviceVulnerabilitiesParamsSortBy `form:"sortBy,omitempty" json:"sortBy,omitempty"`
// Order Sort order for the results.
Order *GetDeviceVulnerabilitiesParamsOrder `form:"order,omitempty" json:"order,omitempty"`
// Limit The maximum number of results returned in the list response. The server will set the 'continue' field in the list response if more results exist. The continue value may then be specified as parameter in a subsequent query.
Limit *int32 `form:"limit,omitempty" json:"limit,omitempty"`
}
GetDeviceVulnerabilitiesParams defines parameters for GetDeviceVulnerabilities.
type GetDeviceVulnerabilitiesParamsOrder ¶ added in v1.2.0
type GetDeviceVulnerabilitiesParamsOrder string
GetDeviceVulnerabilitiesParamsOrder defines parameters for GetDeviceVulnerabilities.
const ( GetDeviceVulnerabilitiesParamsOrderAsc GetDeviceVulnerabilitiesParamsOrder = "asc" GetDeviceVulnerabilitiesParamsOrderDesc GetDeviceVulnerabilitiesParamsOrder = "desc" )
Defines values for GetDeviceVulnerabilitiesParamsOrder.
type GetDeviceVulnerabilitiesParamsSortBy ¶ added in v1.2.0
type GetDeviceVulnerabilitiesParamsSortBy string
GetDeviceVulnerabilitiesParamsSortBy defines parameters for GetDeviceVulnerabilities.
const ( GetDeviceVulnerabilitiesParamsSortByCveId GetDeviceVulnerabilitiesParamsSortBy = "cveId" GetDeviceVulnerabilitiesParamsSortByCvssScore GetDeviceVulnerabilitiesParamsSortBy = "cvssScore" GetDeviceVulnerabilitiesParamsSortByPublishedAt GetDeviceVulnerabilitiesParamsSortBy = "publishedAt" GetDeviceVulnerabilitiesParamsSortBySeverity GetDeviceVulnerabilitiesParamsSortBy = "severity" )
Defines values for GetDeviceVulnerabilitiesParamsSortBy.
type GetDeviceVulnerabilitySummaryParams ¶ added in v1.2.0
type GetDeviceVulnerabilitySummaryParams struct {
// FieldSelector A selector to restrict the list of returned objects by their fields, supporting operators like '=', '==', and '!=' (e.g., "key1=value1,key2!=value2").
FieldSelector *string `form:"fieldSelector,omitempty" json:"fieldSelector,omitempty"`
}
GetDeviceVulnerabilitySummaryParams defines parameters for GetDeviceVulnerabilitySummary.
type GetFleetVulnerabilitiesParams ¶ added in v1.2.0
type GetFleetVulnerabilitiesParams struct {
// Continue An optional parameter to query more results from the server. The value of the parameter must match the value of the 'continue' field in the previous list response.
Continue *string `form:"continue,omitempty" json:"continue,omitempty"`
// FieldSelector A selector to restrict the list of returned objects by their fields, supporting operators like '=', '==', and '!=' (e.g., "key1=value1,key2!=value2").
FieldSelector *string `form:"fieldSelector,omitempty" json:"fieldSelector,omitempty"`
// SortBy Field to sort vulnerability list results by.
SortBy *GetFleetVulnerabilitiesParamsSortBy `form:"sortBy,omitempty" json:"sortBy,omitempty"`
// Order Sort order for the results.
Order *GetFleetVulnerabilitiesParamsOrder `form:"order,omitempty" json:"order,omitempty"`
// Limit The maximum number of results returned in the list response. The server will set the 'continue' field in the list response if more results exist. The continue value may then be specified as parameter in a subsequent query.
Limit *int32 `form:"limit,omitempty" json:"limit,omitempty"`
}
GetFleetVulnerabilitiesParams defines parameters for GetFleetVulnerabilities.
type GetFleetVulnerabilitiesParamsOrder ¶ added in v1.2.0
type GetFleetVulnerabilitiesParamsOrder string
GetFleetVulnerabilitiesParamsOrder defines parameters for GetFleetVulnerabilities.
const ( GetFleetVulnerabilitiesParamsOrderAsc GetFleetVulnerabilitiesParamsOrder = "asc" GetFleetVulnerabilitiesParamsOrderDesc GetFleetVulnerabilitiesParamsOrder = "desc" )
Defines values for GetFleetVulnerabilitiesParamsOrder.
type GetFleetVulnerabilitiesParamsSortBy ¶ added in v1.2.0
type GetFleetVulnerabilitiesParamsSortBy string
GetFleetVulnerabilitiesParamsSortBy defines parameters for GetFleetVulnerabilities.
const ( CveId GetFleetVulnerabilitiesParamsSortBy = "cveId" CvssScore GetFleetVulnerabilitiesParamsSortBy = "cvssScore" PublishedAt GetFleetVulnerabilitiesParamsSortBy = "publishedAt" Severity GetFleetVulnerabilitiesParamsSortBy = "severity" )
Defines values for GetFleetVulnerabilitiesParamsSortBy.
type GetFleetVulnerabilitySummaryParams ¶ added in v1.2.0
type GetFleetVulnerabilitySummaryParams struct {
// FieldSelector A selector to restrict the list of returned objects by their fields, supporting operators like '=', '==', and '!=' (e.g., "key1=value1,key2!=value2").
FieldSelector *string `form:"fieldSelector,omitempty" json:"fieldSelector,omitempty"`
}
GetFleetVulnerabilitySummaryParams defines parameters for GetFleetVulnerabilitySummary.
type GetVulnerabilityImpactParams ¶ added in v1.2.0
type GetVulnerabilityImpactParams struct {
// Continue An optional parameter to query more results from the server. The value of the parameter must match the value of the 'continue' field in the previous list response.
Continue *string `form:"continue,omitempty" json:"continue,omitempty"`
// FieldSelector Restricts blast-radius rows by device owner before aggregation. Supported key is `owner` (device owner string, for example `owner=Fleet/my-fleet`). Operators include `=`, `==`, `!=`, and set-style `in` / `notin` where applicable.
FieldSelector *string `form:"fieldSelector,omitempty" json:"fieldSelector,omitempty"`
// SortBy Field to sort blast radius rows by.
SortBy *GetVulnerabilityImpactParamsSortBy `form:"sortBy,omitempty" json:"sortBy,omitempty"`
// Order Sort order for the results.
Order *GetVulnerabilityImpactParamsOrder `form:"order,omitempty" json:"order,omitempty"`
// Limit The maximum number of results returned in the list response. The server will set the 'continue' field in the list response if more results exist. The continue value may then be specified as parameter in a subsequent query.
Limit *int32 `form:"limit,omitempty" json:"limit,omitempty"`
}
GetVulnerabilityImpactParams defines parameters for GetVulnerabilityImpact.
type GetVulnerabilityImpactParamsOrder ¶ added in v1.2.0
type GetVulnerabilityImpactParamsOrder string
GetVulnerabilityImpactParamsOrder defines parameters for GetVulnerabilityImpact.
const ( GetVulnerabilityImpactParamsOrderAsc GetVulnerabilityImpactParamsOrder = "asc" GetVulnerabilityImpactParamsOrderDesc GetVulnerabilityImpactParamsOrder = "desc" )
Defines values for GetVulnerabilityImpactParamsOrder.
type GetVulnerabilityImpactParamsSortBy ¶ added in v1.2.0
type GetVulnerabilityImpactParamsSortBy string
GetVulnerabilityImpactParamsSortBy defines parameters for GetVulnerabilityImpact.
const ( AffectedDevices GetVulnerabilityImpactParamsSortBy = "affectedDevices" FleetName GetVulnerabilityImpactParamsSortBy = "fleetName" )
Defines values for GetVulnerabilityImpactParamsSortBy.
type ListAllCatalogItemsParams ¶
type ListAllCatalogItemsParams struct {
// Continue An optional parameter to query more results from the server. The value of the parameter must match the value of the 'continue' field in the previous list response.
Continue *string `form:"continue,omitempty" json:"continue,omitempty"`
// LabelSelector A selector to restrict the list of returned objects by their labels. Defaults to everything.
LabelSelector *string `form:"labelSelector,omitempty" json:"labelSelector,omitempty"`
// FieldSelector A selector to restrict the list of returned objects by their fields, supporting operators like '=', '==', and '!=' (e.g., "key1=value1,key2!=value2").
FieldSelector *string `form:"fieldSelector,omitempty" json:"fieldSelector,omitempty"`
// Limit The maximum number of results returned in the list response. The server will set the 'continue' field in the list response if more results exist. The continue value may then be specified as parameter in a subsequent query.
Limit *int32 `form:"limit,omitempty" json:"limit,omitempty"`
}
ListAllCatalogItemsParams defines parameters for ListAllCatalogItems.
type ListCatalogItemsParams ¶
type ListCatalogItemsParams struct {
// Continue An optional parameter to query more results from the server.
Continue *string `form:"continue,omitempty" json:"continue,omitempty"`
// LabelSelector A selector to restrict the list of returned objects by their labels.
LabelSelector *string `form:"labelSelector,omitempty" json:"labelSelector,omitempty"`
// Limit The maximum number of results returned in the list response.
Limit *int32 `form:"limit,omitempty" json:"limit,omitempty"`
}
ListCatalogItemsParams defines parameters for ListCatalogItems.
type ListCatalogsParams ¶
type ListCatalogsParams struct {
// Continue An optional parameter to query more results from the server. The value of the paramter must match the value of the 'continue' field in the previous list response.
Continue *string `form:"continue,omitempty" json:"continue,omitempty"`
// LabelSelector A selector to restrict the list of returned objects by their labels. Defaults to everything.
LabelSelector *string `form:"labelSelector,omitempty" json:"labelSelector,omitempty"`
// FieldSelector A selector to restrict the list of returned objects by their fields, supporting operators like '=', '==', and '!=' (e.g., "key1=value1,key2!=value2").
FieldSelector *string `form:"fieldSelector,omitempty" json:"fieldSelector,omitempty"`
// Limit The maximum number of results returned in the list response. The server will set the 'continue' field in the list response if more results exist. The continue value may then be specified as parameter in a subsequent query.
Limit *int32 `form:"limit,omitempty" json:"limit,omitempty"`
}
ListCatalogsParams defines parameters for ListCatalogs.
type ListVulnerabilitiesParams ¶ added in v1.2.0
type ListVulnerabilitiesParams struct {
// Continue An optional parameter to query more results from the server. The value of the parameter must match the value of the 'continue' field in the previous list response.
Continue *string `form:"continue,omitempty" json:"continue,omitempty"`
// FieldSelector A selector to restrict the list of returned objects by their fields, supporting operators like '=', '==', and '!=' (e.g., "key1=value1,key2!=value2").
FieldSelector *string `form:"fieldSelector,omitempty" json:"fieldSelector,omitempty"`
// SortBy Field to sort vulnerability list results by.
SortBy *ListVulnerabilitiesParamsSortBy `form:"sortBy,omitempty" json:"sortBy,omitempty"`
// Order Sort order for the results.
Order *ListVulnerabilitiesParamsOrder `form:"order,omitempty" json:"order,omitempty"`
// Limit The maximum number of results returned in the list response. The server will set the 'continue' field in the list response if more results exist. The continue value may then be specified as parameter in a subsequent query.
Limit *int32 `form:"limit,omitempty" json:"limit,omitempty"`
}
ListVulnerabilitiesParams defines parameters for ListVulnerabilities.
type ListVulnerabilitiesParamsOrder ¶ added in v1.2.0
type ListVulnerabilitiesParamsOrder string
ListVulnerabilitiesParamsOrder defines parameters for ListVulnerabilities.
const ( ListVulnerabilitiesParamsOrderAsc ListVulnerabilitiesParamsOrder = "asc" ListVulnerabilitiesParamsOrderDesc ListVulnerabilitiesParamsOrder = "desc" )
Defines values for ListVulnerabilitiesParamsOrder.
type ListVulnerabilitiesParamsSortBy ¶ added in v1.2.0
type ListVulnerabilitiesParamsSortBy string
ListVulnerabilitiesParamsSortBy defines parameters for ListVulnerabilities.
const ( ListVulnerabilitiesParamsSortByCveId ListVulnerabilitiesParamsSortBy = "cveId" ListVulnerabilitiesParamsSortByCvssScore ListVulnerabilitiesParamsSortBy = "cvssScore" ListVulnerabilitiesParamsSortByPublishedAt ListVulnerabilitiesParamsSortBy = "publishedAt" ListVulnerabilitiesParamsSortBySeverity ListVulnerabilitiesParamsSortBy = "severity" )
Defines values for ListVulnerabilitiesParamsSortBy.
type PatchCatalogApplicationJSONPatchPlusJSONRequestBody ¶
type PatchCatalogApplicationJSONPatchPlusJSONRequestBody = externalRef0.PatchRequest
PatchCatalogApplicationJSONPatchPlusJSONRequestBody defines body for PatchCatalog for application/json-patch+json ContentType.
type PatchCatalogItemApplicationJSONPatchPlusJSONRequestBody ¶
type PatchCatalogItemApplicationJSONPatchPlusJSONRequestBody = externalRef0.PatchRequest
PatchCatalogItemApplicationJSONPatchPlusJSONRequestBody defines body for PatchCatalogItem for application/json-patch+json ContentType.
type PatchCatalogStatusApplicationJSONPatchPlusJSONRequestBody ¶
type PatchCatalogStatusApplicationJSONPatchPlusJSONRequestBody = externalRef0.PatchRequest
PatchCatalogStatusApplicationJSONPatchPlusJSONRequestBody defines body for PatchCatalogStatus for application/json-patch+json ContentType.
type ReplaceCatalogItemJSONRequestBody ¶
type ReplaceCatalogItemJSONRequestBody = CatalogItem
ReplaceCatalogItemJSONRequestBody defines body for ReplaceCatalogItem for application/json ContentType.
type ReplaceCatalogJSONRequestBody ¶
type ReplaceCatalogJSONRequestBody = Catalog
ReplaceCatalogJSONRequestBody defines body for ReplaceCatalog for application/json ContentType.
type ReplaceCatalogStatusJSONRequestBody ¶
type ReplaceCatalogStatusJSONRequestBody = Catalog
ReplaceCatalogStatusJSONRequestBody defines body for ReplaceCatalogStatus for application/json ContentType.
type SemVer ¶ added in v1.2.0
type SemVer = string
SemVer Semantic version identifier (e.g., 1.2.3, 2.0.0-rc1)
type SemVerRange ¶ added in v1.2.0
type SemVerRange = string
SemVerRange Semver range constraint (e.g., >=1.0.0 <2.0.0). Space-separated terms, each with optional operator (>=, <=, >, <, =, ~, ^) followed by a version.
type Status ¶
type Status struct {
// ApiVersion APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources.
ApiVersion ApiVersion `json:"apiVersion"`
// Code Suggested HTTP return code for this status, 0 if not set.
Code int32 `json:"code"`
// Kind Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds.
Kind string `json:"kind"`
// Message A human-readable description of the status of this operation.
Message string `json:"message"`
// Reason A machine-readable description of why this operation is in the "Failure" status. If this value is empty there is no information available. A Reason clarifies an HTTP status code but does not override it.
Reason string `json:"reason"`
// Status Status of the operation. One of: "Success" or "Failure". More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status.
Status string `json:"status"`
}
Status Status is a return value for calls that don't return other objects.
type Vulnerability ¶ added in v1.2.0
type Vulnerability struct {
// AdvisoryId Vendor advisory identifier when available.
AdvisoryId *string `json:"advisoryId,omitempty"`
// AffectedDevices Distinct devices affected by this CVE. For device context this is always 1; for fleet context it is the number of devices in the fleet running an image with this CVE; for organization-wide context it is the count across the whole organization.
AffectedDevices *int64 `json:"affectedDevices,omitempty"`
// ApiVersion APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources.
ApiVersion ApiVersion `json:"apiVersion"`
// CveId CVE identifier (e.g. CVE-2024-1234).
CveId string `json:"cveId"`
// CvssScore CVSS base score when available.
CvssScore *float32 `json:"cvssScore,omitempty"`
// Description Short summary of the vulnerability.
Description *string `json:"description,omitempty"`
// Image Image reference (name or URL) from the device context.
Image *string `json:"image,omitempty"`
// ImageDigest Immutable image digest from the device context.
ImageDigest *string `json:"imageDigest,omitempty"`
// Issuer Name of the advisory issuer (e.g. Red Hat, NVD) when known.
Issuer *string `json:"issuer,omitempty"`
// Kind Kind is a string value representing the REST resource this object represents. Always Vulnerability.
Kind string `json:"kind"`
// Link URL to the CVE details page. Points to Red Hat Security portal for Red Hat advisories, otherwise to NVD.
Link *string `json:"link,omitempty"`
// PublishedAt Advisory publish time when known.
PublishedAt *time.Time `json:"publishedAt,omitempty"`
// Severity Normalized severity label.
Severity VulnerabilitySeverity `json:"severity"`
}
Vulnerability A single vulnerability (CVE) finding. Vulnerabilities are global CVE records from Trustify; they are not tenant-owned resources. Tenancy is determined by the device or fleet context through which they are queried.
type VulnerabilityGroup ¶ added in v1.2.0
type VulnerabilityGroup struct {
// AffectedDevices Total distinct devices affected by this CVE within scope.
AffectedDevices *int64 `json:"affectedDevices,omitempty"`
// ApiVersion APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources.
ApiVersion ApiVersion `json:"apiVersion"`
// CveId CVE identifier (e.g. CVE-2024-1234).
CveId string `json:"cveId"`
// Findings Per-digest findings for this CVE within the query scope.
Findings []VulnerabilityGroupItem `json:"findings"`
// Kind Kind is a string value representing the REST resource. Always VulnerabilityGroup.
Kind string `json:"kind"`
// MaxCvssScore Highest CVSS base score across all findings.
MaxCvssScore *float32 `json:"maxCvssScore,omitempty"`
// MaxPublishedAt Latest advisory publish time across all findings.
MaxPublishedAt *time.Time `json:"maxPublishedAt,omitempty"`
// Severity Worst severity across all findings in this group.
Severity VulnerabilityGroupSeverity `json:"severity"`
}
VulnerabilityGroup A CVE grouped across one or more images, as returned by fleet-scoped and organization-wide vulnerability list endpoints. Each finding represents one image in which the CVE was detected.
type VulnerabilityGroupItem ¶ added in v1.2.0
type VulnerabilityGroupItem struct {
// AdvisoryId Vendor advisory identifier when available.
AdvisoryId *string `json:"advisoryId,omitempty"`
// AffectedDevices Number of devices in scope running this digest.
AffectedDevices *int64 `json:"affectedDevices,omitempty"`
// CvssScore CVSS base score when available.
CvssScore *float32 `json:"cvssScore,omitempty"`
// Description Short summary of the vulnerability.
Description *string `json:"description,omitempty"`
// FirstSeenAt When this CVE was first observed in this digest.
FirstSeenAt *time.Time `json:"firstSeenAt,omitempty"`
// ImageDigest Immutable image digest.
ImageDigest string `json:"imageDigest"`
// ImageRefs Image references observed for this digest within the query scope.
ImageRefs []string `json:"imageRefs"`
// Issuer Name of the advisory issuer (e.g. Red Hat, NVD) when known.
Issuer *string `json:"issuer,omitempty"`
// Link URL to the CVE details page. Points to Red Hat Security portal for Red Hat advisories, otherwise to NVD.
Link *string `json:"link,omitempty"`
// PublishedAt Advisory publish time when known.
PublishedAt *time.Time `json:"publishedAt,omitempty"`
// Severity Severity of this CVE for this digest.
Severity VulnerabilityGroupItemSeverity `json:"severity"`
}
VulnerabilityGroupItem A single CVE finding for a specific image digest, including all image refs that resolve to that digest.
type VulnerabilityGroupItemSeverity ¶ added in v1.2.0
type VulnerabilityGroupItemSeverity string
VulnerabilityGroupItemSeverity Severity of this CVE for this digest.
const ( VulnerabilityGroupItemSeverityCritical VulnerabilityGroupItemSeverity = "Critical" VulnerabilityGroupItemSeverityHigh VulnerabilityGroupItemSeverity = "High" VulnerabilityGroupItemSeverityLow VulnerabilityGroupItemSeverity = "Low" VulnerabilityGroupItemSeverityMedium VulnerabilityGroupItemSeverity = "Medium" VulnerabilityGroupItemSeverityNone VulnerabilityGroupItemSeverity = "None" VulnerabilityGroupItemSeverityUnknown VulnerabilityGroupItemSeverity = "Unknown" )
Defines values for VulnerabilityGroupItemSeverity.
type VulnerabilityGroupList ¶ added in v1.2.0
type VulnerabilityGroupList struct {
// ApiVersion APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources.
ApiVersion ApiVersion `json:"apiVersion"`
// Items Paginated VulnerabilityGroup resources for this page.
Items []VulnerabilityGroup `json:"items"`
// Kind Kind is a string value representing the REST resource. Always VulnerabilityGroupList.
Kind string `json:"kind"`
// Metadata ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}.
Metadata externalRef0.ListMeta `json:"metadata"`
}
VulnerabilityGroupList Paginated list of VulnerabilityGroup resources (fleet-scoped or organization-wide).
type VulnerabilityGroupSeverity ¶ added in v1.2.0
type VulnerabilityGroupSeverity string
VulnerabilityGroupSeverity Worst severity across all findings in this group.
const ( VulnerabilityGroupSeverityCritical VulnerabilityGroupSeverity = "Critical" VulnerabilityGroupSeverityHigh VulnerabilityGroupSeverity = "High" VulnerabilityGroupSeverityLow VulnerabilityGroupSeverity = "Low" VulnerabilityGroupSeverityMedium VulnerabilityGroupSeverity = "Medium" VulnerabilityGroupSeverityNone VulnerabilityGroupSeverity = "None" VulnerabilityGroupSeverityUnknown VulnerabilityGroupSeverity = "Unknown" )
Defines values for VulnerabilityGroupSeverity.
type VulnerabilityImageRef ¶ added in v1.2.0
type VulnerabilityImageRef struct {
// AffectedDevices Devices running this exact image digest within the parent scope (fleet or blast radius row).
AffectedDevices *int64 `json:"affectedDevices,omitempty"`
// Image Image reference (name or URL).
Image string `json:"image"`
// ImageDigest Immutable image digest.
ImageDigest string `json:"imageDigest"`
}
VulnerabilityImageRef Reference to an OS or workload image by name and digest.
type VulnerabilityImpact ¶ added in v1.2.0
type VulnerabilityImpact struct {
// ApiVersion APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources.
ApiVersion ApiVersion `json:"apiVersion"`
// CveId CVE identifier for this blast radius response.
CveId string `json:"cveId"`
// Issuer Name of the advisory issuer (e.g. Red Hat, NVD) when known.
Issuer *string `json:"issuer,omitempty"`
// Items Per-fleet or fleetless rows with device and image counts.
Items []AffectedFleet `json:"items"`
// Kind Resource kind; always VulnerabilityImpact.
Kind string `json:"kind"`
// Link URL to the CVE details page. Points to Red Hat Security portal for Red Hat advisories, otherwise to NVD.
Link *string `json:"link,omitempty"`
// MaxCvssScore Highest CVSS base score for this CVE in the fleet or fleetless group.
MaxCvssScore *float32 `json:"maxCvssScore,omitempty"`
// MaxPublishedAt When this CVE was first observed in the fleet or fleetless group.
MaxPublishedAt *time.Time `json:"maxPublishedAt,omitempty"`
// Metadata ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}.
Metadata externalRef0.ListMeta `json:"metadata"`
// Severity Worst severity for this CVE in the fleet or fleetless group.
Severity VulnerabilityImpactSeverity `json:"severity"`
}
VulnerabilityImpact Blast radius for a single CVE across fleets and fleetless devices.
type VulnerabilityImpactSeverity ¶ added in v1.2.0
type VulnerabilityImpactSeverity string
VulnerabilityImpactSeverity Worst severity for this CVE in the fleet or fleetless group.
const ( VulnerabilityImpactSeverityCritical VulnerabilityImpactSeverity = "Critical" VulnerabilityImpactSeverityHigh VulnerabilityImpactSeverity = "High" VulnerabilityImpactSeverityLow VulnerabilityImpactSeverity = "Low" VulnerabilityImpactSeverityMedium VulnerabilityImpactSeverity = "Medium" VulnerabilityImpactSeverityNone VulnerabilityImpactSeverity = "None" VulnerabilityImpactSeverityUnknown VulnerabilityImpactSeverity = "Unknown" )
Defines values for VulnerabilityImpactSeverity.
type VulnerabilityList ¶ added in v1.2.0
type VulnerabilityList struct {
// ApiVersion APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources.
ApiVersion ApiVersion `json:"apiVersion"`
// Items Paginated Vulnerability resources for this page.
Items []Vulnerability `json:"items"`
// Kind Kind is a string value representing the REST resource this object represents. Always VulnerabilityList.
Kind string `json:"kind"`
// Metadata ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}.
Metadata externalRef0.ListMeta `json:"metadata"`
}
VulnerabilityList Paginated list of Vulnerability resources.
type VulnerabilitySeverity ¶ added in v1.2.0
type VulnerabilitySeverity string
VulnerabilitySeverity Normalized severity label.
const ( VulnerabilitySeverityCritical VulnerabilitySeverity = "Critical" VulnerabilitySeverityHigh VulnerabilitySeverity = "High" VulnerabilitySeverityLow VulnerabilitySeverity = "Low" VulnerabilitySeverityMedium VulnerabilitySeverity = "Medium" VulnerabilitySeverityNone VulnerabilitySeverity = "None" VulnerabilitySeverityUnknown VulnerabilitySeverity = "Unknown" )
Defines values for VulnerabilitySeverity.
type VulnerabilitySeveritySummary ¶ added in v1.2.0
type VulnerabilitySeveritySummary struct {
// Critical Count of Critical severity findings in the full result set.
Critical int64 `json:"critical"`
// High Count of High severity findings in the full result set.
High int64 `json:"high"`
// Low Count of Low severity findings in the full result set.
Low int64 `json:"low"`
// Medium Count of Medium severity findings in the full result set.
Medium int64 `json:"medium"`
// None Count of findings with no exploitable impact (CVSS score 0).
None int64 `json:"none"`
// Total Total vulnerabilities across all severities for the full result set.
Total int64 `json:"total"`
// Unknown Count of findings with unknown or unscored severity.
Unknown int64 `json:"unknown"`
}
VulnerabilitySeveritySummary Total vulnerability counts by severity for the full result set (not only the current page).
type VulnerabilitySummaryResponse ¶ added in v1.2.0
type VulnerabilitySummaryResponse struct {
// ApiVersion APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources.
ApiVersion ApiVersion `json:"apiVersion"`
// CvesBySeverity Counts of distinct CVEs in the organization by highest severity.
CvesBySeverity CveCountsBySeverity `json:"cvesBySeverity"`
// Kind Resource kind; always VulnerabilitySummary.
Kind string `json:"kind"`
}
VulnerabilitySummaryResponse Estate-wide vulnerability summary counts.