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