Skip to content

Cloud Storage JSON API API

by googleapis.com

OAuthHTTPSAnalytics
Open documentation ↗

Overview

Stores and retrieves potentially large, immutable data objects.

Cloud Storage JSON API is an analytics API from googleapis.com. Requests are authenticated with OAuth. It is served over HTTPS. Its OpenAPI description documents 52 endpoints.

At a glance

Authentication
OAuth
HTTPS
Yes
CORS
Unknown
Category
Analytics
Base URL
https://storage.googleapis.com/storage/v1
Version
v1
Endpoints
52
Spec updated
2023-03-06

Make a first request

Replace the placeholders; the documentation says exactly where credentials go.

cURL
curl -X GET "https://storage.googleapis.com/storage/v1/b" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer YOUR_TOKEN"
JavaScript
const response = await fetch("https://storage.googleapis.com/storage/v1/b", {
  method: "GET",
  headers: {
    "Accept": "application/json",
    "Authorization": "Bearer YOUR_TOKEN",
  },
});
const data = await response.json();
console.log(data);
Python
import requests

response = requests.request(
    "GET",
    "https://storage.googleapis.com/storage/v1/b",
    headers={
    "Accept": "application/json",
    "Authorization": "Bearer YOUR_TOKEN",
    },
    timeout=30,
)
print(response.json())

Endpoints

MethodPathWhat it does
GET/bRetrieves a list of buckets for a given project.
POST/bCreates a new bucket.
GET/b/{bucket}Returns metadata for the specified bucket.
PUT/b/{bucket}Updates a bucket. Changes to the bucket will be readable immediately after writing, but configuration changes may take time to propagate.
PATCH/b/{bucket}Patches a bucket. Changes to the bucket will be readable immediately after writing, but configuration changes may take time to propagate.
DELETE/b/{bucket}Permanently deletes an empty bucket.
GET/b/{bucket}/aclRetrieves ACL entries on the specified bucket.
POST/b/{bucket}/aclCreates a new ACL entry on the specified bucket.
GET/b/{bucket}/acl/{entity}Returns the ACL entry for the specified entity on the specified bucket.
PUT/b/{bucket}/acl/{entity}Updates an ACL entry on the specified bucket.
PATCH/b/{bucket}/acl/{entity}Patches an ACL entry on the specified bucket.
DELETE/b/{bucket}/acl/{entity}Permanently deletes the ACL entry for the specified entity on the specified bucket.
GET/b/{bucket}/defaultObjectAclRetrieves default object ACL entries on the specified bucket.
POST/b/{bucket}/defaultObjectAclCreates a new default object ACL entry on the specified bucket.
GET/b/{bucket}/defaultObjectAcl/{entity}Returns the default object ACL entry for the specified entity on the specified bucket.
PUT/b/{bucket}/defaultObjectAcl/{entity}Updates a default object ACL entry on the specified bucket.
PATCH/b/{bucket}/defaultObjectAcl/{entity}Patches a default object ACL entry on the specified bucket.
DELETE/b/{bucket}/defaultObjectAcl/{entity}Permanently deletes the default object ACL entry for the specified entity on the specified bucket.
GET/b/{bucket}/iamReturns an IAM policy for the specified bucket.
PUT/b/{bucket}/iamUpdates an IAM policy for the specified bucket.
GET/b/{bucket}/iam/testPermissionsTests a set of permissions on the given bucket to see which, if any, are held by the caller.
POST/b/{bucket}/lockRetentionPolicyLocks retention policy on a bucket.
GET/b/{bucket}/notificationConfigsRetrieves a list of notification subscriptions for a given bucket.
POST/b/{bucket}/notificationConfigsCreates a notification subscription for a given bucket.
GET/b/{bucket}/notificationConfigs/{notification}View a notification configuration.
DELETE/b/{bucket}/notificationConfigs/{notification}Permanently deletes a notification subscription.
GET/b/{bucket}/oRetrieves a list of objects matching the criteria.
POST/b/{bucket}/oStores a new object and metadata.
POST/b/{bucket}/o/watchWatch for changes on all objects in a bucket.
GET/b/{bucket}/o/{object}Retrieves an object or its metadata.
PUT/b/{bucket}/o/{object}Updates an object's metadata.
PATCH/b/{bucket}/o/{object}Patches an object's metadata.
DELETE/b/{bucket}/o/{object}Deletes an object and its metadata. Deletions are permanent if versioning is not enabled for the bucket, or if the generation parameter is used.
GET/b/{bucket}/o/{object}/aclRetrieves ACL entries on the specified object.
POST/b/{bucket}/o/{object}/aclCreates a new ACL entry on the specified object.
GET/b/{bucket}/o/{object}/acl/{entity}Returns the ACL entry for the specified entity on the specified object.
PUT/b/{bucket}/o/{object}/acl/{entity}Updates an ACL entry on the specified object.
PATCH/b/{bucket}/o/{object}/acl/{entity}Patches an ACL entry on the specified object.
DELETE/b/{bucket}/o/{object}/acl/{entity}Permanently deletes the ACL entry for the specified entity on the specified object.
GET/b/{bucket}/o/{object}/iamReturns an IAM policy for the specified object.
PUT/b/{bucket}/o/{object}/iamUpdates an IAM policy for the specified object.
GET/b/{bucket}/o/{object}/iam/testPermissionsTests a set of permissions on the given object to see which, if any, are held by the caller.
POST/b/{destinationBucket}/o/{destinationObject}/composeConcatenates a list of existing objects into a new object in the same bucket.
POST/b/{sourceBucket}/o/{sourceObject}/copyTo/b/{destinationBucket}/o/{destinationObject}Copies a source object to a destination object. Optionally overrides metadata.
POST/b/{sourceBucket}/o/{sourceObject}/rewriteTo/b/{destinationBucket}/o/{destinationObject}Rewrites a source object to a destination object. Optionally overrides metadata.
POST/channels/stopStop watching resources through this channel
GET/projects/{projectId}/hmacKeysRetrieves a list of HMAC keys matching the criteria.
POST/projects/{projectId}/hmacKeysCreates a new HMAC key for the specified service account.
GET/projects/{projectId}/hmacKeys/{accessId}Retrieves an HMAC key's metadata
PUT/projects/{projectId}/hmacKeys/{accessId}Updates the state of an HMAC key. See the HMAC Key resource descriptor for valid states.
DELETE/projects/{projectId}/hmacKeys/{accessId}Deletes an HMAC key.
GET/projects/{projectId}/serviceAccountGet the email address of this project's Google Cloud Storage service account.

