Cloud DNS API (dns:v1beta2)

2026-10-10

11 new methods

Additions

    Methods
  • ▼ ▲ dns.locations.list

      Path : dns/v1beta2/{+name}/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

      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
    • Flat Path : dns/v1beta2/projects/{projectsId}/locations

      Parameters :

        pageSize

          Format : int32

          Type : integer

          Description : The maximum number of results to return. If not set, the service selects a default.

          Location : query

        filter

          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

          Type : string

        extraLocationTypes

          Location : query

          Type : string

          Description : Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage.

          Repeated : Yes

        pageToken

          Type : string

          Location : query

          Description : A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.

        name

          Pattern : ^projects/[^/]+$

          Type : string

          Required : Yes

          Description : The resource that owns the locations collection, if applicable.

          Location : path

  • ▼ ▲ dns.locations.get

  • ▼ ▲ dns.operations.list

      Path : dns/v1beta2/{+name}/operations

      HTTP Method : GET

      Scopes :

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/ndev.clouddns.readwrite
    • Description : Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

      Flat Path : dns/v1beta2/projects/{projectsId}/locations/{locationsId}/operations

      Parameters :

        pageToken

          Type : string

          Location : query

          Description : The standard list page token.

        pageSize

          Location : query

          Description : The standard list page size.

          Type : integer

          Format : int32

        returnPartialSuccess

          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.

          Type : boolean

          Location : query

        name

          Type : string

          Required : Yes

          Description : The name of the operation's parent resource.

          Location : path

          Pattern : ^projects/[^/]+/locations/[^/]+$

        filter

          Description : The standard list filter.

          Type : string

          Location : query

      Parameter Order : name

  • ▼ ▲ dns.operations.delete

      Parameter Order : name

      Parameters :

        name

          Description : The name of the operation resource to be deleted.

          Location : path

          Required : Yes

          Type : string

          Pattern : ^projects/[^/]+/locations/[^/]+/operations/[^/]+$

      Scopes :

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/ndev.clouddns.readwrite
    • Path : dns/v1beta2/{+name}

      Flat Path : dns/v1beta2/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}

      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`.

      HTTP Method : DELETE

  • ▼ ▲ dns.operations.get

      Scopes :

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/ndev.clouddns.readwrite
    • HTTP Method : GET

      Path : dns/v1beta2/{+name}

      Parameters :

        name

          Pattern : ^projects/[^/]+/locations/[^/]+/operations/[^/]+$

          Description : The name of the operation resource.

          Location : path

          Type : string

          Required : Yes

      Parameter Order : name

      Flat Path : dns/v1beta2/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}

      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.

  • ▼ ▲ dns.operations.cancel

      Flat Path : dns/v1beta2/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel

      HTTP Method : POST

      Parameter Order : name

      Parameters :

        name

          Type : string

          Pattern : ^projects/[^/]+/locations/[^/]+/operations/[^/]+$

          Location : path

          Description : The name of the operation resource to be cancelled.

          Required : Yes

      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`.

      Scopes :

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/ndev.clouddns.readwrite
    • Path : dns/v1beta2/{+name}:cancel

  • ▼ ▲ dns.outboundEndpoints.create

      Description : Creates a new Outbound Endpoint.

      HTTP Method : POST

      Path : dns/v1beta2/{+parent}/outboundEndpoints

      Parameters :

        requestId

          Location : query

          Description : Optional. An optional request ID to identify requests.

          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

        parent

          Pattern : ^projects/[^/]+/locations/[^/]+$

          Description : Required. The parent project and location where this OutboundEndpoint will be created. Format: projects/{project}/locations/{location}

          Type : string

          Location : path

          Required : Yes

        outboundEndpointId

          Type : string

          Location : query

          Description : Required. The ID to use for the OutboundEndpoint, which will become the final component of the OutboundEndpoint's resource name.

      Parameter Order : parent

      Flat Path : dns/v1beta2/projects/{projectsId}/locations/{locationsId}/outboundEndpoints

      Scopes :

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/ndev.clouddns.readwrite
  • ▼ ▲ dns.outboundEndpoints.delete

      Parameter Order : name

      Parameters :

        requestId

          Location : query

          Type : string

          Description : Optional. An optional request ID to identify requests.

        name

          Type : string

          Pattern : ^projects/[^/]+/locations/[^/]+/outboundEndpoints/[^/]+$

          Description : Required. The name of the OutboundEndpoint to delete. Format: projects/{project}/locations/{location}/outboundEndpoints/{outboundEndpoint}

          Location : path

          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

      Path : dns/v1beta2/{+name}

      Flat Path : dns/v1beta2/projects/{projectsId}/locations/{locationsId}/outboundEndpoints/{outboundEndpointsId}

      HTTP Method : DELETE

      Scopes :

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/ndev.clouddns.readwrite
    • Description : Deletes a previously created Outbound Endpoint.

  • ▼ ▲ dns.outboundEndpoints.patch

      Scopes :

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/ndev.clouddns.readwrite
    • HTTP Method : PATCH

      Description : Updates an existing Outbound Endpoint.

      Parameter Order : name

      Path : dns/v1beta2/{+name}

      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.

        name

          Pattern : ^projects/[^/]+/locations/[^/]+/outboundEndpoints/[^/]+$

          Description : Identifier. The resource name of the OutboundEndpoint. Format: `projects/{project}/locations/{location}/outboundEndpoints/{outboundEndpoint}`

          Type : string

          Required : Yes

          Location : path

        requestId

          Description : Optional. An optional request ID to identify requests.

          Location : query

          Type : string

        updateMask

          Format : google-fieldmask

          Type : string

          Description : Required. The list of fields to be updated.

          Location : query

      Flat Path : dns/v1beta2/projects/{projectsId}/locations/{locationsId}/outboundEndpoints/{outboundEndpointsId}

  • ▼ ▲ dns.outboundEndpoints.get

  • ▼ ▲ dns.outboundEndpoints.list