Google

Google Cloud Memorystore for Redis API

Creates and manages Redis instances on the Google Cloud Platform.

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

Creates and manages Redis instances on the Google Cloud Platform.

Endpoints 27

projects.locations.operations

  • GETGets the latest state of a long-running operation/v1/:nameGets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
  • DELETEDeletes a long-running operation/v1/:nameDeletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If…
  • 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.instances

  • PATCHUpdates the metadata and configuration of a specific Redis instance/v1/:name?updateMask=stringUpdates the metadata and configuration of a specific Redis instance. Completed longrunning.Operation will contain the new instance object in the response…
  • POSTExport Redis instance data into a Redis RDB format file in Cloud Storage/v1/:name:exportExport Redis instance data into a Redis RDB format file in Cloud Storage. Redis will continue serving during this operation. The returned operation is…
  • GETLists all Redis instances owned by a project in either the specified location (region) or all locations/v1/:parent/instances?pageSize=0&pageToken=stringLists all Redis instances owned by a project in either the specified location (region) or all locations. The location should have the following format: *…
  • POSTCreates a Redis instance based on the specified tier and memory size/v1/:parent/instances?instanceId=stringCreates a Redis instance based on the specified tier and memory size. By default, the instance is accessible from the project's default network. The creation…
  • POSTInitiates a failover of the primary node to current replica node for a specific STANDARD tier Cloud Memorystore for…/v1/:name:failoverInitiates a failover of the primary node to current replica node for a specific STANDARD tier Cloud Memorystore for Redis instance.
  • GETGets the AUTH string for a Redis instance/v1/:name/authStringGets the AUTH string for a Redis instance. If AUTH is not enabled for the instance the response will be empty. This information is not included in the details…
  • POSTImport a Redis RDB snapshot file from Cloud Storage into a Redis instance/v1/:name:importImport a Redis RDB snapshot file from Cloud Storage into a Redis instance. Redis may stop serving during this operation. Instance state will be IMPORTING for…
  • POSTReschedule maintenance for a given instance in a given project and location./v1/:name:rescheduleMaintenanceReschedule maintenance for a given instance in a given project and location.
  • POSTUpgrades Redis instance to the newer Redis version specified in the request./v1/:name:upgradeUpgrades Redis instance to the newer Redis version specified in the request.

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.aclPolicies

  • GETLists all ACL policies owned by a project in either the specified location (region) or all locations/v1/:parent/aclPolicies?pageSize=0&pageToken=stringLists all ACL policies owned by a project in either the specified location (region) or all locations. The location should have the following format: *…
  • POSTCreates an ACL policy/v1/:parent/aclPolicies?aclPolicyId=string&requestId=stringCreates an ACL policy. The creation is executed synchronously and the policy is available for use immediately after the RPC returns.

projects.locations.aclPolicies.revisions

  • GETLists all ACL policy revisions in a given ACL policy./v1/:parent/revisions?pageSize=0&pageToken=stringLists all ACL policy revisions in a given ACL policy.

projects.locations.backupCollections

  • GETLists all backup collections owned by a consumer project in either the specified location (region) or all locations/v1/:parent/backupCollections?pageSize=0&pageToken=stringLists all backup collections owned by a consumer project in either the specified location (region) or all locations. If location_id is specified as -…

projects.locations.backupCollections.backups

  • GETLists all backups owned by a backup collection./v1/:parent/backups?pageSize=0&pageToken=stringLists all backups owned by a backup collection.

projects.locations.clusters

  • POSTAdds a token auth user for a token based auth enabled cluster./v1/:cluster:addTokenAuthUserAdds a token auth user for a token based auth enabled cluster.
  • POSTBackup Redis Cluster/v1/:name:backupBackup Redis Cluster. If this is the first time a backup is being created, a backup collection will be created at the backend, and this backup belongs to this…
  • GETLists all Redis clusters owned by a project in either the specified location (region) or all locations/v1/:parent/clusters?pageSize=0&pageToken=stringLists all Redis clusters owned by a project in either the specified location (region) or all locations. The location should have the following format: *…
  • POSTCreates a Redis cluster based on the specified properties/v1/:parent/clusters?clusterId=string&requestId=stringCreates a Redis cluster based on the specified properties. The creation is executed asynchronously and callers may check the returned operation to track its…
  • POSTReschedules upcoming maintenance event./v1/:name:rescheduleClusterMaintenanceReschedules upcoming maintenance event.

projects.locations.clusters.tokenAuthUsers

  • POSTAdds a auth token for a user of a token based auth enabled cluster./v1/:tokenAuthUser:addAuthTokenAdds a auth token for a user of a token based auth enabled cluster.
  • GETLists all the token auth users for a token based auth enabled cluster./v1/:parent/tokenAuthUsers?filter=string&orderBy=string&pageSize=0&pageToken=stringLists all the token auth users for a token based auth enabled cluster.

projects.locations.clusters.tokenAuthUsers.authTokens

  • GETLists all the auth tokens for a specific token auth user./v1/:parent/authTokens?filter=string&orderBy=string&pageSize=0&pageToken=stringLists all the auth tokens for a specific token auth user.

API details

Base URL
https://redis.googleapis.com
Authentication
OAuth 2.0 (authorization code flow) with 3 scopes
An API key in the key query parameter
Operations
27 operations on 22 pathsPOST 13GET 12PATCH 1DELETE 1
Main resources
projects.locations.instances 9projects.locations.clusters 5projects.locations.operations 4projects.locations.aclPolicies 2projects.locations.clusters.tokenAuthUsers 2projects.locations 1projects.locations.aclPolicies.revisions 1projects.locations.backupCollections 1projects.locations.backupCollections.backups 1projects.locations.clusters.tokenAuthUsers.authTokens 1
Response formats
application/json
Description format
Google API Discovery, API version v1

How to test the Google Cloud Memorystore for Redis API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Google Cloud Memorystore for Redis API collection, without the publisher's secrets.
  3. Add your credentialsThis API uses OAuth 2.0 (authorization code flow) with 3 scopes. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Gets the latest state of a long-running operation” (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 Google Cloud Memorystore for Redis API?

Creates and manages Redis instances on the Google Cloud Platform. It is listed under Developer tools and has 27 endpoints.

Who publishes the Google Cloud Memorystore for Redis 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 Google Cloud Memorystore for Redis API?

Requests go to https://redis.googleapis.com. Endpoint paths are added to this base URL.

How do I authenticate with the Google Cloud Memorystore for Redis API?

It accepts 2 methods: OAuth 2.0 (authorization code flow) with 3 scopes; an API key in the key query parameter.

How many endpoints does the Google Cloud Memorystore for Redis API have?

27 operations on 22 paths (13 POST, 12 GET, 1 PATCH, 1 DELETE). The largest groups are projects.locations.instances, projects.locations.clusters, projects.locations.operations, projects.locations.aclPolicies.

Is forking the Google Cloud Memorystore for Redis API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.