Console
    Contact Us Start free

    Use Object Versioning

    Overview Usage

    This page describes how to enable, disable, and check the status of Object Versioning on a bucket. See Using versioned objects to learn how to list, restore, and delete the objects that are retained by Object Versioning.

    Required roles

    To get the permissions that you need to set and manage Object Versioning on a bucket, ask your administrator to grant you the Storage Admin ( roles/storage.admin ) IAM role on the bucket or the project that contains the bucket. This predefined role contains the permissions required to set and manage Object Versioning for a bucket. To see the exact permissions that are required, expand the Required permissionssection:

    Required permissions

    • storage.buckets.get
    • storage.buckets.update
    • storage.buckets.list
      • This permission is only required if you plan on using the Google Cloud console to perform the instructions on this page.

    You might also be able to get these permissions with custom roles .

    For information about granting roles on buckets, see Use IAM with buckets . For information about granting roles on projects, see Manage access to projects .

    Set Object Versioning on a bucket

    Console

    1. In the Google Cloud console, go to the Cloud Storage Buckets page.

      Go to Buckets

    2. In the list of buckets, click the name of the bucket for which you want to enable or disable Object Versioning.

    3. Select the Protectiontab near the top of the page.

      The current status of Object versioning is found in the Object versioningsection.

    4. In the Object versioningsection, click the current status to make changes to it.

      The Object versioningdialog appears.

      1. If you're enabling Object Versioning and you want to minimize storage costs, select the Add recommended lifecycle rules to manage version costscheckbox.

    5. Click Confirm.

    Command line

    Use the gcloud storage buckets update command with the appropriate flag:

    gcloud storage buckets update gs:// BUCKET_NAME 
 FLAG

    Where:

    • BUCKET_NAME is the name of the relevant bucket. For example, my-bucket .

    • FLAG is either --versioning to enable Object Versioning or --no-versioning to disable it.

    If successful, the response looks similar to the following example:

    Updating gs://my-bucket/...
  Completed 1

    Client libraries

    C++

    For more information, see the Cloud Storage C++ API reference documentation .

    To authenticate to Cloud Storage, set up Application Default Credentials. For more information, see Set up authentication for client libraries .

    The following sample enables Object Versioning on a bucket:

      namespace 
  
 gcs 
  
 = 
  
 :: 
 google 
 :: 
 cloud 
 :: 
 storage 
 ; 
 using 
  
 :: 
 google 
 :: 
 cloud 
 :: 
 StatusOr 
 ; 
 []( 
 gcs 
 :: 
 Client 
  
 client 
 , 
  
 std 
 :: 
 string 
  
 const 
&  
 bucket_name 
 ) 
  
 { 
  
 StatusOr<gcs 
 :: 
 BucketMetadata 
>  
 original 
  
 = 
  
 client 
 . 
 GetBucketMetadata 
 ( 
 bucket_name 
 ); 
  
 if 
  
 ( 
 ! 
 original 
 ) 
  
 throw 
  
 std 
 :: 
 move 
 ( 
 original 
 ). 
 status 
 (); 
  
 StatusOr<gcs 
 :: 
 BucketMetadata 
>  
 patched 
  
 = 
  
 client 
 . 
 PatchBucket 
 ( 
  
 bucket_name 
 , 
  
 gcs 
 :: 
 BucketMetadataPatchBuilder 
 (). 
 SetVersioning 
 ( 
  
 gcs 
 :: 
 BucketVersioning 
 { 
 true 
 }), 
  
 gcs 
 :: 
 IfMetagenerationMatch 
 ( 
 original 
 - 
> metageneration 
 ())); 
  
 if 
  
 ( 
 ! 
 patched 
 ) 
  
 throw 
  
 std 
 :: 
 move 
 ( 
 patched 
 ). 
 status 
 (); 
  
 if 
  
 ( 
 patched 
 - 
> versioning 
 (). 
 has_value 
 ()) 
  
 { 
  
 std 
 :: 
 cout 
 << 
 "Object versioning for bucket " 
 << 
 bucket_name 
 << 
 " is " 
 << 
 ( 
 patched 
 - 
> versioning 
 () 
 - 
> enabled 
  
 ? 
  
 "enabled" 
  
 : 
  
 "disabled" 
 ) 
 << 
 " 
 \n 
 " 
 ; 
  
 } 
  
 else 
  
 { 
  
 std 
 :: 
 cout 
 << 
 "Object versioning for bucket " 
 << 
 bucket_name 
 << 
 " is disabled. 
 \n 
 " 
 ; 
  
 } 
 }

    The following sample disables Object Versioning on a bucket:

      namespace 
  
 gcs 
  
 = 
  
 :: 
 google 
 :: 
 cloud 
 :: 
 storage 
 ; 
 using 
  
 :: 
 google 
 :: 
 cloud 
 :: 
 StatusOr 
 ; 
 []( 
 gcs 
 :: 
 Client 
  
 client 
 , 
  
 std 
 :: 
 string 
  
 const 
&  
 bucket_name 
 ) 
  
 { 
  
 StatusOr<gcs 
 :: 
 BucketMetadata 
>  
 original 
  
 = 
  
 client 
 . 
 GetBucketMetadata 
 ( 
 bucket_name 
 ); 
  
 if 
  
 ( 
 ! 
 original 
 ) 
  
 throw 
  
 std 
 :: 
 move 
 ( 
 original 
 ). 
 status 
 (); 
  
 StatusOr<gcs 
 :: 
 BucketMetadata 
>  
 patched 
  
 = 
  
 client 
 . 
 PatchBucket 
 ( 
  
 bucket_name 
 , 
  
 gcs 
 :: 
 BucketMetadataPatchBuilder 
 (). 
 SetVersioning 
 ( 
  
 gcs 
 :: 
 BucketVersioning 
 { 
 false 
 }), 
  
 gcs 
 :: 
 IfMetagenerationMatch 
 ( 
 original 
 - 
> metageneration 
 ())); 
  
 if 
  
 ( 
 ! 
 patched 
 ) 
  
 throw 
  
 std 
 :: 
 move 
 ( 
 patched 
 ). 
 status 
 (); 
  
 auto 
  
 versioning 
  
 = 
  
 patched 
 - 
> versioning 
 (). 
 value_or 
 ( 
 gcs 
 :: 
 BucketVersioning 
 { 
 false 
 }); 
  
 std 
 :: 
 cout 
 << 
 "Object versioning for bucket " 
 << 
 bucket_name 
 << 
 " is " 
 << 
 ( 
 versioning 
 . 
 enabled 
  
 ? 
  
 "enabled" 
  
 : 
  
 "disabled" 
 ) 
 << 
 " 
 \n 
 " 
 ; 
 }

    C#

    For more information, see the Cloud Storage C# API reference documentation .

    To authenticate to Cloud Storage, set up Application Default Credentials. For more information, see Set up authentication for client libraries .

    The following sample enables Object Versioning on a bucket:

      using 
  
 Google.Apis.Storage.v1.Data 
 ; 
 using 
  
  Google.Cloud.Storage.V1 
 
 ; 
 using 
  
 System 
 ; 
 public 
  
 class 
  
 BucketEnableVersioningSample 
 { 
  
 public 
  
 Bucket 
  
 BucketEnableVersioning 
 ( 
 string 
  
 bucketName 
  
 = 
  
 "your-bucket-name" 
 ) 
  
 { 
  
 var 
  
 storage 
  
 = 
  
  StorageClient 
 
 . 
  Create 
 
 (); 
  
 var 
  
 bucket 
  
 = 
  
 storage 
 . 
 GetBucket 
 ( 
 bucketName 
 ); 
  
 if 
  
 ( 
 bucket 
 . 
 Versioning 
  
 == 
  
 null 
 ) 
  
 { 
  
 bucket 
 . 
 Versioning 
  
 = 
  
 new 
  
 Bucket 
 . 
 VersioningData 
 (); 
  
 } 
  
 bucket 
 . 
 Versioning 
 . 
 Enabled 
  
 = 
  
 true 
 ; 
  
 bucket 
  
 = 
  
 storage 
 . 
 UpdateBucket 
 ( 
 bucket 
 ); 
  
 Console 
 . 
 WriteLine 
 ( 
 $"Versioning is now enabled for bucket {bucketName}." 
 ); 
  
 return 
  
 bucket 
 ; 
  
 } 
 }

    The following sample disables Object Versioning on a bucket:

      using 
  
 Google.Apis.Storage.v1.Data 
 ; 
 using 
  
  Google.Cloud.Storage.V1 
 
 ; 
 using 
  
 System 
 ; 
 public 
  
 class 
  
 BucketDisableVersioningSample 
 { 
  
 public 
  
 Bucket 
  
 BucketDisableVersioning 
 ( 
 string 
  
 bucketName 
  
 = 
  
 "your-bucket-name" 
 ) 
  
 { 
  
 var 
  
 storage 
  
 = 
  
  StorageClient 
 
 . 
  Create 
 
 (); 
  
 var 
  
 bucket 
  
 = 
  
 storage 
 . 
 GetBucket 
 ( 
 bucketName 
 ); 
  
 if 
  
 ( 
 bucket 
 . 
 Versioning 
 ?. 
 Enabled 
  
 != 
  
 true 
 ) 
  
 { 
  
 Console 
 . 
 WriteLine 
 ( 
 $"Versioning already disabled for bucket {bucketName}." 
 ); 
  
 } 
  
 else 
  
 { 
  
 bucket 
 . 
 Versioning 
 . 
 Enabled 
  
 = 
  
 false 
 ; 
  
 bucket 
  
 = 
  
 storage 
 . 
 UpdateBucket 
 ( 
 bucket 
 ); 
  
 Console 
 . 
 WriteLine 
 ( 
 $"Versioning is now disabled for bucket {bucketName}." 
 ); 
  
 } 
  
 return 
  
 bucket 
 ; 
  
 } 
 }

    Go

    For more information, see the Cloud Storage Go API reference documentation .

    To authenticate to Cloud Storage, set up Application Default Credentials. For more information, see Set up authentication for client libraries .

    The following sample enables Object Versioning on a bucket:

      import 
  
 ( 
  
 "context" 
  
 "fmt" 
  
 "io" 
  
 "time" 
  
 "cloud.google.com/go/storage" 
 ) 
 // enableVersioning enables object versioning on a bucket. 
 func 
  
 enableVersioning 
 ( 
 w 
  
 io 
 . 
  Writer 
 
 , 
  
 bucketName 
  
 string 
 ) 
  
 error 
  
 { 
  
 // bucketName := "bucket-name" 
  
 ctx 
  
 := 
  
 context 
 . 
 Background 
 () 
  
 client 
 , 
  
 err 
  
 := 
  
 storage 
 . 
 NewClient 
 ( 
 ctx 
 ) 
  
 if 
  
 err 
  
 != 
  
 nil 
  
 { 
  
 return 
  
 fmt 
 . 
 Errorf 
 ( 
 "storage.NewClient: %w" 
 , 
  
 err 
 ) 
  
 } 
  
 defer 
  
 client 
 . 
 Close 
 () 
  
 ctx 
 , 
  
 cancel 
  
 := 
  
 context 
 . 
 WithTimeout 
 ( 
 ctx 
 , 
  
 time 
 . 
 Second 
 * 
 10 
 ) 
  
 defer 
  
 cancel 
 () 
  
 bucket 
  
 := 
  
 client 
 . 
  Bucket 
 
 ( 
 bucketName 
 ) 
  
 bucketAttrsToUpdate 
  
 := 
  
 storage 
 . 
  BucketAttrsToUpdate 
 
 { 
  
 VersioningEnabled 
 : 
  
 true 
 , 
  
 } 
  
 if 
  
 _ 
 , 
  
 err 
  
 := 
  
 bucket 
 . 
 Update 
 ( 
 ctx 
 , 
  
 bucketAttrsToUpdate 
 ); 
  
 err 
  
 != 
  
 nil 
  
 { 
  
 return 
  
 fmt 
 . 
 Errorf 
 ( 
 "Bucket(%q).Update: %w" 
 , 
  
 bucketName 
 , 
  
 err 
 ) 
  
 } 
  
 fmt 
 . 
 Fprintf 
 ( 
 w 
 , 
  
 "Versioning was enabled for %v\n" 
 , 
  
 bucketName 
 ) 
  
 return 
  
 nil 
 }

    The following sample disables Object Versioning on a bucket:

      import 
  
 ( 
  
 "context" 
  
 "fmt" 
  
 "io" 
  
 "time" 
  
 "cloud.google.com/go/storage" 
 ) 
 // disableVersioning disables object versioning on a bucket. 
 func 
  
 disableVersioning 
 ( 
 w 
  
 io 
 . 
  Writer 
 
 , 
  
 bucketName 
  
 string 
 ) 
  
 error 
  
 { 
  
 // bucketName := "bucket-name" 
  
 ctx 
  
 := 
  
 context 
 . 
 Background 
 () 
  
 client 
 , 
  
 err 
  
 := 
  
 storage 
 . 
 NewClient 
 ( 
 ctx 
 ) 
  
 if 
  
 err 
  
 != 
  
 nil 
  
 { 
  
 return 
  
 fmt 
 . 
 Errorf 
 ( 
 "storage.NewClient: %w" 
 , 
  
 err 
 ) 
  
 } 
  
 defer 
  
 client 
 . 
 Close 
 () 
  
 ctx 
 , 
  
 cancel 
  
 := 
  
 context 
 . 
 WithTimeout 
 ( 
 ctx 
 , 
  
 time 
 . 
 Second 
 * 
 10 
 ) 
  
 defer 
  
 cancel 
 () 
  
 bucket 
  
 := 
  
 client 
 . 
  Bucket 
 
 ( 
 bucketName 
 ) 
  
 bucketAttrsToUpdate 
  
 := 
  
 storage 
 . 
  BucketAttrsToUpdate 
 
 { 
  
 VersioningEnabled 
 : 
  
 false 
 , 
  
 } 
  
 if 
  
 _ 
 , 
  
 err 
  
 := 
  
 bucket 
 . 
 Update 
 ( 
 ctx 
 , 
  
 bucketAttrsToUpdate 
 ); 
  
 err 
  
 != 
  
 nil 
  
 { 
  
 return 
  
 fmt 
 . 
 Errorf 
 ( 
 "Bucket(%q).Update: %w" 
 , 
  
 bucketName 
 , 
  
 err 
 ) 
  
 } 
  
 fmt 
 . 
 Fprintf 
 ( 
 w 
 , 
  
 "Versioning was disabled for %v\n" 
 , 
  
 bucketName 
 ) 
  
 return 
  
 nil 
 }

    Java

    For more information, see the Cloud Storage Java API reference documentation .

    To authenticate to Cloud Storage, set up Application Default Credentials. For more information, see Set up authentication for client libraries .

    The following sample enables Object Versioning on a bucket:

      import 
  
 com.google.cloud.storage. Bucket 
 
 ; 
 import 
  
 com.google.cloud.storage. Storage 
 
 ; 
 import 
  
 com.google.cloud.storage. StorageOptions 
 
 ; 
 public 
  
 class 
 EnableBucketVersioning 
  
 { 
  
 public 
  
 static 
  
 void 
  
 enableBucketVersioning 
 ( 
 String 
  
 projectId 
 , 
  
 String 
  
 bucketName 
 ) 
  
 { 
  
 // The ID of your GCP project 
  
 // String projectId = "your-project-id"; 
  
 // The ID of your GCS bucket 
  
 // String bucketName = "your-unique-bucket-name"; 
  
  Storage 
 
  
 storage 
  
 = 
  
  StorageOptions 
 
 . 
 newBuilder 
 (). 
 setProjectId 
 ( 
 projectId 
 ). 
 build 
 (). 
  getService 
 
 (); 
  
  Bucket 
 
  
 bucket 
  
 = 
  
 storage 
 . 
  get 
 
 ( 
 bucketName 
 ); 
  
 bucket 
 . 
  toBuilder 
 
 (). 
 setVersioningEnabled 
 ( 
 true 
 ). 
 build 
 (). 
 update 
 (); 
  
 System 
 . 
 out 
 . 
 println 
 ( 
 "Versioning is now enabled for bucket " 
  
 + 
  
 bucketName 
 ); 
  
 } 
 }

    The following sample disables Object Versioning on a bucket:

      import 
  
 com.google.cloud.storage. Bucket 
 
 ; 
 import 
  
 com.google.cloud.storage. Storage 
 
 ; 
 import 
  
 com.google.cloud.storage. StorageOptions 
 
 ; 
 public 
  
 class 
 DisableBucketVersioning 
  
 { 
  
 public 
  
 static 
  
 void 
  
 disableBucketVersioning 
 ( 
 String 
  
 projectId 
 , 
  
 String 
  
 bucketName 
 ) 
  
 { 
  
 // The ID of your GCP project 
  
 // String projectId = "your-project-id"; 
  
 // The ID of your GCS bucket 
  
 // String bucketName = "your-unique-bucket-name"; 
  
  Storage 
 
  
 storage 
  
 = 
  
  StorageOptions 
 
 . 
 newBuilder 
 (). 
 setProjectId 
 ( 
 projectId 
 ). 
 build 
 (). 
  getService 
 
 (); 
  
  Bucket 
 
  
 bucket 
  
 = 
  
 storage 
 . 
  get 
 
 ( 
 bucketName 
 ); 
  
 bucket 
 . 
  toBuilder 
 
 (). 
 setVersioningEnabled 
 ( 
 false 
 ). 
 build 
 (). 
 update 
 (); 
  
 System 
 . 
 out 
 . 
 println 
 ( 
 "Versioning is now disabled for bucket " 
  
 + 
  
 bucketName 
 ); 
  
 } 
 }

    Node.js

    For more information, see the Cloud Storage Node.js API reference documentation .

    To authenticate to Cloud Storage, set up Application Default Credentials. For more information, see Set up authentication for client libraries .

    The following sample enables Object Versioning on a bucket:

      /** 
 * TODO(developer): Uncomment the following lines before running the sample. 
 */ 
 // The ID of your GCS bucket 
 // const bucketName = 'your-unique-bucket-name'; 
 // Imports the Google Cloud client library 
 const 
  
 { 
 Storage 
 } 
  
 = 
  
 require 
 ( 
 ' @google-cloud/storage 
' 
 ); 
 // Creates a client 
 const 
  
 storage 
  
 = 
  
 new 
  
 Storage 
 (); 
 async 
  
 function 
  
 enableBucketVersioning 
 () 
  
 { 
  
 await 
  
 storage 
 . 
 bucket 
 ( 
 bucketName 
 ). 
 setMetadata 
 ({ 
  
 versioning 
 : 
  
 { 
  
 enabled 
 : 
  
 true 
 , 
  
 }, 
  
 }); 
  
 console 
 . 
 log 
 ( 
 `Versioning is enabled for bucket 
 ${ 
 bucketName 
 } 
 ` 
 ); 
 } 
 enableBucketVersioning 
 (). 
 catch 
 ( 
 console 
 . 
 error 
 );

    The following sample disables Object Versioning on a bucket:

      /** 
 * TODO(developer): Uncomment the following lines before running the sample. 
 */ 
 // The ID of your GCS bucket 
 // const bucketName = 'your-unique-bucket-name'; 
 // Imports the Google Cloud client library 
 const 
  
 { 
 Storage 
 } 
  
 = 
  
 require 
 ( 
 ' @google-cloud/storage 
' 
 ); 
 // Creates a client 
 const 
  
 storage 
  
 = 
  
 new 
  
 Storage 
 (); 
 async 
  
 function 
  
 disableBucketVersioning 
 () 
  
 { 
  
 await 
  
 storage 
 . 
 bucket 
 ( 
 bucketName 
 ). 
 setMetadata 
 ({ 
  
 versioning 
 : 
  
 { 
  
 enabled 
 : 
  
 false 
 , 
  
 }, 
  
 }); 
  
 console 
 . 
 log 
 ( 
 `Versioning is disabled for bucket 
 ${ 
 bucketName 
 } 
 ` 
 ); 
 } 
 disableBucketVersioning 
 (). 
 catch 
 ( 
 console 
 . 
 error 
 );

    PHP

    For more information, see the Cloud Storage PHP API reference documentation .

    To authenticate to Cloud Storage, set up Application Default Credentials. For more information, see Set up authentication for client libraries .

    The following sample enables Object Versioning on a bucket:

      use Google\Cloud\Storage\StorageClient; 
 /** 
 * Enable versioning on the specified bucket. 
 * 
 * @param string $bucketName The name of your Cloud Storage bucket. 
 *        (e.g. 'my-bucket') 
 */ 
 function enable_versioning(string $bucketName): void 
 { 
 $storage = new StorageClient(); 
 $bucket = $storage->bucket($bucketName); 
 $bucket->update([ 
 'versioning' => [ 
 'enabled' => true, 
 ] 
 ]); 
 printf('Versioning is now enabled for bucket %s', $bucketName); 
 }

    The following sample disables Object Versioning on a bucket:

      use Google\Cloud\Storage\StorageClient; 
 /** 
 * Disable versioning of the given bucket. 
 * 
 * @param string $bucketName The name of your Cloud Storage bucket. 
 *        (e.g. 'my-bucket') 
 */ 
 function disable_versioning(string $bucketName): void 
 { 
 $storage = new StorageClient(); 
 $bucket = $storage->bucket($bucketName); 
 $bucket->update([ 
 'versioning' => [ 
 'enabled' => false, 
 ] 
 ]); 
 printf('Versioning is now disabled for bucket %s', $bucketName); 
 }

    Python

    For more information, see the Cloud Storage Python API reference documentation .

    To authenticate to Cloud Storage, set up Application Default Credentials. For more information, see Set up authentication for client libraries .

    The following sample enables Object Versioning on a bucket:

      from 
  
 google.cloud 
  
 import 
  storage 
 
 def 
  
 enable_versioning 
 ( 
 bucket_name 
 ): 
  
 """Enable versioning for this bucket.""" 
 # bucket_name = "my-bucket" 
 storage_client 
 = 
  storage 
 
 . 
  Client 
 
 () 
 bucket 
 = 
 storage_client 
 . 
  get_bucket 
 
 ( 
 bucket_name 
 ) 
 bucket 
 . 
  versioning_enabled 
 
 = 
 True 
 bucket 
 . 
 patch 
 () 
 print 
 ( 
 f 
 "Versioning was enabled for bucket 
 { 
 bucket 
 . 
 name 
 } 
 " 
 ) 
 return 
 bucket

    The following sample disables Object Versioning on a bucket:

      from 
  
 google.cloud 
  
 import 
  storage 
 
 def 
  
 disable_versioning 
 ( 
 bucket_name 
 ): 
  
 """Disable versioning for this bucket.""" 
 # bucket_name = "my-bucket" 
 storage_client 
 = 
  storage 
 
 . 
  Client 
 
 () 
 bucket 
 = 
 storage_client 
 . 
  get_bucket 
 
 ( 
 bucket_name 
 ) 
 bucket 
 . 
  versioning_enabled 
 
 = 
 False 
 bucket 
 . 
 patch 
 () 
 print 
 ( 
 f 
 "Versioning was disabled for bucket 
 { 
 bucket 
 } 
 " 
 ) 
 return 
 bucket

    Ruby

    For more information, see the Cloud Storage Ruby API reference documentation .

    To authenticate to Cloud Storage, set up Application Default Credentials. For more information, see Set up authentication for client libraries .

    The following sample enables Object Versioning on a bucket:

      def 
  
 enable_versioning 
  
 bucket_name 
 : 
  
 # The ID of your GCS bucket 
  
 # bucket_name = "your-unique-bucket-name" 
  
 require 
  
 "google/cloud/storage" 
  
 storage 
  
 = 
  
 Google 
 :: 
 Cloud 
 :: 
  Storage 
 
 . 
  new 
 
  
 bucket 
  
 = 
  
 storage 
 . 
 bucket 
  
 bucket_name 
  
 bucket 
 . 
 versioning 
  
 = 
  
 true 
  
 puts 
  
 "Versioning was enabled for bucket 
 #{ 
 bucket_name 
 } 
 " 
 end

    The following sample disables Object Versioning on a bucket:

      def 
  
 disable_versioning 
  
 bucket_name 
 : 
  
 # The ID of your GCS bucket 
  
 # bucket_name = "your-unique-bucket-name" 
  
 require 
  
 "google/cloud/storage" 
  
 storage 
  
 = 
  
 Google 
 :: 
 Cloud 
 :: 
  Storage 
 
 . 
  new 
 
  
 bucket 
  
 = 
  
 storage 
 . 
 bucket 
  
 bucket_name 
  
 bucket 
 . 
 versioning 
  
 = 
  
 false 
  
 puts 
  
 "Versioning was disabled for bucket 
 #{ 
 bucket_name 
 } 
 " 
 end

    REST APIs

    JSON API

    1. Have gcloud CLI installed and initialized , which lets you generate an access token for the Authorization header.

    2. Create a JSON file that contains the following information:

       { 
  
 "versioning" 
 : 
  
 { 
  
 "enabled" 
 : 
  
  STATE 
 
  
 } 
 }

      Where STATE is either true or false .

    3. Use cURL to call the JSON API with a PATCH Bucket request:

      curl -X PATCH --data-binary @ JSON_FILE_NAME 