Questions

Does the Cloud Storage JSON API API need an API key?

Yes. The Cloud Storage JSON API API uses OAuth authentication; the documentation explains how to get credentials.

Does the Cloud Storage JSON API API support HTTPS?

Yes, the Cloud Storage JSON API API is served over HTTPS.

How many endpoints does the Cloud Storage JSON API API have?

Its OpenAPI description lists 52 endpoints in version v1. All of them are shown on this page.

What are alternatives to the Cloud Storage JSON API API?

Other Analytics APIs include Google Play Integrity API, versionhistory.googleapis.com API, Doc Converter, Perspective Comment Analyzer API, Safe Browsing API.

Compare alternatives →

Google Play Integrity API

Analytics

The Play Integrity API helps you check that you're interacting with your genuine app on a genuine Android device powered by Google Play services. The Play Integrity API has replaced SafetyNet Attestation and Android Device Verification.

OAuth1 endpoints

versionhistory.googleapis.com API

Analytics

Version History API - Prod

No auth4 endpoints

Doc Converter

Analytics

This api converts file formats of OpenXml and OpenOffice documents formats to vector files (e.g., svg)

No auth1 endpoints

Perspective Comment Analyzer API

Analytics

The Perspective Comment Analyzer API provides information about the potential impact of a comment on a conversation (e.g. it can provide a score for the "toxicity" of a comment). Users can leverage the "SuggestCommentScore" method to submit corrections to improve Perspective over time. Users can set the "doNotStore" flag to ensure that all submitted comments are automatically deleted after scores are returned.

OAuth2 endpoints

Safe Browsing API

Analytics

Enables client applications to check web resources (most commonly URLs) against Google-generated lists of unsafe web resources. The Safe Browsing APIs are for non-commercial use only. If you need to use APIs to detect malicious URLs for commercial purposes – meaning “for sale or revenue-generating purposes” – please refer to the Web Risk API.

No auth7 endpoints

Web Fonts Developer API

Analytics

The Google Web Fonts Developer API lets you retrieve information about web fonts served by Google.

No auth1 endpoints

Listed from APIs.guru (CC0).