Container Analysis API (containeranalysis:v1)

2024-03-08

8 new methods

Additions

    Methods
  • containeranalysis.projects.locations.resources.exportSBOM

      Parameters :

        name

          Description : Required. The name of the resource in the form of `projects/[PROJECT_ID]/resources/[RESOURCE_URL]`.

          Type : string

          Pattern : ^projects/[^/]+/locations/[^/]+/resources/.*$

          Required : Yes

          Location : path

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/resources/{resourcesId}:exportSBOM

      Parameter Order : name

      Description : Generates an SBOM for the given resource.

      HTTP Method : POST

      Path : v1/{+name}:exportSBOM

      Scopes : https://www.googleapis.com/auth/cloud-platform

  • containeranalysis.projects.locations.occurrences.getNotes

      HTTP Method : GET

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/occurrences/{occurrencesId}/notes

      Path : v1/{+name}/notes

      Parameter Order : name

      Parameters :

        name

          Required : Yes

          Location : path

          Description : Required. The name of the occurrence in the form of `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]`.

          Type : string

          Pattern : ^projects/[^/]+/locations/[^/]+/occurrences/[^/]+$

      Scopes : https://www.googleapis.com/auth/cloud-platform

      Description : Gets the note attached to the specified occurrence. Consumer projects can use this method to get a note that belongs to a provider project.

  • containeranalysis.projects.locations.occurrences.getVulnerabilitySummary

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/occurrences:vulnerabilitySummary

      Parameter Order : parent

      Parameters :

        parent

          Location : path

          Required : Yes

          Type : string

          Description : Required. The name of the project to get a vulnerability summary for in the form of `projects/[PROJECT_ID]`.

          Pattern : ^projects/[^/]+/locations/[^/]+$

        filter

          Description : The filter expression.

          Location : query

          Type : string

      Scopes : https://www.googleapis.com/auth/cloud-platform

      HTTP Method : GET

      Path : v1/{+parent}/occurrences:vulnerabilitySummary

      Description : Gets a summary of the number and severity of occurrences.

  • containeranalysis.projects.locations.occurrences.get

      Path : v1/{+name}

      Scopes : https://www.googleapis.com/auth/cloud-platform

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/occurrences/{occurrencesId}

      Parameters :

        name

          Location : path

          Type : string

          Description : Required. The name of the occurrence in the form of `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]`.

          Required : Yes

          Pattern : ^projects/[^/]+/locations/[^/]+/occurrences/[^/]+$

      Parameter Order : name

      HTTP Method : GET

      Description : Gets the specified occurrence.

  • containeranalysis.projects.locations.occurrences.list

      Parameter Order : parent

      HTTP Method : GET

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/occurrences

      Scopes : https://www.googleapis.com/auth/cloud-platform

      Parameters :

        pageSize

          Description : Number of occurrences to return in the list. Must be positive. Max allowed page size is 1000. If not specified, page size defaults to 20.

          Location : query

          Format : int32

          Type : integer

        pageToken

          Description : Token to provide to skip to a particular spot in the list.

          Type : string

          Location : query

        filter

          Description : The filter expression.

          Type : string

          Location : query

        parent

          Description : Required. The name of the project to list occurrences for in the form of `projects/[PROJECT_ID]`.

          Pattern : ^projects/[^/]+/locations/[^/]+$

          Location : path

          Type : string

          Required : Yes

      Description : Lists occurrences for the specified project.

      Path : v1/{+parent}/occurrences

  • containeranalysis.projects.locations.notes.occurrences.list

      HTTP Method : GET

      Path : v1/{+name}/occurrences

      Description : Lists occurrences referencing the specified note. Provider projects can use this method to get all occurrences across consumer projects referencing the specified note.

      Scopes : https://www.googleapis.com/auth/cloud-platform

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/notes/{notesId}/occurrences

      Parameters :

        pageToken

          Description : Token to provide to skip to a particular spot in the list.

          Location : query

          Type : string

        filter

          Description : The filter expression.

          Type : string

          Location : query

        pageSize

          Description : Number of occurrences to return in the list.

          Location : query

          Format : int32

          Type : integer

        name

          Pattern : ^projects/[^/]+/locations/[^/]+/notes/[^/]+$

          Type : string

          Description : Required. The name of the note to list occurrences for in the form of `projects/[PROVIDER_ID]/notes/[NOTE_ID]`.

          Required : Yes

          Location : path

      Parameter Order : name

  • containeranalysis.projects.locations.notes.list

      Description : Lists notes for the specified project.

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/notes

      Scopes : https://www.googleapis.com/auth/cloud-platform

      Path : v1/{+parent}/notes

      Parameters :

        pageToken

          Type : string

          Description : Token to provide to skip to a particular spot in the list.

          Location : query

        filter

          Type : string

          Description : The filter expression.

          Location : query

        parent

          Type : string

          Pattern : ^projects/[^/]+/locations/[^/]+$

          Required : Yes

          Description : Required. The name of the project to list notes for in the form of `projects/[PROJECT_ID]`.

          Location : path

        pageSize

          Type : integer

          Format : int32

          Description : Number of notes to return in the list. Must be positive. Max allowed page size is 1000. If not specified, page size defaults to 20.

          Location : query

      HTTP Method : GET

      Parameter Order : parent

  • containeranalysis.projects.locations.notes.get

      Scopes : https://www.googleapis.com/auth/cloud-platform

      Path : v1/{+name}

      Parameters :

        name

          Location : path

          Pattern : ^projects/[^/]+/locations/[^/]+/notes/[^/]+$

          Description : Required. The name of the note in the form of `projects/[PROVIDER_ID]/notes/[NOTE_ID]`.

          Required : Yes

          Type : string

      HTTP Method : GET

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/notes/{notesId}

      Parameter Order : name

      Description : Gets the specified note.