AnywhereCaches: pause

Pauses acache instance in a specified bucket.

When you pause a cache instance, data entries can no longer be ingested into the cache. The existing data held in the cache is evicted when the time to live (TTL) ends. Once paused, the cache can be unpaused by using thestorage.anywhereCaches.resume API.

Required permissions

The authenticated user must have thestorage.anywhereCaches.pause IAM permission on the bucket to use this method.

Request

HTTP request

POST https://storage.googleapis.com/storage/v1/b/bucket/anywhereCaches/anywhereCacheID/pause

In addition tostandard query parameters, the following parameters apply to this method.

To see an example of how to include parameters in a request, see theJSON API Overview page.

Parameters

Parameter nameValueDescription
Path parameters
bucketstring Name of a bucket.
anywhereCacheIDstring A value that, along with the bucket's name, uniquely identifies the cache.

Request body

Do not supply a request body with this method.

Response

If successful, this method returns anAnywhereCache resource.

Try it!

Use the APIs Explorer below to call this method on live data and see the response.

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-12-17 UTC.