\
  -H "Authorization: Bearer $(gcloud auth print-access-token)" \
  -H "Content-Type: application/json" \
  "https://storage.googleapis.com/storage/v1/b/ BUCKET_NAME 
?fields=versioning"

      Where:

      • JSON_FILE_NAME is the path for the JSON file that you created in Step 2.
      • BUCKET_NAME is the name of the relevant bucket. For example, my-bucket .

    XML API

    1. Have gcloud CLI installed and initialized , which lets you generate an access token for the Authorization header.

    2. Create an XML file that contains the following information:

      <VersioningConfiguration>
  <Status> STATE 
</Status>
</VersioningConfiguration>

      Where STATE is either Enabled or Suspended .

    3. Use cURL to call the XML API , with a PUT Bucket request and versioning query string parameter:

      curl -X PUT --data-binary @ XML_FILE_NAME 
\
  -H "Authorization: Bearer $(gcloud auth print-access-token)" \
  "https://storage.googleapis.com/ BUCKET_NAME 
?versioning"

      Where:

      • XML_FILE_NAME is the path for the XML file that you created in Step 2.
      • BUCKET_NAME is the name of the relevant bucket. For example, my-bucket .

    Once Object Versioning is enabled, each time a live object version is replaced or deleted, that version becomes a noncurrent version .

    Check whether Object Versioning is enabled

    To check whether Object Versioning is enabled on a bucket:

    Console

    1. In the Google Cloud console, go to the Cloud Storage Buckets page.

      Go to Buckets

    2. In the list of buckets, the Object Versioning status of each bucket is found in the Protectioncolumn.

    If enabled, the text Object versioningappears.

    Command line

    Use the gcloud storage buckets describe command with the --format flag:

    gcloud storage buckets describe gs:// BUCKET_NAME 
