Container Analysis API

An implementation of the Grafeas API, which stores, and enables querying and retrieval of critical metadata about all of your software artifacts.

Service: containeranalysis.googleapis.com

We recommend that you call this service using Google-provided client libraries. If your application needs to call this service using your own libraries, you should use the following information when making 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 may 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

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.
patch PATCH /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.
patch PATCH /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.scanConfigs

Methods
get GET /v1beta1/{name=projects/*/scanConfigs/*}
Gets the specified scan configuration.
list GET /v1beta1/{parent=projects/*}/scanConfigs
Lists scan configurations for the specified project.
update PUT /v1beta1/{name=projects/*/scanConfigs/*}
Updates the specified scan configuration.

Service: containeranalysis.googleapis.com

We recommend that you call this service using Google-provided client libraries. If your application needs to call this service using your own libraries, you should use the following information when making 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 may 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

REST Resource: v1alpha1.projects.notes

Methods
create POST /v1alpha1/{parent=projects/*}/notes
Creates a new Note.
delete DELETE /v1alpha1/{name=projects/*/notes/*}
Deletes the given Note from the system.
get GET /v1alpha1/{name=projects/*/notes/*}
Returns the requested Note.
getIamPolicy POST /v1alpha1/{resource=projects/*/notes/*}:getIamPolicy
Gets the access control policy for a note or an Occurrence resource.
list GET /v1alpha1/{parent=projects/*}/notes
Lists all Notes for a given project.
patch PATCH /v1alpha1/{name=projects/*/notes/*}
Updates an existing Note.
setIamPolicy POST /v1alpha1/{resource=projects/*/notes/*}:setIamPolicy
Sets the access control policy on the specified Note or Occurrence.
testIamPermissions POST /v1alpha1/{resource=projects/*/notes/*}:testIamPermissions
Returns the permissions that a caller has on the specified note or occurrence resource.

REST Resource: v1alpha1.projects.notes.occurrences

Methods
list GET /v1alpha1/{name=projects/*/notes/*}/occurrences
Lists Occurrences referencing the specified Note.

REST Resource: v1alpha1.projects.occurrences

Methods
create POST /v1alpha1/{parent=projects/*}/occurrences
Creates a new Occurrence.
delete DELETE /v1alpha1/{name=projects/*/occurrences/*}
Deletes the given Occurrence from the system.
get GET /v1alpha1/{name=projects/*/occurrences/*}
Returns the requested Occurrence.
getIamPolicy POST /v1alpha1/{resource=projects/*/occurrences/*}:getIamPolicy
Gets the access control policy for a note or an Occurrence resource.
getNotes GET /v1alpha1/{name=projects/*/occurrences/*}/notes
Gets the Note attached to the given Occurrence.
getVulnerabilitySummary GET /v1alpha1/{parent=projects/*}/occurrences:vulnerabilitySummary
Gets a summary of the number and severity of occurrences.
list GET /v1alpha1/{parent=projects/*}/occurrences
Lists active Occurrences for a given project matching the filters.
patch PATCH /v1alpha1/{name=projects/*/occurrences/*}
Updates an existing occurrence.
setIamPolicy POST /v1alpha1/{resource=projects/*/occurrences/*}:setIamPolicy
Sets the access control policy on the specified Note or Occurrence.
testIamPermissions POST /v1alpha1/{resource=projects/*/occurrences/*}:testIamPermissions
Returns the permissions that a caller has on the specified note or occurrence resource.

REST Resource: v1alpha1.projects.operations

Methods
create POST /v1alpha1/{parent=projects/*}/operations
Creates a new Operation.
patch PATCH /v1alpha1/{name=projects/*/operations/*}
Updates an existing operation returns an error if operation does not exist.

REST Resource: v1alpha1.projects.scanConfigs

Methods
get GET /v1alpha1/{name=projects/*/scanConfigs/*}
Gets a specific scan configuration for a project.
list GET /v1alpha1/{parent=projects/*}/scanConfigs
Lists scan configurations for a project.
patch PATCH /v1alpha1/{name=projects/*/scanConfigs/*}
Updates the scan configuration to a new value.

REST Resource: v1alpha1.providers.notes

Methods
create POST /v1alpha1/{name=providers/*}/notes
Creates a new Note.
delete DELETE /v1alpha1/{name=providers/*/notes/*}
Deletes the given Note from the system.
get GET /v1alpha1/{name=providers/*/notes/*}
Returns the requested Note.
getIamPolicy POST /v1alpha1/{resource=providers/*/notes/*}:getIamPolicy
Gets the access control policy for a note or an Occurrence resource.
list GET /v1alpha1/{name=providers/*}/notes
Lists all Notes for a given project.
patch PATCH /v1alpha1/{name=providers/*/notes/*}
Updates an existing Note.
setIamPolicy POST /v1alpha1/{resource=providers/*/notes/*}:setIamPolicy
Sets the access control policy on the specified Note or Occurrence.
testIamPermissions POST /v1alpha1/{resource=providers/*/notes/*}:testIamPermissions
Returns the permissions that a caller has on the specified note or occurrence resource.

REST Resource: v1alpha1.providers.notes.occurrences

Methods
list GET /v1alpha1/{name=providers/*/notes/*}/occurrences
Lists Occurrences referencing the specified Note.

Service: containeranalysis.googleapis.com

We recommend that you call this service using Google-provided client libraries. If your application needs to call this service using your own libraries, you should use the following information when making 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 may 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

REST Resource: v1.operations

Methods
cancel POST /v1/{name=operations/**}:cancel
Starts asynchronous cancellation on a long-running operation.
delete DELETE /v1/{name=operations/**}
Deletes a long-running operation.
get GET /v1/{name=operations/**}
Gets the latest state of a long-running operation.
list GET /v1/{name}
Lists operations that match the specified filter in the request.

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.
patch PATCH /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.
list GET /v1/{parent=projects/*}/occurrences
Lists occurrences for the specified project.
patch PATCH /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.
Was this page helpful? Let us know how we did:

Send feedback about...

Container Registry