Google

Cloud FTP API

A managed, cloud-native solution to move data in and out of Google Cloud by using SSH File Transfer Protocol (SFTP).

Developer tools#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

A managed, cloud-native solution to move data in and out of Google Cloud by using SSH File Transfer Protocol (SFTP).

Endpoints 12

projects.locations.servers.users

  • GETGets details of a single User./v1/:name?view=USER_VIEW_UNSPECIFIEDGets details of a single User.
  • DELETEDeletes a single User./v1/:name?force=trueDeletes a single User.
  • PATCHUpdates the parameters of a single User./v1/:name?updateMask=stringUpdates the parameters of a single User.
  • GETLists Users in a given project and location./v1/:parent/users?filter=string&orderBy=string&pageSize=0&pageToken=string&view=USER_VIEW_UNSPECIFIEDLists Users in a given project and location.
  • POSTCreates a new User in a given project and location and Server./v1/:parent/users?requestId=string&userId=stringCreates a new User in a given project and location and Server.

projects.locations

  • GETLists information about the supported locations for this service/v1/:name/locations?extraLocationTypes=string&filter=string&pageSize=0&pageToken=stringLists information about the supported locations for this service. This method lists locations based on the resource scope provided in the…

projects.locations.operations

  • POSTStarts asynchronous cancellation on a long-running operation/v1/:name:cancelStarts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the…
  • GETLists operations that match the specified filter in the request/v1/:name/operations?filter=string&pageSize=0&pageToken=string&returnPartialSuccess=trueLists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

projects.locations.servers

  • GETLists Servers in a given project and location./v1/:parent/servers?filter=string&orderBy=string&pageSize=0&pageToken=string&view=SERVER_VIEW_UNSPECIFIEDLists Servers in a given project and location.
  • POSTCreates a new Server in a given project and location./v1/:parent/servers?requestId=string&serverId=stringCreates a new Server in a given project and location.
  • POSTStarts a stopping/stopped Server./v1/:name:startStarts a stopping/stopped Server.
  • POSTStops an active Server./v1/:name:stopStops an active Server.

API details

Base URL
https://ftp.googleapis.com
Authentication
OAuth 2.0 (authorization code flow) with 1 scope
An API key in the key query parameter
Operations
12 operations on 8 pathsGET 5POST 5PATCH 1DELETE 1
Main resources
projects.locations.servers.users 5projects.locations.servers 4projects.locations.operations 2projects.locations 1
Response formats
application/json
Description format
Google API Discovery, API version v1

How to test the Cloud FTP API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Cloud FTP API collection, without the publisher's secrets.
  3. Add your credentialsThis API uses OAuth 2.0 (authorization code flow) with 1 scope. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Gets details of a single User.” (GET /v1/:name?view=USER_VIEW_UNSPECIFIED), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Cloud FTP API?

A managed, cloud-native solution to move data in and out of Google Cloud by using SSH File Transfer Protocol (SFTP). It is listed under Developer tools and has 12 endpoints.

Who publishes the Cloud FTP API?

It is listed from Google's public API description (an OpenAPI document), not published by Google on Swastik Codes. Anyone who controls googleapis.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Cloud FTP API?

Requests go to https://ftp.googleapis.com. Endpoint paths are added to this base URL.

How do I authenticate with the Cloud FTP API?

It accepts 2 methods: OAuth 2.0 (authorization code flow) with 1 scope; an API key in the key query parameter.

How many endpoints does the Cloud FTP API have?

12 operations on 8 paths (5 GET, 5 POST, 1 PATCH, 1 DELETE). The largest groups are projects.locations.servers.users, projects.locations.servers, projects.locations.operations, projects.locations.

Is forking the Cloud FTP API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.