Method: projects.locations.repositories.packages.list

Lists packages.

HTTP request


The URLs use gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The name of the parent resource whose packages will be listed.

Authorization requires the following IAM permission on the specified resource parent:

  • artifactregistry.packages.list

Query parameters

Parameters
pageSize

integer

The maximum number of packages to return. Maximum page size is 1,000.
pageToken

string

The nextPageToken value returned from a previous list request, if any.
filter

string

Optional. An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are:

  • name
  • annotations

Examples of using a filter:

To filter the results of your request to packages with the name my-package in project my-project in the us-central region, in repository my-repo, append the following filter expression to your request:

  • name="projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package"

You can also use wildcards to match any number of characters before or after the value:

  • name="projects/my-project/locations/us-central1/repositories/my-repo/packages/my-*"
  • name="projects/my-project/locations/us-central1/repositories/my-repo/packages/*package"
  • name="projects/my-project/locations/us-central1/repositories/my-repo/packages/*pack*"

To filter the results of your request to packages with the annotation key-value pair [external_link: external_link_value], append the following filter expression to your request":

  • "annotations.external_link:external_link_value"

To filter the results just for a specific annotation key external_link, append the following filter expression to your request:

  • "annotations.external_link"

If the annotation key or value contains special characters, you can escape them by surrounding the value with backticks. For example, to filter the results of your request to packages with the annotation key-value pair [external.link:https://example.com/my-package], append the following filter expression to your request:

  • "annotations.`external.link`:`https://example.com/my-package`"

You can also filter with annotations with a wildcard to match any number of characters before or after the value:

  • "annotations.*_link:`*example.com*`"
orderBy

string

Optional. The field to order the results by.

Request body

The request body must be empty.

Response body

The response from listing packages.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "packages": [
    {
      object (Package)
    }
  ],
  "nextPageToken": string
}
Fields
packages[]

object (Package)

The packages returned.
nextPageToken

string

The token to retrieve the next page of packages, or empty if there are no more packages to return.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-platform.read-only

For more information, see the Authentication Overview.