Cloud Filestore API
The Cloud Filestore API is used for creating and managing cloud file servers.
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
The Cloud Filestore API is used for creating and managing cloud file servers.
Endpoints 23
projects.locations.volumePools.volumes
- GETGets the details of a specific volume.
/v1/:nameGets the details of a specific volume. - DELETEDeletes a volume.
/v1/:nameDeletes a volume. - PATCHUpdates the settings of a specific volume.
/v1/:name?updateMask=stringUpdates the settings of a specific volume. - GETLists all volumes for a specified volume pool.
/v1/:parent/volumes?filter=string&orderBy=string&pageSize=0&pageToken=stringLists all volumes for a specified volume pool. - POSTCreates a volume.
/v1/:parent/volumes?volumeId=stringCreates a volume. - POSTCreates a volume in a volume pool from an existing data source (such as a Filestore backup).
/v1/:parent/volumes:createFromSourceCreates a volume in a volume pool from an existing data source (such as a Filestore backup). - POSTUnfreezes a volume.
/v1/:name:unfreezeUnfreezes a volume.
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.backups
- GETLists all backups in a project for either a specified location or for all locations.
/v1/:parent/backups?filter=string&orderBy=string&pageSize=0&pageToken=stringLists all backups in a project for either a specified location or for all locations. - POSTCreates a backup.
/v1/:parent/backups?backupId=stringCreates a backup.
projects.locations.instances
- GETLists all instances in a project for either a specified location or for all locations.
/v1/:parent/instances?filter=string&orderBy=string&pageSize=0&pageToken=stringLists all instances in a project for either a specified location or for all locations. - POSTCreates an instance
/v1/:parent/instances?instanceId=stringCreates an instance. When creating from a backup, the capacity of the new instance needs to be equal to or larger than the capacity of the backup (and also… - POSTPause the standby instance (replica)
/v1/:name:pauseReplicaPause the standby instance (replica). WARNING: This operation makes the standby instance's NFS filesystem writable. Any data written to the standby instance… - POSTPromote the standby instance (replica).
/v1/:name:promoteReplicaPromote the standby instance (replica). - POSTRestores an existing instance's file share from a backup
/v1/:name:restoreRestores an existing instance's file share from a backup. The capacity of the instance needs to be equal to or larger than the capacity of the backup (and… - POSTResume the standby instance (replica)
/v1/:name:resumeReplicaResume the standby instance (replica). WARNING: Any data written to the standby instance while paused will be lost when the replica is resumed. - POSTRevert an existing instance's file system to a specified snapshot.
/v1/:name:revertRevert an existing instance's file system to a specified snapshot.
projects.locations.instances.snapshots
- GETLists all snapshots in a project for either a specified location or for all locations.
/v1/:parent/snapshots?filter=string&orderBy=string&pageSize=0&pageToken=string&returnPartialSuccess=trueLists all snapshots in a project for either a specified location or for all locations. - POSTCreates a snapshot.
/v1/:parent/snapshots?snapshotId=stringCreates a snapshot.
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.volumePools
- GETLists all volume pools in a project for either a specified location or for all locations.
/v1/:parent/volumePools?filter=string&orderBy=string&pageSize=0&pageToken=stringLists all volume pools in a project for either a specified location or for all locations. - POSTCreates a volume pool.
/v1/:parent/volumePools?volumePoolId=stringCreates a volume pool.
API details
- Base URL
https://file.googleapis.com- Authentication
- OAuth 2.0 (authorization code flow) with 1 scope
An API key in the key query parameter - Operations
- 23 operations on 16 pathsPOST 13GET 8PATCH 1DELETE 1
- Main resources
- projects.locations.instances 7projects.locations.volumePools.volumes 7projects.locations.backups 2projects.locations.instances.snapshots 2projects.locations.operations 2projects.locations.volumePools 2projects.locations 1
- Response formats
application/json- Description format
- Google API Discovery, API version
v1 - Links
- Documentation · OpenAPI document
- Listed from
- Google API Discovery document (googleapis/discovery-artifact-manager) (Apache-2.0)
How to test the Cloud Filestore API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Cloud Filestore API collection, without the publisher's secrets.
- 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.
- Send a requestPick an endpoint, for example “Gets the details of a specific volume.” (GET /v1/:name), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Cloud Filestore API?
The Cloud Filestore API is used for creating and managing cloud file servers. It is listed under Developer tools and has 23 endpoints.
Who publishes the Cloud Filestore 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 Filestore API?
Requests go to https://file.googleapis.com. Endpoint paths are added to this base URL.
How do I authenticate with the Cloud Filestore 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 Filestore API have?
23 operations on 16 paths (13 POST, 8 GET, 1 PATCH, 1 DELETE). The largest groups are projects.locations.instances, projects.locations.volumePools.volumes, projects.locations.backups, projects.locations.instances.snapshots.
Is forking the Cloud Filestore API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.