--format="default(versioning_enabled)"

    Where BUCKET_NAME is the name of the bucket whose status you want to view. For example, my-bucket .

    If successful and Object Versioning is enabled, the response looks similar to the following example:

     versio 
 n 
 i 
 n 
 g 
 : 
  
 e 
 na 
 bled 
 : 
  
 true

    If successful and Object Versioning is not enabled, the response looks similar to the following example:

     null

    REST APIs

    JSON API

    1. Have gcloud CLI installed and initialized , which lets you generate an access token for the Authorization header.

    2. Use cURL to call the JSON API with a GET Bucket request:

      curl -X GET \
  -H "Authorization: Bearer $(gcloud auth print-access-token)" \
  "https://storage.googleapis.com/storage/v1/b/ BUCKET_NAME 
?fields=versioning"

      Where BUCKET_NAME is the name of the relevant bucket. For example, my-bucket .

    If successful and Object Versioning is enabled, the response looks similar to the following example:

     { 
  
 "versioning" 
 : 
  
 { 
  
 "enabled" 
 : 
  
 true 
  
 } 
 }

    If successful and Object Versioning is not enabled, the response looks similar to the following example:

     {}

    XML API

    1. Have gcloud CLI installed and initialized , which lets you generate an access token for the Authorization header.

    2. Use cURL to call the XML API , with a GET Bucket request and versioning query string parameter:

      curl -X GET \
  -H "Authorization: Bearer $(gcloud auth print-access-token)" \
  "https://storage.googleapis.com/ BUCKET_NAME 
?versioning"

      Where BUCKET_NAME is the name of the relevant bucket. For example, my-bucket .

    If successful and Object Versioning is enabled, the response looks similar to the following example:

    <VersioningConfiguration>  
<Status>Enabled</Status>
</VersioningConfiguration>

    If successful and Object Versioning is not enabled, the response looks similar to the following example:

    <VersioningConfiguration/>

    What's next

    Create a Mobile Website
    View Site in Mobile | Classic
    Share by: