2026-04-02
▼ ▲ alloydb.projects.locations.endpoints.list
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/endpoints
Description : Lists Endpoints in a given project and location.
Path : v1alpha/{+parent}/endpoints
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
pageToken
Type : string
Description : Optional. A page token, received from a previous `ListEndpoints` call. This should be provided to retrieve the subsequent page. This field is currently not supported, its value will be ignored if passed.
Location : query
pageSize
Description : Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
Location : query
Type : integer
Format : int32
filter
Description : Optional. Filtering results. This field is currently not supported, its value will be ignored if passed.
Location : query
Type : string
orderBy
Type : string
Description : Optional. Hint for how to order the results
Location : query
parent
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+$
Type : string
Description : Required. The name of the parent resource. For the required format, see the comment on the Endpoint.name field. Additionally, you can perform an aggregated list operation by specifying a value with the following format: * projects/{project}/locations/-
Location : path
HTTP Method : GET
▼ ▲ alloydb.projects.locations.endpoints.get
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}
Description : Gets details of a single Endpoint.
Path : v1alpha/{+name}
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : GET
Parameters :
name
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$
Type : string
Description : Required. The name of the resource. For the required format, see the comment on the Endpoint.name field.
Location : path
▼ ▲ alloydb.projects.locations.endpoints.delete
Path : v1alpha/{+name}
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}
Description : Deletes a single Endpoint.
HTTP Method : DELETE
Parameters :
name
Description : Required. The name of the resource. For the required format, see the comment on the Endpoint.name field.
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$
Type : string
Required : Yes
etag
Description : 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.
Location : query
Type : string
validateOnly
Type : boolean
Description : Optional. If set, the backend validates the request, but doesn't actually execute it.
Location : query
requestId
Description : 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).
Location : query
Type : string
▼ ▲ alloydb.projects.locations.endpoints.create
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/endpoints
Description : Creates a new Endpoint in a given project and location.
Path : v1alpha/{+parent}/endpoints
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : POST
Parameters :
validateOnly
Type : boolean
Description : Optional. If set, the backend validates the request, but doesn't actually execute it.
Location : query
endpointId
Description : Required. ID of the requesting object.
Location : query
Type : string
requestId
Type : string
Description : 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 since 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).
Location : query
parent
Description : Required. The location of the new endpoint. For the required format, see the comment on the Endpoint.name field.
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+$
Type : string
Required : Yes
▼ ▲ alloydb.projects.locations.endpoints.patch
Path : v1alpha/{+name}
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}
Description : Updates the parameters of a single Endpoint.
HTTP Method : PATCH
Parameters :
requestId
Type : string
Description : 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 since 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).
Location : query
allowMissing
Description : Optional. If set to true, update succeeds even if endpoint is not found. In that case, a new endpoint is created and `update_mask` is ignored.
Location : query
Type : boolean
name
Required : Yes
Description : Output only. Identifier. The name of the endpoint resource with the format: * projects/{project}/locations/{region}/endpoints/{endpoint_id} where the endpoint ID segment should satisfy the regex expression `[a-z0-9-]+`. For more details see https://google.aip.dev/122. The prefix of the endpoint resource name is the name of the parent resource: * projects/{project}/locations/{region}
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$
Type : string
updateMask
Description : Optional. Field mask is used to specify the fields to be overwritten in the Endpoint resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.
Location : query
Type : string
Format : google-fieldmask
validateOnly
Description : Optional. If set, the backend validates the request, but doesn't actually execute it.
Location : query
Type : boolean