Cloud Number Registry API

Service: cloudnumberregistry.googleapis.com

To call this service, we recommend that you use the Google-provided client libraries. If your application needs to use your own libraries to call this service, use the following information when you make the API requests.

Discovery document

A Discovery Document is a machine-readable specification for describing and consuming REST APIs. It is used to build client libraries, IDE plugins, and other tools that interact with Google APIs. One service may provide multiple discovery documents. This service provides the following discovery document:

Service endpoint

A service endpoint is a base URL that specifies the network address of an API service. One service might have multiple service endpoints. This service has the following service endpoint and all URIs below are relative to this service endpoint:

  • https://cloudnumberregistry.googleapis.com

REST Resource: v1alpha.projects.locations

Methods
get GET /v1alpha/{name=projects/*/locations/*}
Gets information about a location.
list GET /v1alpha/{name=projects/*}/locations
Lists information about the supported locations for this service.

REST Resource: v1alpha.projects.locations.customRanges

Methods
create POST /v1alpha/{parent=projects/*/locations/*}/customRanges
Creates a new CustomRange in a given project and location.
delete DELETE /v1alpha/{name=projects/*/locations/*/customRanges/*}
Deletes a single CustomRange.
findFreeIpRanges GET /v1alpha/{name=projects/*/locations/*/customRanges/*}:findFreeIpRanges
Finds free IP ranges in a single CustomRange.
get GET /v1alpha/{name=projects/*/locations/*/customRanges/*}
Gets details of a single CustomRange.
list GET /v1alpha/{parent=projects/*/locations/*}/customRanges
Lists CustomRanges in a given project and location.
patch PATCH /v1alpha/{customRange.name=projects/*/locations/*/customRanges/*}
Updates the parameters of a single CustomRange.
showUtilization GET /v1alpha/{name=projects/*/locations/*/customRanges/*}:showUtilization
Gets the details of a single CustomRange and its utilization.

REST Resource: v1alpha.projects.locations.discoveredRanges

Methods
findFreeIpRanges GET /v1alpha/{name=projects/*/locations/*/discoveredRanges/*}:findFreeIpRanges
Finds free IP ranges in a single DiscoveredRange.
get GET /v1alpha/{name=projects/*/locations/*/discoveredRanges/*}
Gets details of a single DiscoveredRange.
list GET /v1alpha/{parent=projects/*/locations/*}/discoveredRanges
Lists DiscoveredRanges in a given project and location.
showUtilization GET /v1alpha/{name=projects/*/locations/*/discoveredRanges/*}:showUtilization
Gets the details of a single DiscoveredRange and its utilization.

REST Resource: v1alpha.projects.locations.ipamAdminScopes

Methods
checkAvailability GET /v1alpha/{parent=projects/*/locations/*}/ipamAdminScopes:checkAvailability
Checks the availability of IPAM admin scopes in a given project and location.
cleanup POST /v1alpha/{name=projects/*/locations/*/ipamAdminScopes/*}:cleanup
Cleans up a single IpamAdminScope.
create POST /v1alpha/{parent=projects/*/locations/*}/ipamAdminScopes
Creates a new IpamAdminScope in a given project and location.
delete DELETE /v1alpha/{name=projects/*/locations/*/ipamAdminScopes/*}
Deletes a single IpamAdminScope.
disable POST /v1alpha/{name=projects/*/locations/*/ipamAdminScopes/*}:disable
Disables a single IpamAdminScope.
get GET /v1alpha/{name=projects/*/locations/*/ipamAdminScopes/*}
Gets details of a single IpamAdminScope.
list GET /v1alpha/{parent=projects/*/locations/*}/ipamAdminScopes
List all IPAM admin scopes in a given project and location.
patch PATCH /v1alpha/{ipamAdminScope.name=projects/*/locations/*/ipamAdminScopes/*}
Updates the parameters of a single IpamAdminScope.

REST Resource: v1alpha.projects.locations.operations

Methods
cancel POST /v1alpha/{name=projects/*/locations/*/operations/*}:cancel
Starts asynchronous cancellation on a long-running operation.
delete DELETE /v1alpha/{name=projects/*/locations/*/operations/*}
Deletes a long-running operation.
get GET /v1alpha/{name=projects/*/locations/*/operations/*}
Gets the latest state of a long-running operation.
list GET /v1alpha/{name=projects/*/locations/*}/operations
Lists operations that match the specified filter in the request.

REST Resource: v1alpha.projects.locations.realms

Methods
create POST /v1alpha/{parent=projects/*/locations/*}/realms
Creates a new Realm in a given project and location.
delete DELETE /v1alpha/{name=projects/*/locations/*/realms/*}
Deletes a single Realm.
get GET /v1alpha/{name=projects/*/locations/*/realms/*}
Gets details of a single Realm.
list GET /v1alpha/{parent=projects/*/locations/*}/realms
Lists Realms in a given project and location.
patch PATCH /v1alpha/{realm.name=projects/*/locations/*/realms/*}
Updates the parameters of a single Realm.

REST Resource: v1alpha.projects.locations.registryBooks

Methods
create POST /v1alpha/{parent=projects/*/locations/*}/registryBooks
Creates a new RegistryBook in a given project and location.
delete DELETE /v1alpha/{name=projects/*/locations/*/registryBooks/*}
Deletes a single RegistryBook.
get GET /v1alpha/{name=projects/*/locations/*/registryBooks/*}
Gets details of a single RegistryBook.
list GET /v1alpha/{parent=projects/*/locations/*}/registryBooks
Lists RegistryBooks in a given project and location.
patch PATCH /v1alpha/{registryBook.name=projects/*/locations/*/registryBooks/*}
Updates the parameters of a single RegistryBook.
searchIpResources POST /v1alpha/{name=projects/*/locations/*/registryBooks/*}:searchIpResources
Searches IP resources in a given RegistryBook.