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