2026-05-12
▼ ▲ cloudnumberregistry.projects.locations.list
Parameters :
pageSize
Location : query
Format : int32
Type : integer
Description : The maximum number of results to return. If not set, the service selects a default.
extraLocationTypes
Repeated : Yes
Type : string
Location : query
Description : Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage.
filter
Location : query
Type : string
Description : A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).
name
Required : Yes
Pattern : ^projects/[^/]+$
Type : string
Description : The resource that owns the locations collection, if applicable.
Location : path
pageToken
Location : query
Type : string
Description : A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.
Flat Path : v1alpha/projects/{projectsId}/locations
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.
HTTP Method : GET
Path : v1alpha/{+name}/locations
Parameter Order : name
▼ ▲ cloudnumberregistry.projects.locations.get
Path : v1alpha/{+name}
Parameter Order : name
HTTP Method : GET
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
name
Description : Resource name for the location.
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+$
Required : Yes
Type : string
Description : Gets information about a location.
▼ ▲ cloudnumberregistry.projects.locations.registryBooks.get
HTTP Method : GET
Path : v1alpha/{+name}
Parameter Order : name
Parameters :
view
Location : query
Description : Optional. The view of the RegistryBook.
Enum :
Type : string
Enum Descriptions :
name
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/registryBooks/[^/]+$
Required : Yes
Location : path
Description : Required. Name of the resource
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/registryBooks/{registryBooksId}
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets details of a single RegistryBook.
▼ ▲ cloudnumberregistry.projects.locations.registryBooks.list
Parameters :
pageSize
Type : integer
Location : query
Format : int32
Description : Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
filter
Description : Optional. Filtering results
Location : query
Type : string
parent
Location : path
Description : Required. Parent value for ListRegistryBooksRequest
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+$
Required : Yes
orderBy
Description : Optional. Hint for how to order the results
Type : string
Location : query
view
Location : query
Description : Optional. The view of the RegistryBook.
Type : string
Enum :
Enum Descriptions :
pageToken
Description : Optional. A token identifying a page of results the server should return.
Location : query
Type : string
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/registryBooks
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists RegistryBooks in a given project and location.
HTTP Method : GET
Path : v1alpha/{+parent}/registryBooks
Parameter Order : parent
▼ ▲ cloudnumberregistry.projects.locations.registryBooks.delete
Description : Deletes a single RegistryBook.
Parameters :
name
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/registryBooks/[^/]+$
Required : Yes
Location : path
Description : Required. Name of the resource
requestId
Description : Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Location : query
Type : string
force
Type : boolean
Location : query
Description : Optional. If set to true, all associated resources will be deleted.
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/registryBooks/{registryBooksId}
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : DELETE
Path : v1alpha/{+name}
Parameter Order : name
▼ ▲ cloudnumberregistry.projects.locations.registryBooks.searchIpResources
HTTP Method : POST
Path : v1alpha/{+name}:searchIpResources
Parameter Order : name
Description : Searches IP resources in a given RegistryBook.
Parameters :
name
Pattern : ^projects/[^/]+/locations/[^/]+/registryBooks/[^/]+$
Required : Yes
Type : string
Description : Required. The name of the RegistryBook to search in.
Location : path
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/registryBooks/{registryBooksId}:searchIpResources
▼ ▲ cloudnumberregistry.projects.locations.registryBooks.create
Description : Creates a new RegistryBook in a given project and location.
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/registryBooks
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
parent
Location : path
Description : Required. Value for parent.
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+$
Required : Yes
registryBookId
Description : Required. Id of the requesting object.
Type : string
Location : query
requestId
Type : string
Location : query
Description : Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Path : v1alpha/{+parent}/registryBooks
Parameter Order : parent
HTTP Method : POST
▼ ▲ cloudnumberregistry.projects.locations.registryBooks.patch
Description : Updates the parameters of a single RegistryBook.
Parameters :
updateMask
Description : Optional. Field mask is used to specify the fields to be overwritten in the RegistryBook resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.
Location : query
Format : google-fieldmask
Type : string
name
Type : string
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/registryBooks/[^/]+$
Location : path
Description : Required. Identifier. name of resource
requestId
Description : Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Type : string
Location : query
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/registryBooks/{registryBooksId}
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : PATCH
Path : v1alpha/{+name}
Parameter Order : name
▼ ▲ cloudnumberregistry.projects.locations.discoveredRanges.list
Description : Lists DiscoveredRanges in a given project and location.
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/discoveredRanges
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
filter
Type : string
Location : query
Description : Optional. Filtering results.
pageSize
Description : Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
Location : query
Format : int32
Type : integer
pageToken
Description : Optional. A token identifying a page of results the server should return.
Location : query
Type : string
parent
Type : string
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Description : Required. Parent value for ListDiscoveredRangesRequest
orderBy
Location : query
Type : string
Description : Optional. Hint for how to order the results.
Path : v1alpha/{+parent}/discoveredRanges
Parameter Order : parent
HTTP Method : GET
▼ ▲ cloudnumberregistry.projects.locations.discoveredRanges.get
Parameters :
name
Pattern : ^projects/[^/]+/locations/[^/]+/discoveredRanges/[^/]+$
Required : Yes
Type : string
Description : Required. Name of the resource
Location : path
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/discoveredRanges/{discoveredRangesId}
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets details of a single DiscoveredRange.
HTTP Method : GET
Path : v1alpha/{+name}
Parameter Order : name
▼ ▲ cloudnumberregistry.projects.locations.discoveredRanges.showUtilization
HTTP Method : GET
Path : v1alpha/{+name}:showUtilization
Parameter Order : name
Description : Gets the details of a single DiscoveredRange and its utilization.
Parameters :
name
Type : string
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/discoveredRanges/[^/]+$
Location : path
Description : Required. Name of the resource
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/discoveredRanges/{discoveredRangesId}:showUtilization
▼ ▲ cloudnumberregistry.projects.locations.discoveredRanges.findFreeIpRanges
Description : Finds free IP ranges in a single DiscoveredRange.
Parameters :
cidrPrefixLength
Description : Required. The prefix length of the free IP ranges to find.
Location : query
Format : int32
Type : integer
name
Type : string
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/discoveredRanges/[^/]+$
Location : path
Description : Required. Name of the DiscoveredRange.
rangeCount
Type : integer
Location : query
Format : int32
Description : Optional. The number of free IP ranges to find.
requestId
Description : Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Type : string
Location : query
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/discoveredRanges/{discoveredRangesId}:findFreeIpRanges
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : GET
Path : v1alpha/{+name}:findFreeIpRanges
Parameter Order : name
▼ ▲ cloudnumberregistry.projects.locations.operations.delete
HTTP Method : DELETE
Path : v1alpha/{+name}
Parameter Order : name
Parameters :
name
Location : path
Description : The name of the operation resource to be deleted.
Type : string
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/operations/[^/]+$
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
▼ ▲ cloudnumberregistry.projects.locations.operations.list
HTTP Method : GET
Path : v1alpha/{+name}/operations
Parameter Order : name
Parameters :
filter
Type : string
Location : query
Description : The standard list filter.
pageSize
Description : The standard list page size.
Location : query
Format : int32
Type : integer
name
Type : string
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Description : The name of the operation's parent resource.
pageToken
Description : The standard list page token.
Type : string
Location : query
returnPartialSuccess
Type : boolean
Location : query
Description : When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/operations
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
▼ ▲ cloudnumberregistry.projects.locations.operations.cancel
Description : Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
name
Location : path
Description : The name of the operation resource to be cancelled.
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/operations/[^/]+$
Required : Yes
Path : v1alpha/{+name}:cancel
Parameter Order : name
HTTP Method : POST
▼ ▲ cloudnumberregistry.projects.locations.operations.get
Description : Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
name
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/operations/[^/]+$
Type : string
Description : The name of the operation resource.
Location : path
Path : v1alpha/{+name}
Parameter Order : name
HTTP Method : GET
▼ ▲ cloudnumberregistry.projects.locations.realms.list
Path : v1alpha/{+parent}/realms
Parameter Order : parent
HTTP Method : GET
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/realms
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
pageToken
Type : string
Location : query
Description : Optional. A token identifying a page of results the server should return.
parent
Location : path
Description : Required. Parent value for ListRealmsRequest
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+$
Required : Yes
orderBy
Description : Optional. Hint for how to order the results
Type : string
Location : query
view
Description : Optional. The view of the Realm.
Location : query
Enum Descriptions :
Type : string
Enum :
filter
Type : string
Location : query
Description : Optional. Filtering results
pageSize
Description : Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
Type : integer
Location : query
Format : int32
Description : Lists Realms in a given project and location.
▼ ▲ cloudnumberregistry.projects.locations.realms.delete
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/realms/{realmsId}
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
force
Location : query
Type : boolean
Description : Optional. If set to true, all associated resources will be deleted.
name
Type : string
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/realms/[^/]+$
Location : path
Description : Required. Name of the resource
requestId
Location : query
Type : string
Description : Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request.
Description : Deletes a single Realm.
Path : v1alpha/{+name}
Parameter Order : name
HTTP Method : DELETE
▼ ▲ cloudnumberregistry.projects.locations.realms.get
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/realms/{realmsId}
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
view
Enum :
Type : string
Enum Descriptions :
Location : query
Description : Optional. The view of the Realm.
name
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/realms/[^/]+$
Required : Yes
Location : path
Description : Required. Name of the resource
Description : Gets details of a single Realm.
Path : v1alpha/{+name}
Parameter Order : name
HTTP Method : GET
▼ ▲ cloudnumberregistry.projects.locations.realms.create
HTTP Method : POST
Path : v1alpha/{+parent}/realms
Parameter Order : parent
Parameters :
realmId
Location : query
Type : string
Description : Required. Id of the requesting object.
requestId
Description : Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.
Type : string
Location : query
parent
Pattern : ^projects/[^/]+/locations/[^/]+$
Required : Yes
Type : string
Description : Required. Value for parent.
Location : path
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/realms
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Creates a new Realm in a given project and location.
▼ ▲ cloudnumberregistry.projects.locations.realms.patch
Parameters :
name
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/realms/[^/]+$
Type : string
Description : Required. Identifier. Unique name/ID of the realm
Location : path
requestId
Description : Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.
Location : query
Type : string
updateMask
Location : query
Format : google-fieldmask
Type : string
Description : Optional. Field mask is used to specify the fields to be overwritten in the Realm resource by the update.
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/realms/{realmsId}
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Updates the parameters of a single Realm.
HTTP Method : PATCH
Path : v1alpha/{+name}
Parameter Order : name
▼ ▲ cloudnumberregistry.projects.locations.ipamAdminScopes.list
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/ipamAdminScopes
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
pageSize
Location : query
Format : int32
Type : integer
Description : Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
filter
Description : Optional. Filtering results
Type : string
Location : query
parent
Location : path
Description : Required. Parent value for ListIpamAdminScopesRequest
Type : string
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+$
orderBy
Location : query
Type : string
Description : Optional. Hint for how to order the results
pageToken
Location : query
Type : string
Description : Optional. A token identifying a page of results the server should return.
Description : List all IPAM admin scopes in a given project and location.
Path : v1alpha/{+parent}/ipamAdminScopes
Parameter Order : parent
HTTP Method : GET
▼ ▲ cloudnumberregistry.projects.locations.ipamAdminScopes.delete
Path : v1alpha/{+name}
Parameter Order : name
HTTP Method : DELETE
Description : Deletes a single IpamAdminScope.
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/ipamAdminScopes/{ipamAdminScopesId}
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
name
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/ipamAdminScopes/[^/]+$
Type : string
Description : Required. Name of the resource
Location : path
requestId
Location : query
Type : string
Description : Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
force
Type : boolean
Location : query
Description : Optional. If set to true, all associated resources will be deleted.
▼ ▲ cloudnumberregistry.projects.locations.ipamAdminScopes.get
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/ipamAdminScopes/{ipamAdminScopesId}
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
name
Description : Required. Name of the resource
Location : path
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/ipamAdminScopes/[^/]+$
Type : string
Description : Gets details of a single IpamAdminScope.
Path : v1alpha/{+name}
Parameter Order : name
HTTP Method : GET
▼ ▲ cloudnumberregistry.projects.locations.ipamAdminScopes.cleanup
Parameters :
name
Description : Required. Name of the resource
Location : path
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/ipamAdminScopes/[^/]+$
Type : string
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/ipamAdminScopes/{ipamAdminScopesId}:cleanup
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Cleans up a single IpamAdminScope.
HTTP Method : POST
Path : v1alpha/{+name}:cleanup
Parameter Order : name
▼ ▲ cloudnumberregistry.projects.locations.ipamAdminScopes.create
Path : v1alpha/{+parent}/ipamAdminScopes
Parameter Order : parent
HTTP Method : POST
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/ipamAdminScopes
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
ipamAdminScopeId
Description : Required. Id of the requesting object.
Type : string
Location : query
requestId
Description : Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Location : query
Type : string
parent
Pattern : ^projects/[^/]+/locations/[^/]+$
Required : Yes
Type : string
Description : Required. Value for parent.
Location : path
Description : Creates a new IpamAdminScope in a given project and location.
▼ ▲ cloudnumberregistry.projects.locations.ipamAdminScopes.patch
Description : Updates the parameters of a single IpamAdminScope.
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/ipamAdminScopes/{ipamAdminScopesId}
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
name
Description : Required. Identifier. name of resource
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/ipamAdminScopes/[^/]+$
Required : Yes
Type : string
requestId
Location : query
Type : string
Description : Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
updateMask
Location : query
Format : google-fieldmask
Type : string
Description : Optional. Field mask is used to specify the fields to be overwritten in the IpamAdminScope resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.
Path : v1alpha/{+name}
Parameter Order : name
HTTP Method : PATCH
▼ ▲ cloudnumberregistry.projects.locations.ipamAdminScopes.checkAvailability
Description : Checks the availability of IPAM admin scopes in a given project and location.
Parameters :
scopes
Description : Required. The scopes of the IpamAdminScopes to look for.
Location : query
Repeated : Yes
Type : string
parent
Description : Required. Parent value for the IpamAdminScopes.
Location : path
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+$
Type : string
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/ipamAdminScopes:checkAvailability
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : GET
Path : v1alpha/{+parent}/ipamAdminScopes:checkAvailability
Parameter Order : parent
▼ ▲ cloudnumberregistry.projects.locations.ipamAdminScopes.disable
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/ipamAdminScopes/{ipamAdminScopesId}:disable
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
name
Location : path
Description : Required. Name of the resource
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/ipamAdminScopes/[^/]+$
Required : Yes
Description : Disables a single IpamAdminScope.
Path : v1alpha/{+name}:disable
Parameter Order : name
HTTP Method : POST
▼ ▲ cloudnumberregistry.projects.locations.customRanges.showUtilization
HTTP Method : GET
Path : v1alpha/{+name}:showUtilization
Parameter Order : name
Description : Gets the details of a single CustomRange and its utilization.
Parameters :
name
Type : string
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/customRanges/[^/]+$
Location : path
Description : Required. Name of the resource
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/customRanges/{customRangesId}:showUtilization
▼ ▲ cloudnumberregistry.projects.locations.customRanges.create
Description : Creates a new CustomRange in a given project and location.
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/customRanges
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
requestId
Description : Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Location : query
Type : string
parent
Description : Required. Value for parent.
Location : path
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+$
Type : string
customRangeId
Type : string
Location : query
Description : Required. Id of the requesting object.
Path : v1alpha/{+parent}/customRanges
Parameter Order : parent
HTTP Method : POST
▼ ▲ cloudnumberregistry.projects.locations.customRanges.patch
Path : v1alpha/{+name}
Parameter Order : name
HTTP Method : PATCH
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/customRanges/{customRangesId}
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
name
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/customRanges/[^/]+$
Required : Yes
Location : path
Description : Required. Identifier. name of resource
requestId
Location : query
Type : string
Description : Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
updateMask
Description : Optional. Field mask is used to specify the fields to be overwritten in the CustomRange resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.
Type : string
Location : query
Format : google-fieldmask
Description : Updates the parameters of a single CustomRange.
▼ ▲ cloudnumberregistry.projects.locations.customRanges.get
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/customRanges/{customRangesId}
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
name
Description : Required. Name of the resource
Location : path
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/customRanges/[^/]+$
Type : string
Description : Gets details of a single CustomRange.
Path : v1alpha/{+name}
Parameter Order : name
HTTP Method : GET
▼ ▲ cloudnumberregistry.projects.locations.customRanges.findFreeIpRanges
HTTP Method : GET
Path : v1alpha/{+name}:findFreeIpRanges
Parameter Order : name
Parameters :
name
Description : Required. Name of the CustomRange.
Location : path
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/customRanges/[^/]+$
Type : string
rangeCount
Type : integer
Location : query
Format : int32
Description : Optional. The number of free IP ranges to find.
requestId
Description : Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Type : string
Location : query
cidrPrefixLength
Description : Required. The prefix length of the free IP ranges to find.
Type : integer
Location : query
Format : int32
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/customRanges/{customRangesId}:findFreeIpRanges
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Finds free IP ranges in a single CustomRange.
▼ ▲ cloudnumberregistry.projects.locations.customRanges.list
HTTP Method : GET
Path : v1alpha/{+parent}/customRanges
Parameter Order : parent
Parameters :
parent
Type : string
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Description : Required. Parent value for ListCustomRangesRequest
orderBy
Type : string
Location : query
Description : Optional. Hint for how to order the results.
pageToken
Type : string
Location : query
Description : Optional. A token identifying a page of results the server should return.
pageSize
Location : query
Format : int32
Type : integer
Description : Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
filter
Description : Optional. Filtering results.
Type : string
Location : query
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/customRanges
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists CustomRanges in a given project and location.
▼ ▲ cloudnumberregistry.projects.locations.customRanges.delete
Path : v1alpha/{+name}
Parameter Order : name
HTTP Method : DELETE
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/customRanges/{customRangesId}
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
name
Type : string
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/customRanges/[^/]+$
Location : path
Description : Required. Name of the resource
requestId
Description : Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Location : query
Type : string
force
Description : Optional. If set to true, all associated resources will be deleted.
Location : query
Type : boolean
Description : Deletes a single CustomRange.