API Reference

This API reference is organized by resource type. Each resource type has one or more data representations and one or more methods.

Resource types

  1. Changes
  2. DnsKeys
  3. ManagedZoneOperations
  4. ManagedZones
  5. Policies
  6. Projects
  7. ResourceRecordSets

Changes

For Changes Resource details, see the resource representation page.

Method HTTP request Description
URIs relative to https://dns.googleapis.com/dns/v1/projects, unless otherwise noted
create POST  /project/managedZones/managedZone/changes Atomically update the ResourceRecordSet collection.
get GET  /project/managedZones/managedZone/changes/changeId Fetch the representation of an existing Change.
list GET  /project/managedZones/managedZone/changes Enumerate Changes to a ResourceRecordSet collection.

DnsKeys

For DnsKeys Resource details, see the resource representation page.

Method HTTP request Description
URIs relative to https://dns.googleapis.com/dns/v1/projects, unless otherwise noted
get GET  /project/managedZones/managedZone/dnsKeys/dnsKeyId Fetch the representation of an existing DnsKey.
list GET  /project/managedZones/managedZone/dnsKeys Enumerate DnsKeys to a ResourceRecordSet collection.

ManagedZoneOperations

For ManagedZoneOperations Resource details, see the resource representation page.

Method HTTP request Description
URIs relative to https://dns.googleapis.com/dns/v1/projects, unless otherwise noted
get GET  /project/managedZones/managedZone/operations/operation Fetch the representation of an existing Operation.
list GET  /project/managedZones/managedZone/operations Enumerate Operations for the given ManagedZone.

ManagedZones

For ManagedZones Resource details, see the resource representation page.

Method HTTP request Description
URIs relative to https://dns.googleapis.com/dns/v1/projects, unless otherwise noted
create POST  /project/managedZones Create a new ManagedZone.
delete DELETE  /project/managedZones/managedZone Delete a previously created ManagedZone.
get GET  /project/managedZones/managedZone Fetch the representation of an existing ManagedZone.
list GET  /project/managedZones Enumerate ManagedZones that have been created but not yet deleted.
patch PATCH  /project/managedZones/managedZone Apply a partial update to an existing ManagedZone.
update PUT  /project/managedZones/managedZone Update an existing ManagedZone.

Policies

For Policies Resource details, see the resource representation page.

Method HTTP request Description
URIs relative to https://www.googleapis.com/dns/v1/projects, unless otherwise noted
create POST  /project/policies Create a new Policy
delete DELETE  /project/policies/policy Delete a previously created Policy. Will fail if the policy is still being referenced by a network.
get GET  /project/policies/policy Fetch the representation of an existing Policy.
list GET  /project/policies Enumerate all Policies associated with a project.
patch PATCH  /project/policies/policy Apply a partial update to an existing Policy.
update PUT  /project/policies/policy Update an existing Policy.

Projects

For Projects Resource details, see the resource representation page.

Method HTTP request Description
URIs relative to https://dns.googleapis.com/dns/v1/projects, unless otherwise noted
get GET  /project Fetch the representation of an existing Project.

ResourceRecordSets

For ResourceRecordSets Resource details, see the resource representation page.

Method HTTP request Description
URIs relative to https://dns.googleapis.com/dns/v1/projects, unless otherwise noted
list GET  /project/managedZones/managedZone/rrsets Enumerate ResourceRecordSets that have been created but not yet deleted.