Required. The resource name of the Location from which to list the IndexEndpoints. Format:projects/{project}/locations/{location}
Query parameters
filterstring
Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported.
indexEndpointsupports = and !=.indexEndpointrepresents the IndexEndpoint id, ie. the last segment of the IndexEndpoint'sresourcename.
displayNamesupports =, != and regex() (usesre2syntax)
labelssupports general map functions that is:labels.key=value- key:value equalitylabels.key:* or labels:key - key existence
A key including a space must be quoted.labels."a key"`.
Some examples: *indexEndpoint="1"*displayName="myDisplayName"*regex(displayName, "^A") -> The display name starts with an A.
*labels.myKey="myValue"`
[[["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: indexEndpoints.list\n\n**Full name**: projects.locations.indexEndpoints.list\n\nLists IndexEndpoints in a Location. \n\n### Endpoint\n\nget `https:``/``/{service-endpoint}``/v1``/{parent}``/indexEndpoints` \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 from which to list the IndexEndpoints. Format: `projects/{project}/locations/{location}`\n\n### Query parameters\n\n`filter` `string` \nOptional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported.\n\n- `indexEndpoint` supports = and !=. `indexEndpoint` represents the IndexEndpoint id, ie. the last segment of the IndexEndpoint's [resourcename](/vertex-ai/docs/reference/rest/v1/projects.locations.indexEndpoints#IndexEndpoint.FIELDS.name).\n- `displayName` supports =, != and regex() (uses [re2](https://github.com/google/re2/wiki/Syntax) syntax)\n- `labels` supports general map functions that is: `labels.key=value` - key:value equality `labels.key:* or labels:key - key existence\n A key including a space must be quoted.`labels.\"a key\"\\`.\n\nSome examples: \\* `indexEndpoint=\"1\"` \\* `displayName=\"myDisplayName\"` \\* `regex(displayName, \"^A\") -\u003e The display name starts with an A.\n*`labels.myKey=\"myValue\"\\`\n`pageSize` `integer` \nOptional. The standard list page size.\n`pageToken` `string` \nOptional. The standard list page token. Typically obtained via [ListIndexEndpointsResponse.next_page_token](/vertex-ai/docs/reference/rest/v1/projects.locations.indexEndpoints/list#body.ListIndexEndpointsResponse.FIELDS.next_page_token) of the previous [IndexEndpointService.ListIndexEndpoints](/vertex-ai/docs/reference/rest/v1/projects.locations.indexEndpoints/list#google.cloud.aiplatform.v1.IndexEndpointService.ListIndexEndpoints) call.\n`readMask` `string (`[FieldMask](https://protobuf.dev/reference/protobuf/google.protobuf/#field-mask)` format)` \nOptional. Mask 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 [IndexEndpointService.ListIndexEndpoints](/vertex-ai/docs/reference/rest/v1/projects.locations.indexEndpoints/list#google.cloud.aiplatform.v1.IndexEndpointService.ListIndexEndpoints).\n\nIf successful, the response body contains data with the following structure:\nFields `indexEndpoints[]` `object (`[IndexEndpoint](/vertex-ai/docs/reference/rest/v1/projects.locations.indexEndpoints#IndexEndpoint)`)` \nList of IndexEndpoints in the requested page.\n`nextPageToken` `string` \nA token to retrieve next page of results. Pass to [ListIndexEndpointsRequest.page_token](/vertex-ai/docs/reference/rest/v1/projects.locations.indexEndpoints/list#body.QUERY_PARAMETERS.page_token) to obtain that page."]]
