Stay organized with collections Save and categorize content based on your preferences.

Lists all endpoints.

HTTP request


The URL uses gRPC Transcoding syntax.

Path parameters



Required. The resource name of the service whose endpoints you'd like to list.

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

  • servicedirectory.endpoints.list

Query parameters



Optional. The maximum number of items to return.



Optional. The nextPageToken value returned from a previous List request, if any.



Optional. The filter to list results by.

General filter string syntax: <field> <operator> <value> (<logical connector>)

  • <field> can be name, address, port, or metadata.<key> for map field
  • <operator> can be <, >, <=, >=, !=, =, :. Of which : means HAS, and is roughly the same as =
  • <value> must be the same data type as field
  • <logical connector> can be AND, OR, NOT

Examples of valid filters:

  • metadata.owner returns endpoints that have a metadata with the key owner, this is the same as metadata:owner
  • metadata.protocol=gRPC returns endpoints that have key/value protocol=gRPC
  • address= returns endpoints that have this address
  • port>8080 returns endpoints that have port number larger than 8080 * name>projects/my-project/locations/us-east1/namespaces/my-namespace/services/my-service/endpoints/endpoint-c returns endpoints that have name that is alphabetically later than the string, so "endpoint-e" is returned but "endpoint-a" is not
  • metadata.owner!=sd AND returns endpoints that have owner in metadata key but value is not sd AND have key/value foo=bar
  • returns an empty list. Note that endpoint doesn't have a field called "doesnotexist". Since the filter does not match any endpoints, it returns no results

For more information about filtering, see API Filtering.



Optional. The order to list results by.

General orderBy string syntax: <field> (<asc|desc>) (,)

  • <field> allows values: name, address, port
  • <asc|desc> ascending or descending order by <field>. If this is left blank, asc is used

Note that an empty orderBy string results in default order, which is order by name in ascending order.

Request body

The request body must be empty.

Response body

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

The response message for RegistrationService.ListEndpoints.

JSON representation
  "endpoints": [
      object (Endpoint)
  "nextPageToken": string

object (Endpoint)

The list of endpoints.



Token to retrieve the next page of results, or empty if there are no more results in the list.

Authorization Scopes

Requires the following OAuth scope:


For more information, see the Authentication Overview.