Container Analysis API
Stay organized with collections Save and categorize content based on your preferences.

This API is a prerequisite for leveraging Artifact Analysis scanning capabilities in both Artifact Registry and with Advanced Vulnerability Insights (runtime scanning) in GKE.

In addition, the Container Analysis API is an implementation of the Grafeas API, which enables storing, querying, and retrieval of critical metadata about all of your software artifacts.

Service: containeranalysis.googleapis.com

To call this service, we recommend that you use the Google-provided client libraries. If your application needs to use your own libraries to call this service, use the following information when you make the API requests.

Discovery document

A Discovery Document is a machine-readable specification for describing and consuming REST APIs. It is used to build client libraries, IDE plugins, and other tools that interact with Google APIs. One service may provide multiple discovery documents. This service provides the following discovery documents:

Service endpoint

A service endpoint is a base URL that specifies the network address of an API service. One service might have multiple service endpoints. This service has the following service endpoint and all URIs below are relative to this service endpoint:

https://containeranalysis.googleapis.com

Regional service endpoint

A regional service endpoint is a base URL that specifies the network address of an API service in a single region. A service that is available in multiple regions might have multiple regional endpoints. Select a location to see its regional service endpoint for this service.

REST Resource: v1beta1.projects.locations.notes

Methods
`batchCreate`	`POST /v1beta1/{parent=projects//locations/}/notes:batchCreate` Creates new notes in batch.
`create`	`POST /v1beta1/{parent=projects//locations/}/notes` Creates a new note.
`delete`	`DELETE /v1beta1/{name=projects//locations//notes/*}` Deletes the specified note.
`get`	`GET /v1beta1/{name=projects//locations//notes/*}` Gets the specified note.
`getIamPolicy`	`POST /v1beta1/{resource=projects//locations//notes/*}:getIamPolicy` Gets the access control policy for a note or an occurrence resource.
`list`	`GET /v1beta1/{parent=projects//locations/}/notes` Lists notes for the specified project.
	`/v1beta1/{name=projects//locations//notes/*}` Updates the specified note.
`setIamPolicy`	`POST /v1beta1/{resource=projects//locations//notes/*}:setIamPolicy` Sets the access control policy on the specified note or occurrence.
`testIamPermissions`	`POST /v1beta1/{resource=projects//locations//notes/*}:testIamPermissions` Returns the permissions that a caller has on the specified note or occurrence.

REST Resource: v1beta1.projects.locations.notes.occurrences

Methods
`list`	`GET /v1beta1/{name=projects//locations//notes/*}/occurrences` Lists occurrences referencing the specified note.

REST Resource: v1beta1.projects.locations.occurrences

Methods
`batchCreate`	`POST /v1beta1/{parent=projects//locations/}/occurrences:batchCreate` Creates new occurrences in batch.
`create`	`POST /v1beta1/{parent=projects//locations/}/occurrences` Creates a new occurrence.
`delete`	`DELETE /v1beta1/{name=projects//locations//occurrences/*}` Deletes the specified occurrence.
`get`	`GET /v1beta1/{name=projects//locations//occurrences/*}` Gets the specified occurrence.
`getIamPolicy`	`POST /v1beta1/{resource=projects//locations//occurrences/*}:getIamPolicy` Gets the access control policy for a note or an occurrence resource.
`getNotes`	`GET /v1beta1/{name=projects//locations//occurrences/*}/notes` Gets the note attached to the specified occurrence.
`getVulnerabilitySummary`	`GET /v1beta1/{parent=projects//locations/}/occurrences:vulnerabilitySummary` Gets a summary of the number and severity of occurrences.
`list`	`GET /v1beta1/{parent=projects//locations/}/occurrences` Lists occurrences for the specified project.
	`/v1beta1/{name=projects//locations//occurrences/*}` Updates the specified occurrence.
`setIamPolicy`	`POST /v1beta1/{resource=projects//locations//occurrences/*}:setIamPolicy` Sets the access control policy on the specified note or occurrence.
`testIamPermissions`	`POST /v1beta1/{resource=projects//locations//occurrences/*}:testIamPermissions` Returns the permissions that a caller has on the specified note or occurrence.

REST Resource: v1beta1.projects.locations.resources

Methods
`exportSBOM`	`POST /v1beta1/{name=projects//locations//resources/**}:exportSBOM` Generates an SBOM and other dependency information for the given resource.
`generatePackagesSummary`	`POST /v1beta1/{name=projects//locations//resources/**}:generatePackagesSummary` Gets a summary of the packages within a given resource.

