2022-05-06
▼ ▲ dns.managedZones.patch
Parameter Order:
Path: dns/v2/projects/{project}/locations/{location}/managedZones/{managedZone}
Description: Applies a partial update to an existing ManagedZone.
HTTP Method: PATCH
Scopes:
Parameters:
location
Required: Yes
Description: Specifies the location of the resource. This information will be used for routing and will be part of the resource name.
Type: string
Location: path
Default: global
managedZone
Description: Identifies the managed zone addressed by this request. Can be the managed zone name or ID.
Type: string
Location: path
Required: Yes
project
Required: Yes
Description: Identifies the project addressed by this request.
Location: path
Type: string
clientOperationId
Location: query
Type: string
Description: For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
Flat Path: dns/v2/projects/{project}/locations/{location}/managedZones/{managedZone}
▼ ▲ dns.managedZones.get
Parameters:
project
Description: Identifies the project addressed by this request.
Required: Yes
Type: string
Location: path
clientOperationId
Location: query
Description: For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
Type: string
managedZone
Location: path
Required: Yes
Description: Identifies the managed zone addressed by this request. Can be the managed zone name or ID.
Type: string
location
Description: Specifies the location of the resource. This information will be used for routing and will be part of the resource name.
Location: path
Type: string
Required: Yes
Default: global
HTTP Method: GET
Flat Path: dns/v2/projects/{project}/locations/{location}/managedZones/{managedZone}
Parameter Order:
Path: dns/v2/projects/{project}/locations/{location}/managedZones/{managedZone}
Description: Fetches the representation of an existing ManagedZone.
Scopes:
▼ ▲ dns.managedZones.list
Flat Path: dns/v2/projects/{project}/locations/{location}/managedZones
Description: Enumerates ManagedZones that have been created but not yet deleted.
Path: dns/v2/projects/{project}/locations/{location}/managedZones
Scopes:
Parameters:
pageToken
Location: query
Description: Optional. A tag returned by a previous list request that was truncated. Use this parameter to continue a previous list request.
Type: string
project
Type: string
Location: path
Required: Yes
Description: Identifies the project addressed by this request.
dnsName
Type: string
Description: Restricts the list to return only zones with this domain name.
Location: query
maxResults
Location: query
Type: integer
Description: Optional. Maximum number of results to be returned. If unspecified, the server decides how many results to return.
Format: int32
location
Location: path
Required: Yes
Type: string
Description: Specifies the location of the resource. This information will be used for routing and will be part of the resource name.
Default: global
Parameter Order:
HTTP Method: GET
▼ ▲ dns.managedZones.create
HTTP Method: POST
Scopes:
Path: dns/v2/projects/{project}/locations/{location}/managedZones
Description: Creates a new ManagedZone.
Parameters:
clientOperationId
Type: string
Location: query
Description: For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
location
Required: Yes
Location: path
Default: global
Type: string
Description: Specifies the location of the resource. This information will be used for routing and will be part of the resource name.
project
Location: path
Type: string
Description: Identifies the project addressed by this request.
Required: Yes
Flat Path: dns/v2/projects/{project}/locations/{location}/managedZones
Parameter Order:
▼ ▲ dns.managedZones.update
Parameters:
location
Type: string
Required: Yes
Default: global
Location: path
Description: Specifies the location of the resource. This information will be used for routing and will be part of the resource name.
managedZone
Location: path
Description: Identifies the managed zone addressed by this request. Can be the managed zone name or ID.
Required: Yes
Type: string
clientOperationId
Type: string
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
project
Type: string
Location: path
Description: Identifies the project addressed by this request.
Required: Yes
HTTP Method: PUT
Path: dns/v2/projects/{project}/locations/{location}/managedZones/{managedZone}
Flat Path: dns/v2/projects/{project}/locations/{location}/managedZones/{managedZone}
Parameter Order:
Description: Updates an existing ManagedZone.
Scopes:
▼ ▲ dns.managedZones.delete
Flat Path: dns/v2/projects/{project}/locations/{location}/managedZones/{managedZone}
Parameters:
location
Location: path
Required: Yes
Default: global
Description: Specifies the location of the resource. This information will be used for routing and will be part of the resource name.
Type: string
project
Required: Yes
Type: string
Location: path
Description: Identifies the project addressed by this request.
clientOperationId
Type: string
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
managedZone
Required: Yes
Type: string
Description: Identifies the managed zone addressed by this request. Can be the managed zone name or ID.
Location: path
Path: dns/v2/projects/{project}/locations/{location}/managedZones/{managedZone}
Scopes:
Parameter Order:
Description: Deletes a previously created ManagedZone.
HTTP Method: DELETE
▼ ▲ dns.responsePolicyRules.list
HTTP Method: GET
Description: Enumerates all Response Policy Rules associated with a project.
Parameter Order:
Flat Path: dns/v2/projects/{project}/locations/{location}/responsePolicies/{responsePolicy}/rules
Parameters:
location
Description: Specifies the location of the resource. This information will be used for routing and will be part of the resource name.
Location: path
Default: global
Required: Yes
Type: string
responsePolicy
Description: User assigned name of the Response Policy to list.
Required: Yes
Location: path
Type: string
maxResults
Type: integer
Description: Optional. Maximum number of results to be returned. If unspecified, the server decides how many results to return.
Format: int32
Location: query
project
Description: Identifies the project addressed by this request.
Required: Yes
Location: path
Type: string
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
Scopes:
Path: dns/v2/projects/{project}/locations/{location}/responsePolicies/{responsePolicy}/rules
▼ ▲ dns.responsePolicyRules.create
Scopes:
Parameter Order:
Path: dns/v2/projects/{project}/locations/{location}/responsePolicies/{responsePolicy}/rules
Description: Creates a new Response Policy Rule.
Parameters:
location
Required: Yes
Default: global
Type: string
Location: path
Description: Specifies the location of the resource. This information will be used for routing and will be part of the resource name.
responsePolicy
Required: Yes
Type: string
Location: path
Description: User assigned name of the Response Policy containing the Response Policy Rule.
clientOperationId
Type: string
Location: query
Description: For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
project
Type: string
Description: Identifies the project addressed by this request.
Required: Yes
Location: path
HTTP Method: POST
Flat Path: dns/v2/projects/{project}/locations/{location}/responsePolicies/{responsePolicy}/rules
▼ ▲ dns.responsePolicyRules.delete
Description: Deletes a previously created Response Policy Rule.
Scopes:
Path: dns/v2/projects/{project}/locations/{location}/responsePolicies/{responsePolicy}/rules/{responsePolicyRule}
Parameter Order:
Flat Path: dns/v2/projects/{project}/locations/{location}/responsePolicies/{responsePolicy}/rules/{responsePolicyRule}
Parameters:
location
Type: string
Location: path
Required: Yes
Description: Specifies the location of the resource. This information will be used for routing and will be part of the resource name.
Default: global
responsePolicyRule
Required: Yes
Description: User assigned name of the Response Policy Rule addressed by this request.
Type: string
Location: path
project
Description: Identifies the project addressed by this request.
Type: string
Location: path
Required: Yes
responsePolicy
Required: Yes
Location: path
Type: string
Description: User assigned name of the Response Policy containing the Response Policy Rule.
clientOperationId
Location: query
Type: string
Description: For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
HTTP Method: DELETE
▼ ▲ dns.responsePolicyRules.get
Flat Path: dns/v2/projects/{project}/locations/{location}/responsePolicies/{responsePolicy}/rules/{responsePolicyRule}
Parameters:
responsePolicy
Required: Yes
Description: User assigned name of the Response Policy containing the Response Policy Rule.
Type: string
Location: path
project
Required: Yes
Location: path
Description: Identifies the project addressed by this request.
Type: string
responsePolicyRule
Required: Yes
Type: string
Location: path
Description: User assigned name of the Response Policy Rule addressed by this request.
location
Description: Specifies the location of the resource. This information will be used for routing and will be part of the resource name.
Required: Yes
Default: global
Type: string
Location: path
clientOperationId
Type: string
Location: query
Description: For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
Description: Fetches the representation of an existing Response Policy Rule.
Parameter Order:
Scopes:
Path: dns/v2/projects/{project}/locations/{location}/responsePolicies/{responsePolicy}/rules/{responsePolicyRule}
HTTP Method: GET
▼ ▲ dns.responsePolicyRules.patch
Path: dns/v2/projects/{project}/locations/{location}/responsePolicies/{responsePolicy}/rules/{responsePolicyRule}
Flat Path: dns/v2/projects/{project}/locations/{location}/responsePolicies/{responsePolicy}/rules/{responsePolicyRule}
Parameters:
responsePolicy
Location: path
Description: User assigned name of the Response Policy containing the Response Policy Rule.
Type: string
Required: Yes
clientOperationId
Location: query
Description: For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
Type: string
project
Location: path
Description: Identifies the project addressed by this request.
Type: string
Required: Yes
location
Location: path
Required: Yes
Default: global
Description: Specifies the location of the resource. This information will be used for routing and will be part of the resource name.
Type: string
responsePolicyRule
Required: Yes
Location: path
Type: string
Description: User assigned name of the Response Policy Rule addressed by this request.
Description: Applies a partial update to an existing Response Policy Rule.
Scopes:
HTTP Method: PATCH
Parameter Order:
▼ ▲ dns.responsePolicyRules.update
Scopes:
Parameter Order:
Path: dns/v2/projects/{project}/locations/{location}/responsePolicies/{responsePolicy}/rules/{responsePolicyRule}
Flat Path: dns/v2/projects/{project}/locations/{location}/responsePolicies/{responsePolicy}/rules/{responsePolicyRule}
Parameters:
location
Location: path
Required: Yes
Description: Specifies the location of the resource. This information will be used for routing and will be part of the resource name.
Type: string
Default: global
responsePolicy
Type: string
Location: path
Description: User assigned name of the Response Policy containing the Response Policy Rule.
Required: Yes
project
Location: path
Required: Yes
Type: string
Description: Identifies the project addressed by this request.
responsePolicyRule
Required: Yes
Type: string
Location: path
Description: User assigned name of the Response Policy Rule addressed by this request.
clientOperationId
Type: string
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
HTTP Method: PUT
Description: Updates an existing Response Policy Rule.
▼ ▲ dns.dnsKeys.list
Parameter Order:
Parameters:
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
project
Description: Identifies the project addressed by this request.
Type: string
Location: path
Required: Yes
location
Location: path
Description: Specifies the location of the resource. This information will be used for routing and will be part of the resource name.
Type: string
Default: global
Required: Yes
managedZone
Required: Yes
Location: path
Type: string
Description: Identifies the managed zone addressed by this request. Can be the managed zone name or ID.
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
maxResults
Location: query
Format: int32
Description: Optional. Maximum number of results to be returned. If unspecified, the server decides how many results to return.
Type: integer
Description: Enumerates DnsKeys to a ResourceRecordSet collection.
Path: dns/v2/projects/{project}/locations/{location}/managedZones/{managedZone}/dnsKeys
Flat Path: dns/v2/projects/{project}/locations/{location}/managedZones/{managedZone}/dnsKeys
HTTP Method: GET
Scopes:
▼ ▲ dns.dnsKeys.get
Path: dns/v2/projects/{project}/locations/{location}/managedZones/{managedZone}/dnsKeys/{dnsKeyId}
Parameter Order:
Parameters:
project
Description: Identifies the project addressed by this request.
Location: path
Type: string
Required: Yes
location
Required: Yes
Default: global
Location: path
Description: Specifies the location of the resource. This information will be used for routing and will be part of the resource name.
Type: string
clientOperationId
Location: query
Description: For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
Type: string
digestType
Type: string
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
managedZone
Required: Yes
Type: string
Location: path
Description: Identifies the managed zone addressed by this request. Can be the managed zone name or ID.
dnsKeyId
Required: Yes
Description: The identifier of the requested DnsKey.
Type: string
Location: path
Description: Fetches the representation of an existing DnsKey.
Flat Path: dns/v2/projects/{project}/locations/{location}/managedZones/{managedZone}/dnsKeys/{dnsKeyId}
Scopes:
HTTP Method: GET
▼ ▲ dns.changes.create
Description: Atomically updates the ResourceRecordSet collection.
Flat Path: dns/v2/projects/{project}/locations/{location}/managedZones/{managedZone}/changes
HTTP Method: POST
Parameter Order:
Parameters:
project
Description: Identifies the project addressed by this request.
Required: Yes
Type: string
Location: path
location
Location: path
Required: Yes
Default: global
Type: string
managedZone
Type: string
Description: Identifies the managed zone addressed by this request. Can be the managed zone name or ID.
Location: path
Required: Yes
clientOperationId
Location: query
Type: string
Description: For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
Scopes:
Path: dns/v2/projects/{project}/locations/{location}/managedZones/{managedZone}/changes
▼ ▲ dns.changes.list
Parameter Order:
Flat Path: dns/v2/projects/{project}/locations/{location}/managedZones/{managedZone}/changes
Scopes:
Path: dns/v2/projects/{project}/locations/{location}/managedZones/{managedZone}/changes
Parameters:
pageToken
Type: string
Description: Optional. A tag returned by a previous list request that was truncated. Use this parameter to continue a previous list request.
Location: query
project
Location: path
Description: Identifies the project addressed by this request.
Type: string
Required: Yes
managedZone
Required: Yes
Type: string
Description: Identifies the managed zone addressed by this request. Can be the managed zone name or ID.
Location: path
location
Required: Yes
Location: path
Type: string
Default: global
sortBy
Description: Sorting criterion. The only supported value is change sequence.
Default: CHANGE_SEQUENCE
Enum: CHANGE_SEQUENCE
Type: string
Enum Descriptions:
Location: query
sortOrder
Location: query
Type: string
Description: Sorting order direction: 'ascending' or 'descending'.
maxResults
Type: integer
Location: query
Format: int32
Description: Optional. Maximum number of results to be returned. If unspecified, the server decides how many results to return.
Description: Enumerates Changes to a ResourceRecordSet collection.
HTTP Method: GET
▼ ▲ dns.changes.get
Scopes:
Parameter Order:
Parameters:
changeId
Required: Yes
Location: path
Description: The identifier of the requested change, from a previous ResourceRecordSetsChangeResponse.
Type: string
project
Location: path
Description: Identifies the project addressed by this request.
Type: string
Required: Yes
clientOperationId
Type: string
Location: query
Description: For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
managedZone
Description: Identifies the managed zone addressed by this request. Can be the managed zone name or ID.
Location: path
Required: Yes
Type: string
location
Default: global
Location: path
Type: string
Required: Yes
Path: dns/v2/projects/{project}/locations/{location}/managedZones/{managedZone}/changes/{changeId}
HTTP Method: GET
Flat Path: dns/v2/projects/{project}/locations/{location}/managedZones/{managedZone}/changes/{changeId}
Description: Fetches the representation of an existing Change.
▼ ▲ dns.policies.list
Flat Path: dns/v2/projects/{project}/locations/{location}/policies
Parameter Order:
HTTP Method: GET
Scopes:
Description: Enumerates all Policies associated with a project.
Parameters:
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
location
Default: global
Description: Specifies the location of the resource. This information will be used for routing and will be part of the resource name.
Required: Yes
Location: path
Type: string
project
Location: path
Type: string
Required: Yes
Description: Identifies the project addressed by this request.
maxResults
Location: query
Format: int32
Description: Optional. Maximum number of results to be returned. If unspecified, the server decides how many results to return.
Type: integer
Path: dns/v2/projects/{project}/locations/{location}/policies
▼ ▲ dns.policies.delete
Parameters:
clientOperationId
Location: query
Type: string
Description: For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
policy
Required: Yes
Location: path
Description: User given friendly name of the policy addressed by this request.
Type: string
location
Description: Specifies the location of the resource. This information will be used for routing and will be part of the resource name.
Default: global
Type: string
Location: path
Required: Yes
project
Location: path
Type: string
Required: Yes
Description: Identifies the project addressed by this request.
HTTP Method: DELETE
Parameter Order:
Path: dns/v2/projects/{project}/locations/{location}/policies/{policy}
Description: Deletes a previously created Policy. Fails if the policy is still being referenced by a network.
Flat Path: dns/v2/projects/{project}/locations/{location}/policies/{policy}
Scopes:
▼ ▲ dns.policies.create
HTTP Method: POST
Description: Creates a new Policy.
Scopes:
Path: dns/v2/projects/{project}/locations/{location}/policies
Parameter Order:
Flat Path: dns/v2/projects/{project}/locations/{location}/policies
Parameters:
project
Location: path
Description: Identifies the project addressed by this request.
Required: Yes
Type: string
clientOperationId
Type: string
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
location
Default: global
Required: Yes
Description: Specifies the location of the resource. This information will be used for routing and will be part of the resource name.
Location: path
Type: string
▼ ▲ dns.policies.patch
Path: dns/v2/projects/{project}/locations/{location}/policies/{policy}
Description: Applies a partial update to an existing Policy.
Parameter Order:
HTTP Method: PATCH
Parameters:
project
Description: Identifies the project addressed by this request.
Required: Yes
Location: path
Type: string
location
Type: string
Location: path
Description: Specifies the location of the resource. This information will be used for routing and will be part of the resource name.
Required: Yes
Default: global
clientOperationId
Type: string
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
policy
Description: User given friendly name of the policy addressed by this request.
Required: Yes
Location: path
Type: string
Scopes:
Flat Path: dns/v2/projects/{project}/locations/{location}/policies/{policy}
▼ ▲ dns.policies.get
Scopes:
Description: Fetches the representation of an existing Policy.
Flat Path: dns/v2/projects/{project}/locations/{location}/policies/{policy}
HTTP Method: GET
Path: dns/v2/projects/{project}/locations/{location}/policies/{policy}
Parameters:
project
Type: string
Required: Yes
Location: path
Description: Identifies the project addressed by this request.
location
Default: global
Type: string
Required: Yes
Description: Specifies the location of the resource. This information will be used for routing and will be part of the resource name.
Location: path
clientOperationId
Location: query
Type: string
Description: For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
policy
Location: path
Type: string
Description: User given friendly name of the policy addressed by this request.
Required: Yes
Parameter Order:
▼ ▲ dns.policies.update
Parameter Order:
Flat Path: dns/v2/projects/{project}/locations/{location}/policies/{policy}
Parameters:
policy
Location: path
Required: Yes
Description: User given friendly name of the policy addressed by this request.
Type: string
clientOperationId
Location: query
Type: string
Description: For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
location
Description: Specifies the location of the resource. This information will be used for routing and will be part of the resource name.
Type: string
Location: path
Required: Yes
Default: global
project
Type: string
Required: Yes
Location: path
Description: Identifies the project addressed by this request.
Description: Updates an existing Policy.
HTTP Method: PUT
Path: dns/v2/projects/{project}/locations/{location}/policies/{policy}
Scopes:
▼ ▲ dns.resourceRecordSets.delete
HTTP Method: DELETE
Parameter Order:
Scopes:
Flat Path: dns/v2/projects/{project}/locations/{location}/managedZones/{managedZone}/rrsets/{name}/{type}
Path: dns/v2/projects/{project}/locations/{location}/managedZones/{managedZone}/rrsets/{name}/{type}
Parameters:
location
Location: path
Description: Specifies the location of the resource. This information will be used for routing and will be part of the resource name.
Required: Yes
Type: string
Default: global
managedZone
Description: Identifies the managed zone addressed by this request. Can be the managed zone name or ID.
Location: path
Required: Yes
Type: string
name
Type: string
Description: Fully qualified domain name.
Required: Yes
Location: path
clientOperationId
Type: string
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
project
Location: path
Description: Identifies the project addressed by this request.
Required: Yes
Type: string
type
Location: path
Type: string
Description: RRSet type.
Required: Yes
Description: Deletes a previously created ResourceRecordSet.
▼ ▲ dns.resourceRecordSets.patch
Parameters:
location
Required: Yes
Description: Specifies the location of the resource. This information will be used for routing and will be part of the resource name.
Type: string
Default: global
Location: path
clientOperationId
Location: query
Type: string
Description: For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
project
Description: Identifies the project addressed by this request.
Type: string
Required: Yes
Location: path
name
Location: path
Description: Fully qualified domain name.
Required: Yes
Type: string
managedZone
Location: path
Type: string
Required: Yes
Description: Identifies the managed zone addressed by this request. Can be the managed zone name or ID.
type
Description: RRSet type.
Required: Yes
Type: string
Location: path
HTTP Method: PATCH
Description: Applies a partial update to an existing ResourceRecordSet.
Path: dns/v2/projects/{project}/locations/{location}/managedZones/{managedZone}/rrsets/{name}/{type}
Flat Path: dns/v2/projects/{project}/locations/{location}/managedZones/{managedZone}/rrsets/{name}/{type}
Scopes:
Parameter Order:
▼ ▲ dns.resourceRecordSets.get
Description: Fetches the representation of an existing ResourceRecordSet.
Path: dns/v2/projects/{project}/locations/{location}/managedZones/{managedZone}/rrsets/{name}/{type}
Parameter Order:
Flat Path: dns/v2/projects/{project}/locations/{location}/managedZones/{managedZone}/rrsets/{name}/{type}
Scopes:
HTTP Method: GET
Parameters:
managedZone
Type: string
Location: path
Required: Yes
Description: Identifies the managed zone addressed by this request. Can be the managed zone name or ID.
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
project
Type: string
Required: Yes
Description: Identifies the project addressed by this request.
Location: path
name
Type: string
Location: path
Description: Fully qualified domain name.
Required: Yes
type
Description: RRSet type.
Location: path
Required: Yes
Type: string
location
Required: Yes
Type: string
Location: path
Default: global
Description: Specifies the location of the resource. This information will be used for routing and will be part of the resource name.
▼ ▲ dns.resourceRecordSets.list
Parameter Order:
Description: Enumerates ResourceRecordSets that you have created but not yet deleted.
Parameters:
name
Location: query
Type: string
Description: Restricts the list to return only records with this fully qualified domain name.
project
Location: path
Type: string
Description: Identifies the project addressed by this request.
Required: Yes
location
Description: Specifies the location of the resource. This information will be used for routing and will be part of the resource name.
Type: string
Default: global
Location: path
Required: Yes
maxResults
Type: integer
Location: query
Format: int32
Description: Optional. Maximum number of results to be returned. If unspecified, the server decides how many results to return.
pageToken
Description: Optional. A tag returned by a previous list request that was truncated. Use this parameter to continue a previous list request.
Type: string
Location: query
managedZone
Required: Yes
Type: string
Location: path
Description: Identifies the managed zone addressed by this request. Can be the managed zone name or ID.
type
Description: Restricts the list to return only records of this type. If present, the "name" parameter must also be present.
Type: string
Location: query
Scopes:
Path: dns/v2/projects/{project}/locations/{location}/managedZones/{managedZone}/rrsets
HTTP Method: GET
Flat Path: dns/v2/projects/{project}/locations/{location}/managedZones/{managedZone}/rrsets
▼ ▲ dns.resourceRecordSets.create
Parameter Order:
Flat Path: dns/v2/projects/{project}/locations/{location}/managedZones/{managedZone}/rrsets
Description: Creates a new ResourceRecordSet.
Scopes:
Path: dns/v2/projects/{project}/locations/{location}/managedZones/{managedZone}/rrsets
Parameters:
location
Required: Yes
Location: path
Default: global
Description: Specifies the location of the resource. This information will be used for routing and will be part of the resource name.
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
managedZone
Description: Identifies the managed zone addressed by this request. Can be the managed zone name or ID.
Type: string
Required: Yes
Location: path
project
Required: Yes
Type: string
Location: path
Description: Identifies the project addressed by this request.
HTTP Method: POST
▼ ▲ dns.projects.get
Scopes:
Parameters:
project
Type: string
Location: path
Description: Identifies the project addressed by this request.
Required: Yes
location
Type: string
Location: path
Default: global
Required: Yes
clientOperationId
Type: string
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
Path: dns/v2/projects/{project}/locations/{location}
Flat Path: dns/v2/projects/{project}/locations/{location}
HTTP Method: GET
Description: Fetches the representation of an existing Project.
Parameter Order:
▼ ▲ dns.managedZoneOperations.list
Parameters:
pageToken
Type: string
Location: query
Description: Optional. A tag returned by a previous list request that was truncated. Use this parameter to continue a previous list request.
project
Required: Yes
Location: path
Type: string
Description: Identifies the project addressed by this request.
managedZone
Required: Yes
Location: path
Description: Identifies the managed zone addressed by this request.
Type: string
sortBy
Location: query
Enum:
Default: START_TIME
Type: string
Enum Descriptions:
Description: Sorting criterion. The only supported values are START_TIME and ID.
maxResults
Location: query
Type: integer
Format: int32
Description: Optional. Maximum number of results to be returned. If unspecified, the server decides how many results to return.
location
Location: path
Description: Specifies the location of the resource. This information will be used for routing and will be part of the resource name.
Required: Yes
Type: string
Default: global
Description: Enumerates Operations for the given ManagedZone.
Flat Path: dns/v2/projects/{project}/locations/{location}/managedZones/{managedZone}/operations
HTTP Method: GET
Parameter Order:
Scopes:
Path: dns/v2/projects/{project}/locations/{location}/managedZones/{managedZone}/operations
▼ ▲ dns.managedZoneOperations.get
Path: dns/v2/projects/{project}/locations/{location}/managedZones/{managedZone}/operations/{operation}
Flat Path: dns/v2/projects/{project}/locations/{location}/managedZones/{managedZone}/operations/{operation}
HTTP Method: GET
Parameter Order:
Description: Fetches the representation of an existing Operation.
Scopes:
Parameters:
clientOperationId
Type: string
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
managedZone
Type: string
Description: Identifies the managed zone addressed by this request.
Location: path
Required: Yes
operation
Description: Identifies the operation addressed by this request (ID of the operation).
Type: string
Location: path
Required: Yes
project
Location: path
Required: Yes
Type: string
Description: Identifies the project addressed by this request.
location
Location: path
Type: string
Default: global
Required: Yes
Description: Specifies the location of the resource. This information will be used for routing and will be part of the resource name.
▼ ▲ dns.responsePolicies.delete
HTTP Method: DELETE
Path: dns/v2/projects/{project}/locations/{location}/responsePolicies/{responsePolicy}
Parameter Order:
Scopes:
Parameters:
location
Location: path
Type: string
Required: Yes
Default: global
Description: Specifies the location of the resource. This information will be used for routing and will be part of the resource name.
clientOperationId
Type: string
Location: query
Description: For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
project
Description: Identifies the project addressed by this request.
Type: string
Location: path
Required: Yes
responsePolicy
Type: string
Description: User assigned name of the Response Policy addressed by this request.
Required: Yes
Location: path
Description: Deletes a previously created Response Policy. Fails if the response policy is non-empty or still being referenced by a network.
Flat Path: dns/v2/projects/{project}/locations/{location}/responsePolicies/{responsePolicy}
▼ ▲ dns.responsePolicies.patch
Description: Applies a partial update to an existing Response Policy.
Flat Path: dns/v2/projects/{project}/locations/{location}/responsePolicies/{responsePolicy}
HTTP Method: PATCH
Scopes:
Path: dns/v2/projects/{project}/locations/{location}/responsePolicies/{responsePolicy}
Parameter Order:
Parameters:
project
Required: Yes
Type: string
Location: path
Description: Identifies the project addressed by this request.
location
Location: path
Required: Yes
Description: Specifies the location of the resource. This information will be used for routing and will be part of the resource name.
Default: global
Type: string
responsePolicy
Type: string
Description: User assigned name of the Respones Policy addressed by this request.
Required: Yes
Location: path
clientOperationId
Type: string
Location: query
Description: For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
▼ ▲ dns.responsePolicies.create
Description: Creates a new Response Policy
Path: dns/v2/projects/{project}/locations/{location}/responsePolicies
HTTP Method: POST
Flat Path: dns/v2/projects/{project}/locations/{location}/responsePolicies
Parameters:
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
location
Required: Yes
Location: path
Default: global
Description: Specifies the location of the resource, only applicable in the v APIs. This information will be used for routing and will be part of the resource name.
Type: string
project
Description: Identifies the project addressed by this request.
Type: string
Required: Yes
Location: path
Parameter Order:
Scopes:
▼ ▲ dns.responsePolicies.get
HTTP Method: GET
Path: dns/v2/projects/{project}/locations/{location}/responsePolicies/{responsePolicy}
Parameter Order:
Parameters:
location
Default: global
Description: Specifies the location of the resource. This information will be used for routing and will be part of the resource name.
Location: path
Type: string
Required: Yes
responsePolicy
Required: Yes
Description: User assigned name of the Response Policy addressed by this request.
Location: path
Type: string
project
Required: Yes
Type: string
Description: Identifies the project addressed by this request.
Location: path
clientOperationId
Location: query
Description: For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
Type: string
Description: Fetches the representation of an existing Response Policy.
Flat Path: dns/v2/projects/{project}/locations/{location}/responsePolicies/{responsePolicy}
Scopes:
▼ ▲ dns.responsePolicies.update
Flat Path: dns/v2/projects/{project}/locations/{location}/responsePolicies/{responsePolicy}
Parameter Order:
HTTP Method: PUT
Scopes:
Path: dns/v2/projects/{project}/locations/{location}/responsePolicies/{responsePolicy}
Parameters:
responsePolicy
Location: path
Description: User assigned name of the Response Policy addressed by this request.
Type: string
Required: Yes
clientOperationId
Type: string
Location: query
Description: For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
project
Required: Yes
Type: string
Description: Identifies the project addressed by this request.
Location: path
location
Required: Yes
Type: string
Description: Specifies the location of the resource. This information will be used for routing and will be part of the resource name.
Location: path
Default: global
Description: Updates an existing Response Policy.
▼ ▲ dns.responsePolicies.list
Flat Path: dns/v2/projects/{project}/locations/{location}/responsePolicies
Scopes:
Path: dns/v2/projects/{project}/locations/{location}/responsePolicies
HTTP Method: GET
Parameter Order:
Description: Enumerates all Response Policies associated with a project.
Parameters:
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
location
Type: string
Default: global
Description: Specifies the location of the resource. This information will be used for routing and will be part of the resource name.
Location: path
Required: Yes
project
Type: string
Location: path
Required: Yes
Description: Identifies the project addressed by this request.
maxResults
Type: integer
Description: Optional. Maximum number of results to be returned. If unspecified, the server decides how many results to return.
Format: int32
Location: query
▼ ▲ dns.projects.get
Description: Fetches the representation of an existing Project.
HTTP Method: GET
Flat Path: dns/v2/projects/{project}/locations/{location}
Path: dns/v2/projects/{project}/locations/{location}
Parameters:
clientOperationId
Type: string
Location: query
Description: For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
location
Location: path
Default: global
Type: string
Required: Yes
project
Location: path
Type: string
Description: Identifies the project addressed by this request.
Required: Yes
Scopes:
Parameter Order:
▼ ▲ dns.responsePolicies.update
Flat Path: dns/v2/projects/{project}/locations/{location}/responsePolicies/{responsePolicy}
Scopes:
Path: dns/v2/projects/{project}/locations/{location}/responsePolicies/{responsePolicy}
HTTP Method: PUT
Parameters:
clientOperationId
Location: query
Type: string
Description: For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
location
Required: Yes
Location: path
Description: Specifies the location of the resource. This information will be used for routing and will be part of the resource name.
Default: global
Type: string
responsePolicy
Description: User assigned name of the Response Policy addressed by this request.
Required: Yes
Type: string
Location: path
project
Location: path
Required: Yes
Type: string
Description: Identifies the project addressed by this request.
Description: Updates an existing Response Policy.
Parameter Order:
▼ ▲ dns.responsePolicies.list
Scopes:
Parameter Order:
Description: Enumerates all Response Policies associated with a project.
Parameters:
location
Location: path
Required: Yes
Description: Specifies the location of the resource. This information will be used for routing and will be part of the resource name.
Type: string
Default: global
maxResults
Format: int32
Description: Optional. Maximum number of results to be returned. If unspecified, the server decides how many results to return.
Location: query
Type: integer
project
Description: Identifies the project addressed by this request.
Type: string
Location: path
Required: Yes
pageToken
Description: Optional. A tag returned by a previous list request that was truncated. Use this parameter to continue a previous list request.
Type: string
Location: query
HTTP Method: GET
Path: dns/v2/projects/{project}/locations/{location}/responsePolicies
Flat Path: dns/v2/projects/{project}/locations/{location}/responsePolicies
▼ ▲ dns.responsePolicies.create
Flat Path: dns/v2/projects/{project}/locations/{location}/responsePolicies
Parameters:
location
Required: Yes
Default: global
Location: path
Description: Specifies the location of the resource, only applicable in the v APIs. This information will be used for routing and will be part of the resource name.
Type: string
project
Location: path
Required: Yes
Type: string
Description: Identifies the project addressed by this request.
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
Path: dns/v2/projects/{project}/locations/{location}/responsePolicies
Parameter Order:
HTTP Method: POST
Description: Creates a new Response Policy
Scopes:
▼ ▲ dns.responsePolicies.delete
Scopes:
Flat Path: dns/v2/projects/{project}/locations/{location}/responsePolicies/{responsePolicy}
Parameter Order:
Path: dns/v2/projects/{project}/locations/{location}/responsePolicies/{responsePolicy}
Parameters:
responsePolicy
Type: string
Required: Yes
Location: path
Description: User assigned name of the Response Policy addressed by this request.
location
Type: string
Description: Specifies the location of the resource. This information will be used for routing and will be part of the resource name.
Required: Yes
Location: path
Default: global
project
Required: Yes
Type: string
Location: path
Description: Identifies the project addressed by this request.
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
Description: Deletes a previously created Response Policy. Fails if the response policy is non-empty or still being referenced by a network.
HTTP Method: DELETE
▼ ▲ dns.responsePolicies.patch
Scopes:
Description: Applies a partial update to an existing Response Policy.
HTTP Method: PATCH
Parameter Order:
Parameters:
location
Default: global
Type: string
Description: Specifies the location of the resource. This information will be used for routing and will be part of the resource name.
Required: Yes
Location: path
project
Required: Yes
Type: string
Description: Identifies the project addressed by this request.
Location: path
clientOperationId
Location: query
Description: For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
Type: string
responsePolicy
Type: string
Description: User assigned name of the Respones Policy addressed by this request.
Required: Yes
Location: path
Flat Path: dns/v2/projects/{project}/locations/{location}/responsePolicies/{responsePolicy}
Path: dns/v2/projects/{project}/locations/{location}/responsePolicies/{responsePolicy}
▼ ▲ dns.responsePolicies.get
Parameter Order:
HTTP Method: GET
Flat Path: dns/v2/projects/{project}/locations/{location}/responsePolicies/{responsePolicy}
Scopes:
Parameters:
project
Location: path
Required: Yes
Description: Identifies the project addressed by this request.
Type: string
responsePolicy
Location: path
Required: Yes
Type: string
Description: User assigned name of the Response Policy addressed by this request.
location
Location: path
Default: global
Type: string
Required: Yes
Description: Specifies the location of the resource. This information will be used for routing and will be part of the resource name.
clientOperationId
Description: For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
Type: string
Location: query
Path: dns/v2/projects/{project}/locations/{location}/responsePolicies/{responsePolicy}
Description: Fetches the representation of an existing Response Policy.
▼ ▲ dns.responsePolicyRules.list
HTTP Method: GET
Parameter Order:
Parameters:
responsePolicy
Description: User assigned name of the Response Policy to list.
Required: Yes
Type: string
Location: path
project
Required: Yes
Location: path
Type: string
Description: Identifies the project addressed by this request.
pageToken
Location: query
Description: Optional. A tag returned by a previous list request that was truncated. Use this parameter to continue a previous list request.
Type: string
location
Description: Specifies the location of the resource. This information will be used for routing and will be part of the resource name.
Default: global
Type: string
Location: path
Required: Yes
maxResults
Type: integer
Format: int32
Description: Optional. Maximum number of results to be returned. If unspecified, the server decides how many results to return.
Location: query
Description: Enumerates all Response Policy Rules associated with a project.
Scopes:
Path: dns/v2/projects/{project}/locations/{location}/responsePolicies/{responsePolicy}/rules
Flat Path: dns/v2/projects/{project}/locations/{location}/responsePolicies/{responsePolicy}/rules
▼ ▲ dns.responsePolicyRules.patch
HTTP Method: PATCH
Path: dns/v2/projects/{project}/locations/{location}/responsePolicies/{responsePolicy}/rules/{responsePolicyRule}
Description: Applies a partial update to an existing Response Policy Rule.
Parameter Order:
Scopes:
Parameters:
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
responsePolicy
Description: User assigned name of the Response Policy containing the Response Policy Rule.
Type: string
Required: Yes
Location: path
location
Required: Yes
Description: Specifies the location of the resource. This information will be used for routing and will be part of the resource name.
Default: global
Type: string
Location: path
project
Required: Yes
Type: string
Description: Identifies the project addressed by this request.
Location: path
responsePolicyRule
Location: path
Description: User assigned name of the Response Policy Rule addressed by this request.
Required: Yes
Type: string
Flat Path: dns/v2/projects/{project}/locations/{location}/responsePolicies/{responsePolicy}/rules/{responsePolicyRule}
▼ ▲ dns.responsePolicyRules.get
Flat Path: dns/v2/projects/{project}/locations/{location}/responsePolicies/{responsePolicy}/rules/{responsePolicyRule}
HTTP Method: GET
Parameter Order:
Description: Fetches the representation of an existing Response Policy Rule.
Scopes:
Parameters:
clientOperationId
Description: For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
Type: string
Location: query
responsePolicy
Required: Yes
Description: User assigned name of the Response Policy containing the Response Policy Rule.
Type: string
Location: path
location
Default: global
Type: string
Location: path
Description: Specifies the location of the resource. This information will be used for routing and will be part of the resource name.
Required: Yes
responsePolicyRule
Type: string
Description: User assigned name of the Response Policy Rule addressed by this request.
Required: Yes
Location: path
project
Required: Yes
Description: Identifies the project addressed by this request.
Location: path
Type: string
Path: dns/v2/projects/{project}/locations/{location}/responsePolicies/{responsePolicy}/rules/{responsePolicyRule}
▼ ▲ dns.responsePolicyRules.delete
Parameter Order:
Path: dns/v2/projects/{project}/locations/{location}/responsePolicies/{responsePolicy}/rules/{responsePolicyRule}
Scopes:
HTTP Method: DELETE
Parameters:
clientOperationId
Location: query
Description: For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
Type: string
project
Type: string
Location: path
Required: Yes
Description: Identifies the project addressed by this request.
location
Location: path
Default: global
Description: Specifies the location of the resource. This information will be used for routing and will be part of the resource name.
Type: string
Required: Yes
responsePolicy
Required: Yes
Location: path
Description: User assigned name of the Response Policy containing the Response Policy Rule.
Type: string
responsePolicyRule
Location: path
Description: User assigned name of the Response Policy Rule addressed by this request.
Required: Yes
Type: string
Description: Deletes a previously created Response Policy Rule.
Flat Path: dns/v2/projects/{project}/locations/{location}/responsePolicies/{responsePolicy}/rules/{responsePolicyRule}
▼ ▲ dns.responsePolicyRules.update
Parameter Order:
Parameters:
responsePolicyRule
Description: User assigned name of the Response Policy Rule addressed by this request.
Type: string
Required: Yes
Location: path
responsePolicy
Type: string
Required: Yes
Description: User assigned name of the Response Policy containing the Response Policy Rule.
Location: path
clientOperationId
Location: query
Type: string
Description: For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
location
Location: path
Description: Specifies the location of the resource. This information will be used for routing and will be part of the resource name.
Default: global
Type: string
Required: Yes
project
Type: string
Location: path
Description: Identifies the project addressed by this request.
Required: Yes
Description: Updates an existing Response Policy Rule.
Path: dns/v2/projects/{project}/locations/{location}/responsePolicies/{responsePolicy}/rules/{responsePolicyRule}
Flat Path: dns/v2/projects/{project}/locations/{location}/responsePolicies/{responsePolicy}/rules/{responsePolicyRule}
HTTP Method: PUT
Scopes:
▼ ▲ dns.responsePolicyRules.create
Scopes:
Parameter Order:
Flat Path: dns/v2/projects/{project}/locations/{location}/responsePolicies/{responsePolicy}/rules
HTTP Method: POST
Path: dns/v2/projects/{project}/locations/{location}/responsePolicies/{responsePolicy}/rules
Parameters:
responsePolicy
Description: User assigned name of the Response Policy containing the Response Policy Rule.
Required: Yes
Type: string
Location: path
project
Type: string
Required: Yes
Location: path
Description: Identifies the project addressed by this request.
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
location
Description: Specifies the location of the resource. This information will be used for routing and will be part of the resource name.
Required: Yes
Default: global
Type: string
Location: path
Description: Creates a new Response Policy Rule.
▼ ▲ dns.managedZones.get
Path: dns/v2/projects/{project}/locations/{location}/managedZones/{managedZone}
Parameter Order:
Scopes:
Parameters:
managedZone
Required: Yes
Type: string
Location: path
Description: Identifies the managed zone addressed by this request. Can be the managed zone name or ID.
location
Required: Yes
Type: string
Default: global
Location: path
Description: Specifies the location of the resource. This information will be used for routing and will be part of the resource name.
project
Description: Identifies the project addressed by this request.
Required: Yes
Type: string
Location: path
clientOperationId
Location: query
Description: For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
Type: string
Description: Fetches the representation of an existing ManagedZone.
HTTP Method: GET
Flat Path: dns/v2/projects/{project}/locations/{location}/managedZones/{managedZone}
▼ ▲ dns.managedZones.list
Description: Enumerates ManagedZones that have been created but not yet deleted.
Parameter Order:
Flat Path: dns/v2/projects/{project}/locations/{location}/managedZones
HTTP Method: GET
Parameters:
dnsName
Description: Restricts the list to return only zones with this domain name.
Location: query
Type: string
maxResults
Type: integer
Description: Optional. Maximum number of results to be returned. If unspecified, the server decides how many results to return.
Format: int32
Location: query
project
Location: path
Required: Yes
Type: string
Description: Identifies the project addressed by this request.
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
location
Required: Yes
Description: Specifies the location of the resource. This information will be used for routing and will be part of the resource name.
Type: string
Default: global
Location: path
Scopes:
Path: dns/v2/projects/{project}/locations/{location}/managedZones
▼ ▲ dns.managedZones.update
Parameter Order:
Scopes:
Description: Updates an existing ManagedZone.
HTTP Method: PUT
Path: dns/v2/projects/{project}/locations/{location}/managedZones/{managedZone}
Flat Path: dns/v2/projects/{project}/locations/{location}/managedZones/{managedZone}
Parameters:
clientOperationId
Type: string
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
project
Required: Yes
Description: Identifies the project addressed by this request.
Location: path
Type: string
managedZone
Type: string
Description: Identifies the managed zone addressed by this request. Can be the managed zone name or ID.
Location: path
Required: Yes
location
Location: path
Required: Yes
Default: global
Type: string
Description: Specifies the location of the resource. This information will be used for routing and will be part of the resource name.
▼ ▲ dns.managedZones.delete
Parameter Order:
Flat Path: dns/v2/projects/{project}/locations/{location}/managedZones/{managedZone}
Parameters:
location
Description: Specifies the location of the resource. This information will be used for routing and will be part of the resource name.
Required: Yes
Default: global
Location: path
Type: string
managedZone
Type: string
Required: Yes
Description: Identifies the managed zone addressed by this request. Can be the managed zone name or ID.
Location: path
project
Description: Identifies the project addressed by this request.
Location: path
Type: string
Required: Yes
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
Scopes:
Description: Deletes a previously created ManagedZone.
HTTP Method: DELETE
Path: dns/v2/projects/{project}/locations/{location}/managedZones/{managedZone}
▼ ▲ dns.managedZones.patch
Description: Applies a partial update to an existing ManagedZone.
Scopes:
Parameters:
managedZone
Description: Identifies the managed zone addressed by this request. Can be the managed zone name or ID.
Required: Yes
Type: string
Location: path
project
Location: path
Description: Identifies the project addressed by this request.
Required: Yes
Type: string
location
Location: path
Required: Yes
Description: Specifies the location of the resource. This information will be used for routing and will be part of the resource name.
Default: global
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.
Type: string
Location: query
Parameter Order:
HTTP Method: PATCH
Flat Path: dns/v2/projects/{project}/locations/{location}/managedZones/{managedZone}
Path: dns/v2/projects/{project}/locations/{location}/managedZones/{managedZone}
▼ ▲ dns.managedZones.create
Parameter Order:
Scopes:
Path: dns/v2/projects/{project}/locations/{location}/managedZones
Parameters:
clientOperationId
Description: For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
Type: string
Location: query
project
Location: path
Type: string
Required: Yes
Description: Identifies the project addressed by this request.
location
Required: Yes
Default: global
Type: string
Location: path
Description: Specifies the location of the resource. This information will be used for routing and will be part of the resource name.
Flat Path: dns/v2/projects/{project}/locations/{location}/managedZones
Description: Creates a new ManagedZone.
HTTP Method: POST
▼ ▲ dns.managedZoneOperations.get
Flat Path: dns/v2/projects/{project}/locations/{location}/managedZones/{managedZone}/operations/{operation}
HTTP Method: GET
Path: dns/v2/projects/{project}/locations/{location}/managedZones/{managedZone}/operations/{operation}
Scopes:
Parameters:
project
Description: Identifies the project addressed by this request.
Location: path
Required: Yes
Type: string
location
Required: Yes
Default: global
Location: path
Type: string
Description: Specifies the location of the resource. This information will be used for routing and will be part of the resource name.
clientOperationId
Description: For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
Type: string
Location: query
operation
Description: Identifies the operation addressed by this request (ID of the operation).
Type: string
Required: Yes
Location: path
managedZone
Type: string
Description: Identifies the managed zone addressed by this request.
Required: Yes
Location: path
Description: Fetches the representation of an existing Operation.
Parameter Order:
▼ ▲ dns.managedZoneOperations.list
HTTP Method: GET
Flat Path: dns/v2/projects/{project}/locations/{location}/managedZones/{managedZone}/operations
Description: Enumerates Operations for the given ManagedZone.
Parameters:
managedZone
Description: Identifies the managed zone addressed by this request.
Required: Yes
Type: string
Location: path
pageToken
Description: Optional. A tag returned by a previous list request that was truncated. Use this parameter to continue a previous list request.
Type: string
Location: query
location
Default: global
Description: Specifies the location of the resource. This information will be used for routing and will be part of the resource name.
Location: path
Type: string
Required: Yes
sortBy
Enum:
Type: string
Default: START_TIME
Location: query
Enum Descriptions:
Description: Sorting criterion. The only supported values are START_TIME and ID.
project
Location: path
Required: Yes
Description: Identifies the project addressed by this request.
Type: string
maxResults
Location: query
Description: Optional. Maximum number of results to be returned. If unspecified, the server decides how many results to return.
Format: int32
Type: integer
Parameter Order:
Path: dns/v2/projects/{project}/locations/{location}/managedZones/{managedZone}/operations
Scopes:
▼ ▲ dns.policies.update
Description: Updates an existing Policy.
Scopes:
Parameters:
project
Location: path
Type: string
Description: Identifies the project addressed by this request.
Required: Yes
location
Description: Specifies the location of the resource. This information will be used for routing and will be part of the resource name.
Required: Yes
Default: global
Location: path
Type: string
policy
Description: User given friendly name of the policy addressed by this request.
Location: path
Type: string
Required: Yes
clientOperationId
Type: string
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
Parameter Order:
HTTP Method: PUT
Flat Path: dns/v2/projects/{project}/locations/{location}/policies/{policy}
Path: dns/v2/projects/{project}/locations/{location}/policies/{policy}
▼ ▲ dns.policies.list
HTTP Method: GET
Parameter Order:
Path: dns/v2/projects/{project}/locations/{location}/policies
Parameters:
project
Description: Identifies the project addressed by this request.
Location: path
Type: string
Required: Yes
location
Type: string
Description: Specifies the location of the resource. This information will be used for routing and will be part of the resource name.
Required: Yes
Location: path
Default: global
maxResults
Format: int32
Location: query
Description: Optional. Maximum number of results to be returned. If unspecified, the server decides how many results to return.
Type: integer
pageToken
Type: string
Location: query
Description: Optional. A tag returned by a previous list request that was truncated. Use this parameter to continue a previous list request.
Flat Path: dns/v2/projects/{project}/locations/{location}/policies
Description: Enumerates all Policies associated with a project.
Scopes:
▼ ▲ dns.policies.patch
Flat Path: dns/v2/projects/{project}/locations/{location}/policies/{policy}
Scopes:
HTTP Method: PATCH
Path: dns/v2/projects/{project}/locations/{location}/policies/{policy}
Parameters:
project
Location: path
Description: Identifies the project addressed by this request.
Type: string
Required: Yes
policy
Description: User given friendly name of the policy addressed by this request.
Type: string
Location: path
Required: Yes
location
Type: string
Default: global
Location: path
Required: Yes
Description: Specifies the location of the resource. This information will be used for routing and will be part of the resource name.
clientOperationId
Type: string
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
Description: Applies a partial update to an existing Policy.
Parameter Order:
▼ ▲ dns.policies.delete
Description: Deletes a previously created Policy. Fails if the policy is still being referenced by a network.
Path: dns/v2/projects/{project}/locations/{location}/policies/{policy}
Scopes:
Parameters:
location
Location: path
Required: Yes
Default: global
Description: Specifies the location of the resource. This information will be used for routing and will be part of the resource name.
Type: string
project
Type: string
Location: path
Required: Yes
Description: Identifies the project addressed by this request.
clientOperationId
Location: query
Description: For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
Type: string
policy
Location: path
Required: Yes
Description: User given friendly name of the policy addressed by this request.
Type: string
Flat Path: dns/v2/projects/{project}/locations/{location}/policies/{policy}
Parameter Order:
HTTP Method: DELETE
▼ ▲ dns.policies.create
Flat Path: dns/v2/projects/{project}/locations/{location}/policies
Parameters:
location
Description: Specifies the location of the resource. This information will be used for routing and will be part of the resource name.
Default: global
Location: path
Type: string
Required: Yes
project
Location: path
Description: Identifies the project addressed by this request.
Type: string
Required: Yes
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
Scopes:
Parameter Order:
Path: dns/v2/projects/{project}/locations/{location}/policies
Description: Creates a new Policy.
HTTP Method: POST
▼ ▲ dns.policies.get
Parameters:
location
Required: Yes
Description: Specifies the location of the resource. This information will be used for routing and will be part of the resource name.
Default: global
Location: path
Type: string
policy
Description: User given friendly name of the policy addressed by this request.
Required: Yes
Location: path
Type: string
clientOperationId
Location: query
Type: string
Description: For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
project
Type: string
Description: Identifies the project addressed by this request.
Required: Yes
Location: path
Scopes:
HTTP Method: GET
Description: Fetches the representation of an existing Policy.
Parameter Order:
Path: dns/v2/projects/{project}/locations/{location}/policies/{policy}
Flat Path: dns/v2/projects/{project}/locations/{location}/policies/{policy}
▼ ▲ dns.dnsKeys.get
Path: dns/v2/projects/{project}/locations/{location}/managedZones/{managedZone}/dnsKeys/{dnsKeyId}
Flat Path: dns/v2/projects/{project}/locations/{location}/managedZones/{managedZone}/dnsKeys/{dnsKeyId}
Description: Fetches the representation of an existing DnsKey.
Scopes:
Parameters:
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
location
Description: Specifies the location of the resource. This information will be used for routing and will be part of the resource name.
Location: path
Required: Yes
Default: global
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.
Type: string
Location: query
project
Required: Yes
Description: Identifies the project addressed by this request.
Location: path
Type: string
managedZone
Location: path
Type: string
Description: Identifies the managed zone addressed by this request. Can be the managed zone name or ID.
Required: Yes
dnsKeyId
Location: path
Required: Yes
Type: string
Description: The identifier of the requested DnsKey.
HTTP Method: GET
Parameter Order:
▼ ▲ dns.dnsKeys.list
Flat Path: dns/v2/projects/{project}/locations/{location}/managedZones/{managedZone}/dnsKeys
Description: Enumerates DnsKeys to a ResourceRecordSet collection.
Parameters:
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
pageToken
Type: string
Location: query
Description: Optional. A tag returned by a previous list request that was truncated. Use this parameter to continue a previous list request.
maxResults
Location: query
Type: integer
Description: Optional. Maximum number of results to be returned. If unspecified, the server decides how many results to return.
Format: int32
project
Description: Identifies the project addressed by this request.
Type: string
Location: path
Required: Yes
location
Type: string
Required: Yes
Description: Specifies the location of the resource. This information will be used for routing and will be part of the resource name.
Location: path
Default: global
managedZone
Required: Yes
Location: path
Type: string
Description: Identifies the managed zone addressed by this request. Can be the managed zone name or ID.
Path: dns/v2/projects/{project}/locations/{location}/managedZones/{managedZone}/dnsKeys
Parameter Order:
HTTP Method: GET
Scopes:
▼ ▲ dns.changes.create
Scopes:
Parameter Order:
Flat Path: dns/v2/projects/{project}/locations/{location}/managedZones/{managedZone}/changes
HTTP Method: POST
Parameters:
managedZone
Required: Yes
Type: string
Description: Identifies the managed zone addressed by this request. Can be the managed zone name or ID.
Location: path
clientOperationId
Description: For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
Type: string
Location: query
project
Location: path
Required: Yes
Description: Identifies the project addressed by this request.
Type: string
location
Type: string
Default: global
Required: Yes
Location: path
Description: Atomically updates the ResourceRecordSet collection.
Path: dns/v2/projects/{project}/locations/{location}/managedZones/{managedZone}/changes
▼ ▲ dns.changes.get
HTTP Method: GET
Parameters:
changeId
Description: The identifier of the requested change, from a previous ResourceRecordSetsChangeResponse.
Type: string
Location: path
Required: Yes
location
Location: path
Required: Yes
Type: string
Default: global
clientOperationId
Description: For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
Type: string
Location: query
project
Description: Identifies the project addressed by this request.
Type: string
Required: Yes
Location: path
managedZone
Type: string
Location: path
Description: Identifies the managed zone addressed by this request. Can be the managed zone name or ID.
Required: Yes
Flat Path: dns/v2/projects/{project}/locations/{location}/managedZones/{managedZone}/changes/{changeId}
Path: dns/v2/projects/{project}/locations/{location}/managedZones/{managedZone}/changes/{changeId}
Description: Fetches the representation of an existing Change.
Parameter Order:
Scopes:
▼ ▲ dns.changes.list
Scopes:
Description: Enumerates Changes to a ResourceRecordSet collection.
Path: dns/v2/projects/{project}/locations/{location}/managedZones/{managedZone}/changes
Flat Path: dns/v2/projects/{project}/locations/{location}/managedZones/{managedZone}/changes
HTTP Method: GET
Parameter Order:
Parameters:
pageToken
Description: Optional. A tag returned by a previous list request that was truncated. Use this parameter to continue a previous list request.
Type: string
Location: query
managedZone
Location: path
Type: string
Required: Yes
Description: Identifies the managed zone addressed by this request. Can be the managed zone name or ID.
location
Location: path
Default: global
Required: Yes
Type: string
maxResults
Description: Optional. Maximum number of results to be returned. If unspecified, the server decides how many results to return.
Format: int32
Location: query
Type: integer
project
Required: Yes
Description: Identifies the project addressed by this request.
Location: path
Type: string
sortBy
Location: query
Description: Sorting criterion. The only supported value is change sequence.
Default: CHANGE_SEQUENCE
Type: string
Enum Descriptions:
Enum: CHANGE_SEQUENCE
sortOrder
Type: string
Description: Sorting order direction: 'ascending' or 'descending'.
Location: query
▼ ▲ dns.resourceRecordSets.patch
Parameter Order:
Scopes:
HTTP Method: PATCH
Flat Path: dns/v2/projects/{project}/locations/{location}/managedZones/{managedZone}/rrsets/{name}/{type}
Description: Applies a partial update to an existing ResourceRecordSet.
Path: dns/v2/projects/{project}/locations/{location}/managedZones/{managedZone}/rrsets/{name}/{type}
Parameters:
clientOperationId
Description: For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
Type: string
Location: query
location
Location: path
Description: Specifies the location of the resource. This information will be used for routing and will be part of the resource name.
Type: string
Default: global
Required: Yes
managedZone
Description: Identifies the managed zone addressed by this request. Can be the managed zone name or ID.
Type: string
Location: path
Required: Yes
project
Type: string
Description: Identifies the project addressed by this request.
Required: Yes
Location: path
name
Type: string
Location: path
Required: Yes
Description: Fully qualified domain name.
type
Location: path
Description: RRSet type.
Required: Yes
Type: string
▼ ▲ dns.resourceRecordSets.delete
HTTP Method: DELETE
Parameters:
type
Location: path
Description: RRSet type.
Required: Yes
Type: string
managedZone
Description: Identifies the managed zone addressed by this request. Can be the managed zone name or ID.
Location: path
Type: string
Required: Yes
location
Default: global
Description: Specifies the location of the resource. This information will be used for routing and will be part of the resource name.
Required: Yes
Type: string
Location: path
project
Location: path
Description: Identifies the project addressed by this request.
Required: Yes
Type: string
name
Type: string
Description: Fully qualified domain name.
Location: path
Required: Yes
clientOperationId
Type: string
Location: query
Description: For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
Parameter Order:
Description: Deletes a previously created ResourceRecordSet.
Scopes:
Flat Path: dns/v2/projects/{project}/locations/{location}/managedZones/{managedZone}/rrsets/{name}/{type}
Path: dns/v2/projects/{project}/locations/{location}/managedZones/{managedZone}/rrsets/{name}/{type}
▼ ▲ dns.resourceRecordSets.list
Description: Enumerates ResourceRecordSets that you have created but not yet deleted.
Parameter Order:
Scopes:
Path: dns/v2/projects/{project}/locations/{location}/managedZones/{managedZone}/rrsets
Flat Path: dns/v2/projects/{project}/locations/{location}/managedZones/{managedZone}/rrsets
Parameters:
name
Location: query
Type: string
Description: Restricts the list to return only records with this fully qualified domain name.
managedZone
Location: path
Required: Yes
Description: Identifies the managed zone addressed by this request. Can be the managed zone name or ID.
Type: string
location
Required: Yes
Default: global
Type: string
Description: Specifies the location of the resource. This information will be used for routing and will be part of the resource name.
Location: path
maxResults
Location: query
Format: int32
Type: integer
Description: Optional. Maximum number of results to be returned. If unspecified, the server decides how many results to return.
type
Type: string
Description: Restricts the list to return only records of this type. If present, the "name" parameter must also be present.
Location: query
project
Type: string
Location: path
Description: Identifies the project addressed by this request.
Required: Yes
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
HTTP Method: GET
▼ ▲ dns.resourceRecordSets.create
Parameter Order:
Flat Path: dns/v2/projects/{project}/locations/{location}/managedZones/{managedZone}/rrsets
Description: Creates a new ResourceRecordSet.
HTTP Method: POST
Path: dns/v2/projects/{project}/locations/{location}/managedZones/{managedZone}/rrsets
Parameters:
project
Required: Yes
Description: Identifies the project addressed by this request.
Location: path
Type: string
managedZone
Description: Identifies the managed zone addressed by this request. Can be the managed zone name or ID.
Required: Yes
Location: path
Type: string
clientOperationId
Type: string
Location: query
Description: For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
location
Type: string
Default: global
Location: path
Description: Specifies the location of the resource. This information will be used for routing and will be part of the resource name.
Required: Yes
Scopes:
▼ ▲ dns.resourceRecordSets.get
Scopes:
Parameters:
type
Location: path
Type: string
Description: RRSet type.
Required: Yes
clientOperationId
Type: string
Location: query
Description: For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
location
Location: path
Description: Specifies the location of the resource. This information will be used for routing and will be part of the resource name.
Type: string
Required: Yes
Default: global
project
Description: Identifies the project addressed by this request.
Location: path
Required: Yes
Type: string
managedZone
Required: Yes
Location: path
Description: Identifies the managed zone addressed by this request. Can be the managed zone name or ID.
Type: string
name
Description: Fully qualified domain name.
Type: string
Location: path
Required: Yes
Flat Path: dns/v2/projects/{project}/locations/{location}/managedZones/{managedZone}/rrsets/{name}/{type}
Path: dns/v2/projects/{project}/locations/{location}/managedZones/{managedZone}/rrsets/{name}/{type}
Parameter Order:
HTTP Method: GET
Description: Fetches the representation of an existing ResourceRecordSet.