Method: tensorboards.list

Full name: projects.locations.tensorboards.list

Lists Tensorboards in a Location.

Endpoint

gethttps://{service-endpoint}/v1/{parent}/tensorboards

Where{service-endpoint} is one of thesupported service endpoints.

Path parameters

parentstring

Required. The resource name of the Location to list Tensorboards. Format:projects/{project}/locations/{location}

Query parameters

filterstring

Lists the Tensorboards that match the filter expression.

pageSizeinteger

The maximum number of Tensorboards to return. The service may return fewer than this value. If unspecified, at most 100 Tensorboards are returned. The maximum value is 100; values above 100 are coerced to 100.

pageTokenstring

A page token, received from a previousTensorboardService.ListTensorboards call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided toTensorboardService.ListTensorboards must match the call that provided the page token.

orderBystring

Field to use to sort the list.

readMaskstring (FieldMask format)

Mask specifying which fields to read.

This is a comma-separated list of fully qualified names of fields. Example:"user.displayName,photo".

Request body

The request body must be empty.

Response body

Response message forTensorboardService.ListTensorboards.

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

Fields
tensorboards[]object (Tensorboard)

The Tensorboards mathching the request.

nextPageTokenstring

A token, which can be sent asListTensorboardsRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

JSON representation
{"tensorboards":[{object (Tensorboard)}],"nextPageToken":string}

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-06-27 UTC.