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