--- title: "POST /v1/{+parent}/notes" method: POST path: "/v1/{+parent}/notes" tags: ["projects"] --- # POST /v1/{+parent}/notes `POST /v1/{+parent}/notes` Creates a new note. ## Path parameters - `parent` string, required ## Query parameters - `noteId` string ## Request body - Note — A type of analysis that can be done for a resource. - `kind` 'NOTE_KIND_UNSPECIFIED' | 'VULNERABILITY' | 'BUILD' | 'IMAGE' | 'PACKAGE' | 'DEPLOYMENT' | 'DISCOVERY' | 'ATTESTATION' | 'UPGRADE' | 'COMPLIANCE' | 'DSSE_ATTESTATION' | 'VULNERABILITY_ASSESSMENT' | 'SBOM_REFERENCE' | 'SECRET' | 'AI_SKILL_ANALYSIS' — Output only. The type of analysis. This field can be used as a filter in list requests. - `relatedUrl` RelatedUrl[] — URLs associated with this note. - `url` string — Specific URL associated with the resource. - `label` string — Label to describe usage of the URL. - `expirationTime` string, google-datetime — Time of expiration for this note. Empty if note does not expire. - `attestation` AttestationNote — Note kind that represents a logical attestation "role" or "authority". For example, an organization might have one `Authority` for "QA" and one for "build". This note is intended to act strictly as a grouping mechanism for the attached occurrences (Attestations). This grouping mechanism also provides a security boundary, since IAM ACLs gate the ability for a principle to attach an occurrence to a given note. It also provides a single point of lookup to find all attached attestation occurrences, even if they don't all live in the same project. - `hint` Hint — This submessage provides human-readable hints about the purpose of the authority. Because the name of a note acts as its resource reference, it is important to disambiguate the canonical name of the Note (which might be a UUID for security purposes) from "readable" names more suitable for debug output. Note that these hints should not be used to look up authorities in security sensitive contexts, such as when looking up attestations to verify. - `humanReadableName` string — Required. The human readable name of this attestation authority, for example "qa". - `package` PackageNote — PackageNote represents a particular package version. - `name` string — Required. Immutable. The name of the package. - `cpeUri` string — The cpe_uri in [CPE format](https://cpe.mitre.org/specification/) denoting the package manager version distributing a package. The cpe_uri will be blank for language packages. - `architecture` 'ARCHITECTURE_UNSPECIFIED' | 'X86' | 'X64' — The CPU architecture for which packages in this distribution channel were built. Architecture will be blank for language packages. - `url` string — The homepage for this package. - `description` string — The description of this package. - `version` Version — Version contains structured information about the version of a package. - `kind` 'VERSION_KIND_UNSPECIFIED' | 'NORMAL' | 'MINIMUM' | 'MAXIMUM' — Required. Distinguishes between sentinel MIN/MAX versions and normal versions. - `revision` string — The iteration of the package build from the above version. - `epoch` integer — Used to correct mistakes in the version numbering scheme. - `fullName` string — Human readable version string. This string is of the form :- and is only set when kind is NORMAL. - `name` string — Required only when version kind is NORMAL. The main part of the version name. - `inclusive` boolean — Whether this version is specifying part of an inclusive range. Grafeas does not have the capability to specify version ranges; instead we have fields that specify start version and end versions. At times this is insufficient - we also need to specify whether the version is included in the range or is excluded from the range. This boolean is expected to be set to true when the version is included in a range. - `distribution` Distribution[] — Deprecated. The various channels by which a package is distributed. - `maintainer` string — A freeform string denoting the maintainer of this package. - `url` string — The distribution channel-specific homepage for this package. - `description` string — The distribution channel-specific description of this package. - `architecture` 'ARCHITECTURE_UNSPECIFIED' | 'X86' | 'X64' — The CPU architecture for which packages in this distribution channel were built. - `cpeUri` string — Required. The cpe_uri in [CPE format](https://cpe.mitre.org/specification/) denoting the package manager version distributing a package. - `latestVersion` Version — Version contains structured information about the version of a package. - `kind` 'VERSION_KIND_UNSPECIFIED' | 'NORMAL' | 'MINIMUM' | 'MAXIMUM' — Required. Distinguishes between sentinel MIN/MAX versions and normal versions. - `revision` string — The iteration of the package build from the above version. - `epoch` integer — Used to correct mistakes in the version numbering scheme. - `fullName` string — Human readable version string. This string is of the form :- and is only set when kind is NORMAL. - `name` string — Required only when version kind is NORMAL. The main part of the version name. - `inclusive` boolean — Whether this version is specifying part of an inclusive range. Grafeas does not have the capability to specify version ranges; instead we have fields that specify start version and end versions. At times this is insufficient - we also need to specify whether the version is included in the range or is excluded from the range. This boolean is expected to be set to true when the version is included in a range. - `license` License — License information. - `expression` string — Often a single license can be used to represent the licensing terms. Sometimes it is necessary to include a choice of one or more licenses or some combination of license identifiers. Examples: "LGPL-2.1-only OR MIT", "LGPL-2.1-only AND MIT", "GPL-2.0-or-later WITH Bison-exception-2.2". - `comments` string — Comments - `packageType` string — The type of package; whether native or non native (e.g., ruby gems, node.js packages, etc.). - `maintainer` string — A freeform text denoting the maintainer of this package. - `digest` Digest[] — Hash value, typically a file digest, that allows unique identification a specific package. - `algo` string — `SHA1`, `SHA512` etc. - `digestBytes` string, byte — Value of the digest. - `vulnerability` VulnerabilityNote — A security vulnerability that can be found in resources. - `cvssV4` CVSS — Common Vulnerability Scoring System. For details, see https://www.first.org/cvss/specification-document This is a message we will try to use for storing various versions of CVSS rather than making a separate proto for storing a specific version. - `userInteraction` 'USER_INTERACTION_UNSPECIFIED' | 'USER_INTERACTION_NONE' | 'USER_INTERACTION_REQUIRED' | 'USER_INTERACTION_PASSIVE' | 'USER_INTERACTION_ACTIVE' — User Interaction (UI). Defined in CVSS v3, v4. - `impactScore` number, float - `vulnerableSystemAvailabilityImpact` 'IMPACT_UNSPECIFIED' | 'IMPACT_HIGH' | 'IMPACT_LOW' | 'IMPACT_NONE' | 'IMPACT_PARTIAL' | 'IMPACT_COMPLETE' — Vulnerable System Availability Impact (VA). Defined in CVSS v4. - `authentication` 'AUTHENTICATION_UNSPECIFIED' | 'AUTHENTICATION_MULTIPLE' | 'AUTHENTICATION_SINGLE' | 'AUTHENTICATION_NONE' — Authentication (Au). Defined in CVSS v2. - `exploitMaturity` 'EXPLOIT_MATURITY_UNSPECIFIED' | 'EXPLOIT_MATURITY_NOT_DEFINED' | 'EXPLOIT_MATURITY_ATTACKED' | 'EXPLOIT_MATURITY_POC' | 'EXPLOIT_MATURITY_UNREPORTED' — Exploit Maturity (E). Defined in CVSS v4. - `subsequentSystemIntegrityImpact` 'IMPACT_UNSPECIFIED' | 'IMPACT_HIGH' | 'IMPACT_LOW' | 'IMPACT_NONE' | 'IMPACT_PARTIAL' | 'IMPACT_COMPLETE' — Subsequent System Integrity Impact (SI). Defined in CVSS v4. - `integrityImpact` 'IMPACT_UNSPECIFIED' | 'IMPACT_HIGH' | 'IMPACT_LOW' | 'IMPACT_NONE' | 'IMPACT_PARTIAL' | 'IMPACT_COMPLETE' — Integrity Impact (I). Defined in CVSS v2, v3. - `attackRequirements` 'ATTACK_REQUIREMENTS_UNSPECIFIED' | 'ATTACK_REQUIREMENTS_NONE' | 'ATTACK_REQUIREMENTS_PRESENT' — Attack Requirements (AT). Defined in CVSS v4. - `exploitabilityScore` number, float - `attackComplexity` 'ATTACK_COMPLEXITY_UNSPECIFIED' | 'ATTACK_COMPLEXITY_LOW' | 'ATTACK_COMPLEXITY_HIGH' | 'ATTACK_COMPLEXITY_MEDIUM' — Attack Complexity (AC). Defined in CVSS v2, v3, v4. - `availabilityImpact` 'IMPACT_UNSPECIFIED' | 'IMPACT_HIGH' | 'IMPACT_LOW' | 'IMPACT_NONE' | 'IMPACT_PARTIAL' | 'IMPACT_COMPLETE' — Availability Impact (A). Defined in CVSS v2, v3. - `privilegesRequired` 'PRIVILEGES_REQUIRED_UNSPECIFIED' | 'PRIVILEGES_REQUIRED_NONE' | 'PRIVILEGES_REQUIRED_LOW' | 'PRIVILEGES_REQUIRED_HIGH' — Privileges Required (PR). Defined in CVSS v3, v4. - `baseScore` number, float — The base score is a function of the base metric scores. - `vulnerableSystemConfidentialityImpact` 'IMPACT_UNSPECIFIED' | 'IMPACT_HIGH' | 'IMPACT_LOW' | 'IMPACT_NONE' | 'IMPACT_PARTIAL' | 'IMPACT_COMPLETE' — Vulnerable System Confidentiality Impact (VC). Defined in CVSS v4. - `vulnerableSystemIntegrityImpact` 'IMPACT_UNSPECIFIED' | 'IMPACT_HIGH' | 'IMPACT_LOW' | 'IMPACT_NONE' | 'IMPACT_PARTIAL' | 'IMPACT_COMPLETE' — Vulnerable System Integrity Impact (VI). Defined in CVSS v4. - `subsequentSystemConfidentialityImpact` 'IMPACT_UNSPECIFIED' | 'IMPACT_HIGH' | 'IMPACT_LOW' | 'IMPACT_NONE' | 'IMPACT_PARTIAL' | 'IMPACT_COMPLETE' — Subsequent System Confidentiality Impact (SC). Defined in CVSS v4. - `subsequentSystemAvailabilityImpact` 'IMPACT_UNSPECIFIED' | 'IMPACT_HIGH' | 'IMPACT_LOW' | 'IMPACT_NONE' | 'IMPACT_PARTIAL' | 'IMPACT_COMPLETE' — Subsequent System Availability Impact (SA). Defined in CVSS v4. - `scope` 'SCOPE_UNSPECIFIED' | 'SCOPE_UNCHANGED' | 'SCOPE_CHANGED' — Scope (S). Defined in CVSS v3. - `confidentialityImpact` 'IMPACT_UNSPECIFIED' | 'IMPACT_HIGH' | 'IMPACT_LOW' | 'IMPACT_NONE' | 'IMPACT_PARTIAL' | 'IMPACT_COMPLETE' — Confidentiality Impact (C). Defined in CVSS v2, v3. - `attackVector` 'ATTACK_VECTOR_UNSPECIFIED' | 'ATTACK_VECTOR_NETWORK' | 'ATTACK_VECTOR_ADJACENT' | 'ATTACK_VECTOR_LOCAL' | 'ATTACK_VECTOR_PHYSICAL' — Attack Vector (AV). Defined in CVSS v2, v3, v4. - `cvssScore` number, float — The CVSS score of this vulnerability. CVSS score is on a scale of 0 - 10 where 0 indicates low severity and 10 indicates high severity. - `severity` 'SEVERITY_UNSPECIFIED' | 'MINIMAL' | 'LOW' | 'MEDIUM' | 'HIGH' | 'CRITICAL' — The note provider assigned severity of this vulnerability. - `cvssV2` CVSS — Common Vulnerability Scoring System. For details, see https://www.first.org/cvss/specification-document This is a message we will try to use for storing various versions of CVSS rather than making a separate proto for storing a specific version. - `userInteraction` 'USER_INTERACTION_UNSPECIFIED' | 'USER_INTERACTION_NONE' | 'USER_INTERACTION_REQUIRED' | 'USER_INTERACTION_PASSIVE' | 'USER_INTERACTION_ACTIVE' — User Interaction (UI). Defined in CVSS v3, v4. - `impactScore` number, float - `vulnerableSystemAvailabilityImpact` 'IMPACT_UNSPECIFIED' | 'IMPACT_HIGH' | 'IMPACT_LOW' | 'IMPACT_NONE' | 'IMPACT_PARTIAL' | 'IMPACT_COMPLETE' — Vulnerable System Availability Impact (VA). Defined in CVSS v4. - `authentication` 'AUTHENTICATION_UNSPECIFIED' | 'AUTHENTICATION_MULTIPLE' | 'AUTHENTICATION_SINGLE' | 'AUTHENTICATION_NONE' — Authentication (Au). Defined in CVSS v2. - `exploitMaturity` 'EXPLOIT_MATURITY_UNSPECIFIED' | 'EXPLOIT_MATURITY_NOT_DEFINED' | 'EXPLOIT_MATURITY_ATTACKED' | 'EXPLOIT_MATURITY_POC' | 'EXPLOIT_MATURITY_UNREPORTED' — Exploit Maturity (E). Defined in CVSS v4. - `subsequentSystemIntegrityImpact` 'IMPACT_UNSPECIFIED' | 'IMPACT_HIGH' | 'IMPACT_LOW' | 'IMPACT_NONE' | 'IMPACT_PARTIAL' | 'IMPACT_COMPLETE' — Subsequent System Integrity Impact (SI). Defined in CVSS v4. - `integrityImpact` 'IMPACT_UNSPECIFIED' | 'IMPACT_HIGH' | 'IMPACT_LOW' | 'IMPACT_NONE' | 'IMPACT_PARTIAL' | 'IMPACT_COMPLETE' — Integrity Impact (I). Defined in CVSS v2, v3. - `attackRequirements` 'ATTACK_REQUIREMENTS_UNSPECIFIED' | 'ATTACK_REQUIREMENTS_NONE' | 'ATTACK_REQUIREMENTS_PRESENT' — Attack Requirements (AT). Defined in CVSS v4. - `exploitabilityScore` number, float - `attackComplexity` 'ATTACK_COMPLEXITY_UNSPECIFIED' | 'ATTACK_COMPLEXITY_LOW' | 'ATTACK_COMPLEXITY_HIGH' | 'ATTACK_COMPLEXITY_MEDIUM' — Attack Complexity (AC). Defined in CVSS v2, v3, v4. - `availabilityImpact` 'IMPACT_UNSPECIFIED' | 'IMPACT_HIGH' | 'IMPACT_LOW' | 'IMPACT_NONE' | 'IMPACT_PARTIAL' | 'IMPACT_COMPLETE' — Availability Impact (A). Defined in CVSS v2, v3. - `privilegesRequired` 'PRIVILEGES_REQUIRED_UNSPECIFIED' | 'PRIVILEGES_REQUIRED_NONE' | 'PRIVILEGES_REQUIRED_LOW' | 'PRIVILEGES_REQUIRED_HIGH' — Privileges Required (PR). Defined in CVSS v3, v4. - `baseScore` number, float — The base score is a function of the base metric scores. - `vulnerableSystemConfidentialityImpact` 'IMPACT_UNSPECIFIED' | 'IMPACT_HIGH' | 'IMPACT_LOW' | 'IMPACT_NONE' | 'IMPACT_PARTIAL' | 'IMPACT_COMPLETE' — Vulnerable System Confidentiality Impact (VC). Defined in CVSS v4. - `vulnerableSystemIntegrityImpact` 'IMPACT_UNSPECIFIED' | 'IMPACT_HIGH' | 'IMPACT_LOW' | 'IMPACT_NONE' | 'IMPACT_PARTIAL' | 'IMPACT_COMPLETE' — Vulnerable System Integrity Impact (VI). Defined in CVSS v4. - `subsequentSystemConfidentialityImpact` 'IMPACT_UNSPECIFIED' | 'IMPACT_HIGH' | 'IMPACT_LOW' | 'IMPACT_NONE' | 'IMPACT_PARTIAL' | 'IMPACT_COMPLETE' — Subsequent System Confidentiality Impact (SC). Defined in CVSS v4. - `subsequentSystemAvailabilityImpact` 'IMPACT_UNSPECIFIED' | 'IMPACT_HIGH' | 'IMPACT_LOW' | 'IMPACT_NONE' | 'IMPACT_PARTIAL' | 'IMPACT_COMPLETE' — Subsequent System Availability Impact (SA). Defined in CVSS v4. - `scope` 'SCOPE_UNSPECIFIED' | 'SCOPE_UNCHANGED' | 'SCOPE_CHANGED' — Scope (S). Defined in CVSS v3. - `confidentialityImpact` 'IMPACT_UNSPECIFIED' | 'IMPACT_HIGH' | 'IMPACT_LOW' | 'IMPACT_NONE' | 'IMPACT_PARTIAL' | 'IMPACT_COMPLETE' — Confidentiality Impact (C). Defined in CVSS v2, v3. - `attackVector` 'ATTACK_VECTOR_UNSPECIFIED' | 'ATTACK_VECTOR_NETWORK' | 'ATTACK_VECTOR_ADJACENT' | 'ATTACK_VECTOR_LOCAL' | 'ATTACK_VECTOR_PHYSICAL' — Attack Vector (AV). Defined in CVSS v2, v3, v4. - `cvssVersion` 'CVSS_VERSION_UNSPECIFIED' | 'CVSS_VERSION_2' | 'CVSS_VERSION_3' | 'CVSS_VERSION_4' — CVSS version used to populate cvss_score and severity. - `cvssV3` CVSSv3 — Common Vulnerability Scoring System version 3. For details, see https://www.first.org/cvss/specification-document - `baseScore` number, float — The base score is a function of the base metric scores. - `integrityImpact` 'IMPACT_UNSPECIFIED' | 'IMPACT_HIGH' | 'IMPACT_LOW' | 'IMPACT_NONE' - `scope` 'SCOPE_UNSPECIFIED' | 'SCOPE_UNCHANGED' | 'SCOPE_CHANGED' - `exploitabilityScore` number, float - `confidentialityImpact` 'IMPACT_UNSPECIFIED' | 'IMPACT_HIGH' | 'IMPACT_LOW' | 'IMPACT_NONE' - `attackVector` 'ATTACK_VECTOR_UNSPECIFIED' | 'ATTACK_VECTOR_NETWORK' | 'ATTACK_VECTOR_ADJACENT' | 'ATTACK_VECTOR_LOCAL' | 'ATTACK_VECTOR_PHYSICAL' — Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments. - `userInteraction` 'USER_INTERACTION_UNSPECIFIED' | 'USER_INTERACTION_NONE' | 'USER_INTERACTION_REQUIRED' - `impactScore` number, float - `attackComplexity` 'ATTACK_COMPLEXITY_UNSPECIFIED' | 'ATTACK_COMPLEXITY_LOW' | 'ATTACK_COMPLEXITY_HIGH' - `availabilityImpact` 'IMPACT_UNSPECIFIED' | 'IMPACT_HIGH' | 'IMPACT_LOW' | 'IMPACT_NONE' - `privilegesRequired` 'PRIVILEGES_REQUIRED_UNSPECIFIED' | 'PRIVILEGES_REQUIRED_NONE' | 'PRIVILEGES_REQUIRED_LOW' | 'PRIVILEGES_REQUIRED_HIGH' - `windowsDetails` WindowsDetail[] — Windows details get their own format because the information format and model don't match a normal detail. Specifically Windows updates are done as patches, thus Windows vulnerabilities really are a missing package, rather than a package being at an incorrect version. - `name` string — Required. The name of this vulnerability. - `cpeUri` string — Required. The [CPE URI](https://cpe.mitre.org/specification/) this vulnerability affects. - `fixingKbs` KnowledgeBase[] — Required. The names of the KBs which have hotfixes to mitigate this vulnerability. Note that there may be multiple hotfixes (and thus multiple KBs) that mitigate a given vulnerability. Currently any listed KBs presence is considered a fix. - `url` string — A link to the KB in the [Windows update catalog] (https://www.catalog.update.microsoft.com/). - `name` string — The KB name (generally of the form KB[0-9]+ (e.g., KB123456)). - `description` string — The description of this vulnerability. - `details` Detail[] — Details of all known distros and packages affected by this vulnerability. - `sourceUpdateTime` string, google-datetime — The time this information was last changed at the source. This is an upstream timestamp from the underlying information source - e.g. Ubuntu security tracker. - `isObsolete` boolean — Whether this detail is obsolete. Occurrences are expected not to point to obsolete details. - `severityName` string — The distro assigned severity of this vulnerability. - `fixedVersion` Version — Version contains structured information about the version of a package. - `kind` 'VERSION_KIND_UNSPECIFIED' | 'NORMAL' | 'MINIMUM' | 'MAXIMUM' — Required. Distinguishes between sentinel MIN/MAX versions and normal versions. - `revision` string — The iteration of the package build from the above version. - `epoch` integer — Used to correct mistakes in the version numbering scheme. - `fullName` string — Human readable version string. This string is of the form :- and is only set when kind is NORMAL. - `name` string — Required only when version kind is NORMAL. The main part of the version name. - `inclusive` boolean — Whether this version is specifying part of an inclusive range. Grafeas does not have the capability to specify version ranges; instead we have fields that specify start version and end versions. At times this is insufficient - we also need to specify whether the version is included in the range or is excluded from the range. This boolean is expected to be set to true when the version is included in a range. - `affectedCpeUri` string — Required. The [CPE URI](https://cpe.mitre.org/specification/) this vulnerability affects. - `fixedPackage` string — The distro recommended package to update to that contains a fix for this vulnerability. It is possible for this to be different from the affected_package. - `affectedPackage` string — Required. The package this vulnerability affects. - `packageType` string — The type of package; whether native or non native (e.g., ruby gems, node.js packages, etc.). - `vendor` string — The name of the vendor of the product. - `source` string — The source from which the information in this Detail was obtained. - `description` string — A vendor-specific description of this vulnerability. - `affectedVersionEnd` Version — Version contains structured information about the version of a package. - `kind` 'VERSION_KIND_UNSPECIFIED' | 'NORMAL' | 'MINIMUM' | 'MAXIMUM' — Required. Distinguishes between sentinel MIN/MAX versions and normal versions. - `revision` string — The iteration of the package build from the above version. - `epoch` integer — Used to correct mistakes in the version numbering scheme. - `fullName` string — Human readable version string. This string is of the form :- and is only set when kind is NORMAL. - `name` string — Required only when version kind is NORMAL. The main part of the version name. - `inclusive` boolean — Whether this version is specifying part of an inclusive range. Grafeas does not have the capability to specify version ranges; instead we have fields that specify start version and end versions. At times this is insufficient - we also need to specify whether the version is included in the range or is excluded from the range. This boolean is expected to be set to true when the version is included in a range. - `affectedVersionStart` Version — Version contains structured information about the version of a package. - `kind` 'VERSION_KIND_UNSPECIFIED' | 'NORMAL' | 'MINIMUM' | 'MAXIMUM' — Required. Distinguishes between sentinel MIN/MAX versions and normal versions. - `revision` string — The iteration of the package build from the above version. - `epoch` integer — Used to correct mistakes in the version numbering scheme. - `fullName` string — Human readable version string. This string is of the form :- and is only set when kind is NORMAL. - `name` string — Required only when version kind is NORMAL. The main part of the version name. - `inclusive` boolean — Whether this version is specifying part of an inclusive range. Grafeas does not have the capability to specify version ranges; instead we have fields that specify start version and end versions. At times this is insufficient - we also need to specify whether the version is included in the range or is excluded from the range. This boolean is expected to be set to true when the version is included in a range. - `fixedCpeUri` string — The distro recommended [CPE URI](https://cpe.mitre.org/specification/) to update to that contains a fix for this vulnerability. It is possible for this to be different from the affected_cpe_uri. - `sourceUpdateTime` string, google-datetime — The time this information was last changed at the source. This is an upstream timestamp from the underlying information source - e.g. Ubuntu security tracker. - `advisoryPublishTime` string, google-datetime — The time this advisory was published by the source. - `deployment` DeploymentNote — An artifact that can be deployed in some runtime. - `resourceUri` string[] — Required. Resource URI for the artifact being deployed. - `name` string — Output only. The name of the note in the form of `projects/[PROVIDER_ID]/notes/[NOTE_ID]`. - `secret` SecretNote — The note representing a secret. - `longDescription` string — A detailed description of this note. - `relatedNoteNames` string[] — Other notes related to this note. - `aiSkillAnalysis` AISkillAnalysisNote — AISkillAnalysisNote provides the metadata of an AI-based skill analysis. - `sbomReference` SBOMReferenceNote — The note representing an SBOM reference. - `version` string — The version of the format that the SBOM takes. E.g. if the format is spdx, the version may be 2.3. - `format` string — The format that SBOM takes. E.g. may be spdx, cyclonedx, etc... - `build` BuildNote — Note holding the version of the provider's builder and the signature of the provenance message in the build details occurrence. - `builderVersion` string — Required. Immutable. Version of the builder which produced this build. - `updateTime` string, google-datetime — Output only. The time this note was last updated. This field can be used as a filter in list requests. - `vulnerabilityAssessment` VulnerabilityAssessmentNote — A single VulnerabilityAssessmentNote represents one particular product's vulnerability assessment for one CVE. - `shortDescription` string — A one sentence description of this Vex. - `assessment` Assessment — Assessment provides all information that is related to a single vulnerability for this product. - `longDescription` string — A detailed description of this Vex. - `shortDescription` string — A one sentence description of this Vex. - `vulnerabilityId` string — The vulnerability identifier for this Assessment. Will hold one of common identifiers e.g. CVE, GHSA etc. - `remediations` Remediation[] — Specifies details on how to handle (and presumably, fix) a vulnerability. - `details` string — Contains a comprehensive human-readable discussion of the remediation. - `remediationType` 'REMEDIATION_TYPE_UNSPECIFIED' | 'MITIGATION' | 'NO_FIX_PLANNED' | 'NONE_AVAILABLE' | 'VENDOR_FIX' | 'WORKAROUND' — The type of remediation that can be applied. - `remediationUri` RelatedUrl — Metadata for any related URL information. - `url` string — Specific URL associated with the resource. - `label` string — Label to describe usage of the URL. - `state` 'STATE_UNSPECIFIED' | 'AFFECTED' | 'NOT_AFFECTED' | 'FIXED' | 'UNDER_INVESTIGATION' — Provides the state of this Vulnerability assessment. - `relatedUris` RelatedUrl[] — Holds a list of references associated with this vulnerability item and assessment. These uris have additional information about the vulnerability and the assessment itself. E.g. Link to a document which details how this assessment concluded the state of this vulnerability. - `url` string — Specific URL associated with the resource. - `label` string — Label to describe usage of the URL. - `impacts` string[] — Contains information about the impact of this vulnerability, this will change with time. - `cve` string — Holds the MITRE standard Common Vulnerabilities and Exposures (CVE) tracking number for the vulnerability. Deprecated: Use vulnerability_id instead to denote CVEs. - `justification` Justification — Justification provides the justification when the state of the assessment if NOT_AFFECTED. - `justificationType` 'JUSTIFICATION_TYPE_UNSPECIFIED' | 'COMPONENT_NOT_PRESENT' | 'VULNERABLE_CODE_NOT_PRESENT' | 'VULNERABLE_CODE_NOT_IN_EXECUTE_PATH' | 'VULNERABLE_CODE_CANNOT_BE_CONTROLLED_BY_ADVERSARY' | 'INLINE_MITIGATIONS_ALREADY_EXIST' — The justification type for this vulnerability. - `details` string — Additional details on why this justification was chosen. - `longDescription` string — A detailed description of this Vex. - `publisher` Publisher — Publisher contains information about the publisher of this Note. - `publisherNamespace` string — The context or namespace. Contains a URL which is under control of the issuing party and can be used as a globally unique identifier for that issuing party. Example: https://csaf.io - `issuingAuthority` string — Provides information about the authority of the issuing party to release the document, in particular, the party's constituency and responsibilities or other obligations. - `name` string — Name of the publisher. Examples: 'Google', 'Google Cloud Platform'. - `product` Product — Product contains information about a product and how to uniquely identify it. - `id` string — Token that identifies a product so that it can be referred to from other parts in the document. There is no predefined format as long as it uniquely identifies a group in the context of the current document. - `name` string — Name of the product. - `genericUri` string — Contains a URI which is vendor-specific. Example: The artifact repository URL of an image. - `title` string — The title of the note. E.g. `Vex-Debian-11.4` - `languageCode` string — Identifies the language used by this document, corresponding to IETF BCP 47 / RFC 5646. - `createTime` string, google-datetime — Output only. The time this note was created. This field can be used as a filter in list requests. - `compliance` ComplianceNote - `rationale` string — A rationale for the existence of this compliance check. - `scanInstructions` string, byte — Serialized scan instructions with a predefined format. - `cisBenchmark` CisBenchmark — A compliance check that is a CIS benchmark. - `profileLevel` integer - `severity` 'SEVERITY_UNSPECIFIED' | 'MINIMAL' | 'LOW' | 'MEDIUM' | 'HIGH' | 'CRITICAL' - `description` string — A description about this compliance check. - `title` string — The title that identifies this compliance check. - `version` ComplianceVersion[] — The OS and config versions the benchmark applies to. - `cpeUri` string — The CPE URI (https://cpe.mitre.org/specification/) this benchmark is applicable to. - `version` string — The version of the benchmark. This is set to the version of the OS-specific CIS document the benchmark is defined in. - `benchmarkDocument` string — The name of the document that defines this benchmark, e.g. "CIS Container-Optimized OS". - `impact` string - `remediation` string — A description of remediation steps if the compliance check fails. - `dsseAttestation` DSSEAttestationNote - `hint` DSSEHint — This submessage provides human-readable hints about the purpose of the authority. Because the name of a note acts as its resource reference, it is important to disambiguate the canonical name of the Note (which might be a UUID for security purposes) from "readable" names more suitable for debug output. Note that these hints should not be used to look up authorities in security sensitive contexts, such as when looking up attestations to verify. - `humanReadableName` string — Required. The human readable name of this attestation authority, for example "cloudbuild-prod". - `image` ImageNote — Basis describes the base image portion (Note) of the DockerImage relationship. Linked occurrences are derived from this or an equivalent image via: FROM Or an equivalent reference, e.g., a tag of the resource_url. - `resourceUrl` string — Required. Immutable. The resource_url for the resource representing the basis of associated occurrence images. - `fingerprint` Fingerprint — A set of properties that uniquely identify a given Docker image. - `v2Name` string — Output only. The name of the image's v2 blobs computed via: [bottom] := v2_blobbottom := sha256(v2_blob[N] + " " + v2_name[N+1]) Only the name of the final blob is kept. - `v2Blob` string[] — Required. The ordered list of v2 blobs that represent a given image. - `v1Name` string — Required. The layer ID of the final layer in the Docker image's v1 representation. - `discovery` DiscoveryNote — A note that indicates a type of analysis a provider would perform. This note exists in a provider's project. A `Discovery` occurrence is created in a consumer's project at the start of analysis. - `analysisKind` 'NOTE_KIND_UNSPECIFIED' | 'VULNERABILITY' | 'BUILD' | 'IMAGE' | 'PACKAGE' | 'DEPLOYMENT' | 'DISCOVERY' | 'ATTESTATION' | 'UPGRADE' | 'COMPLIANCE' | 'DSSE_ATTESTATION' | 'VULNERABILITY_ASSESSMENT' | 'SBOM_REFERENCE' | 'SECRET' | 'AI_SKILL_ANALYSIS' — Required. Immutable. The kind of analysis that is handled by this discovery. - `upgrade` UpgradeNote — An Upgrade Note represents a potential upgrade of a package to a given version. For each package version combination (i.e. bash 4.0, bash 4.1, bash 4.1.2), there will be an Upgrade Note. For Windows, windows_update field represents the information related to the update. - `package` string — Required for non-Windows OS. The package this Upgrade is for. - `version` Version — Version contains structured information about the version of a package. - `kind` 'VERSION_KIND_UNSPECIFIED' | 'NORMAL' | 'MINIMUM' | 'MAXIMUM' — Required. Distinguishes between sentinel MIN/MAX versions and normal versions. - `revision` string — The iteration of the package build from the above version. - `epoch` integer — Used to correct mistakes in the version numbering scheme. - `fullName` string — Human readable version string. This string is of the form :- and is only set when kind is NORMAL. - `name` string — Required only when version kind is NORMAL. The main part of the version name. - `inclusive` boolean — Whether this version is specifying part of an inclusive range. Grafeas does not have the capability to specify version ranges; instead we have fields that specify start version and end versions. At times this is insufficient - we also need to specify whether the version is included in the range or is excluded from the range. This boolean is expected to be set to true when the version is included in a range. - `distributions` UpgradeDistribution[] — Metadata about the upgrade for each specific operating system. - `severity` string — The severity as specified by the upstream operating system. - `cve` string[] — The cve tied to this Upgrade. - `cpeUri` string — Required - The specific operating system this metadata applies to. See https://cpe.mitre.org/specification/. - `classification` string — The operating system classification of this Upgrade, as specified by the upstream operating system upgrade feed. For Windows the classification is one of the category_ids listed at https://docs.microsoft.com/en-us/previous-versions/windows/desktop/ff357803(v=vs.85) - `windowsUpdate` WindowsUpdate — Windows Update represents the metadata about the update for the Windows operating system. The fields in this message come from the Windows Update API documented at https://docs.microsoft.com/en-us/windows/win32/api/wuapi/nn-wuapi-iupdate. - `title` string — The localized title of the update. - `supportUrl` string — The hyperlink to the support information for the update. - `identity` Identity — The unique identifier of the update. - `revision` integer — The revision number of the update. - `updateId` string — The revision independent identifier of the update. - `description` string — The localized description of the update. - `kbArticleIds` string[] — The Microsoft Knowledge Base article IDs that are associated with the update. - `lastPublishedTimestamp` string, google-datetime — The last published timestamp of the update. - `categories` Category[] — The list of categories to which the update belongs. - `categoryId` string — The identifier of the category. - `name` string — The localized name of the category. - `shortDescription` string — A one sentence description of this note. ## Response `200` Successful response --- [API](https://skmtc.dev/google/apis/containeranalysis.md) · [All operations](https://skmtc.dev/google/apis/containeranalysis/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/google/containeranalysis/revisions/024ed008c491/schema)