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
  8. ResponsePolicies
  9. ResponsePolicyRules

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 updates the ResourceRecordSet collection.
get GET  /project/managedZones/managedZone/changes/changeId Fetches the representation of an existing Change.
list GET  /project/managedZones/managedZone/changes Enumerates 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 Fetches the representation of an existing DnsKey.
list GET  /project/managedZones/managedZone/dnsKeys Enumerates 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 Fetches the representation of an existing Operation.
list GET  /project/managedZones/managedZone/operations Enumerates 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 Creates a new ManagedZone.
delete DELETE  /project/managedZones/managedZone Deletes a previously created ManagedZone.
get GET  /project/managedZones/managedZone Fetches the representation of an existing ManagedZone.
list GET  /project/managedZones Enumerates ManagedZones that have been created but not yet deleted.
patch PATCH  /project/managedZones/managedZone Applies a partial update to an existing ManagedZone.
update PUT  /project/managedZones/managedZone Updates an existing ManagedZone.

Policies

For Policies 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/policies Creates a new Policy.
delete DELETE  /project/policies/policy Deletes a previously created Policy. Fails if the policy is still being referenced by a network.
get GET  /project/policies/policy Fetches the representation of an existing Policy.
list GET  /project/policies Enumerates all Policies associated with a project.
patch PATCH  /project/policies/policy Applies a partial update to an existing Policy.
update PUT  /project/policies/policy Updates 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 Fetches 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
create POST  /project/managedZones/managedZone/rrsets Creates a new ResourceRecordSet.
delete DELETE  /project/managedZones/managedZone/rrsets/name/type Deletes a previously created ResourceRecordSet.
get GET  /project/managedZones/managedZone/rrsets/name/type Fetches the representation of an existing ResourceRecordSet.
list GET  /project/managedZones/managedZone/rrsets Enumerates ResourceRecordSets that you have created but not yet deleted.
patch PATCH  /project/managedZones/managedZone/rrsets/name/type Applies a partial update to an existing ResourceRecordSet.

ResponsePolicies

For ResponsePolicies 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/responsePolicies Creates a new Response Policy
delete DELETE  /project/responsePolicies/responsePolicy Deletes a previously created Response Policy. Fails if the response policy is non-empty or still being referenced by a network.
get GET  /project/responsePolicies/responsePolicy Fetches the representation of an existing Response Policy.
list GET  /project/responsePolicies Enumerates all Response Policies associated with a project.
patch PATCH  /project/responsePolicies/responsePolicy Applies a partial update to an existing Response Policy.
update PUT  /project/responsePolicies/responsePolicy Updates an existing Response Policy.

ResponsePolicyRules

For ResponsePolicyRules 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/responsePolicies/responsePolicy/rules Creates a new Response Policy Rule.
delete DELETE  /project/responsePolicies/responsePolicy/rules/responsePolicyRule Deletes a previously created Response Policy Rule.
get GET  /project/responsePolicies/responsePolicy/rules/responsePolicyRule Fetches the representation of an existing Response Policy Rule.
list GET  /project/responsePolicies/responsePolicy/rules Enumerates all Response Policy Rules associated with a project.
patch PATCH  /project/responsePolicies/responsePolicy/rules/responsePolicyRule Applies a partial update to an existing Response Policy Rule.
update PUT  /project/responsePolicies/responsePolicy/rules/responsePolicyRule Updates an existing Response Policy Rule.