Google

Cloud Domains API

Enables management and configuration of domain names.

Developer tools#openapi#analytics#media

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Enables management and configuration of domain names.

Endpoints 26

projects.locations.registrations

  • GETGets the details of a `Registration` resource./v1/:nameGets the details of a Registration resource.
  • DELETEDeletes a `Registration` resource/v1/:nameDeletes a Registration resource. This method works on any Registration resource using Subscription or Commitment billing, provided that the resource was…
  • PATCHUpdates select fields of a `Registration` resource, notably `labels`/v1/:name?updateMask=string&validateOnly=trueUpdates select fields of a Registration resource, notably labels. To update other fields, use the appropriate custom update method: * To update management…
  • POSTUpdates a `Registration`'s contact settings/v1/:registration:configureContactSettingsUpdates a Registration's contact settings. Some changes require confirmation by the domain's registrant contact . Caution: Please consider carefully any…
  • POSTUpdates a `Registration`'s DNS settings./v1/:registration:configureDnsSettingsUpdates a Registration's DNS settings.
  • POSTUpdates a `Registration`'s management settings./v1/:registration:configureManagementSettingsUpdates a Registration's management settings.
  • POSTDeprecated: For more information, see [Cloud Domains feature…/v1/:name:exportDeprecated: For more information, see Cloud Domains feature deprecation Exports a Registration resource, such that it is no longer managed by Cloud Domains.…
  • GETGets the access control policy for a resource/v1/:resource:getIamPolicy?options.requestedPolicyVersion=0Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
  • POSTDeprecated: For more information, see [Cloud Domains feature…/v1/:parent/registrations:importDeprecated: For more information, see Cloud Domains feature deprecation Imports a domain name from Google Domains for use in Cloud Domains. To transfer a…
  • POSTInitiates the `Push Transfer` process to transfer the domain to another registrar/v1/:registration:initiatePushTransferInitiates the Push Transfer process to transfer the domain to another registrar. The process might complete instantly or might require confirmation or…
  • GETLists the `Registration` resources in a project./v1/:parent/registrations?filter=string&pageSize=0&pageToken=stringLists the Registration resources in a project.
  • POSTRegisters a new domain name and creates a corresponding `Registration` resource/v1/:parent/registrations:registerRegisters a new domain name and creates a corresponding Registration resource. Call RetrieveRegisterParameters first to check availability of the domain name…
  • POSTRenews a recently expired domain/v1/:registration:renewDomainRenews a recently expired domain. This method can only be called on domains that expired in the previous 30 days. After the renewal, the new expiration time…
  • POSTResets the authorization code of the `Registration` to a new random string/v1/:registration:resetAuthorizationCodeResets the authorization code of the Registration to a new random string. You can call this method only after 60 days have elapsed since the initial domain…
  • GETGets the authorization code of the `Registration` for the purpose of transferring the domain to another registrar/v1/:registration:retrieveAuthorizationCodeGets the authorization code of the Registration for the purpose of transferring the domain to another registrar. You can call this method only after 60 days…
  • GETLists the DNS records from the Google Domains DNS zone for domains that use the deprecated `google_domains_dns` in the…/v1/:registration:retrieveGoogleDomainsDnsRecords?pageSize=0&pageToken=stringLists the DNS records from the Google Domains DNS zone for domains that use the deprecated google_domains_dns in the Registration's dns_settings.
  • GETLists the deprecated domain and email forwarding configurations you set up in the deprecated Google Domains UI/v1/:registration:retrieveGoogleDomainsForwardingConfigLists the deprecated domain and email forwarding configurations you set up in the deprecated Google Domains UI. The configuration is present only for domains…
  • GETDeprecated: For more information, see [Cloud Domains feature…/v1/:location/registrations:retrieveImportableDomains?pageSize=0&pageToken=stringDeprecated: For more information, see Cloud Domains feature deprecation Lists domain names from Google Domains that can be imported to Cloud Domains using the…
  • GETGets parameters needed to register a new domain name, including price and up-to-date availability/v1/:location/registrations:retrieveRegisterParameters?domainName=stringGets parameters needed to register a new domain name, including price and up-to-date availability. Use the returned values to call RegisterDomain.
  • GETDeprecated: For more information, see [Cloud Domains feature…/v1/:location/registrations:retrieveTransferParameters?domainName=stringDeprecated: For more information, see Cloud Domains feature deprecation Gets parameters needed to transfer a domain name from another registrar to Cloud…
  • GETSearches for available domain names similar to the provided query/v1/:location/registrations:searchDomains?query=stringSearches for available domain names similar to the provided query. Availability results from this method are approximate; call RetrieveRegisterParameters on a…
  • POSTSets the access control policy on the specified resource/v1/:resource:setIamPolicySets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.
  • POSTReturns permissions that a caller has on the specified resource/v1/:resource:testIamPermissionsReturns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND…
  • POSTDeprecated: For more information, see [Cloud Domains feature…/v1/:parent/registrations:transferDeprecated: For more information, see Cloud Domains feature deprecation Transfers a domain name from another registrar to Cloud Domains. For domains already…

projects.locations

  • GETLists information about the supported locations for this service/v1/:name/locations?extraLocationTypes=string&filter=string&pageSize=0&pageToken=stringLists information about the supported locations for this service. This method lists locations based on the resource scope provided in the…

projects.locations.operations

  • GETLists operations that match the specified filter in the request/v1/:name/operations?filter=string&pageSize=0&pageToken=string&returnPartialSuccess=trueLists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

API details

Base URL
https://domains.googleapis.com
Authentication
OAuth 2.0 (authorization code flow) with 1 scope
An API key in the key query parameter
Operations
26 operations on 24 pathsGET 12POST 12PATCH 1DELETE 1
Main resources
projects.locations.registrations 24projects.locations 1projects.locations.operations 1
Response formats
application/json
Description format
Google API Discovery, API version v1

How to test the Cloud Domains API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Cloud Domains API collection, without the publisher's secrets.
  3. Add your credentialsThis API uses OAuth 2.0 (authorization code flow) with 1 scope. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Gets the details of a `Registration` resource.” (GET /v1/:name), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Cloud Domains API?

Enables management and configuration of domain names. It is listed under Developer tools and has 26 endpoints.

Who publishes the Cloud Domains API?

It is listed from Google's public API description (an OpenAPI document), not published by Google on Swastik Codes. Anyone who controls googleapis.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Cloud Domains API?

Requests go to https://domains.googleapis.com. Endpoint paths are added to this base URL.

How do I authenticate with the Cloud Domains API?

It accepts 2 methods: OAuth 2.0 (authorization code flow) with 1 scope; an API key in the key query parameter.

How many endpoints does the Cloud Domains API have?

26 operations on 24 paths (12 GET, 12 POST, 1 PATCH, 1 DELETE). The largest groups are projects.locations.registrations, projects.locations, projects.locations.operations.

Is forking the Cloud Domains API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.