2026-10-10
▼ ▲ dns.locations.list
Flat Path : dns/v1/projects/{projectsId}/locations
Description : Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.
Parameter Order : name
HTTP Method : GET
Parameters :
name
Required : Yes
Type : string
Location : path
Pattern : ^projects/[^/]+$
Description : The resource that owns the locations collection, if applicable.
extraLocationTypes
Description : Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage.
Type : string
Repeated : Yes
Location : query
filter
Type : string
Description : A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).
Location : query
pageToken
Description : A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.
Location : query
Type : string
pageSize
Location : query
Description : The maximum number of results to return. If not set, the service selects a default.
Type : integer
Format : int32
Scopes :
Path : dns/v1/{+name}/locations
▼ ▲ dns.locations.get
Description : Gets information about a location.
Parameter Order : name
Path : dns/v1/{+name}
Flat Path : dns/v1/projects/{projectsId}/locations/{locationsId}
Scopes :
Parameters :
name
Description : Resource name for the location.
Required : Yes
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+$
Type : string
HTTP Method : GET
▼ ▲ dns.operations.delete
Path : dns/v1/{+name}
Scopes :
Description : Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
Parameter Order : name
Flat Path : dns/v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}
HTTP Method : DELETE
Parameters :
name
Pattern : ^projects/[^/]+/locations/[^/]+/operations/[^/]+$
Type : string
Location : path
Description : The name of the operation resource to be deleted.
Required : Yes
▼ ▲ dns.operations.get
HTTP Method : GET
Parameters :
name
Required : Yes
Location : path
Description : The name of the operation resource.
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/operations/[^/]+$
Path : dns/v1/{+name}
Flat Path : dns/v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}
Scopes :
Description : Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
Parameter Order : name
▼ ▲ dns.operations.cancel
HTTP Method : POST
Parameters :
name
Description : The name of the operation resource to be cancelled.
Required : Yes
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/operations/[^/]+$
Type : string
Parameter Order : name
Scopes :
Description : Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
Path : dns/v1/{+name}:cancel
Flat Path : dns/v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel
▼ ▲ dns.operations.list
Parameter Order : name
Parameters :
pageToken
Type : string
Location : query
Description : The standard list page token.
returnPartialSuccess
Type : boolean
Location : query
Description : When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
name
Location : path
Description : The name of the operation's parent resource.
Required : Yes
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+$
pageSize
Description : The standard list page size.
Format : int32
Type : integer
Location : query
filter
Type : string
Location : query
Description : The standard list filter.
HTTP Method : GET
Path : dns/v1/{+name}/operations
Description : Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
Scopes :
Flat Path : dns/v1/projects/{projectsId}/locations/{locationsId}/operations
▼ ▲ dns.outboundEndpoints.create
Parameters :
outboundEndpointId
Description : Required. The ID to use for the OutboundEndpoint, which will become the final component of the OutboundEndpoint's resource name.
Type : string
Location : query
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
parent
Required : Yes
Location : path
Type : string
Description : Required. The parent project and location where this OutboundEndpoint will be created. Format: projects/{project}/locations/{location}
Pattern : ^projects/[^/]+/locations/[^/]+$
requestId
Location : query
Type : string
Description : Optional. An optional request ID to identify requests.
Description : Creates a new Outbound Endpoint.
HTTP Method : POST
Path : dns/v1/{+parent}/outboundEndpoints
Flat Path : dns/v1/projects/{projectsId}/locations/{locationsId}/outboundEndpoints
Parameter Order : parent
Scopes :
▼ ▲ dns.outboundEndpoints.list
Parameter Order : parent
HTTP Method : GET
Parameters :
parent
Type : string
Description : Required. The parent project and location from which to list resources. Format: projects/{project}/locations/{location}
Required : Yes
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+$
pageToken
Type : string
Location : query
Description : Optional. A page token received from a previous List call.
clientOperationId
Type : string
Location : query
pageSize
Type : integer
Format : int32
Description : Optional. The maximum number of results to return.
Location : query
Description : Enumerates all Outbound Endpoints associated with a project.
Flat Path : dns/v1/projects/{projectsId}/locations/{locationsId}/outboundEndpoints
Scopes :
Path : dns/v1/{+parent}/outboundEndpoints
▼ ▲ dns.outboundEndpoints.get
Path : dns/v1/{+name}
Parameter Order : name
Flat Path : dns/v1/projects/{projectsId}/locations/{locationsId}/outboundEndpoints/{outboundEndpointsId}
Description : Fetches the representation of an existing Outbound Endpoint.
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
name
Description : Required. The name of the OutboundEndpoint to retrieve. Format: projects/{project}/locations/{location}/outboundEndpoints/{outboundEndpoint}
Location : path
Type : string
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/outboundEndpoints/[^/]+$
HTTP Method : GET
Scopes :
▼ ▲ dns.outboundEndpoints.patch
Path : dns/v1/{+name}
Parameters :
requestId
Description : Optional. An optional request ID to identify requests.
Type : string
Location : query
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
name
Required : Yes
Location : path
Description : Identifier. The resource name of the OutboundEndpoint. Format: `projects/{project}/locations/{location}/outboundEndpoints/{outboundEndpoint}`
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/outboundEndpoints/[^/]+$
updateMask
Description : Required. The list of fields to be updated.
Type : string
Location : query
Format : google-fieldmask
HTTP Method : PATCH
Flat Path : dns/v1/projects/{projectsId}/locations/{locationsId}/outboundEndpoints/{outboundEndpointsId}
Scopes :
Description : Updates an existing Outbound Endpoint.
Parameter Order : name
▼ ▲ dns.outboundEndpoints.delete
Flat Path : dns/v1/projects/{projectsId}/locations/{locationsId}/outboundEndpoints/{outboundEndpointsId}
Description : Deletes a previously created Outbound Endpoint.
Parameter Order : name
Path : dns/v1/{+name}
Scopes :
Parameters :
requestId
Description : Optional. An optional request ID to identify requests.
Type : string
Location : query
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
name
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/outboundEndpoints/[^/]+$
Required : Yes
Type : string
Description : Required. The name of the OutboundEndpoint to delete. Format: projects/{project}/locations/{location}/outboundEndpoints/{outboundEndpoint}
HTTP Method : DELETE