Method: projects.locations.repositories.files.list

Lists files.

HTTP request


The URLs use gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The name of the repository whose files will be listed. For example: "projects/p1/locations/us-central1/repositories/repo1

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

  • artifactregistry.files.list

Query parameters

Parameters
filter

string

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

  • name
  • owner
  • annotations

Examples of using a filter:

To filter the results of your request to files with the name my_file.txt 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/files/my-file.txt"

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/files/my-*"
  • name="projects/my-project/locations/us-central1/repositories/my-repo/files/*file.txt"
  • name="projects/my-project/locations/us-central1/repositories/my-repo/files/*file*"

To filter the results of your request to files owned by the version 1.0 in package pkg1, append the following filter expression to your request:

  • owner="projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/versions/1.0"

To filter the results of your request to files 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 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 files with the annotation key-value pair [external.link:https://example.com/my-file], append the following filter expression to your request:

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

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

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

integer

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

string

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

string

The field to order the results by.

Request body

The request body must be empty.

Response body

The response from listing files.

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

JSON representation 
{
  "files": [
    {
      object (File)
    }
  ],
  "nextPageToken": string
}
Fields
files[]

object (File)

The files returned.
nextPageToken

string

The token to retrieve the next page of files, or empty if there are no more files 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.