Google

Storage Transfer API

Transfers data from external data sources to a Google Cloud Storage bucket or between Google Cloud Storage buckets.

Developer tools#openapi#analytics#media

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

Transfers data from external data sources to a Google Cloud Storage bucket or between Google Cloud Storage buckets.

Endpoints 15

googleServiceAccounts

  • GETReturns the Google service account that is used by Storage Transfer Service to access buckets in the project where…/v1/googleServiceAccounts/:projectIdReturns the Google service account that is used by Storage Transfer Service to access buckets in the project where transfers run or in other projects. Each…

projects.agentPools

  • GETLists agent pools./v1/projects/:projectId/agentPools?filter=string&pageSize=0&pageToken=stringLists agent pools.
  • POSTCreates an agent pool resource./v1/projects/:projectId/agentPools?agentPoolId=stringCreates an agent pool resource.
  • DELETEDeletes an agent pool./v1/:nameDeletes an agent pool.
  • PATCHUpdates an existing agent pool resource./v1/:name?updateMask=stringUpdates an existing agent pool resource.

transferOperations

  • GETLists transfer operations/v1/:name?filter=string&pageSize=0&pageToken=string&returnPartialSuccess=trueLists transfer operations. Operations are ordered by their creation time in reverse chronological order.
  • POSTCancels a transfer/v1/:name:cancelCancels a transfer. Use the transferOperations.get method to check if the cancellation succeeded or if the operation completed despite the cancel request.…
  • POSTPauses a transfer operation./v1/:name:pausePauses a transfer operation.
  • POSTResumes a transfer operation that is paused./v1/:name:resumeResumes a transfer operation that is paused.

transferJobs

  • GETLists transfer jobs./v1/transferJobs?filter=string&pageSize=0&pageToken=stringLists transfer jobs.
  • POSTCreates a transfer job that runs periodically./v1/transferJobsCreates a transfer job that runs periodically.
  • GETGets a transfer job./v1/:jobName?projectId=stringGets a transfer job.
  • DELETEDeletes a transfer job/v1/:jobName?projectId=stringDeletes a transfer job. Deleting a transfer job sets its status to DELETED.
  • PATCHUpdates a transfer job/v1/:jobNameUpdates a transfer job. Updating a job's transfer spec does not affect transfer operations that are running already. Note: The job's status field can be…
  • POSTStarts a new operation for the specified transfer job/v1/:jobName:runStarts a new operation for the specified transfer job. A TransferJob has a maximum of one active TransferOperation. If this method is called while a…

API details

Base URL
https://storagetransfer.googleapis.com
Authentication
OAuth 2.0 (authorization code flow) with 1 scope
An API key in the key query parameter
Operations
15 operations on 9 pathsPOST 6GET 5PATCH 2DELETE 2
Main resources
transferJobs 6projects.agentPools 4transferOperations 4googleServiceAccounts 1
Response formats
application/json
Description format
Google API Discovery, API version v1

How to test the Storage Transfer 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 Storage Transfer 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 “Returns the Google service account that is used by Storage Transfer Service to access buckets in the project where…” (GET /v1/googleServiceAccounts/:projectId), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Storage Transfer API?

Transfers data from external data sources to a Google Cloud Storage bucket or between Google Cloud Storage buckets. It is listed under Developer tools and has 15 endpoints.

Who publishes the Storage Transfer 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 Storage Transfer API?

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

How do I authenticate with the Storage Transfer 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 Storage Transfer API have?

15 operations on 9 paths (6 POST, 5 GET, 2 PATCH, 2 DELETE). The largest groups are transferJobs, projects.agentPools, transferOperations, googleServiceAccounts.

Is forking the Storage Transfer 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.