Method: endpoints.list

Full name: projects.locations.endpoints.list

Lists endpoints in a Location.

Endpoint

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

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

Path parameters

parentstring

Required. The resource name of the Location from which to list the endpoints. 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.

  • endpoint supports= and!=.endpoint represents the Endpoint id, i.e. the last segment of the Endpoint'sresource name.
  • displayName supports= and!=.
  • labels supports general map functions that is:
    • labels.key=value - key:value equality
    • labels.key:* orlabels:key - key existence
    • A key including a space must be quoted.labels."a key".
  • base_model_name only supports=.

Some examples:

  • endpoint=1
  • displayName="myDisplayName"
  • labels.myKey="myValue"
  • baseModelName="text-bison"
pageSizeinteger

Optional. The standard list page size.

pageTokenstring

Optional. The standard list page token. Typically obtained viaListEndpointsResponse.next_page_token of the previousEndpointService.ListEndpoints call.

readMaskstring (FieldMask format)

Optional. Mask specifying which fields to read.

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

orderBystring

A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields:

  • displayName
  • createTime
  • updateTime

Example:displayName, createTime desc.

gdcZonestring

Optional. Configures the Google Distributed Cloud (GDC) environment for online prediction. Only set this field when the Endpoint is to be deployed in a GDC environment.

Request body

The request body must be empty.

Response body

Response message forEndpointService.ListEndpoints.

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

Fields
endpoints[]object (Endpoint)

List of endpoints in the requested page.

nextPageTokenstring

A token to retrieve the next page of results. Pass toListEndpointsRequest.page_token to obtain that page.

JSON representation
{"endpoints":[{object (Endpoint)}],"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-07-31 UTC.