Method: projects.locations.endpoints.delete

Deletes a single Endpoint.

HTTP request


DELETE https://alloydb.googleapis.com/v1beta/{name=projects/*/locations/*/endpoints/*}

The URLs use gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. The name of the resource. For the required format, see the comment on the Endpoint.name field.

Authorization requires the following IAM permission on the specified resource name:

  • alloydb.endpoints.delete

Query parameters

Parameters
requestId

string

Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees that for at least 60 minutes after the first request.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
etag

string

Optional. The current etag of the Endpoint. If an etag is provided and does not match the current etag of the Endpoint, deletion will be blocked and an ABORTED error will be returned.
validateOnly

boolean

Optional. If set, the backend validates the request, but doesn't actually execute it.

Request body

The request body must be empty.

Response body

If successful, the response body contains an instance of Operation.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/alloydb
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.