REST Resource: v1beta1.projects.notes

Methods
`batchCreate`	`POST /v1beta1/{parent=projects/*}/notes:batchCreate` Creates new notes in batch.
`create`	`POST /v1beta1/{parent=projects/*}/notes` Creates a new note.
`delete`	`DELETE /v1beta1/{name=projects//notes/}` Deletes the specified note.
`get`	`GET /v1beta1/{name=projects//notes/}` Gets the specified note.
`getIamPolicy`	`POST /v1beta1/{resource=projects//notes/}:getIamPolicy` Gets the access control policy for a note or an occurrence resource.
`list`	`GET /v1beta1/{parent=projects/*}/notes` Lists notes for the specified project.
	`/v1beta1/{name=projects//notes/}` Updates the specified note.
`setIamPolicy`	`POST /v1beta1/{resource=projects//notes/}:setIamPolicy` Sets the access control policy on the specified note or occurrence.
`testIamPermissions`	`POST /v1beta1/{resource=projects//notes/}:testIamPermissions` Returns the permissions that a caller has on the specified note or occurrence.

REST Resource: v1beta1.projects.notes.occurrences

Methods
`list`	`GET /v1beta1/{name=projects//notes/}/occurrences` Lists occurrences referencing the specified note.

REST Resource: v1beta1.projects.occurrences

Methods
`batchCreate`	`POST /v1beta1/{parent=projects/*}/occurrences:batchCreate` Creates new occurrences in batch.
`create`	`POST /v1beta1/{parent=projects/*}/occurrences` Creates a new occurrence.
`delete`	`DELETE /v1beta1/{name=projects//occurrences/}` Deletes the specified occurrence.
`get`	`GET /v1beta1/{name=projects//occurrences/}` Gets the specified occurrence.
`getIamPolicy`	`POST /v1beta1/{resource=projects//occurrences/}:getIamPolicy` Gets the access control policy for a note or an occurrence resource.
`getNotes`	`GET /v1beta1/{name=projects//occurrences/}/notes` Gets the note attached to the specified occurrence.
`getVulnerabilitySummary`	`GET /v1beta1/{parent=projects/*}/occurrences:vulnerabilitySummary` Gets a summary of the number and severity of occurrences.
`list`	`GET /v1beta1/{parent=projects/*}/occurrences` Lists occurrences for the specified project.
	`/v1beta1/{name=projects//occurrences/}` Updates the specified occurrence.
`setIamPolicy`	`POST /v1beta1/{resource=projects//occurrences/}:setIamPolicy` Sets the access control policy on the specified note or occurrence.
`testIamPermissions`	`POST /v1beta1/{resource=projects//occurrences/}:testIamPermissions` Returns the permissions that a caller has on the specified note or occurrence.

REST Resource: v1beta1.projects.resources

Methods
`exportSBOM`	`POST /v1beta1/{name=projects//resources/*}:exportSBOM` Generates an SBOM and other dependency information for the given resource.
`generatePackagesSummary`	`POST /v1beta1/{name=projects//resources/*}:generatePackagesSummary` Gets a summary of the packages within a given resource.

REST Resource: v1.projects.locations.notes

Methods
`batchCreate`	`POST /v1/{parent=projects//locations/}/notes:batchCreate` Creates new notes in batch.
`create`	`POST /v1/{parent=projects//locations/}/notes` Creates a new note.
`delete`	`DELETE /v1/{name=projects//locations//notes/*}` Deletes the specified note.
`get`	`GET /v1/{name=projects//locations//notes/*}` Gets the specified note.
`getIamPolicy`	`POST /v1/{resource=projects//locations//notes/*}:getIamPolicy` Gets the access control policy for a note or an occurrence resource.
`list`	`GET /v1/{parent=projects//locations/}/notes` Lists notes for the specified project.
	`/v1/{name=projects//locations//notes/*}` Updates the specified note.
`setIamPolicy`	`POST /v1/{resource=projects//locations//notes/*}:setIamPolicy` Sets the access control policy on the specified note or occurrence.
`testIamPermissions`	`POST /v1/{resource=projects//locations//notes/*}:testIamPermissions` Returns the permissions that a caller has on the specified note or occurrence.

REST Resource: v1.projects.locations.notes.occurrences

Methods
`list`	`GET /v1/{name=projects//locations//notes/*}/occurrences` Lists occurrences referencing the specified note.

