Required. The resource name of the Location to list Tensorboards. Format: projects/{project}/locations/{location}
Query parameters
filter
string
Lists the Tensorboards that match the filter expression.
pageSize
integer
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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-06-27 UTC."],[],[],null,["# Method: tensorboards.list\n\n**Full name**: projects.locations.tensorboards.list\n\nLists Tensorboards in a Location. \n\n### Endpoint\n\nget `https:``/``/{service-endpoint}``/v1beta1``/{parent}``/tensorboards` \nWhere `{service-endpoint}` is one of the [supported service endpoints](/vertex-ai/docs/reference/rest#rest_endpoints).\n\n### Path parameters\n\n`parent` `string` \nRequired. The resource name of the Location to list Tensorboards. Format: `projects/{project}/locations/{location}`\n\n### Query parameters\n\n`filter` `string` \nLists the Tensorboards that match the filter expression.\n`pageSize` `integer` \nThe 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.\n`pageToken` `string` \nA page token, received from a previous [TensorboardService.ListTensorboards](/vertex-ai/docs/reference/rest/v1beta1/projects.locations.tensorboards/list#google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboards) call. Provide this to retrieve the subsequent page.\n\nWhen paginating, all other parameters provided to [TensorboardService.ListTensorboards](/vertex-ai/docs/reference/rest/v1beta1/projects.locations.tensorboards/list#google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboards) must match the call that provided the page token.\n`orderBy` `string` \nField to use to sort the list.\n`readMask` `string (`[FieldMask](https://protobuf.dev/reference/protobuf/google.protobuf/#field-mask)` format)` \nMask specifying which fields to read.\n\nThis is a comma-separated list of fully qualified names of fields. Example: `\"user.displayName,photo\"`.\n\n### Request body\n\nThe request body must be empty. \n\n### Response body\n\nResponse message for [TensorboardService.ListTensorboards](/vertex-ai/docs/reference/rest/v1beta1/projects.locations.tensorboards/list#google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboards).\n\nIf successful, the response body contains data with the following structure:\nFields `tensorboards[]` `object (`[Tensorboard](/vertex-ai/docs/reference/rest/v1beta1/projects.locations.tensorboards#Tensorboard)`)` \nThe Tensorboards mathching the request.\n`nextPageToken` `string` \nA token, which can be sent as [ListTensorboardsRequest.page_token](/vertex-ai/docs/reference/rest/v1beta1/projects.locations.tensorboards/list#body.QUERY_PARAMETERS.page_token) to retrieve the next page. If this field is omitted, there are no subsequent pages."]]