2026-08-04
▼ ▲ ftp.projects.locations.list
Parameter Order : name
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.
HTTP Method : GET
Path : v1alpha/{+name}/locations
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1alpha/projects/{projectsId}/locations
Parameters :
extraLocationTypes
Location : query
Repeated : Yes
Type : string
Description : Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage.
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
pageSize
Description : The maximum number of results to return. If not set, the service selects a default.
Location : query
Type : integer
Format : int32
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
name
Type : string
Description : The resource that owns the locations collection, if applicable.
Pattern : ^projects/[^/]+$
Location : path
Required : Yes
▼ ▲ ftp.projects.locations.get
Parameters :
name
Description : Resource name for the location.
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
Path : v1alpha/{+name}
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}
HTTP Method : GET
Description : Gets information about a location.
Parameter Order : name
▼ ▲ ftp.projects.locations.operations.get
Parameter Order : name
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.
HTTP Method : GET
Path : v1alpha/{+name}
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}
Parameters :
name
Location : path
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/operations/[^/]+$
Description : The name of the operation resource.
Type : string
▼ ▲ ftp.projects.locations.operations.cancel
Parameters :
name
Type : string
Location : path
Required : Yes
Description : The name of the operation resource to be cancelled.
Pattern : ^projects/[^/]+/locations/[^/]+/operations/[^/]+$
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel
Path : v1alpha/{+name}:cancel
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : name
HTTP Method : POST
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`.
▼ ▲ ftp.projects.locations.operations.list
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/operations
Path : v1alpha/{+name}/operations
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
pageToken
Location : query
Type : string
Description : The standard list page token.
returnPartialSuccess
Location : query
Type : boolean
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
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+$
Description : The name of the operation's parent resource.
Location : path
Required : Yes
filter
Description : The standard list filter.
Location : query
Type : string
pageSize
Location : query
Type : integer
Format : int32
Description : The standard list page size.
Description : Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
HTTP Method : GET
Parameter Order : name
▼ ▲ ftp.projects.locations.operations.delete
HTTP Method : DELETE
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
Parameters :
name
Pattern : ^projects/[^/]+/locations/[^/]+/operations/[^/]+$
Description : The name of the operation resource to be deleted.
Location : path
Required : Yes
Type : string
Path : v1alpha/{+name}
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}
▼ ▲ ftp.projects.locations.servers.users.create
Parameter Order : parent
Description : Creates a new User in a given project and location and Server.
HTTP Method : POST
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/servers/{serversId}/users
Path : v1alpha/{+parent}/users
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
parent
Location : path
Required : Yes
Description : Required. Value for parent.
Pattern : ^projects/[^/]+/locations/[^/]+/servers/[^/]+$
Type : string
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 will know to ignore the request if it has already been completed. The server will guarantee 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 original operation with the same request ID was received, and if so, will ignore 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
userId
Location : query
Type : string
Description : Required. Id of the requesting object If auto-generating Id server-side, remove this field and server_id from the method_signature of Create RPC
▼ ▲ ftp.projects.locations.servers.users.list
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/servers/{serversId}/users
Path : v1alpha/{+parent}/users
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
pageToken
Location : query
Type : string
Description : Optional. A token identifying a page of results the user should return.
parent
Type : string
Location : path
Required : Yes
Description : Required. Parent value for ListUsersRequest
Pattern : ^projects/[^/]+/locations/[^/]+/servers/[^/]+$
pageSize
Location : query
Type : integer
Format : int32
Description : Optional. Requested page size. User may return fewer items than requested. The maximum value is 1000; The default value is 50 if the field is omitted (or set to 0).
view
Type : string
Enum Descriptions :
Location : query
Enum :
Description : Optional. The view of the User resource to return.
filter
Description : Optional. Filtering results
Location : query
Type : string
orderBy
Description : Optional. Hint for how to order the results
Location : query
Type : string
Description : Lists Users in a given project and location.
HTTP Method : GET
Parameter Order : parent
▼ ▲ ftp.projects.locations.servers.users.get
Parameters :
name
Type : string
Description : Required. Name of the resource
Pattern : ^projects/[^/]+/locations/[^/]+/servers/[^/]+/users/[^/]+$
Location : path
Required : Yes
view
Enum :
Description : Optional. The view of the User resource to return.
Location : query
Enum Descriptions :
Type : string
Path : v1alpha/{+name}
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/servers/{serversId}/users/{usersId}
HTTP Method : GET
Description : Gets details of a single User.
Parameter Order : name
▼ ▲ ftp.projects.locations.servers.users.patch
Parameters :
name
Location : path
Required : Yes
Description : Identifier. User-friendly name via which User will be identified. projects/{project}/locations/{location}/servers/{server}/users/{user}
Pattern : ^projects/[^/]+/locations/[^/]+/servers/[^/]+/users/[^/]+$
Type : string
updateMask
Location : query
Type : string
Format : google-fieldmask
Description : Optional. Field mask is used to specify the fields to be overwritten in the User 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 present in the request will be overwritten.
Path : v1alpha/{+name}
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/servers/{serversId}/users/{usersId}
HTTP Method : PATCH
Description : Updates the parameters of a single User.
Parameter Order : name
▼ ▲ ftp.projects.locations.servers.users.delete
Parameter Order : name
Description : Deletes a single User.
HTTP Method : DELETE
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/servers/{serversId}/users/{usersId}
Path : v1alpha/{+name}
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
name
Type : string
Description : Required. Name of the resource
Pattern : ^projects/[^/]+/locations/[^/]+/servers/[^/]+/users/[^/]+$
Location : path
Required : Yes
force
Location : query
Type : boolean
Description : Optional. If set to true, the request will force the deletion of the User.
▼ ▲ ftp.projects.locations.servers.list
HTTP Method : GET
Description : Lists Servers in a given project and location.
Parameter Order : parent
Parameters :
parent
Type : string
Location : path
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+$
Description : Required. Parent value for ListServersRequest
pageToken
Location : query
Type : string
Description : Optional. A token identifying a page of results the server should return.
filter
Location : query
Type : string
Description : Optional. Filtering results
orderBy
Description : Optional. Hint for how to order the results
Location : query
Type : string
view
Enum Descriptions :
Type : string
Description : Optional. The view of the Server resource to return.
Enum :
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
Path : v1alpha/{+parent}/servers
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/servers
▼ ▲ ftp.projects.locations.servers.create
Description : Creates a new Server in a given project and location.
HTTP Method : POST
Parameter Order : parent
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/servers
Path : v1alpha/{+parent}/servers
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
serverId
Description : Required. Id of the requesting object If auto-generating Id server-side, remove this field and server_id from the method_signature of Create RPC
Location : query
Type : string
parent
Location : path
Required : Yes
Description : Required. Value for parent.
Pattern : ^projects/[^/]+/locations/[^/]+$
Type : string
requestId
Location : query
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 will know to ignore the request if it has already been completed. The server will guarantee 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 original operation with the same request ID was received, and if so, will ignore 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).
▼ ▲ ftp.projects.locations.servers.stop
HTTP Method : POST
Description : Stops an active Server.
Parameter Order : name
Parameters :
name
Pattern : ^projects/[^/]+/locations/[^/]+/servers/[^/]+$
Description : Required. Name of the resource. Format: `projects/{project}/locations/{location}/servers/{server}`
Location : path
Required : Yes
Type : string
Path : v1alpha/{+name}:stop
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/servers/{serversId}:stop
▼ ▲ ftp.projects.locations.servers.get
Parameter Order : name
HTTP Method : GET
Description : Gets details of a single Server.
Parameters :
name
Description : Required. Name of the resource
Pattern : ^projects/[^/]+/locations/[^/]+/servers/[^/]+$
Location : path
Required : Yes
Type : string
view
Type : string
Enum Descriptions :
Location : query
Description : Optional. The view of the Server resource to return.
Enum :
Path : v1alpha/{+name}
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/servers/{serversId}
▼ ▲ ftp.projects.locations.servers.start
Parameter Order : name
Description : Starts a stopping/stopped Server.
HTTP Method : POST
Path : v1alpha/{+name}:start
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/servers/{serversId}:start
Parameters :
name
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/servers/[^/]+$
Description : Required. Name of the resource Format: `projects/{project}/locations/{location}/servers/{server}`
Location : path
Required : Yes
▼ ▲ ftp.projects.locations.servers.delete
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/servers/{serversId}
Path : v1alpha/{+name}
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
name
Type : string
Location : path
Required : Yes
Description : Required. Name of the resource
Pattern : ^projects/[^/]+/locations/[^/]+/servers/[^/]+$
Description : Deletes a single Server.
HTTP Method : DELETE
Parameter Order : name
▼ ▲ ftp.projects.locations.servers.patch
Parameter Order : name
HTTP Method : PATCH
Description : Updates the parameters of a single Server.
Parameters :
name
Type : string
Location : path
Required : Yes
Description : Identifier. name of resource
Pattern : ^projects/[^/]+/locations/[^/]+/servers/[^/]+$
updateMask
Description : Optional. Field mask is used to specify the fields to be overwritten in the Server 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 present in the request will be overwritten.
Location : query
Type : string
Format : google-fieldmask
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 will know to ignore the request if it has already been completed. The server will guarantee 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 original operation with the same request ID was received, and if so, will ignore 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
Path : v1alpha/{+name}
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/servers/{serversId}