Cloud Storage for Firebase API
The Cloud Storage for Firebase API enables programmatic management of Cloud Storage buckets for use in Firebase projects
COMMUNITYBEARER0 INSTALLS
OpenAPI Specificationv3.0
{
"openapi": "3.0.0",
"servers": [
{
"url": "https://firebasestorage.googleapis.com/"
}
],
"info": {
"contact": {
"name": "Google",
"url": "https://google.com",
"x-twitter": "youtube"
},
"description": "The Cloud Storage for Firebase API enables programmatic management of Cloud Storage buckets for use in Firebase projects",
"license": {
"name": "Creative Commons Attribution 3.0",
"url": "http://creativecommons.org/licenses/by/3.0/"
},
"termsOfService": "https://developers.google.com/terms/",
"title": "Cloud Storage for Firebase API",
"version": "v1beta",
"x-apisguru-categories": [
"analytics",
"media"
],
"x-logo": {
"url": "https://api.apis.guru/v2/cache/logo/https_upload.wikimedia.org_wikipedia_commons_e_e1_YouTube_play_buttom_icon_%282013-2017%29.svg"
},
"x-origin": [
{
"format": "google",
"url": "https://firebasestorage.googleapis.com/$discovery/rest?version=v1beta",
"version": "v1"
}
],
"x-providerName": "googleapis.com",
"x-serviceName": "firebasestorage"
},
"externalDocs": {
"url": "https://firebase.google.com/docs/storage"
},
"tags": [
{
"name": "projects"
}
],
"paths": {
"/v1beta/{bucket}:addFirebase": {
"parameters": [
{
"$ref": "#/components/parameters/_.xgafv"
},
{
"$ref": "#/components/parameters/access_token"
},
{
"$ref": "#/components/parameters/alt"
},
{
"$ref": "#/components/parameters/callback"
},
{
"$ref": "#/components/parameters/fields"
},
{
"$ref": "#/components/parameters/key"
},
{
"$ref": "#/components/parameters/oauth_token"
},
{
"$ref": "#/components/parameters/prettyPrint"
},
{
"$ref": "#/components/parameters/quotaUser"
},
{
"$ref": "#/components/parameters/upload_protocol"
},
{
"$ref": "#/components/parameters/uploadType"
}
],
"post": {
"description": "Links a Google Cloud Storage bucket to a Firebase project.",
"operationId": "firebasestorage.projects.buckets.addFirebase",
"parameters": [
{
"description": "Required. Resource name of the bucket, mirrors the ID of the underlying Google Cloud Storage bucket, `projects/{project_number}/buckets/{bucket_id}`.",
"in": "path",
"name": "bucket",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AddFirebaseRequest"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Bucket"
}
}
},
"description": "Successful response"
}
},
"security": [
{
"Oauth2": [
"https://www.googleapis.com/auth/cloud-platform"
],
"Oauth2c": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
{
"Oauth2": [
"https://www.googleapis.com/auth/firebase"
],
"Oauth2c": [
"https://www.googleapis.com/auth/firebase"
]
}
],
"tags": [
"projects"
]
}
},
"/v1beta/{bucket}:removeFirebase": {
"parameters": [
{
"$ref": "#/components/parameters/_.xgafv"
},
{
"$ref": "#/components/parameters/access_token"
},
{
"$ref": "#/components/parameters/alt"
},
{
"$ref": "#/components/parameters/callback"
},
{
"$ref": "#/components/parameters/fields"
},
{
"$ref": "#/components/parameters/key"
},
{
"$ref": "#/components/parameters/oauth_token"
},
{
"$ref": "#/components/parameters/prettyPrint"
},
{
"$ref": "#/components/parameters/quotaUser"
},
{
"$ref": "#/components/parameters/upload_protocol"
},
{
"$ref": "#/components/parameters/uploadType"
}
],
"post": {
"description": "Unlinks a linked Google Cloud Storage bucket from a Firebase project.",
"operationId": "firebasestorage.projects.buckets.removeFirebase",
"parameters": [
{
"description": "Required. Resource name of the bucket, mirrors the ID of the underlying Google Cloud Storage bucket, `projects/{project_number}/buckets/{bucket_id}`.",
"in": "path",
"name": "bucket",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RemoveFirebaseRequest"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Empty"
}
}
},
"description": "Successful response"
}
},
"security": [
{
"Oauth2": [
"https://www.googleapis.com/auth/cloud-platform"
],
"Oauth2c": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
{
"Oauth2": [
"https://www.googleapis.com/auth/firebase"
],
"Oauth2c": [
"https://www.googleapis.com/auth/firebase"
]
}
],
"tags": [
"projects"
]
}
},
"/v1beta/{name}": {
"get": {
"description": "Gets a single linked storage bucket.",
"operationId": "firebasestorage.projects.buckets.get",
"parameters": [
{
"description": "Required. Resource name of the bucket, mirrors the ID of the underlying Google Cloud Storage bucket, `projects/{project_number}/buckets/{bucket_id}`.",
"in": "path",
"name": "name",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Bucket"
}
}
},
"description": "Successful response"
}
},
"security": [
{
"Oauth2": [
"https://www.googleapis.com/auth/cloud-platform"
],
"Oauth2c": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
{
"Oauth2": [
"https://www.googleapis.com/auth/firebase"
],
"Oauth2c": [
"https://www.googleapis.com/auth/firebase"
]
}
],
"tags": [
"projects"
]
},
"parameters": [
{
"$ref": "#/components/parameters/_.xgafv"
},
{
"$ref": "#/components/parameters/access_token"
},
{
"$ref": "#/components/parameters/alt"
},
{
"$ref": "#/components/parameters/callback"
},
{
"$ref": "#/components/parameters/fields"
},
{
"$ref": "#/components/parameters/key"
},
{
"$ref": "#/components/parameters/oauth_token"
},
{
"$ref": "#/components/parameters/prettyPrint"
},
{
"$ref": "#/components/parameters/quotaUser"
},
{
"$ref": "#/components/parameters/upload_protocol"
},
{
"$ref": "#/components/parameters/uploadType"
}
]
},
"/v1beta/{parent}/buckets": {
"get": {
"description": "Lists the linked storage buckets for a project.",
"operationId": "firebasestorage.projects.buckets.list",
"parameters": [
{
"description": "Required. Resource name of the parent Firebase project, `projects/{project_number}`.",
"in": "path",
"name": "parent",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "The maximum number of buckets to return. If not set, the server will use a reasonable default.",
"in": "query",
"name": "pageSize",
"schema": {
"type": "integer"
}
},
{
"description": "A page token, received from a previous `ListBuckets` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListBuckets` must match the call that provided the page token.",
"in": "query",
"name": "pageToken",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ListBucketsResponse"
}
}
},
"description": "Successful response"
}
},
"security": [
{
"Oauth2": [
"https://www.googleapis.com/auth/cloud-platform"
],
"Oauth2c": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
{
"Oauth2": [
"https://www.googleapis.com/auth/firebase"
],
"Oauth2c": [
"https://www.googleapis.com/auth/firebase"
]
}
],
"tags": [
"projects"
]
},
"parameters": [
{
"$ref": "#/components/parameters/_.xgafv"
},
{
"$ref": "#/components/parameters/access_token"
},
{
"$ref": "#/components/parameters/alt"
},
{
"$ref": "#/components/parameters/callback"
},
{
"$ref": "#/components/parameters/fields"
},
{
"$ref": "#/components/parameters/key"
},
{
"$ref": "#/components/parameters/oauth_token"
},
{
"$ref": "#/components/parameters/prettyPrint"
},
{
"$ref": "#/components/parameters/quotaUser"
},
{
"$ref": "#/components/parameters/upload_protocol"
},
{
"$ref": "#/components/parameters/uploadType"
}
]
}
},
"components": {
"parameters": {
"_.xgafv": {
"description": "V1 error format.",
"in": "query",
"name": "$.xgafv",
"schema": {
"enum": [
"1",
"2"
],
"type": "string"
}
},
"access_token": {
"description": "OAuth access token.",
"in": "query",
"name": "access_token",
"schema": {
"type": "string"
}
},
"alt": {
"description": "Data format for response.",
"in": "query",
"name": "alt",
"schema": {
"enum": [
"json",
"media",
"proto"
],
"type": "string"
}
},
"callback": {
"description": "JSONP",
"in": "query",
"name": "callback",
"schema": {
"type": "string"
}
},
"fields": {
"description": "Selector specifying which fields to include in a partial response.",
"in": "query",
"name": "fields",
"schema": {
"type": "string"
}
},
"key": {
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
"in": "query",
"name": "key",
"schema": {
"type": "string"
}
},
"oauth_token": {
"description": "OAuth 2.0 token for the current user.",
"in": "query",
"name": "oauth_token",
"schema": {
"type": "string"
}
},
"prettyPrint": {
"description": "Returns response with indentations and line breaks.",
"in": "query",
"name": "prettyPrint",
"schema": {
"type": "boolean"
}
},
"quotaUser": {
"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
"in": "query",
"name": "quotaUser",
"schema": {
"type": "string"
}
},
"uploadType": {
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"in": "query",
"name": "uploadType",
"schema": {
"type": "string"
}
},
"upload_protocol": {
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"in": "query",
"name": "upload_protocol",
"schema": {
"type": "string"
}
}
},
"schemas": {
"AddFirebaseRequest": {
"description": "The request used to link a Google Cloud Storage bucket to a Firebase project.",
"properties": {},
"type": "object"
},
"Bucket": {
"description": "A storage bucket and its relation to a parent Firebase project.",
"properties": {
"name": {
"description": "Resource name of the bucket.",
"type": "string"
}
},
"type": "object"
},
"Empty": {
"description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }",
"properties": {},
"type": "object"
},
"GoogleFirebaseStorageControlplaneV1alphaMigrateLocationDestructivelyMetadata": {
"description": "Metadata for MigrateLocationDestructively LRO.",
"properties": {
"createTime": {
"description": "The time the LRO was created.",
"format": "google-datetime",
"type": "string"
},
"lastUpdateTime": {
"description": "The time the LRO was last updated.",
"format": "google-datetime",
"type": "string"
},
"state": {
"description": "The current state of the migration.",
"enum": [
"STATE_UNSPECIFIED",
"PENDING",
"CREATING_TEMP_BUCKET",
"TRANSFERRING_TO_TEMP",
"DELETING_SOURCE_BUCKET",
"CREATING_DESTINATION_BUCKET",
"TRANSFERRING_TO_DESTINATION",
"DELETING_TEMP_BUCKET",
"SUCCEEDED",
"FAILED",
"ROLLING_BACK",
"ROLLED_BACK"
],
"type": "string"
}
},
"type": "object"
},
"GoogleFirebaseStorageControlplaneV1betaMigrateLocationDestructivelyMetadata": {
"description": "Metadata for MigrateLocationDestructively LRO.",
"properties": {
"createTime": {
"description": "The time the LRO was created.",
"format": "google-datetime",
"type": "string"
},
"lastUpdateTime": {
"description": "The time the LRO was last updated.",
"format": "google-datetime",
"type": "string"
},
"state": {
"description": "The current state of the migration.",
"enum": [
"STATE_UNSPECIFIED",
"PENDING",
"CREATING_TEMP_BUCKET",
"TRANSFERRING_TO_TEMP",
"DELETING_SOURCE_BUCKET",
"CREATING_DESTINATION_BUCKET",
"TRANSFERRING_TO_DESTINATION",
"DELETING_TEMP_BUCKET",
"SUCCEEDED",
"FAILED",
"ROLLING_BACK",
"ROLLED_BACK"
],
"type": "string"
}
},
"type": "object"
},
"ListBucketsResponse": {
"description": "The response returned by `ListBuckets`.",
"properties": {
"buckets": {
"description": "The list of linked buckets.",
"items": {
"$ref": "#/components/schemas/Bucket"
},
"type": "array"
},
"nextPageToken": {
"description": "A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.",
"type": "string"
}
},
"type": "object"
},
"RemoveFirebaseRequest": {
"description": "The request used to unlink a Google Cloud Storage bucket from a Firebase project.",
"properties": {},
"type": "object"
}
},
"securitySchemes": {
"Oauth2": {
"description": "Oauth 2.0 implicit authentication",
"flows": {
"implicit": {
"authorizationUrl": "https://accounts.google.com/o/oauth2/auth",
"scopes": {
"https://www.googleapis.com/auth/cloud-platform": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account.",
"https://www.googleapis.com/auth/firebase": "View and administer all your Firebase data and settings"
}
}
},
"type": "oauth2"
},
"Oauth2c": {
"description": "Oauth 2.0 authorizationCode authentication",
"flows": {
"authorizationCode": {
"authorizationUrl": "https://accounts.google.com/o/oauth2/auth",
"scopes": {
"https://www.googleapis.com/auth/cloud-platform": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account.",
"https://www.googleapis.com/auth/firebase": "View and administer all your Firebase data and settings"
},
"tokenUrl": "https://accounts.google.com/o/oauth2/token"
}
},
"type": "oauth2"
}
}
}
}