- HTTP request
- Path parameters
- Query parameters
- Request body
- Response body
- Authorization Scopes
- Try it!
Lists all namespaces.
HTTP request
GET https://servicedirectory.googleapis.com/v1/{parent=projects/*/locations/*}/namespaces
The URL uses gRPC Transcoding syntax.
Path parameters
parent
string
Required. The resource name of the project and location whose namespaces you'd like to list.
Authorization requires the following IAM
permission on the specified resource parent
:
-
servicedirectory.namespaces.list
Query parameters
pageSize
integer
Optional. The maximum number of items to return.
pageToken
string
Optional. The nextPageToken value returned from a previous List request, if any.
filter
string
Optional. The filter to list results by.
General filter
string syntax: <field> <operator> <value> (<logical connector>)
-
<field>can benameorlabels.<key>for map field -
<operator>can be<,>,<=,>=,!=,=,:. Of which:meansHAS, and is roughly the same as= -
<value>must be the same data type as field -
<logical connector>can beAND,OR,NOT
Examples of valid filters:
-
labels.ownerreturns namespaces that have a label with the keyowner, this is the same aslabels:owner -
labels.owner=sdreturns namespaces that have key/valueowner=sd -
name>projects/my-project/locations/us-east1/namespaces/namespace-creturns namespaces that have name that is alphabetically later than the string, so "namespace-e" is returned but "namespace-a" is not -
labels.owner!=sd AND labels.foo=barreturns namespaces that haveownerin label key but value is notsdAND have key/valuefoo=bar -
doesnotexist.foo=barreturns an empty list. Note that namespace doesn't have a field called "doesnotexist". Since the filter does not match any namespaces, it returns no results
For more information about filtering, see API Filtering .
orderBy
string
Optional. The order to list results by.
General orderBy
string syntax: <field> (<asc|desc>) (,)
-
<field>allows value:name -
<asc|desc>ascending or descending order by<field>. If this is left blank,ascis 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.ListNamespaces
.
| JSON representation |
|---|
{
"namespaces"
:
[
{
object (
|
| Fields | |
|---|---|
namespaces[]
|
The list of namespaces. |
nextPageToken
|
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:
-
https://www.googleapis.com/auth/cloud-platform
For more information, see the Authentication Overview .

