{ "parameters": { "access_token": { "type": "string", "description": "OAuth access token.", "location": "query" }, "alt": { "type": "string", "description": "Data format for response.", "default": "json", "enum": [ "json", "media", "proto" ], "enumDescriptions": [ "Responses with Content-Type of application/json", "Media download with context-dependent Content-Type", "Responses with Content-Type of application/x-protobuf" ], "location": "query" }, "callback": { "type": "string", "description": "JSONP", "location": "query" }, "fields": { "type": "string", "description": "Selector specifying which fields to include in a partial response.", "location": "query" }, "key": { "type": "string", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.", "location": "query" }, "oauth_token": { "type": "string", "description": "OAuth 2.0 token for the current user.", "location": "query" }, "prettyPrint": { "type": "boolean", "description": "Returns response with indentations and line breaks.", "default": "true", "location": "query" }, "quotaUser": { "type": "string", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.", "location": "query" }, "upload_protocol": { "type": "string", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", "location": "query" }, "uploadType": { "type": "string", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", "location": "query" }, "$.xgafv": { "type": "string", "description": "V1 error format.", "enum": [ "1", "2" ], "enumDescriptions": [ "v1 error format", "v2 error format" ], "location": "query" } }, "rootUrl": "https://dns.googleapis.com/", "description": "", "schemas": { "ResourceRecordSetsListResponse": { "id": "ResourceRecordSetsListResponse", "type": "object", "properties": { "rrsets": { "description": "The resource record set resources.", "type": "array", "items": { "$ref": "ResourceRecordSet" } }, "nextPageToken": { "description": "This field indicates that more results are available beyond the last page displayed. To fetch the results, make another list request and use this value as your page token. This lets you retrieve the complete contents of a very large collection one page at a time. However, if the contents of the collection change between the first and last paginated list request, the set of all elements returned are an inconsistent view of the collection. You can't retrieve a consistent snapshot of a collection larger than the maximum page size.", "type": "string" }, "kind": { "description": "Type of resource.", "default": "dns#resourceRecordSetsListResponse", "type": "string" } } }, "ResourceRecordSet": { "id": "ResourceRecordSet", "description": "A unit of data that is returned by the DNS servers.", "type": "object", "properties": { "name": { "description": "For example, www.example.com.", "type": "string" }, "type": { "description": "The identifier of a supported record type. See the list of Supported DNS record types.", "type": "string" }, "ttl": { "description": "Number of seconds that this `ResourceRecordSet` can be cached by resolvers.", "type": "integer", "format": "int32" }, "rrdatas": { "description": "As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) -- see examples.", "type": "array", "items": { "type": "string" } }, "signatureRrdatas": { "description": "As defined in RFC 4034 (section 3.2).", "type": "array", "items": { "type": "string" } }, "routingPolicy": { "description": "Configures dynamic query responses based on either the geo location of the querying user or a weighted round robin based routing policy. A valid `ResourceRecordSet` contains only `rrdata` (for static resolution) or a `routing_policy` (for dynamic resolution).", "$ref": "RRSetRoutingPolicy" }, "kind": { "default": "dns#resourceRecordSet", "type": "string" } } }, "RRSetRoutingPolicy": { "id": "RRSetRoutingPolicy", "description": "A RRSetRoutingPolicy represents ResourceRecordSet data that is returned dynamically with the response varying based on configured properties such as geolocation or by weighted random selection.", "type": "object", "properties": { "geo": { "$ref": "RRSetRoutingPolicyGeoPolicy" }, "wrr": { "$ref": "RRSetRoutingPolicyWrrPolicy" }, "primaryBackup": { "$ref": "RRSetRoutingPolicyPrimaryBackupPolicy" }, "healthCheck": { "description": "The fully qualified URL of the HealthCheck to use for this RRSetRoutingPolicy. Format this URL like `https://www.googleapis.com/compute/v1/projects/{project}/global/healthChecks/{healthCheck}`. https://cloud.google.com/compute/docs/reference/rest/v1/healthChecks", "type": "string" }, "kind": { "default": "dns#rRSetRoutingPolicy", "type": "string" } } }, "RRSetRoutingPolicyGeoPolicy": { "id": "RRSetRoutingPolicyGeoPolicy", "description": "Configures a `RRSetRoutingPolicy` that routes based on the geo location of the querying user.", "type": "object", "properties": { "items": { "description": "The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead.", "type": "array", "items": { "$ref": "RRSetRoutingPolicyGeoPolicyGeoPolicyItem" } }, "enableFencing": { "description": "Without fencing, if health check fails for all configured items in the current geo bucket, we failover to the next nearest geo bucket. With fencing, if health checking is enabled, as long as some targets in the current geo bucket are healthy, we return only the healthy targets. However, if all targets are unhealthy, we don't failover to the next nearest bucket; instead, we return all the items in the current bucket even when all targets are unhealthy.", "type": "boolean" }, "kind": { "default": "dns#rRSetRoutingPolicyGeoPolicy", "type": "string" } } }, "RRSetRoutingPolicyGeoPolicyGeoPolicyItem": { "id": "RRSetRoutingPolicyGeoPolicyGeoPolicyItem", "description": "ResourceRecordSet data for one geo location.", "type": "object", "properties": { "location": { "description": "The geo-location granularity is a GCP region. This location string should correspond to a GCP region. e.g. \"us-east1\", \"southamerica-east1\", \"asia-east1\", etc.", "type": "string" }, "rrdatas": { "type": "array", "items": { "type": "string" } }, "signatureRrdatas": { "description": "DNSSEC generated signatures for all the `rrdata` within this item. When using health-checked targets for DNSSEC-enabled zones, you can only use at most one health-checked IP address per item.", "type": "array", "items": { "type": "string" } }, "healthCheckedTargets": { "description": "For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item.", "$ref": "RRSetRoutingPolicyHealthCheckTargets" }, "kind": { "default": "dns#rRSetRoutingPolicyGeoPolicyGeoPolicyItem", "type": "string" } } }, "RRSetRoutingPolicyHealthCheckTargets": { "id": "RRSetRoutingPolicyHealthCheckTargets", "description": "HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Set either `internal_load_balancer` or `external_endpoints`. Do not set both.", "type": "object", "properties": { "internalLoadBalancers": { "description": "Configuration for internal load balancers to be health checked.", "type": "array", "items": { "$ref": "RRSetRoutingPolicyLoadBalancerTarget" } }, "externalEndpoints": { "description": "The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1)", "type": "array", "items": { "type": "string" } } } }, "RRSetRoutingPolicyLoadBalancerTarget": { "id": "RRSetRoutingPolicyLoadBalancerTarget", "description": "The configuration for an individual load balancer to health check.", "type": "object", "properties": { "loadBalancerType": { "description": "The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. ", "type": "string", "enumDescriptions": [ "", "Indicates the load balancer is a Cross-Region Application Load Balancer.", "Indicates the load balancer is a Regional Network Passthrough Load Balancer.", "Indicates the load balancer is a Regional Application Load Balancer." ], "enum": [ "NONE", "GLOBAL_L7ILB", "REGIONAL_L4ILB", "REGIONAL_L7ILB" ] }, "ipAddress": { "description": "The frontend IP address of the load balancer to health check.", "type": "string" }, "port": { "description": "The configured port of the load balancer.", "type": "string" }, "ipProtocol": { "description": "The protocol of the load balancer to health check.", "type": "string", "enumDescriptions": [ "", "Indicates the load balancer is accessible via TCP.", "Indicates the load balancer is accessible via UDP." ], "enum": [ "UNDEFINED", "TCP", "UDP" ] }, "networkUrl": { "description": "The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`.", "type": "string" }, "project": { "description": "The project ID in which the load balancer is located.", "type": "string" }, "region": { "description": "The region in which the load balancer is located.", "type": "string" }, "kind": { "default": "dns#rRSetRoutingPolicyLoadBalancerTarget", "type": "string" } } }, "RRSetRoutingPolicyWrrPolicy": { "id": "RRSetRoutingPolicyWrrPolicy", "description": "Configures a RRSetRoutingPolicy that routes in a weighted round robin fashion.", "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "RRSetRoutingPolicyWrrPolicyWrrPolicyItem" } }, "kind": { "default": "dns#rRSetRoutingPolicyWrrPolicy", "type": "string" } } }, "RRSetRoutingPolicyWrrPolicyWrrPolicyItem": { "id": "RRSetRoutingPolicyWrrPolicyWrrPolicyItem", "description": "A routing block which contains the routing information for one WRR item.", "type": "object", "properties": { "weight": { "description": "The weight corresponding to this `WrrPolicyItem` object. When multiple `WrrPolicyItem` objects are configured, the probability of returning an `WrrPolicyItem` object's data is proportional to its weight relative to the sum of weights configured for all items. This weight must be non-negative.", "type": "number", "format": "double" }, "rrdatas": { "type": "array", "items": { "type": "string" } }, "signatureRrdatas": { "description": "DNSSEC generated signatures for all the `rrdata` within this item. When using health-checked targets for DNSSEC-enabled zones, you can only use at most one health-checked IP address per item.", "type": "array", "items": { "type": "string" } }, "healthCheckedTargets": { "description": "Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of `rrdata` or `health_checked_targets` can be set.", "$ref": "RRSetRoutingPolicyHealthCheckTargets" }, "kind": { "default": "dns#rRSetRoutingPolicyWrrPolicyWrrPolicyItem", "type": "string" } } }, "RRSetRoutingPolicyPrimaryBackupPolicy": { "id": "RRSetRoutingPolicyPrimaryBackupPolicy", "description": "Configures a RRSetRoutingPolicy such that all queries are responded with the primary_targets if they are healthy. And if all of them are unhealthy, then we fallback to a geo localized policy.", "type": "object", "properties": { "primaryTargets": { "description": "Endpoints that are health checked before making the routing decision. Unhealthy endpoints are omitted from the results. If all endpoints are unhealthy, we serve a response based on the `backup_geo_targets`.", "$ref": "RRSetRoutingPolicyHealthCheckTargets" }, "backupGeoTargets": { "description": "Backup targets provide a regional failover policy for the otherwise global primary targets. If serving state is set to `BACKUP`, this policy essentially becomes a geo routing policy.", "$ref": "RRSetRoutingPolicyGeoPolicy" }, "trickleTraffic": { "description": "When serving state is `PRIMARY`, this field provides the option of sending a small percentage of the traffic to the backup targets.", "type": "number", "format": "double" }, "kind": { "default": "dns#rRSetRoutingPolicyPrimaryBackupPolicy", "type": "string" } } }, "Change": { "id": "Change", "description": "A Change represents a set of `ResourceRecordSet` additions and deletions applied atomically to a ManagedZone. ResourceRecordSets within a ManagedZone are modified by creating a new Change element in the Changes collection. In turn the Changes collection also records the past modifications to the `ResourceRecordSets` in a `ManagedZone`. The current state of the `ManagedZone` is the sum effect of applying all `Change` elements in the `Changes` collection in sequence.", "type": "object", "properties": { "additions": { "description": "Which ResourceRecordSets to add?", "type": "array", "items": { "$ref": "ResourceRecordSet" } }, "deletions": { "description": "Which ResourceRecordSets to remove? Must match existing data exactly.", "type": "array", "items": { "$ref": "ResourceRecordSet" } }, "startTime": { "description": "The time that this operation was started by the server (output only). This is in RFC3339 text format.", "type": "string" }, "id": { "description": "Unique identifier for the resource; defined by the server (output only).", "type": "string" }, "status": { "description": "Status of the operation (output only). A status of \"done\" means that the request to update the authoritative servers has been sent, but the servers might not be updated yet.", "type": "string", "enumDescriptions": [ "", "" ], "enum": [ "PENDING", "DONE" ] }, "isServing": { "description": "If the DNS queries for the zone will be served.", "type": "boolean" }, "kind": { "default": "dns#change", "type": "string" } } }, "ChangesListResponse": { "id": "ChangesListResponse", "description": "The response to a request to enumerate Changes to a ResourceRecordSets collection.", "type": "object", "properties": { "changes": { "description": "The requested changes.", "type": "array", "items": { "$ref": "Change" } }, "nextPageToken": { "description": "This field indicates that more results are available beyond the last page displayed. To fetch the results, make another list request and use this value as your page token. This lets you retrieve the complete contents of a very large collection one page at a time. However, if the contents of the collection change between the first and last paginated list request, the set of all elements returned are an inconsistent view of the collection. You can't retrieve a consistent snapshot of a collection larger than the maximum page size.", "type": "string" }, "kind": { "description": "Type of resource.", "default": "dns#changesListResponse", "type": "string" } } }, "DnsKey": { "id": "DnsKey", "description": "A DNSSEC key pair.", "type": "object", "properties": { "id": { "description": "Unique identifier for the resource; defined by the server (output only).", "type": "string" }, "algorithm": { "description": "String mnemonic specifying the DNSSEC algorithm of this key. Immutable after creation time.", "type": "string", "enumDescriptions": [ "", "", "", "", "" ], "enum": [ "RSASHA1", "RSASHA256", "RSASHA512", "ECDSAP256SHA256", "ECDSAP384SHA384" ] }, "keyLength": { "description": "Length of the key in bits. Specified at creation time, and then immutable.", "type": "integer", "format": "uint32" }, "publicKey": { "description": "Base64 encoded public half of this key. Output only.", "type": "string" }, "creationTime": { "description": "The time that this resource was created in the control plane. This is in RFC3339 text format. Output only.", "type": "string" }, "isActive": { "description": "Active keys are used to sign subsequent changes to the ManagedZone. Inactive keys are still present as DNSKEY Resource Records for the use of resolvers validating existing signatures.", "type": "boolean" }, "type": { "description": "One of \"KEY_SIGNING\" or \"ZONE_SIGNING\". Keys of type KEY_SIGNING have the Secure Entry Point flag set and, when active, are used to sign only resource record sets of type DNSKEY. Otherwise, the Secure Entry Point flag is cleared, and this key is used to sign only resource record sets of other types. Immutable after creation time.", "type": "string", "enumDescriptions": [ "", "" ], "enum": [ "KEY_SIGNING", "ZONE_SIGNING" ] }, "keyTag": { "description": "The key tag is a non-cryptographic hash of the a DNSKEY resource record associated with this DnsKey. The key tag can be used to identify a DNSKEY more quickly (but it is not a unique identifier). In particular, the key tag is used in a parent zone's DS record to point at the DNSKEY in this child ManagedZone. The key tag is a number in the range [0, 65535] and the algorithm to calculate it is specified in RFC4034 Appendix B. Output only.", "type": "integer", "format": "int32" }, "digests": { "description": "Cryptographic hashes of the DNSKEY resource record associated with this DnsKey. These digests are needed to construct a DS record that points at this DNS key. Output only.", "type": "array", "items": { "$ref": "DnsKeyDigest" } }, "description": { "description": "A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the resource's function.", "type": "string" }, "kind": { "default": "dns#dnsKey", "type": "string" } } }, "DnsKeyDigest": { "id": "DnsKeyDigest", "type": "object", "properties": { "type": { "description": "Specifies the algorithm used to calculate this digest.", "type": "string", "enumDescriptions": [ "", "", "" ], "enum": [ "SHA1", "SHA256", "SHA384" ] }, "digest": { "description": "The base-16 encoded bytes of this digest. Suitable for use in a DS resource record.", "type": "string" } } }, "DnsKeysListResponse": { "id": "DnsKeysListResponse", "description": "The response to a request to enumerate DnsKeys in a ManagedZone.", "type": "object", "properties": { "dnsKeys": { "description": "The requested resources.", "type": "array", "items": { "$ref": "DnsKey" } }, "nextPageToken": { "description": "This field indicates that more results are available beyond the last page displayed. To fetch the results, make another list request and use this value as your page token. This lets you retrieve the complete contents of a very large collection one page at a time. However, if the contents of the collection change between the first and last paginated list request, the set of all elements returned are an inconsistent view of the collection. You can't retrieve a consistent snapshot of a collection larger than the maximum page size.", "type": "string" }, "kind": { "description": "Type of resource.", "default": "dns#dnsKeysListResponse", "type": "string" } } }, "Project": { "id": "Project", "description": "A project resource. The project is a top level container for resources including Cloud DNS ManagedZones. Projects can be created only in the APIs console.", "type": "object", "properties": { "number": { "description": "Unique numeric identifier for the resource; defined by the server (output only).", "type": "string", "format": "uint64" }, "id": { "description": "User assigned unique identifier for the resource (output only).", "type": "string" }, "quota": { "description": "Quotas assigned to this project (output only).", "$ref": "Quota" }, "kind": { "default": "dns#project", "type": "string" } } }, "Quota": { "id": "Quota", "description": "Limits associated with a Project.", "type": "object", "properties": { "managedZones": { "description": "Maximum allowed number of managed zones in the project.", "type": "integer", "format": "int32" }, "rrsetsPerManagedZone": { "description": "Maximum allowed number of ResourceRecordSets per zone in the project.", "type": "integer", "format": "int32" }, "rrsetAdditionsPerChange": { "description": "Maximum allowed number of ResourceRecordSets to add per ChangesCreateRequest.", "type": "integer", "format": "int32" }, "rrsetDeletionsPerChange": { "description": "Maximum allowed number of ResourceRecordSets to delete per ChangesCreateRequest.", "type": "integer", "format": "int32" }, "totalRrdataSizePerChange": { "description": "Maximum allowed size for total rrdata in one ChangesCreateRequest in bytes.", "type": "integer", "format": "int32" }, "resourceRecordsPerRrset": { "description": "Maximum allowed number of ResourceRecords per ResourceRecordSet.", "type": "integer", "format": "int32" }, "dnsKeysPerManagedZone": { "description": "Maximum allowed number of DnsKeys per ManagedZone.", "type": "integer", "format": "int32" }, "whitelistedKeySpecs": { "description": "DNSSEC algorithm and key length types that can be used for DnsKeys.", "type": "array", "items": { "$ref": "DnsKeySpec" } }, "networksPerManagedZone": { "description": "Maximum allowed number of networks to which a privately scoped zone can be attached.", "type": "integer", "format": "int32" }, "managedZonesPerNetwork": { "description": "Maximum allowed number of managed zones which can be attached to a network.", "type": "integer", "format": "int32" }, "policies": { "description": "Maximum allowed number of policies per project.", "type": "integer", "format": "int32" }, "networksPerPolicy": { "description": "Maximum allowed number of networks per policy.", "type": "integer", "format": "int32" }, "targetNameServersPerPolicy": { "description": "Maximum allowed number of alternative target name servers per policy.", "type": "integer", "format": "int32" }, "targetNameServersPerManagedZone": { "description": "Maximum allowed number of target name servers per managed forwarding zone.", "type": "integer", "format": "int32" }, "peeringZonesPerTargetNetwork": { "description": "Maximum allowed number of consumer peering zones per target network owned by this producer project", "type": "integer", "format": "int32" }, "responsePolicies": { "description": "Maximum allowed number of response policies per project.", "type": "integer", "format": "int32" }, "networksPerResponsePolicy": { "description": "Maximum allowed number of networks per response policy.", "type": "integer", "format": "int32" }, "nameserversPerDelegation": { "description": "Maximum number of nameservers per delegation, meant to prevent abuse", "type": "integer", "format": "int32" }, "gkeClustersPerManagedZone": { "description": "Maximum allowed number of GKE clusters to which a privately scoped zone can be attached.", "type": "integer", "format": "int32" }, "managedZonesPerGkeCluster": { "description": "Maximum allowed number of managed zones which can be attached to a GKE cluster.", "type": "integer", "format": "int32" }, "gkeClustersPerPolicy": { "description": "Maximum allowed number of GKE clusters per policy.", "type": "integer", "format": "int32" }, "responsePolicyRulesPerResponsePolicy": { "description": "Maximum allowed number of rules per response policy.", "type": "integer", "format": "int32" }, "gkeClustersPerResponsePolicy": { "description": "Maximum allowed number of GKE clusters per response policy.", "type": "integer", "format": "int32" }, "itemsPerRoutingPolicy": { "description": "Maximum allowed number of items per routing policy.", "type": "integer", "format": "int32" }, "internetHealthChecksPerManagedZone": { "type": "integer", "format": "int32" }, "kind": { "default": "dns#quota", "type": "string" } } }, "DnsKeySpec": { "id": "DnsKeySpec", "description": "Parameters for DnsKey key generation. Used for generating initial keys for a new ManagedZone and as default when adding a new DnsKey.", "type": "object", "properties": { "keyType": { "description": "Specifies whether this is a key signing key (KSK) or a zone signing key (ZSK). Key signing keys have the Secure Entry Point flag set and, when active, are only used to sign resource record sets of type DNSKEY. Zone signing keys do not have the Secure Entry Point flag set and are used to sign all other types of resource record sets.", "type": "string", "enumDescriptions": [ "", "" ], "enum": [ "KEY_SIGNING", "ZONE_SIGNING" ] }, "algorithm": { "description": "String mnemonic specifying the DNSSEC algorithm of this key.", "type": "string", "enumDescriptions": [ "", "", "", "", "" ], "enum": [ "RSASHA1", "RSASHA256", "RSASHA512", "ECDSAP256SHA256", "ECDSAP384SHA384" ] }, "keyLength": { "description": "Length of the keys in bits.", "type": "integer", "format": "uint32" }, "kind": { "default": "dns#dnsKeySpec", "type": "string" } } }, "Operation": { "id": "Operation", "description": "An operation represents a successful mutation performed on a Cloud DNS resource. Operations provide: - An audit log of server resource mutations. - A way to recover/retry API calls in the case where the response is never received by the caller. Use the caller specified client_operation_id.", "type": "object", "properties": { "id": { "description": "Unique identifier for the resource. This is the client_operation_id if the client specified it when the mutation was initiated, otherwise, it is generated by the server. The name must be 1-63 characters long and match the regular expression [-a-z0-9]? (output only)", "type": "string" }, "startTime": { "description": "The time that this operation was started by the server. This is in RFC3339 text format (output only).", "type": "string" }, "status": { "description": "Status of the operation. Can be one of the following: \"PENDING\" or \"DONE\" (output only). A status of \"DONE\" means that the request to update the authoritative servers has been sent, but the servers might not be updated yet.", "type": "string", "enumDescriptions": [ "", "" ], "enum": [ "PENDING", "DONE" ] }, "user": { "description": "User who requested the operation, for example: user@example.com. cloud-dns-system for operations automatically done by the system. (output only)", "type": "string" }, "type": { "description": "Type of the operation. Operations include insert, update, and delete (output only).", "type": "string" }, "zoneContext": { "description": "Only populated if the operation targeted a ManagedZone (output only).", "$ref": "OperationManagedZoneContext" }, "dnsKeyContext": { "description": "Only populated if the operation targeted a DnsKey (output only).", "$ref": "OperationDnsKeyContext" }, "kind": { "default": "dns#operation", "type": "string" } } }, "OperationManagedZoneContext": { "id": "OperationManagedZoneContext", "type": "object", "properties": { "oldValue": { "description": "The pre-operation ManagedZone resource.", "$ref": "ManagedZone" }, "newValue": { "description": "The post-operation ManagedZone resource.", "$ref": "ManagedZone" } } }, "ManagedZone": { "id": "ManagedZone", "description": "A zone is a subtree of the DNS namespace under one administrative responsibility. A ManagedZone is a resource that represents a DNS zone hosted by the Cloud DNS service.", "type": "object", "properties": { "name": { "description": "User assigned name for this resource. Must be unique within the project. The name must be 1-63 characters long, must begin with a letter, end with a letter or digit, and only contain lowercase letters, digits or dashes.", "type": "string" }, "dnsName": { "description": "The DNS name of this managed zone, for instance \"example.com.\".", "type": "string" }, "description": { "description": "A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the managed zone's function.", "type": "string" }, "id": { "description": "Unique identifier for the resource; defined by the server (output only)", "type": "string", "format": "uint64" }, "nameServers": { "description": "Delegate your managed_zone to these virtual name servers; defined by the server (output only)", "type": "array", "items": { "type": "string" } }, "creationTime": { "description": "The time that this resource was created on the server. This is in RFC3339 text format. Output only.", "type": "string" }, "dnssecConfig": { "description": "DNSSEC configuration.", "$ref": "ManagedZoneDnsSecConfig" }, "nameServerSet": { "description": "Optionally specifies the NameServerSet for this ManagedZone. A NameServerSet is a set of DNS name servers that all host the same ManagedZones. Most users leave this field unset. If you need to use this field, contact your account team.", "type": "string" }, "visibility": { "description": "The zone's visibility: public zones are exposed to the Internet, while private zones are visible only to Virtual Private Cloud resources.", "type": "string", "enumDescriptions": [ "Indicates that records in this zone can be queried from the public internet.", "Indicates that records in this zone cannot be queried from the public internet. Access to private zones depends on the zone configuration." ], "enum": [ "PUBLIC", "PRIVATE" ] }, "privateVisibilityConfig": { "description": "For privately visible zones, the set of Virtual Private Cloud resources that the zone is visible from.", "$ref": "ManagedZonePrivateVisibilityConfig" }, "forwardingConfig": { "description": "The presence for this field indicates that outbound forwarding is enabled for this zone. The value of this field contains the set of destinations to forward to.", "$ref": "ManagedZoneForwardingConfig" }, "labels": { "description": "User labels.", "type": "object", "additionalProperties": { "type": "string" } }, "peeringConfig": { "description": "The presence of this field indicates that DNS Peering is enabled for this zone. The value of this field contains the network to peer with.", "$ref": "ManagedZonePeeringConfig" }, "reverseLookupConfig": { "description": "The presence of this field indicates that this is a managed reverse lookup zone and Cloud DNS resolves reverse lookup queries using automatically configured records for VPC resources. This only applies to networks listed under private_visibility_config.", "$ref": "ManagedZoneReverseLookupConfig" }, "serviceDirectoryConfig": { "description": "This field links to the associated service directory namespace. Do not set this field for public zones or forwarding zones.", "$ref": "ManagedZoneServiceDirectoryConfig" }, "cloudLoggingConfig": { "$ref": "ManagedZoneCloudLoggingConfig" }, "kind": { "default": "dns#managedZone", "type": "string" } } }, "ManagedZoneDnsSecConfig": { "id": "ManagedZoneDnsSecConfig", "type": "object", "properties": { "state": { "description": "Specifies whether DNSSEC is enabled, and what mode it is in.", "type": "string", "enumDescriptions": [ "DNSSEC is disabled; the zone is not signed.", "DNSSEC is enabled; the zone is signed and fully managed.", "DNSSEC is enabled, but in a \"transfer\" mode." ], "enum": [ "OFF", "ON", "TRANSFER" ] }, "defaultKeySpecs": { "description": "Specifies parameters for generating initial DnsKeys for this ManagedZone. Can only be changed while the state is OFF.", "type": "array", "items": { "$ref": "DnsKeySpec" } }, "nonExistence": { "description": "Specifies the mechanism for authenticated denial-of-existence responses. Can only be changed while the state is OFF.", "type": "string", "enumDescriptions": [ "Indicates that Cloud DNS will sign records in the managed zone according to RFC 4034 and respond with NSEC records for names that do not exist.", "Indicates that Cloud DNS will sign records in the managed zone according to RFC 5155 and respond with NSEC3 records for names that do not exist." ], "enum": [ "NSEC", "NSEC3" ] }, "kind": { "default": "dns#managedZoneDnsSecConfig", "type": "string" } } }, "ManagedZonePrivateVisibilityConfig": { "id": "ManagedZonePrivateVisibilityConfig", "type": "object", "properties": { "networks": { "description": "The list of VPC networks that can see this zone.", "type": "array", "items": { "$ref": "ManagedZonePrivateVisibilityConfigNetwork" } }, "gkeClusters": { "description": "The list of Google Kubernetes Engine clusters that can see this zone.", "type": "array", "items": { "$ref": "ManagedZonePrivateVisibilityConfigGKECluster" } }, "kind": { "default": "dns#managedZonePrivateVisibilityConfig", "type": "string" } } }, "ManagedZonePrivateVisibilityConfigNetwork": { "id": "ManagedZonePrivateVisibilityConfigNetwork", "type": "object", "properties": { "networkUrl": { "description": "The fully qualified URL of the VPC network to bind to. Format this URL like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`", "type": "string" }, "kind": { "default": "dns#managedZonePrivateVisibilityConfigNetwork", "type": "string" } } }, "ManagedZonePrivateVisibilityConfigGKECluster": { "id": "ManagedZonePrivateVisibilityConfigGKECluster", "type": "object", "properties": { "gkeClusterName": { "description": "The resource name of the cluster to bind this ManagedZone to. This should be specified in the format like: projects/*/locations/*/clusters/*. This is referenced from GKE projects.locations.clusters.get API: https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters/get", "type": "string" }, "kind": { "default": "dns#managedZonePrivateVisibilityConfigGKECluster", "type": "string" } } }, "ManagedZoneForwardingConfig": { "id": "ManagedZoneForwardingConfig", "type": "object", "properties": { "targetNameServers": { "description": "List of target name servers to forward to. Cloud DNS selects the best available name server if more than one target is given.", "type": "array", "items": { "$ref": "ManagedZoneForwardingConfigNameServerTarget" } }, "kind": { "default": "dns#managedZoneForwardingConfig", "type": "string" } } }, "ManagedZoneForwardingConfigNameServerTarget": { "id": "ManagedZoneForwardingConfigNameServerTarget", "type": "object", "properties": { "ipv4Address": { "description": "IPv4 address of a target name server.", "type": "string" }, "forwardingPath": { "description": "Forwarding path for this NameServerTarget. If unset or set to DEFAULT, Cloud DNS makes forwarding decisions based on IP address ranges; that is, RFC1918 addresses go to the VPC network, non-RFC1918 addresses go to the internet. When set to PRIVATE, Cloud DNS always sends queries through the VPC network for this target.", "type": "string", "enumDescriptions": [ "Cloud DNS makes forwarding decisions based on address ranges; that is, RFC1918 addresses forward to the target through the VPC and non-RFC1918 addresses forward to the target through the internet", "Cloud DNS always forwards to this target through the VPC." ], "enum": [ "DEFAULT", "PRIVATE" ] }, "ipv6Address": { "description": "IPv6 address of a target name server. Does not accept both fields (ipv4 & ipv6) being populated. Public preview as of November 2022.", "type": "string" }, "domainName": { "description": "Fully qualified domain name for the forwarding target.", "type": "string" }, "kind": { "default": "dns#managedZoneForwardingConfigNameServerTarget", "type": "string" } } }, "ManagedZonePeeringConfig": { "id": "ManagedZonePeeringConfig", "type": "object", "properties": { "targetNetwork": { "description": "The network with which to peer.", "$ref": "ManagedZonePeeringConfigTargetNetwork" }, "kind": { "default": "dns#managedZonePeeringConfig", "type": "string" } } }, "ManagedZonePeeringConfigTargetNetwork": { "id": "ManagedZonePeeringConfigTargetNetwork", "type": "object", "properties": { "networkUrl": { "description": "The fully qualified URL of the VPC network to forward queries to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`", "type": "string" }, "deactivateTime": { "description": "The time at which the zone was deactivated, in RFC 3339 date-time format. An empty string indicates that the peering connection is active. The producer network can deactivate a zone. The zone is automatically deactivated if the producer network that the zone targeted is deleted. Output only.", "type": "string" }, "kind": { "default": "dns#managedZonePeeringConfigTargetNetwork", "type": "string" } } }, "ManagedZoneReverseLookupConfig": { "id": "ManagedZoneReverseLookupConfig", "type": "object", "properties": { "kind": { "default": "dns#managedZoneReverseLookupConfig", "type": "string" } } }, "ManagedZoneServiceDirectoryConfig": { "id": "ManagedZoneServiceDirectoryConfig", "description": "Contains information about Service Directory-backed zones.", "type": "object", "properties": { "namespace": { "description": "Contains information about the namespace associated with the zone.", "$ref": "ManagedZoneServiceDirectoryConfigNamespace" }, "kind": { "default": "dns#managedZoneServiceDirectoryConfig", "type": "string" } } }, "ManagedZoneServiceDirectoryConfigNamespace": { "id": "ManagedZoneServiceDirectoryConfigNamespace", "type": "object", "properties": { "namespaceUrl": { "description": "The fully qualified URL of the namespace associated with the zone. Format must be `https://servicedirectory.googleapis.com/v1/projects/{project}/locations/{location}/namespaces/{namespace}`", "type": "string" }, "deletionTime": { "description": "The time that the namespace backing this zone was deleted; an empty string if it still exists. This is in RFC3339 text format. Output only.", "type": "string" }, "kind": { "default": "dns#managedZoneServiceDirectoryConfigNamespace", "type": "string" } } }, "ManagedZoneCloudLoggingConfig": { "id": "ManagedZoneCloudLoggingConfig", "description": "Cloud Logging configurations for publicly visible zones.", "type": "object", "properties": { "enableLogging": { "description": "If set, enable query logging for this ManagedZone. False by default, making logging opt-in.", "type": "boolean" }, "kind": { "default": "dns#managedZoneCloudLoggingConfig", "type": "string" } } }, "OperationDnsKeyContext": { "id": "OperationDnsKeyContext", "type": "object", "properties": { "oldValue": { "description": "The pre-operation DnsKey resource.", "$ref": "DnsKey" }, "newValue": { "description": "The post-operation DnsKey resource.", "$ref": "DnsKey" } } }, "ManagedZoneOperationsListResponse": { "id": "ManagedZoneOperationsListResponse", "type": "object", "properties": { "operations": { "description": "The operation resources.", "type": "array", "items": { "$ref": "Operation" } }, "nextPageToken": { "description": "This field indicates that more results are available beyond the last page displayed. To fetch the results, make another list request and use this value as your page token. This lets you retrieve the complete contents of a very large collection one page at a time. However, if the contents of the collection change between the first and last paginated list request, the set of all elements returned are an inconsistent view of the collection. You can't retrieve a consistent snapshot of a collection larger than the maximum page size.", "type": "string" }, "kind": { "description": "Type of resource.", "default": "dns#managedZoneOperationsListResponse", "type": "string" } } }, "ManagedZonesListResponse": { "id": "ManagedZonesListResponse", "type": "object", "properties": { "managedZones": { "description": "The managed zone resources.", "type": "array", "items": { "$ref": "ManagedZone" } }, "nextPageToken": { "description": "This field indicates that more results are available beyond the last page displayed. To fetch the results, make another list request and use this value as your page token. This lets you retrieve the complete contents of a very large collection one page at a time. However, if the contents of the collection change between the first and last paginated list request, the set of all elements returned are an inconsistent view of the collection. You can't retrieve a consistent snapshot of a collection larger than the maximum page size.", "type": "string" }, "kind": { "description": "Type of resource.", "default": "dns#managedZonesListResponse", "type": "string" } } }, "Policy": { "id": "Policy", "description": "A policy is a collection of DNS rules applied to one or more Virtual Private Cloud resources.", "type": "object", "properties": { "id": { "description": "Unique identifier for the resource; defined by the server (output only).", "type": "string", "format": "uint64" }, "name": { "description": "User-assigned name for this policy.", "type": "string" }, "enableInboundForwarding": { "description": "Allows networks bound to this policy to receive DNS queries sent by VMs or applications over VPN connections. When enabled, a virtual IP address is allocated from each of the subnetworks that are bound to this policy.", "type": "boolean" }, "description": { "description": "A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the policy's function.", "type": "string" }, "networks": { "description": "List of network names specifying networks to which this policy is applied.", "type": "array", "items": { "$ref": "PolicyNetwork" } }, "alternativeNameServerConfig": { "description": "Sets an alternative name server for the associated networks. When specified, all DNS queries are forwarded to a name server that you choose. Names such as .internal are not available when an alternative name server is specified.", "$ref": "PolicyAlternativeNameServerConfig" }, "enableLogging": { "description": "Controls whether logging is enabled for the networks bound to this policy. Defaults to no logging if not set.", "type": "boolean" }, "dns64Config": { "description": "Configurations related to DNS64 for this policy.", "$ref": "PolicyDns64Config" }, "kind": { "default": "dns#policy", "type": "string" } } }, "PolicyNetwork": { "id": "PolicyNetwork", "type": "object", "properties": { "networkUrl": { "description": "The fully qualified URL of the VPC network to bind to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}", "type": "string" }, "kind": { "default": "dns#policyNetwork", "type": "string" } } }, "PolicyAlternativeNameServerConfig": { "id": "PolicyAlternativeNameServerConfig", "type": "object", "properties": { "targetNameServers": { "description": "Sets an alternative name server for the associated networks. When specified, all DNS queries are forwarded to a name server that you choose. Names such as .internal are not available when an alternative name server is specified.", "type": "array", "items": { "$ref": "PolicyAlternativeNameServerConfigTargetNameServer" } }, "kind": { "default": "dns#policyAlternativeNameServerConfig", "type": "string" } } }, "PolicyAlternativeNameServerConfigTargetNameServer": { "id": "PolicyAlternativeNameServerConfigTargetNameServer", "type": "object", "properties": { "ipv4Address": { "description": "IPv4 address to forward queries to.", "type": "string" }, "forwardingPath": { "description": "Forwarding path for this TargetNameServer. If unset or set to DEFAULT, Cloud DNS makes forwarding decisions based on address ranges; that is, RFC1918 addresses go to the VPC network, non-RFC1918 addresses go to the internet. When set to PRIVATE, Cloud DNS always sends queries through the VPC network for this target.", "type": "string", "enumDescriptions": [ "Cloud DNS makes forwarding decision based on IP address ranges; that is, RFC1918 addresses forward to the target through the VPC and non-RFC1918 addresses forward to the target through the internet", "Cloud DNS always forwards to this target through the VPC." ], "enum": [ "DEFAULT", "PRIVATE" ] }, "ipv6Address": { "description": "IPv6 address to forward to. Does not accept both fields (ipv4 & ipv6) being populated. Public preview as of November 2022.", "type": "string" }, "kind": { "default": "dns#policyAlternativeNameServerConfigTargetNameServer", "type": "string" } } }, "PolicyDns64Config": { "id": "PolicyDns64Config", "description": "DNS64 policies", "type": "object", "properties": { "scope": { "description": "The scope to which DNS64 config will be applied to.", "$ref": "PolicyDns64ConfigScope" }, "kind": { "default": "dns#policyDns64Config", "type": "string" } } }, "PolicyDns64ConfigScope": { "id": "PolicyDns64ConfigScope", "type": "object", "properties": { "allQueries": { "description": "Controls whether DNS64 is enabled globally for all networks bound to the policy.", "type": "boolean" }, "kind": { "default": "dns#policyDns64ConfigScope", "type": "string" } } }, "PoliciesListResponse": { "id": "PoliciesListResponse", "type": "object", "properties": { "policies": { "description": "The policy resources.", "type": "array", "items": { "$ref": "Policy" } }, "nextPageToken": { "description": "This field indicates that more results are available beyond the last page displayed. To fetch the results, make another list request and use this value as your page token. This lets you retrieve the complete contents of a very large collection one page at a time. However, if the contents of the collection change between the first and last paginated list request, the set of all elements returned are an inconsistent view of the collection. You can't retrieve a consistent snapshot of a collection larger than the maximum page size.", "type": "string" }, "kind": { "description": "Type of resource.", "default": "dns#policiesListResponse", "type": "string" } } }, "PoliciesPatchResponse": { "id": "PoliciesPatchResponse", "type": "object", "properties": { "policy": { "$ref": "Policy" } } }, "PoliciesUpdateResponse": { "id": "PoliciesUpdateResponse", "type": "object", "properties": { "policy": { "$ref": "Policy" } } }, "GoogleLongrunningOperation": { "id": "GoogleLongrunningOperation", "description": "This resource represents a long-running operation that is the result of a network API call.", "type": "object", "properties": { "name": { "description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.", "type": "string" }, "metadata": { "description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." } }, "done": { "description": "If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.", "type": "boolean" }, "error": { "description": "The error result of the operation in case of failure or cancellation.", "$ref": "Status" }, "response": { "description": "The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." } } } }, "Status": { "id": "Status", "description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).", "type": "object", "properties": { "code": { "description": "The status code, which should be an enum value of google.rpc.Code.", "type": "integer", "format": "int32" }, "message": { "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.", "type": "string" }, "details": { "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", "type": "array", "items": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." } } } } } }, "resources": { "resourceRecordSets": { "methods": { "list": { "id": "dns.resourceRecordSets.list", "path": "dns/v2beta1/projects/{project}/managedZones/{managedZone}/rrsets", "flatPath": "dns/v2beta1/projects/{project}/managedZones/{managedZone}/rrsets", "httpMethod": "GET", "parameters": { "project": { "description": "Identifies the project addressed by this request.", "location": "path", "required": true, "type": "string" }, "managedZone": { "description": "Identifies the managed zone addressed by this request. Can be the managed zone name or ID.", "location": "path", "required": true, "type": "string" }, "maxResults": { "description": "Optional. Maximum number of results to be returned. If unspecified, the server decides how many results to return.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "Optional. A tag returned by a previous list request that was truncated. Use this parameter to continue a previous list request.", "location": "query", "type": "string" }, "name": { "description": "Specify a fully qualified domain name to view only those records. The `name` parameter is not supported and must be omitted when you use `filter`.", "location": "query", "type": "string" }, "type": { "description": "Specify a record type to view only those records. You must also specify the `name` parameter. The `type` parameter is not supported and must be omitted when you use `filter`.", "location": "query", "type": "string" }, "filter": { "description": "Specify a filter expression to view records that exactly match the specified domain. Both the `name` and `type` parameters are not supported and must be omitted when you use `filter`. Your `filter` expression must conform to AIP-160 and you must specify a domain in the `name` field. Optionally, you can include the `type` field to filter records by type. You can also include the `has_suffix` function to view records that match by domain suffix. Examples: * `name`=\"example.com.\" * `name`=\"example.com.\" AND type=\"A\" * `name`=`has_suffix`(\"example.com.\") * `name`=`has_suffix`(\"example.com.\") AND type=\"A\"", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "managedZone" ], "response": { "$ref": "ResourceRecordSetsListResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only", "https://www.googleapis.com/auth/ndev.clouddns.readonly", "https://www.googleapis.com/auth/ndev.clouddns.readwrite" ], "description": "Enumerates ResourceRecordSets that you have created but not yet deleted." } } }, "changes": { "methods": { "create": { "id": "dns.changes.create", "path": "dns/v2beta1/projects/{project}/managedZones/{managedZone}/changes", "flatPath": "dns/v2beta1/projects/{project}/managedZones/{managedZone}/changes", "httpMethod": "POST", "parameters": { "project": { "description": "Identifies the project addressed by this request.", "location": "path", "required": true, "type": "string" }, "managedZone": { "description": "Identifies the managed zone addressed by this request. Can be the managed zone name or ID.", "location": "path", "required": true, "type": "string" }, "clientOperationId": { "description": "For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "managedZone" ], "request": { "$ref": "Change" }, "response": { "$ref": "Change" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/ndev.clouddns.readwrite" ], "description": "Atomically updates the ResourceRecordSet collection." }, "get": { "id": "dns.changes.get", "path": "dns/v2beta1/projects/{project}/managedZones/{managedZone}/changes/{changeId}", "flatPath": "dns/v2beta1/projects/{project}/managedZones/{managedZone}/changes/{changeId}", "httpMethod": "GET", "parameters": { "project": { "description": "Identifies the project addressed by this request.", "location": "path", "required": true, "type": "string" }, "managedZone": { "description": "Identifies the managed zone addressed by this request. Can be the managed zone name or ID.", "location": "path", "required": true, "type": "string" }, "changeId": { "description": "The identifier of the requested change, from a previous ResourceRecordSetsChangeResponse.", "location": "path", "required": true, "type": "string" }, "clientOperationId": { "description": "For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "managedZone", "changeId" ], "response": { "$ref": "Change" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only", "https://www.googleapis.com/auth/ndev.clouddns.readonly", "https://www.googleapis.com/auth/ndev.clouddns.readwrite" ], "description": "Fetches the representation of an existing Change." }, "list": { "id": "dns.changes.list", "path": "dns/v2beta1/projects/{project}/managedZones/{managedZone}/changes", "flatPath": "dns/v2beta1/projects/{project}/managedZones/{managedZone}/changes", "httpMethod": "GET", "parameters": { "project": { "description": "Identifies the project addressed by this request.", "location": "path", "required": true, "type": "string" }, "managedZone": { "description": "Identifies the managed zone addressed by this request. Can be the managed zone name or ID.", "location": "path", "required": true, "type": "string" }, "maxResults": { "description": "Optional. Maximum number of results to be returned. If unspecified, the server decides how many results to return.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "Optional. A tag returned by a previous list request that was truncated. Use this parameter to continue a previous list request.", "location": "query", "type": "string" }, "sortBy": { "description": "Sorting criterion. The only supported value is change sequence.", "default": "CHANGE_SEQUENCE", "location": "query", "type": "string", "enumDescriptions": [ "" ], "enum": [ "CHANGE_SEQUENCE" ] }, "sortOrder": { "description": "Sorting order direction: 'ascending' or 'descending'.", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "managedZone" ], "response": { "$ref": "ChangesListResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only", "https://www.googleapis.com/auth/ndev.clouddns.readonly", "https://www.googleapis.com/auth/ndev.clouddns.readwrite" ], "description": "Enumerates Changes to a ResourceRecordSet collection." } } }, "dnsKeys": { "methods": { "get": { "id": "dns.dnsKeys.get", "path": "dns/v2beta1/projects/{project}/managedZones/{managedZone}/dnsKeys/{dnsKeyId}", "flatPath": "dns/v2beta1/projects/{project}/managedZones/{managedZone}/dnsKeys/{dnsKeyId}", "httpMethod": "GET", "parameters": { "project": { "description": "Identifies the project addressed by this request.", "location": "path", "required": true, "type": "string" }, "managedZone": { "description": "Identifies the managed zone addressed by this request. Can be the managed zone name or ID.", "location": "path", "required": true, "type": "string" }, "dnsKeyId": { "description": "The identifier of the requested DnsKey.", "location": "path", "required": true, "type": "string" }, "clientOperationId": { "description": "For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.", "location": "query", "type": "string" }, "digestType": { "description": "An optional comma-separated list of digest types to compute and display for key signing keys. If omitted, the recommended digest type is computed and displayed.", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "managedZone", "dnsKeyId" ], "response": { "$ref": "DnsKey" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only", "https://www.googleapis.com/auth/ndev.clouddns.readonly", "https://www.googleapis.com/auth/ndev.clouddns.readwrite" ], "description": "Fetches the representation of an existing DnsKey." }, "list": { "id": "dns.dnsKeys.list", "path": "dns/v2beta1/projects/{project}/managedZones/{managedZone}/dnsKeys", "flatPath": "dns/v2beta1/projects/{project}/managedZones/{managedZone}/dnsKeys", "httpMethod": "GET", "parameters": { "project": { "description": "Identifies the project addressed by this request.", "location": "path", "required": true, "type": "string" }, "managedZone": { "description": "Identifies the managed zone addressed by this request. Can be the managed zone name or ID.", "location": "path", "required": true, "type": "string" }, "maxResults": { "description": "Optional. Maximum number of results to be returned. If unspecified, the server decides how many results to return.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "Optional. A tag returned by a previous list request that was truncated. Use this parameter to continue a previous list request.", "location": "query", "type": "string" }, "digestType": { "description": "An optional comma-separated list of digest types to compute and display for key signing keys. If omitted, the recommended digest type is computed and displayed.", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "managedZone" ], "response": { "$ref": "DnsKeysListResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only", "https://www.googleapis.com/auth/ndev.clouddns.readonly", "https://www.googleapis.com/auth/ndev.clouddns.readwrite" ], "description": "Enumerates DnsKeys to a ResourceRecordSet collection." } } }, "projects": { "methods": { "get": { "id": "dns.projects.get", "path": "dns/v2beta1/projects/{project}", "flatPath": "dns/v2beta1/projects/{project}", "httpMethod": "GET", "parameters": { "project": { "description": "Identifies the project addressed by this request.", "location": "path", "required": true, "type": "string" }, "clientOperationId": { "description": "For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.", "location": "query", "type": "string" } }, "parameterOrder": [ "project" ], "response": { "$ref": "Project" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only", "https://www.googleapis.com/auth/ndev.clouddns.readonly", "https://www.googleapis.com/auth/ndev.clouddns.readwrite" ], "description": "Fetches the representation of an existing Project." } } }, "managedZoneOperations": { "methods": { "get": { "id": "dns.managedZoneOperations.get", "path": "dns/v2beta1/projects/{project}/managedZones/{managedZone}/operations/{operation}", "flatPath": "dns/v2beta1/projects/{project}/managedZones/{managedZone}/operations/{operation}", "httpMethod": "GET", "parameters": { "project": { "description": "Identifies the project addressed by this request.", "location": "path", "required": true, "type": "string" }, "managedZone": { "description": "Identifies the managed zone addressed by this request.", "location": "path", "required": true, "type": "string" }, "operation": { "description": "Identifies the operation addressed by this request (ID of the operation).", "location": "path", "required": true, "type": "string" }, "clientOperationId": { "description": "For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "managedZone", "operation" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only", "https://www.googleapis.com/auth/ndev.clouddns.readonly", "https://www.googleapis.com/auth/ndev.clouddns.readwrite" ], "description": "Fetches the representation of an existing Operation." }, "list": { "id": "dns.managedZoneOperations.list", "path": "dns/v2beta1/projects/{project}/managedZones/{managedZone}/operations", "flatPath": "dns/v2beta1/projects/{project}/managedZones/{managedZone}/operations", "httpMethod": "GET", "parameters": { "project": { "description": "Identifies the project addressed by this request.", "location": "path", "required": true, "type": "string" }, "managedZone": { "description": "Identifies the managed zone addressed by this request.", "location": "path", "required": true, "type": "string" }, "maxResults": { "description": "Optional. Maximum number of results to be returned. If unspecified, the server decides how many results to return.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "Optional. A tag returned by a previous list request that was truncated. Use this parameter to continue a previous list request.", "location": "query", "type": "string" }, "sortBy": { "description": "Sorting criterion. The only supported values are START_TIME and ID.", "default": "START_TIME", "location": "query", "type": "string", "enumDescriptions": [ "", "" ], "enum": [ "START_TIME", "ID" ] } }, "parameterOrder": [ "project", "managedZone" ], "response": { "$ref": "ManagedZoneOperationsListResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only", "https://www.googleapis.com/auth/ndev.clouddns.readonly", "https://www.googleapis.com/auth/ndev.clouddns.readwrite" ], "description": "Enumerates Operations for the given ManagedZone." } } }, "managedZones": { "methods": { "create": { "id": "dns.managedZones.create", "path": "dns/v2beta1/projects/{project}/managedZones", "flatPath": "dns/v2beta1/projects/{project}/managedZones", "httpMethod": "POST", "parameters": { "project": { "description": "Identifies the project addressed by this request.", "location": "path", "required": true, "type": "string" }, "clientOperationId": { "description": "For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.", "location": "query", "type": "string" } }, "parameterOrder": [ "project" ], "request": { "$ref": "ManagedZone" }, "response": { "$ref": "ManagedZone" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/ndev.clouddns.readwrite" ], "description": "Creates a new ManagedZone." }, "get": { "id": "dns.managedZones.get", "path": "dns/v2beta1/projects/{project}/managedZones/{managedZone}", "flatPath": "dns/v2beta1/projects/{project}/managedZones/{managedZone}", "httpMethod": "GET", "parameters": { "project": { "description": "Identifies the project addressed by this request.", "location": "path", "required": true, "type": "string" }, "managedZone": { "description": "Identifies the managed zone addressed by this request. Can be the managed zone name or ID.", "location": "path", "required": true, "type": "string" }, "clientOperationId": { "description": "For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "managedZone" ], "response": { "$ref": "ManagedZone" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only", "https://www.googleapis.com/auth/ndev.clouddns.readonly", "https://www.googleapis.com/auth/ndev.clouddns.readwrite" ], "description": "Fetches the representation of an existing ManagedZone." }, "list": { "id": "dns.managedZones.list", "path": "dns/v2beta1/projects/{project}/managedZones", "flatPath": "dns/v2beta1/projects/{project}/managedZones", "httpMethod": "GET", "parameters": { "project": { "description": "Identifies the project addressed by this request.", "location": "path", "required": true, "type": "string" }, "maxResults": { "description": "Optional. Maximum number of results to be returned. If unspecified, the server decides how many results to return.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "Optional. A tag returned by a previous list request that was truncated. Use this parameter to continue a previous list request.", "location": "query", "type": "string" }, "dnsName": { "description": "Restricts the list to return only zones with this domain name.", "location": "query", "type": "string" } }, "parameterOrder": [ "project" ], "response": { "$ref": "ManagedZonesListResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only", "https://www.googleapis.com/auth/ndev.clouddns.readonly", "https://www.googleapis.com/auth/ndev.clouddns.readwrite" ], "description": "Enumerates ManagedZones that have been created but not yet deleted." }, "delete": { "id": "dns.managedZones.delete", "path": "dns/v2beta1/projects/{project}/managedZones/{managedZone}", "flatPath": "dns/v2beta1/projects/{project}/managedZones/{managedZone}", "httpMethod": "DELETE", "parameters": { "project": { "description": "Identifies the project addressed by this request.", "location": "path", "required": true, "type": "string" }, "managedZone": { "description": "Identifies the managed zone addressed by this request. Can be the managed zone name or ID.", "location": "path", "required": true, "type": "string" }, "clientOperationId": { "description": "For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "managedZone" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/ndev.clouddns.readwrite" ], "description": "Deletes a previously created ManagedZone." }, "patch": { "id": "dns.managedZones.patch", "path": "dns/v2beta1/projects/{project}/managedZones/{managedZone}", "flatPath": "dns/v2beta1/projects/{project}/managedZones/{managedZone}", "httpMethod": "PATCH", "parameters": { "project": { "description": "Identifies the project addressed by this request.", "location": "path", "required": true, "type": "string" }, "managedZone": { "description": "Identifies the managed zone addressed by this request. Can be the managed zone name or ID.", "location": "path", "required": true, "type": "string" }, "clientOperationId": { "description": "For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "managedZone" ], "request": { "$ref": "ManagedZone" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/ndev.clouddns.readwrite" ], "description": "Applies a partial update to an existing ManagedZone." }, "update": { "id": "dns.managedZones.update", "path": "dns/v2beta1/projects/{project}/managedZones/{managedZone}", "flatPath": "dns/v2beta1/projects/{project}/managedZones/{managedZone}", "httpMethod": "PUT", "parameters": { "project": { "description": "Identifies the project addressed by this request.", "location": "path", "required": true, "type": "string" }, "managedZone": { "description": "Identifies the managed zone addressed by this request. Can be the managed zone name or ID.", "location": "path", "required": true, "type": "string" }, "clientOperationId": { "description": "For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "managedZone" ], "request": { "$ref": "ManagedZone" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/ndev.clouddns.readwrite" ], "description": "Updates an existing ManagedZone." } } }, "policies": { "methods": { "create": { "id": "dns.policies.create", "path": "dns/v2beta1/projects/{project}/policies", "flatPath": "dns/v2beta1/projects/{project}/policies", "httpMethod": "POST", "parameters": { "project": { "description": "Identifies the project addressed by this request.", "location": "path", "required": true, "type": "string" }, "clientOperationId": { "description": "For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.", "location": "query", "type": "string" } }, "parameterOrder": [ "project" ], "request": { "$ref": "Policy" }, "response": { "$ref": "Policy" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/ndev.clouddns.readwrite" ], "description": "Creates a new policy." }, "get": { "id": "dns.policies.get", "path": "dns/v2beta1/projects/{project}/policies/{policy}", "flatPath": "dns/v2beta1/projects/{project}/policies/{policy}", "httpMethod": "GET", "parameters": { "project": { "description": "Identifies the project addressed by this request.", "location": "path", "required": true, "type": "string" }, "policy": { "description": "User given friendly name of the policy addressed by this request.", "location": "path", "required": true, "type": "string" }, "clientOperationId": { "description": "For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "policy" ], "response": { "$ref": "Policy" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only", "https://www.googleapis.com/auth/ndev.clouddns.readonly", "https://www.googleapis.com/auth/ndev.clouddns.readwrite" ], "description": "Fetches the representation of an existing policy." }, "list": { "id": "dns.policies.list", "path": "dns/v2beta1/projects/{project}/policies", "flatPath": "dns/v2beta1/projects/{project}/policies", "httpMethod": "GET", "parameters": { "project": { "description": "Identifies the project addressed by this request.", "location": "path", "required": true, "type": "string" }, "maxResults": { "description": "Optional. Maximum number of results to be returned. If unspecified, the server decides how many results to return.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "Optional. A tag returned by a previous list request that was truncated. Use this parameter to continue a previous list request.", "location": "query", "type": "string" } }, "parameterOrder": [ "project" ], "response": { "$ref": "PoliciesListResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only", "https://www.googleapis.com/auth/ndev.clouddns.readonly", "https://www.googleapis.com/auth/ndev.clouddns.readwrite" ], "description": "Enumerates all policies associated with a project." }, "delete": { "id": "dns.policies.delete", "path": "dns/v2beta1/projects/{project}/policies/{policy}", "flatPath": "dns/v2beta1/projects/{project}/policies/{policy}", "httpMethod": "DELETE", "parameters": { "project": { "description": "Identifies the project addressed by this request.", "location": "path", "required": true, "type": "string" }, "policy": { "description": "User given friendly name of the policy addressed by this request.", "location": "path", "required": true, "type": "string" }, "clientOperationId": { "description": "For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "policy" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/ndev.clouddns.readwrite" ], "description": "Deletes a previously created policy. Fails if the policy is still being referenced by a network." }, "patch": { "id": "dns.policies.patch", "path": "dns/v2beta1/projects/{project}/policies/{policy}", "flatPath": "dns/v2beta1/projects/{project}/policies/{policy}", "httpMethod": "PATCH", "parameters": { "project": { "description": "Identifies the project addressed by this request.", "location": "path", "required": true, "type": "string" }, "policy": { "description": "User given friendly name of the policy addressed by this request.", "location": "path", "required": true, "type": "string" }, "clientOperationId": { "description": "For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "policy" ], "request": { "$ref": "Policy" }, "response": { "$ref": "PoliciesPatchResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/ndev.clouddns.readwrite" ], "description": "Applies a partial update to an existing policy." }, "update": { "id": "dns.policies.update", "path": "dns/v2beta1/projects/{project}/policies/{policy}", "flatPath": "dns/v2beta1/projects/{project}/policies/{policy}", "httpMethod": "PUT", "parameters": { "project": { "description": "Identifies the project addressed by this request.", "location": "path", "required": true, "type": "string" }, "policy": { "description": "User given friendly name of the policy addressed by this request.", "location": "path", "required": true, "type": "string" }, "clientOperationId": { "description": "For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "policy" ], "request": { "$ref": "Policy" }, "response": { "$ref": "PoliciesUpdateResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/ndev.clouddns.readwrite" ], "description": "Updates an existing policy." } } } }, "mtlsRootUrl": "https://dns.mtls.googleapis.com/", "baseUrl": "https://dns.googleapis.com/", "protocol": "rest", "ownerDomain": "google.com", "discoveryVersion": "v1", "fullyEncodeReservedExpansion": true, "ownerName": "Google", "id": "dns:v2beta1", "batchPath": "batch", "revision": "20260512", "servicePath": "", "version": "v2beta1", "documentationLink": "https://cloud.google.com/dns/docs", "basePath": "", "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", "x32": "http://www.google.com/images/icons/product/search-32.gif" }, "canonicalName": "Dns", "kind": "discovery#restDescription", "name": "dns", "auth": { "oauth2": { "scopes": { "https://www.googleapis.com/auth/cloud-platform": { "description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account." }, "https://www.googleapis.com/auth/cloud-platform.read-only": { "description": "View your data across Google Cloud services and see the email address of your Google Account" }, "https://www.googleapis.com/auth/ndev.clouddns.readonly": { "description": "View your DNS records hosted by Google Cloud DNS" }, "https://www.googleapis.com/auth/ndev.clouddns.readwrite": { "description": "View and manage your DNS records hosted by Google Cloud DNS" } } } }, "title": "Cloud DNS API" }