Container Analysis API: projects. An implementation of the Grafeas API, which stores, and enables querying and retrieval of critical metadata about all of your software artifacts. See: https://cloud.google.com/container-analysis/api/reference/rest/api/reference/rest/v1alpha1/projects
Container Analysis API: projects. An implementation of the Grafeas API, which stores, and enables querying and retrieval of critical metadata about all of your software artifacts. See: https://cloud.google.com/container-analysis/api/reference/rest/api/reference/rest/v1alpha1/projects
(notes-create$ auth args body)
Required parameters: parent
Optional parameters: name, noteId
Body:
{:vulnerabilityType {:cvssScore number, :severity string, :details [Detail]}, :relatedUrl [{:url string, :label string}], :package {:name string, :distribution [Distribution]}, :buildType {:builderVersion string, :signature BuildSignature}, :discovery {:analysisKind string}, :deployable {:resourceUri [string]}, :expirationTime string, :name string, :createTime string, :updateTime string, :attestationAuthority {:hint AttestationAuthorityHint}, :shortDescription string, :upgrade {:distributions [UpgradeDistribution], :package string, :version Version}, :baseImage {:fingerprint Fingerprint, :resourceUrl string}, :kind string, :longDescription string}
Creates a new Note
.
https://cloud.google.com/container-analysis/api/reference/rest/api/reference/rest/v1alpha1/projects/notes/create Required parameters: parent Optional parameters: name, noteId Body: {:vulnerabilityType {:cvssScore number, :severity string, :details [Detail]}, :relatedUrl [{:url string, :label string}], :package {:name string, :distribution [Distribution]}, :buildType {:builderVersion string, :signature BuildSignature}, :discovery {:analysisKind string}, :deployable {:resourceUri [string]}, :expirationTime string, :name string, :createTime string, :updateTime string, :attestationAuthority {:hint AttestationAuthorityHint}, :shortDescription string, :upgrade {:distributions [UpgradeDistribution], :package string, :version Version}, :baseImage {:fingerprint Fingerprint, :resourceUrl string}, :kind string, :longDescription string} Creates a new `Note`.
(notes-delete$ auth args)
Required parameters: name
Optional parameters: none
Deletes the given Note
from the system.
https://cloud.google.com/container-analysis/api/reference/rest/api/reference/rest/v1alpha1/projects/notes/delete Required parameters: name Optional parameters: none Deletes the given `Note` from the system.
(notes-get$ auth args)
Required parameters: name
Optional parameters: none
Returns the requested Note
.
https://cloud.google.com/container-analysis/api/reference/rest/api/reference/rest/v1alpha1/projects/notes/get Required parameters: name Optional parameters: none Returns the requested `Note`.
(notes-getIamPolicy$ auth args body)
Required parameters: resource
Optional parameters: none
Body:
{:options {:requestedPolicyVersion integer}}
Gets the access control policy for a note or an Occurrence
resource.
Requires containeranalysis.notes.setIamPolicy
or
containeranalysis.occurrences.setIamPolicy
permission if the resource is
a note or occurrence, respectively.
Attempting to call this method on a resource without the required
permission will result in a PERMISSION_DENIED
error. Attempting to call
this method on a non-existent resource will result in a NOT_FOUND
error
if the user has list permission on the project, or a PERMISSION_DENIED
error otherwise. The resource takes the following formats:
projects/{PROJECT_ID}/occurrences/{OCCURRENCE_ID}
for occurrences and
projects/{PROJECT_ID}/notes/{NOTE_ID} for notes
https://cloud.google.com/container-analysis/api/reference/rest/api/reference/rest/v1alpha1/projects/notes/getIamPolicy Required parameters: resource Optional parameters: none Body: {:options {:requestedPolicyVersion integer}} Gets the access control policy for a note or an `Occurrence` resource. Requires `containeranalysis.notes.setIamPolicy` or `containeranalysis.occurrences.setIamPolicy` permission if the resource is a note or occurrence, respectively. Attempting to call this method on a resource without the required permission will result in a `PERMISSION_DENIED` error. Attempting to call this method on a non-existent resource will result in a `NOT_FOUND` error if the user has list permission on the project, or a `PERMISSION_DENIED` error otherwise. The resource takes the following formats: `projects/{PROJECT_ID}/occurrences/{OCCURRENCE_ID}` for occurrences and projects/{PROJECT_ID}/notes/{NOTE_ID} for notes
(notes-list$ auth args)
Required parameters: parent
Optional parameters: pageSize, filter, name, pageToken
Lists all Notes
for a given project.
https://cloud.google.com/container-analysis/api/reference/rest/api/reference/rest/v1alpha1/projects/notes/list Required parameters: parent Optional parameters: pageSize, filter, name, pageToken Lists all `Notes` for a given project.
(notes-occurrences-list$ auth args)
Required parameters: name
Optional parameters: pageToken, pageSize, filter
Lists Occurrences
referencing the specified Note
. Use this method to
get all occurrences referencing your Note
across all your customer
projects.
https://cloud.google.com/container-analysis/api/reference/rest/api/reference/rest/v1alpha1/projects/notes/occurrences/list Required parameters: name Optional parameters: pageToken, pageSize, filter Lists `Occurrences` referencing the specified `Note`. Use this method to get all occurrences referencing your `Note` across all your customer projects.
(notes-patch$ auth args body)
Required parameters: name
Optional parameters: updateMask
Body:
{:vulnerabilityType {:cvssScore number, :severity string, :details [Detail]}, :relatedUrl [{:url string, :label string}], :package {:name string, :distribution [Distribution]}, :buildType {:builderVersion string, :signature BuildSignature}, :discovery {:analysisKind string}, :deployable {:resourceUri [string]}, :expirationTime string, :name string, :createTime string, :updateTime string, :attestationAuthority {:hint AttestationAuthorityHint}, :shortDescription string, :upgrade {:distributions [UpgradeDistribution], :package string, :version Version}, :baseImage {:fingerprint Fingerprint, :resourceUrl string}, :kind string, :longDescription string}
Updates an existing Note
.
https://cloud.google.com/container-analysis/api/reference/rest/api/reference/rest/v1alpha1/projects/notes/patch Required parameters: name Optional parameters: updateMask Body: {:vulnerabilityType {:cvssScore number, :severity string, :details [Detail]}, :relatedUrl [{:url string, :label string}], :package {:name string, :distribution [Distribution]}, :buildType {:builderVersion string, :signature BuildSignature}, :discovery {:analysisKind string}, :deployable {:resourceUri [string]}, :expirationTime string, :name string, :createTime string, :updateTime string, :attestationAuthority {:hint AttestationAuthorityHint}, :shortDescription string, :upgrade {:distributions [UpgradeDistribution], :package string, :version Version}, :baseImage {:fingerprint Fingerprint, :resourceUrl string}, :kind string, :longDescription string} Updates an existing `Note`.
(notes-setIamPolicy$ auth args body)
Required parameters: resource
Optional parameters: none
Body:
{:policy {:etag string, :version integer, :bindings [Binding]}}
Sets the access control policy on the specified Note
or Occurrence
.
Requires containeranalysis.notes.setIamPolicy
or
containeranalysis.occurrences.setIamPolicy
permission if the resource is
a Note
or an Occurrence
, respectively.
Attempting to call this method without these permissions will result in a PERMISSION_DENIED
error. Attempting to call this method on a non-existent resource will result in a
NOT_FOUNDerror if the user has
containeranalysis.notes.listpermission on a
Noteor
containeranalysis.occurrences.liston an
Occurrence, or a
PERMISSION_DENIEDerror otherwise. The resource takes the following formats:
projects/{projectid}/occurrences/{occurrenceid}` for occurrences
and projects/{projectid}/notes/{noteid} for notes
https://cloud.google.com/container-analysis/api/reference/rest/api/reference/rest/v1alpha1/projects/notes/setIamPolicy Required parameters: resource Optional parameters: none Body: {:policy {:etag string, :version integer, :bindings [Binding]}} Sets the access control policy on the specified `Note` or `Occurrence`. Requires `containeranalysis.notes.setIamPolicy` or `containeranalysis.occurrences.setIamPolicy` permission if the resource is a `Note` or an `Occurrence`, respectively. Attempting to call this method without these permissions will result in a ` `PERMISSION_DENIED` error. Attempting to call this method on a non-existent resource will result in a `NOT_FOUND` error if the user has `containeranalysis.notes.list` permission on a `Note` or `containeranalysis.occurrences.list` on an `Occurrence`, or a `PERMISSION_DENIED` error otherwise. The resource takes the following formats: `projects/{projectid}/occurrences/{occurrenceid}` for occurrences and projects/{projectid}/notes/{noteid} for notes
(notes-testIamPermissions$ auth args body)
Required parameters: resource
Optional parameters: none
Body:
{:permissions [string]}
Returns the permissions that a caller has on the specified note or
occurrence resource. Requires list permission on the project (for example,
"storage.objects.list" on the containing bucket for testing permission of
an object). Attempting to call this method on a non-existent resource will
result in a NOT_FOUND
error if the user has list permission on the
project, or a PERMISSION_DENIED
error otherwise. The resource takes the
following formats: projects/{PROJECT_ID}/occurrences/{OCCURRENCE_ID}
for
Occurrences
and projects/{PROJECT_ID}/notes/{NOTE_ID}
for Notes
https://cloud.google.com/container-analysis/api/reference/rest/api/reference/rest/v1alpha1/projects/notes/testIamPermissions Required parameters: resource Optional parameters: none Body: {:permissions [string]} Returns the permissions that a caller has on the specified note or occurrence resource. Requires list permission on the project (for example, "storage.objects.list" on the containing bucket for testing permission of an object). Attempting to call this method on a non-existent resource will result in a `NOT_FOUND` error if the user has list permission on the project, or a `PERMISSION_DENIED` error otherwise. The resource takes the following formats: `projects/{PROJECT_ID}/occurrences/{OCCURRENCE_ID}` for `Occurrences` and `projects/{PROJECT_ID}/notes/{NOTE_ID}` for `Notes`
(occurrences-create$ auth args body)
Required parameters: parent
Optional parameters: name
Body:
{:noteName string, :remediation string, :resourceUrl string, :buildDetails {:provenanceBytes string, :provenance BuildProvenance}, :vulnerabilityDetails {:type string, :effectiveSeverity string, :packageIssue [PackageIssue], :severity string, :cvssScore number}, :name string, :createTime string, :discovered {:analysisStatusError Status, :operation Operation, :analysisStatus string, :continuousAnalysis string, :cpe string}, :updateTime string, :upgrade {:package string, :parsedVersion Version, :distribution UpgradeDistribution}, :installation {:name string, :location [Location]}, :derivedImage {:baseResourceUrl string, :fingerprint Fingerprint, :layerInfo [Layer], :distance integer}, :attestation {:pgpSignedAttestation PgpSignedAttestation}, :resource {:contentHash Hash, :uri string, :name string}, :kind string, :deployment {:platform string, :deployTime string, :address string, :resourceUri [string], :userEmail string, :config string, :undeployTime string}}
Creates a new Occurrence
. Use this method to create Occurrences
for a resource.
https://cloud.google.com/container-analysis/api/reference/rest/api/reference/rest/v1alpha1/projects/occurrences/create Required parameters: parent Optional parameters: name Body: {:noteName string, :remediation string, :resourceUrl string, :buildDetails {:provenanceBytes string, :provenance BuildProvenance}, :vulnerabilityDetails {:type string, :effectiveSeverity string, :packageIssue [PackageIssue], :severity string, :cvssScore number}, :name string, :createTime string, :discovered {:analysisStatusError Status, :operation Operation, :analysisStatus string, :continuousAnalysis string, :cpe string}, :updateTime string, :upgrade {:package string, :parsedVersion Version, :distribution UpgradeDistribution}, :installation {:name string, :location [Location]}, :derivedImage {:baseResourceUrl string, :fingerprint Fingerprint, :layerInfo [Layer], :distance integer}, :attestation {:pgpSignedAttestation PgpSignedAttestation}, :resource {:contentHash Hash, :uri string, :name string}, :kind string, :deployment {:platform string, :deployTime string, :address string, :resourceUri [string], :userEmail string, :config string, :undeployTime string}} Creates a new `Occurrence`. Use this method to create `Occurrences` for a resource.
(occurrences-delete$ auth args)
Required parameters: name
Optional parameters: none
Deletes the given Occurrence
from the system. Use this when
an Occurrence
is no longer applicable for the given resource.
https://cloud.google.com/container-analysis/api/reference/rest/api/reference/rest/v1alpha1/projects/occurrences/delete Required parameters: name Optional parameters: none Deletes the given `Occurrence` from the system. Use this when an `Occurrence` is no longer applicable for the given resource.
(occurrences-get$ auth args)
Required parameters: name
Optional parameters: none
Returns the requested Occurrence
.
https://cloud.google.com/container-analysis/api/reference/rest/api/reference/rest/v1alpha1/projects/occurrences/get Required parameters: name Optional parameters: none Returns the requested `Occurrence`.
(occurrences-getIamPolicy$ auth args body)
Required parameters: resource
Optional parameters: none
Body:
{:options {:requestedPolicyVersion integer}}
Gets the access control policy for a note or an Occurrence
resource.
Requires containeranalysis.notes.setIamPolicy
or
containeranalysis.occurrences.setIamPolicy
permission if the resource is
a note or occurrence, respectively.
Attempting to call this method on a resource without the required
permission will result in a PERMISSION_DENIED
error. Attempting to call
this method on a non-existent resource will result in a NOT_FOUND
error
if the user has list permission on the project, or a PERMISSION_DENIED
error otherwise. The resource takes the following formats:
projects/{PROJECT_ID}/occurrences/{OCCURRENCE_ID}
for occurrences and
projects/{PROJECT_ID}/notes/{NOTE_ID} for notes
https://cloud.google.com/container-analysis/api/reference/rest/api/reference/rest/v1alpha1/projects/occurrences/getIamPolicy Required parameters: resource Optional parameters: none Body: {:options {:requestedPolicyVersion integer}} Gets the access control policy for a note or an `Occurrence` resource. Requires `containeranalysis.notes.setIamPolicy` or `containeranalysis.occurrences.setIamPolicy` permission if the resource is a note or occurrence, respectively. Attempting to call this method on a resource without the required permission will result in a `PERMISSION_DENIED` error. Attempting to call this method on a non-existent resource will result in a `NOT_FOUND` error if the user has list permission on the project, or a `PERMISSION_DENIED` error otherwise. The resource takes the following formats: `projects/{PROJECT_ID}/occurrences/{OCCURRENCE_ID}` for occurrences and projects/{PROJECT_ID}/notes/{NOTE_ID} for notes
(occurrences-getNotes$ auth args)
Required parameters: name
Optional parameters: none
Gets the Note
attached to the given Occurrence
.
https://cloud.google.com/container-analysis/api/reference/rest/api/reference/rest/v1alpha1/projects/occurrences/getNotes Required parameters: name Optional parameters: none Gets the `Note` attached to the given `Occurrence`.
(occurrences-getVulnerabilitySummary$ auth args)
Required parameters: parent
Optional parameters: filter Gets a summary of the number and severity of occurrences.
https://cloud.google.com/container-analysis/api/reference/rest/api/reference/rest/v1alpha1/projects/occurrences/getVulnerabilitySummary Required parameters: parent Optional parameters: filter Gets a summary of the number and severity of occurrences.
(occurrences-list$ auth args)
Required parameters: parent
Optional parameters: name, filter, pageToken, kind, pageSize
Lists active Occurrences
for a given project matching the filters.
https://cloud.google.com/container-analysis/api/reference/rest/api/reference/rest/v1alpha1/projects/occurrences/list Required parameters: parent Optional parameters: name, filter, pageToken, kind, pageSize Lists active `Occurrences` for a given project matching the filters.
(occurrences-patch$ auth args body)
Required parameters: name
Optional parameters: updateMask
Body:
{:noteName string, :remediation string, :resourceUrl string, :buildDetails {:provenanceBytes string, :provenance BuildProvenance}, :vulnerabilityDetails {:type string, :effectiveSeverity string, :packageIssue [PackageIssue], :severity string, :cvssScore number}, :name string, :createTime string, :discovered {:analysisStatusError Status, :operation Operation, :analysisStatus string, :continuousAnalysis string, :cpe string}, :updateTime string, :upgrade {:package string, :parsedVersion Version, :distribution UpgradeDistribution}, :installation {:name string, :location [Location]}, :derivedImage {:baseResourceUrl string, :fingerprint Fingerprint, :layerInfo [Layer], :distance integer}, :attestation {:pgpSignedAttestation PgpSignedAttestation}, :resource {:contentHash Hash, :uri string, :name string}, :kind string, :deployment {:platform string, :deployTime string, :address string, :resourceUri [string], :userEmail string, :config string, :undeployTime string}}
Updates an existing occurrence.
https://cloud.google.com/container-analysis/api/reference/rest/api/reference/rest/v1alpha1/projects/occurrences/patch Required parameters: name Optional parameters: updateMask Body: {:noteName string, :remediation string, :resourceUrl string, :buildDetails {:provenanceBytes string, :provenance BuildProvenance}, :vulnerabilityDetails {:type string, :effectiveSeverity string, :packageIssue [PackageIssue], :severity string, :cvssScore number}, :name string, :createTime string, :discovered {:analysisStatusError Status, :operation Operation, :analysisStatus string, :continuousAnalysis string, :cpe string}, :updateTime string, :upgrade {:package string, :parsedVersion Version, :distribution UpgradeDistribution}, :installation {:name string, :location [Location]}, :derivedImage {:baseResourceUrl string, :fingerprint Fingerprint, :layerInfo [Layer], :distance integer}, :attestation {:pgpSignedAttestation PgpSignedAttestation}, :resource {:contentHash Hash, :uri string, :name string}, :kind string, :deployment {:platform string, :deployTime string, :address string, :resourceUri [string], :userEmail string, :config string, :undeployTime string}} Updates an existing occurrence.
(occurrences-setIamPolicy$ auth args body)
Required parameters: resource
Optional parameters: none
Body:
{:policy {:etag string, :version integer, :bindings [Binding]}}
Sets the access control policy on the specified Note
or Occurrence
.
Requires containeranalysis.notes.setIamPolicy
or
containeranalysis.occurrences.setIamPolicy
permission if the resource is
a Note
or an Occurrence
, respectively.
Attempting to call this method without these permissions will result in a PERMISSION_DENIED
error. Attempting to call this method on a non-existent resource will result in a
NOT_FOUNDerror if the user has
containeranalysis.notes.listpermission on a
Noteor
containeranalysis.occurrences.liston an
Occurrence, or a
PERMISSION_DENIEDerror otherwise. The resource takes the following formats:
projects/{projectid}/occurrences/{occurrenceid}` for occurrences
and projects/{projectid}/notes/{noteid} for notes
https://cloud.google.com/container-analysis/api/reference/rest/api/reference/rest/v1alpha1/projects/occurrences/setIamPolicy Required parameters: resource Optional parameters: none Body: {:policy {:etag string, :version integer, :bindings [Binding]}} Sets the access control policy on the specified `Note` or `Occurrence`. Requires `containeranalysis.notes.setIamPolicy` or `containeranalysis.occurrences.setIamPolicy` permission if the resource is a `Note` or an `Occurrence`, respectively. Attempting to call this method without these permissions will result in a ` `PERMISSION_DENIED` error. Attempting to call this method on a non-existent resource will result in a `NOT_FOUND` error if the user has `containeranalysis.notes.list` permission on a `Note` or `containeranalysis.occurrences.list` on an `Occurrence`, or a `PERMISSION_DENIED` error otherwise. The resource takes the following formats: `projects/{projectid}/occurrences/{occurrenceid}` for occurrences and projects/{projectid}/notes/{noteid} for notes
(occurrences-testIamPermissions$ auth args body)
Required parameters: resource
Optional parameters: none
Body:
{:permissions [string]}
Returns the permissions that a caller has on the specified note or
occurrence resource. Requires list permission on the project (for example,
"storage.objects.list" on the containing bucket for testing permission of
an object). Attempting to call this method on a non-existent resource will
result in a NOT_FOUND
error if the user has list permission on the
project, or a PERMISSION_DENIED
error otherwise. The resource takes the
following formats: projects/{PROJECT_ID}/occurrences/{OCCURRENCE_ID}
for
Occurrences
and projects/{PROJECT_ID}/notes/{NOTE_ID}
for Notes
https://cloud.google.com/container-analysis/api/reference/rest/api/reference/rest/v1alpha1/projects/occurrences/testIamPermissions Required parameters: resource Optional parameters: none Body: {:permissions [string]} Returns the permissions that a caller has on the specified note or occurrence resource. Requires list permission on the project (for example, "storage.objects.list" on the containing bucket for testing permission of an object). Attempting to call this method on a non-existent resource will result in a `NOT_FOUND` error if the user has list permission on the project, or a `PERMISSION_DENIED` error otherwise. The resource takes the following formats: `projects/{PROJECT_ID}/occurrences/{OCCURRENCE_ID}` for `Occurrences` and `projects/{PROJECT_ID}/notes/{NOTE_ID}` for `Notes`
(operations-create$ auth args body)
Required parameters: parent
Optional parameters: none
Body:
{:operation {:done boolean, :response {}, :name string, :error Status, :metadata {}}, :operationId string}
Creates a new Operation
.
https://cloud.google.com/container-analysis/api/reference/rest/api/reference/rest/v1alpha1/projects/operations/create Required parameters: parent Optional parameters: none Body: {:operation {:done boolean, :response {}, :name string, :error Status, :metadata {}}, :operationId string} Creates a new `Operation`.
(operations-patch$ auth args body)
Required parameters: name
Optional parameters: none
Body:
{:updateMask string, :operation {:done boolean, :response {}, :name string, :error Status, :metadata {}}}
Updates an existing operation returns an error if operation does not exist. The only valid operations are to update mark the done bit change the result.
https://cloud.google.com/container-analysis/api/reference/rest/api/reference/rest/v1alpha1/projects/operations/patch Required parameters: name Optional parameters: none Body: {:updateMask string, :operation {:done boolean, :response {}, :name string, :error Status, :metadata {}}} Updates an existing operation returns an error if operation does not exist. The only valid operations are to update mark the done bit change the result.
(scanConfigs-get$ auth args)
Required parameters: name
Optional parameters: none Gets a specific scan configuration for a project.
https://cloud.google.com/container-analysis/api/reference/rest/api/reference/rest/v1alpha1/projects/scanConfigs/get Required parameters: name Optional parameters: none Gets a specific scan configuration for a project.
(scanConfigs-list$ auth args)
Required parameters: parent
Optional parameters: filter, pageToken, pageSize Lists scan configurations for a project.
https://cloud.google.com/container-analysis/api/reference/rest/api/reference/rest/v1alpha1/projects/scanConfigs/list Required parameters: parent Optional parameters: filter, pageToken, pageSize Lists scan configurations for a project.
(scanConfigs-patch$ auth args body)
Required parameters: name
Optional parameters: updateMask
Body:
{:name string, :description string, :enabled boolean, :createTime string, :updateTime string}
Updates the scan configuration to a new value.
https://cloud.google.com/container-analysis/api/reference/rest/api/reference/rest/v1alpha1/projects/scanConfigs/patch Required parameters: name Optional parameters: updateMask Body: {:name string, :description string, :enabled boolean, :createTime string, :updateTime string} Updates the scan configuration to a new value.
cljdoc is a website building & hosting documentation for Clojure/Script libraries
× close