REST Resource: v1.projects.locations.occurrences

Methods
`batchCreate`	`POST /v1/{parent=projects//locations/}/occurrences:batchCreate` Creates new occurrences in batch.
`create`	`POST /v1/{parent=projects//locations/}/occurrences` Creates a new occurrence.
`delete`	`DELETE /v1/{name=projects//locations//occurrences/*}` Deletes the specified occurrence.
`get`	`GET /v1/{name=projects//locations//occurrences/*}` Gets the specified occurrence.
`getIamPolicy`	`POST /v1/{resource=projects//locations//occurrences/*}:getIamPolicy` Gets the access control policy for a note or an occurrence resource.
`getNotes`	`GET /v1/{name=projects//locations//occurrences/*}/notes` Gets the note attached to the specified occurrence.
`getVulnerabilitySummary`	`GET /v1/{parent=projects//locations/}/occurrences:vulnerabilitySummary` Gets a summary of the number and severity of occurrences.
`list`	`GET /v1/{parent=projects//locations/}/occurrences` Lists occurrences for the specified project.
	`/v1/{name=projects//locations//occurrences/*}` Updates the specified occurrence.
`setIamPolicy`	`POST /v1/{resource=projects//locations//occurrences/*}:setIamPolicy` Sets the access control policy on the specified note or occurrence.
`testIamPermissions`	`POST /v1/{resource=projects//locations//occurrences/*}:testIamPermissions` Returns the permissions that a caller has on the specified note or occurrence.

REST Resource: v1.projects.locations.resources

Methods
`exportSBOM`	`POST /v1/{name=projects//locations//resources/**}:exportSBOM` Generates an SBOM for the given resource.

REST Resource: v1.projects.notes

Methods
`batchCreate`	`POST /v1/{parent=projects/*}/notes:batchCreate` Creates new notes in batch.
`create`	`POST /v1/{parent=projects/*}/notes` Creates a new note.
`delete`	`DELETE /v1/{name=projects//notes/}` Deletes the specified note.
`get`	`GET /v1/{name=projects//notes/}` Gets the specified note.
`getIamPolicy`	`POST /v1/{resource=projects//notes/}:getIamPolicy` Gets the access control policy for a note or an occurrence resource.
`list`	`GET /v1/{parent=projects/*}/notes` Lists notes for the specified project.
	`/v1/{name=projects//notes/}` Updates the specified note.
`setIamPolicy`	`POST /v1/{resource=projects//notes/}:setIamPolicy` Sets the access control policy on the specified note or occurrence.
`testIamPermissions`	`POST /v1/{resource=projects//notes/}:testIamPermissions` Returns the permissions that a caller has on the specified note or occurrence.

REST Resource: v1.projects.notes.occurrences

Methods
`list`	`GET /v1/{name=projects//notes/}/occurrences` Lists occurrences referencing the specified note.

REST Resource: v1.projects.occurrences

Methods
`batchCreate`	`POST /v1/{parent=projects/*}/occurrences:batchCreate` Creates new occurrences in batch.
`create`	`POST /v1/{parent=projects/*}/occurrences` Creates a new occurrence.
`delete`	`DELETE /v1/{name=projects//occurrences/}` Deletes the specified occurrence.
`get`	`GET /v1/{name=projects//occurrences/}` Gets the specified occurrence.
`getIamPolicy`	`POST /v1/{resource=projects//occurrences/}:getIamPolicy` Gets the access control policy for a note or an occurrence resource.
`getNotes`	`GET /v1/{name=projects//occurrences/}/notes` Gets the note attached to the specified occurrence.
`getVulnerabilitySummary`	`GET /v1/{parent=projects/*}/occurrences:vulnerabilitySummary` Gets a summary of the number and severity of occurrences.
`list`	`GET /v1/{parent=projects/*}/occurrences` Lists occurrences for the specified project.
	`/v1/{name=projects//occurrences/}` Updates the specified occurrence.
`setIamPolicy`	`POST /v1/{resource=projects//occurrences/}:setIamPolicy` Sets the access control policy on the specified note or occurrence.
`testIamPermissions`	`POST /v1/{resource=projects//occurrences/}:testIamPermissions` Returns the permissions that a caller has on the specified note or occurrence.

REST Resource: v1.projects.resources

Methods
`exportSBOM`	`POST /v1/{name=projects//resources/*}:exportSBOM` Generates an SBOM for the given resource.

Container Analysis APIStay organized with collections Save and categorize content based on your preferences.