2026-08-19
▼ ▲ ftp.projects.locations.operations.list
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/operations
Description : Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
filter
Description : The standard list filter.
Location : query
Type : string
pageSize
Description : The standard list page size.
Location : query
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.
Location : query
Type : boolean
name
Required : Yes
Description : The name of the operation's parent resource.
Location : path
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+$
pageToken
Description : The standard list page token.
Location : query
Type : string
Path : v1alpha/{+name}/operations
HTTP Method : GET
Parameter Order : name
▼ ▲ ftp.projects.locations.operations.delete
Parameters :
name
Description : The name of the operation resource to be deleted.
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/operations/[^/]+$
Location : path
Type : string
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1alpha/{+name}
HTTP Method : DELETE
Parameter Order : name
Flat Path : v1alpha/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`.
▼ ▲ ftp.projects.locations.operations.cancel
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel
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`.
HTTP Method : POST
Parameter Order : name
Parameters :
name
Location : path
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/operations/[^/]+$
Required : Yes
Description : The name of the operation resource to be cancelled.
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1alpha/{+name}:cancel
▼ ▲ ftp.projects.locations.operations.get
Path : v1alpha/{+name}
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
name
Description : The name of the operation resource.
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/operations/[^/]+$
Location : path
Type : string
Parameter Order : name
HTTP Method : GET
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.
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}
▼ ▲ ftp.projects.locations.servers.create
Description : Creates a new Server in a given project and location.
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/servers
Path : v1alpha/{+parent}/servers
Parameters :
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
parent
Location : path
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+$
Required : Yes
Description : Required. Value for parent.
serverId
Description : Required. A unique ID for the server. Must start with a lowercase letter, and end with a lowercase letter or number. Can contain lowercase letters, numbers, and hyphens. Maximum length is 30 characters.
Location : query
Type : string
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : parent
HTTP Method : POST
▼ ▲ ftp.projects.locations.servers.patch
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
name
Pattern : ^projects/[^/]+/locations/[^/]+/servers/[^/]+$
Location : path
Type : string
Description : Identifier. name of resource
Required : Yes
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
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).
Path : v1alpha/{+name}
HTTP Method : PATCH
Parameter Order : name
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/servers/{serversId}
Description : Updates the parameters of a single Server.
▼ ▲ ftp.projects.locations.servers.get
Parameters :
name
Pattern : ^projects/[^/]+/locations/[^/]+/servers/[^/]+$
Location : path
Type : string
Description : Required. Name of the resource
Required : Yes
view
Enum :
Description : Optional. The view of the Server resource to return.
Enum Descriptions :
Location : query
Type : string
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1alpha/{+name}
HTTP Method : GET
Parameter Order : name
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/servers/{serversId}
Description : Gets details of a single Server.
▼ ▲ ftp.projects.locations.servers.stop
Parameters :
name
Pattern : ^projects/[^/]+/locations/[^/]+/servers/[^/]+$
Location : path
Type : string
Description : Required. Name of the resource. Format: `projects/{project}/locations/{location}/servers/{server}`
Required : Yes
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1alpha/{+name}:stop
HTTP Method : POST
Parameter Order : name
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/servers/{serversId}:stop
Description : Stops an active Server.
▼ ▲ ftp.projects.locations.servers.delete
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/servers/{serversId}
Description : Deletes a single Server.
Parameters :
name
Description : Required. Name of the resource
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/servers/[^/]+$
Location : path
Type : string
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1alpha/{+name}
HTTP Method : DELETE
Parameter Order : name
▼ ▲ ftp.projects.locations.servers.start
Description : Starts a stopping/stopped Server.
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/servers/{serversId}:start
Parameter Order : name
HTTP Method : POST
Path : v1alpha/{+name}:start
Parameters :
name
Pattern : ^projects/[^/]+/locations/[^/]+/servers/[^/]+$
Location : path
Type : string
Description : Required. Name of the resource Format: `projects/{project}/locations/{location}/servers/{server}`
Required : Yes
▼ ▲ ftp.projects.locations.servers.list
Parameter Order : parent
HTTP Method : GET
Path : v1alpha/{+parent}/servers
Parameters :
pageToken
Description : Optional. A token identifying a page of results the server should return.
Location : query
Type : string
orderBy
Description : Optional. Hint for how to order the results
Location : query
Type : string
parent
Location : path
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+$
Required : Yes
Description : Required. Parent value for ListServersRequest
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
view
Description : Optional. The view of the Server resource to return.
Enum :
Location : query
Type : string
Enum Descriptions :
filter
Location : query
Type : string
Description : Optional. Filtering results
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists Servers in a given project and location.
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/servers
▼ ▲ ftp.projects.locations.servers.users.patch
Parameters :
name
Required : Yes
Description : Identifier. User-friendly name via which User will be identified. projects/{project}/locations/{location}/servers/{server}/users/{user}
Location : path
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/servers/[^/]+/users/[^/]+$
updateMask
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.
Location : query
Type : string
Format : google-fieldmask
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1alpha/{+name}
HTTP Method : PATCH
Parameter Order : name
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/servers/{serversId}/users/{usersId}
Description : Updates the parameters of a single User.
▼ ▲ ftp.projects.locations.servers.users.create
Parameter Order : parent
HTTP Method : POST
Path : v1alpha/{+parent}/users
Parameters :
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).
parent
Required : Yes
Description : Required. Value for parent.
Location : path
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/servers/[^/]+$
userId
Description : Required. A unique user ID for the SFTP user. The user ID must start with a lowercase letter and can include lowercase letters, numbers, or hyphens.
Location : query
Type : string
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Creates a new User in a given project and location and Server.
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/servers/{serversId}/users
▼ ▲ ftp.projects.locations.servers.users.delete
Description : Deletes a single User.
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/servers/{serversId}/users/{usersId}
Path : v1alpha/{+name}
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
name
Description : Required. Name of the resource
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/servers/[^/]+/users/[^/]+$
Location : path
Type : string
force
Description : Optional. If set to true, the request will force the deletion of the User.
Location : query
Type : boolean
Parameter Order : name
HTTP Method : DELETE
▼ ▲ ftp.projects.locations.servers.users.get
Path : v1alpha/{+name}
Parameters :
name
Pattern : ^projects/[^/]+/locations/[^/]+/servers/[^/]+/users/[^/]+$
Location : path
Type : string
Description : Required. Name of the resource
Required : Yes
view
Enum :
Description : Optional. The view of the User resource to return.
Enum Descriptions :
Location : query
Type : string
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : name
HTTP Method : GET
Description : Gets details of a single User.
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/servers/{serversId}/users/{usersId}
▼ ▲ ftp.projects.locations.servers.users.list
Parameter Order : parent
HTTP Method : GET
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.
orderBy
Location : query
Type : string
Description : Optional. Hint for how to order the results
filter
Description : Optional. Filtering results
Location : query
Type : string
parent
Required : Yes
Description : Required. Parent value for ListUsersRequest
Location : path
Type : string
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
Description : Optional. The view of the User resource to return.
Enum :
Location : query
Type : string
Enum Descriptions :
Description : Lists Users in a given project and location.
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/servers/{serversId}/users
▼ ▲ ftp.projects.locations.get
Path : v1alpha/{+name}
Parameters :
name
Description : Resource name for the location.
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Type : string
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : name
HTTP Method : GET
Description : Gets information about a location.
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}
▼ ▲ ftp.projects.locations.list
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.
Flat Path : v1alpha/projects/{projectsId}/locations
Parameter Order : name
HTTP Method : GET
Path : v1alpha/{+name}/locations
Parameters :
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
extraLocationTypes
Location : query
Type : string
Repeated : Yes
Description : Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage.
name
Location : path
Type : string
Pattern : ^projects/[^/]+$
Required : Yes
Description : The resource that owns the locations collection, if applicable.
pageSize
Location : query
Type : integer
Format : int32
Description : The maximum number of results to return. If not set, the service selects a default.
filter
Location : query
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).