Google Cloud Memorystore for Redis API

Creates and manages Redis instances on the Google Cloud Platform.

Service: redis.googleapis.com

To call this service, we recommend that you use the Google-provided client libraries. If your application needs to use your own libraries to call this service, use the following information when you make the API requests.

Discovery document

A Discovery Document is a machine-readable specification for describing and consuming REST APIs. It is used to build client libraries, IDE plugins, and other tools that interact with Google APIs. One service may provide multiple discovery documents. This service provides the following discovery documents:

Service endpoint

A service endpoint is a base URL that specifies the network address of an API service. One service might have multiple service endpoints. This service has the following service endpoint and all URIs below are relative to this service endpoint:

  • https://redis.googleapis.com

REST Resource: v1beta1.projects.locations

Methods
get GET /v1beta1/{name=projects/*/locations/*}
Gets information about a location.
getSharedRegionalCertificateAuthority GET /v1beta1/{name=projects/*/locations/*/sharedRegionalCertificateAuthority}
Gets the details of regional certificate authority information for Redis cluster.
list GET /v1beta1/{name=projects/*}/locations
Lists information about the supported locations for this service.

REST Resource: v1beta1.projects.locations.aclPolicies

Methods
create POST /v1beta1/{parent=projects/*/locations/*}/aclPolicies
Creates an ACL policy.
delete DELETE /v1beta1/{name=projects/*/locations/*/aclPolicies/*}
Deletes a specific ACL policy.
get GET /v1beta1/{name=projects/*/locations/*/aclPolicies/*}
Gets the details of a specific Redis Cluster ACL policy.
list GET /v1beta1/{parent=projects/*/locations/*}/aclPolicies
Lists all ACL policies owned by a project in either the specified location (region) or all locations.
patch PATCH /v1beta1/{aclPolicy.name=projects/*/locations/*/aclPolicies/*}
Updates the ACL policy.

REST Resource: v1beta1.projects.locations.aclPolicies.revisions

Methods
get GET /v1beta1/{name=projects/*/locations/*/aclPolicies/*/revisions/*}
Gets details of a specific ACL policy revision.
list GET /v1beta1/{parent=projects/*/locations/*/aclPolicies/*}/revisions
Lists all ACL policy revisions in a given ACL policy.

REST Resource: v1beta1.projects.locations.backupCollections

Methods
get GET /v1beta1/{name=projects/*/locations/*/backupCollections/*}
Get a backup collection.
list GET /v1beta1/{parent=projects/*/locations/*}/backupCollections
Lists all backup collections owned by a consumer project in either the specified location (region) or all locations.

REST Resource: v1beta1.projects.locations.backupCollections.backups

Methods
delete DELETE /v1beta1/{name=projects/*/locations/*/backupCollections/*/backups/*}
Deletes a specific backup.
export POST /v1beta1/{name=projects/*/locations/*/backupCollections/*/backups/*}:export
Exports a specific backup to a customer target Cloud Storage URI.
get GET /v1beta1/{name=projects/*/locations/*/backupCollections/*/backups/*}
Gets the details of a specific backup.
list GET /v1beta1/{parent=projects/*/locations/*/backupCollections/*}/backups
Lists all backups owned by a backup collection.

REST Resource: v1beta1.projects.locations.clusters

Methods
addTokenAuthUser POST /v1beta1/{cluster=projects/*/locations/*/clusters/*}:addTokenAuthUser
Adds a token auth user for a token based auth enabled cluster.
backup POST /v1beta1/{name=projects/*/locations/*/clusters/*}:backup
Backup Redis Cluster.
create POST /v1beta1/{parent=projects/*/locations/*}/clusters
Creates a Redis cluster based on the specified properties.
delete DELETE /v1beta1/{name=projects/*/locations/*/clusters/*}
Deletes a specific Redis cluster.
get GET /v1beta1/{name=projects/*/locations/*/clusters/*}
Gets the details of a specific Redis cluster.
getCertificateAuthority GET /v1beta1/{name=projects/*/locations/*/clusters/*/certificateAuthority}
Gets the details of certificate authority information for Redis cluster.
list GET /v1beta1/{parent=projects/*/locations/*}/clusters
Lists all Redis clusters owned by a project in either the specified location (region) or all locations.
patch PATCH /v1beta1/{cluster.name=projects/*/locations/*/clusters/*}
Updates the metadata and configuration of a specific Redis cluster.
rescheduleClusterMaintenance POST /v1beta1/{name=projects/*/locations/*/clusters/*}:rescheduleClusterMaintenance
Reschedules upcoming maintenance event.

REST Resource: v1beta1.projects.locations.clusters.tokenAuthUsers

Methods
addAuthToken POST /v1beta1/{tokenAuthUser=projects/*/locations/*/clusters/*/tokenAuthUsers/*}:addAuthToken
Adds a auth token for a user of a token based auth enabled cluster.
delete DELETE /v1beta1/{name=projects/*/locations/*/clusters/*/tokenAuthUsers/*}
Deletes a token auth user for a token based auth enabled cluster.
get GET /v1beta1/{name=projects/*/locations/*/clusters/*/tokenAuthUsers/*}
Gets a specific token auth user for a basic auth enabled cluster.
list GET /v1beta1/{parent=projects/*/locations/*/clusters/*}/tokenAuthUsers
Lists all the token auth users for a token based auth enabled cluster.

REST Resource: v1beta1.projects.locations.clusters.tokenAuthUsers.authTokens

Methods
delete DELETE /v1beta1/{name=projects/*/locations/*/clusters/*/tokenAuthUsers/*/authTokens/*}
Removes a auth token for a user of a token based auth enabled instance.
get GET /v1beta1/{name=projects/*/locations/*/clusters/*/tokenAuthUsers/*/authTokens/*}
Gets a specific auth token for a specific token auth user.
list GET /v1beta1/{parent=projects/*/locations/*/clusters/*/tokenAuthUsers/*}/authTokens
Lists all the auth tokens for a specific token auth user.

REST Resource: v1beta1.projects.locations.operations

Methods
cancel POST /v1beta1/{name=projects/*/locations/*/operations/*}:cancel
Starts asynchronous cancellation on a long-running operation.
delete DELETE /v1beta1/{name=projects/*/locations/*/operations/*}
Deletes a long-running operation.
get GET /v1beta1/{name=projects/*/locations/*/operations/*}
Gets the latest state of a long-running operation.
list GET /v1beta1/{name=projects/*/locations/*}/operations
Lists operations that match the specified filter in the request.

REST Resource: v1alpha1.projects.locations

Methods
get GET /v1alpha1/{name=projects/*/locations/*}
Gets information about a location.
getSharedRegionalCertificateAuthority GET /v1alpha1/{name=projects/*/locations/*/sharedRegionalCertificateAuthority}
Gets the details of regional certificate authority information for Redis cluster.
list GET /v1alpha1/{name=projects/*}/locations
Lists information about the supported locations for this service.

REST Resource: v1alpha1.projects.locations.aclPolicies

Methods
create POST /v1alpha1/{parent=projects/*/locations/*}/aclPolicies
Creates an ACL policy.
delete DELETE /v1alpha1/{name=projects/*/locations/*/aclPolicies/*}
Deletes a specific ACL policy.
get GET /v1alpha1/{name=projects/*/locations/*/aclPolicies/*}
Gets the details of a specific Redis Cluster ACL policy.
list GET /v1alpha1/{parent=projects/*/locations/*}/aclPolicies
Lists all ACL policies owned by a project in either the specified location (region) or all locations.
patch PATCH /v1alpha1/{aclPolicy.name=projects/*/locations/*/aclPolicies/*}
Updates the ACL policy.

REST Resource: v1alpha1.projects.locations.aclPolicies.revisions

Methods
get GET /v1alpha1/{name=projects/*/locations/*/aclPolicies/*/revisions/*}
Gets details of a specific ACL policy revision.
list GET /v1alpha1/{parent=projects/*/locations/*/aclPolicies/*}/revisions
Lists all ACL policy revisions in a given ACL policy.

REST Resource: v1alpha1.projects.locations.backupCollections

Methods
get GET /v1alpha1/{name=projects/*/locations/*/backupCollections/*}
Get a backup collection.
list GET /v1alpha1/{parent=projects/*/locations/*}/backupCollections
Lists all backup collections owned by a consumer project in either the specified location (region) or all locations.

REST Resource: v1alpha1.projects.locations.backupCollections.backups

Methods
delete DELETE /v1alpha1/{name=projects/*/locations/*/backupCollections/*/backups/*}
Deletes a specific backup.
export POST /v1alpha1/{name=projects/*/locations/*/backupCollections/*/backups/*}:export
Exports a specific backup to a customer target Cloud Storage URI.
get GET /v1alpha1/{name=projects/*/locations/*/backupCollections/*/backups/*}
Gets the details of a specific backup.
list GET /v1alpha1/{parent=projects/*/locations/*/backupCollections/*}/backups
Lists all backups owned by a backup collection.

REST Resource: v1alpha1.projects.locations.clusters

Methods
addTokenAuthUser POST /v1alpha1/{cluster=projects/*/locations/*/clusters/*}:addTokenAuthUser
Adds a token auth user for a token based auth enabled cluster.
backup POST /v1alpha1/{name=projects/*/locations/*/clusters/*}:backup
Backup Redis Cluster.
create POST /v1alpha1/{parent=projects/*/locations/*}/clusters
Creates a Redis cluster based on the specified properties.
delete DELETE /v1alpha1/{name=projects/*/locations/*/clusters/*}
Deletes a specific Redis cluster.
get GET /v1alpha1/{name=projects/*/locations/*/clusters/*}
Gets the details of a specific Redis cluster.
getCertificateAuthority GET /v1alpha1/{name=projects/*/locations/*/clusters/*/certificateAuthority}
Gets the details of certificate authority information for Redis cluster.
list GET /v1alpha1/{parent=projects/*/locations/*}/clusters
Lists all Redis clusters owned by a project in either the specified location (region) or all locations.
patch PATCH /v1alpha1/{cluster.name=projects/*/locations/*/clusters/*}
Updates the metadata and configuration of a specific Redis cluster.
rescheduleClusterMaintenance POST /v1alpha1/{name=projects/*/locations/*/clusters/*}:rescheduleClusterMaintenance
Reschedules upcoming maintenance event.

REST Resource: v1alpha1.projects.locations.clusters.tokenAuthUsers

Methods
addAuthToken POST /v1alpha1/{tokenAuthUser=projects/*/locations/*/clusters/*/tokenAuthUsers/*}:addAuthToken
Adds a auth token for a user of a token based auth enabled cluster.
delete DELETE /v1alpha1/{name=projects/*/locations/*/clusters/*/tokenAuthUsers/*}
Deletes a token auth user for a token based auth enabled cluster.
get GET /v1alpha1/{name=projects/*/locations/*/clusters/*/tokenAuthUsers/*}
Gets a specific token auth user for a basic auth enabled cluster.
list GET /v1alpha1/{parent=projects/*/locations/*/clusters/*}/tokenAuthUsers
Lists all the token auth users for a token based auth enabled cluster.

REST Resource: v1alpha1.projects.locations.clusters.tokenAuthUsers.authTokens

Methods
delete DELETE /v1alpha1/{name=projects/*/locations/*/clusters/*/tokenAuthUsers/*/authTokens/*}
Removes a auth token for a user of a token based auth enabled instance.
get GET /v1alpha1/{name=projects/*/locations/*/clusters/*/tokenAuthUsers/*/authTokens/*}
Gets a specific auth token for a specific token auth user.
list GET /v1alpha1/{parent=projects/*/locations/*/clusters/*/tokenAuthUsers/*}/authTokens
Lists all the auth tokens for a specific token auth user.

REST Resource: v1alpha1.projects.locations.operations

Methods
cancel POST /v1alpha1/{name=projects/*/locations/*/operations/*}:cancel
Starts asynchronous cancellation on a long-running operation.
delete DELETE /v1alpha1/{name=projects/*/locations/*/operations/*}
Deletes a long-running operation.
get GET /v1alpha1/{name=projects/*/locations/*/operations/*}
Gets the latest state of a long-running operation.
list GET /v1alpha1/{name=projects/*/locations/*}/operations
Lists operations that match the specified filter in the request.

REST Resource: v1.projects.locations

Methods
get GET /v1/{name=projects/*/locations/*}
Gets information about a location.
getSharedRegionalCertificateAuthority GET /v1/{name=projects/*/locations/*/sharedRegionalCertificateAuthority}
Gets the details of regional certificate authority information for Redis cluster.
list GET /v1/{name=projects/*}/locations
Lists information about the supported locations for this service.

REST Resource: v1.projects.locations.aclPolicies

Methods
create POST /v1/{parent=projects/*/locations/*}/aclPolicies
Creates an ACL policy.
delete DELETE /v1/{name=projects/*/locations/*/aclPolicies/*}
Deletes a specific ACL policy.
get GET /v1/{name=projects/*/locations/*/aclPolicies/*}
Gets the details of a specific Redis Cluster ACL policy.
list GET /v1/{parent=projects/*/locations/*}/aclPolicies
Lists all ACL policies owned by a project in either the specified location (region) or all locations.
patch PATCH /v1/{aclPolicy.name=projects/*/locations/*/aclPolicies/*}
Updates the ACL policy.

REST Resource: v1.projects.locations.aclPolicies.revisions

Methods
get GET /v1/{name=projects/*/locations/*/aclPolicies/*/revisions/*}
Gets details of a specific ACL policy revision.
list GET /v1/{parent=projects/*/locations/*/aclPolicies/*}/revisions
Lists all ACL policy revisions in a given ACL policy.

REST Resource: v1.projects.locations.backupCollections

Methods
get GET /v1/{name=projects/*/locations/*/backupCollections/*}
Get a backup collection.
list GET /v1/{parent=projects/*/locations/*}/backupCollections
Lists all backup collections owned by a consumer project in either the specified location (region) or all locations.

REST Resource: v1.projects.locations.backupCollections.backups

Methods
delete DELETE /v1/{name=projects/*/locations/*/backupCollections/*/backups/*}
Deletes a specific backup.
export POST /v1/{name=projects/*/locations/*/backupCollections/*/backups/*}:export
Exports a specific backup to a customer target Cloud Storage URI.
get GET /v1/{name=projects/*/locations/*/backupCollections/*/backups/*}
Gets the details of a specific backup.
list GET /v1/{parent=projects/*/locations/*/backupCollections/*}/backups
Lists all backups owned by a backup collection.

REST Resource: v1.projects.locations.clusters

Methods
addTokenAuthUser POST /v1/{cluster=projects/*/locations/*/clusters/*}:addTokenAuthUser
Adds a token auth user for a token based auth enabled cluster.
backup POST /v1/{name=projects/*/locations/*/clusters/*}:backup
Backup Redis Cluster.
create POST /v1/{parent=projects/*/locations/*}/clusters
Creates a Redis cluster based on the specified properties.
delete DELETE /v1/{name=projects/*/locations/*/clusters/*}
Deletes a specific Redis cluster.
get GET /v1/{name=projects/*/locations/*/clusters/*}
Gets the details of a specific Redis cluster.
getCertificateAuthority GET /v1/{name=projects/*/locations/*/clusters/*/certificateAuthority}
Gets the details of certificate authority information for Redis cluster.
list GET /v1/{parent=projects/*/locations/*}/clusters
Lists all Redis clusters owned by a project in either the specified location (region) or all locations.
patch PATCH /v1/{cluster.name=projects/*/locations/*/clusters/*}
Updates the metadata and configuration of a specific Redis cluster.
rescheduleClusterMaintenance POST /v1/{name=projects/*/locations/*/clusters/*}:rescheduleClusterMaintenance
Reschedules upcoming maintenance event.

REST Resource: v1.projects.locations.clusters.tokenAuthUsers

Methods
addAuthToken POST /v1/{tokenAuthUser=projects/*/locations/*/clusters/*/tokenAuthUsers/*}:addAuthToken
Adds a auth token for a user of a token based auth enabled cluster.
delete DELETE /v1/{name=projects/*/locations/*/clusters/*/tokenAuthUsers/*}
Deletes a token auth user for a token based auth enabled cluster.
get GET /v1/{name=projects/*/locations/*/clusters/*/tokenAuthUsers/*}
Gets a specific token auth user for a basic auth enabled cluster.
list GET /v1/{parent=projects/*/locations/*/clusters/*}/tokenAuthUsers
Lists all the token auth users for a token based auth enabled cluster.

REST Resource: v1.projects.locations.clusters.tokenAuthUsers.authTokens

Methods
delete DELETE /v1/{name=projects/*/locations/*/clusters/*/tokenAuthUsers/*/authTokens/*}
Removes a auth token for a user of a token based auth enabled instance.
get GET /v1/{name=projects/*/locations/*/clusters/*/tokenAuthUsers/*/authTokens/*}
Gets a specific auth token for a specific token auth user.
list GET /v1/{parent=projects/*/locations/*/clusters/*/tokenAuthUsers/*}/authTokens
Lists all the auth tokens for a specific token auth user.

REST Resource: v1.projects.locations.operations

Methods
cancel POST /v1/{name=projects/*/locations/*/operations/*}:cancel
Starts asynchronous cancellation on a long-running operation.
delete DELETE /v1/{name=projects/*/locations/*/operations/*}
Deletes a long-running operation.
get GET /v1/{name=projects/*/locations/*/operations/*}
Gets the latest state of a long-running operation.
list GET /v1/{name=projects/*/locations/*}/operations
Lists operations that match the specified filter in the request.