Memorystore API

Service: memorystore.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://memorystore.googleapis.com

Regional service endpoint

A regional service endpoint is a base URL that specifies the network address of an API service in a single region. A service that is available in multiple regions might have multiple regional endpoints. Select a location to see its regional service endpoint for this service.


  • https://memorystore.googleapis.com

    • REST Resource: v1beta.projects.locations

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

    REST Resource: v1beta.projects.locations.aclPolicies

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

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

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

    REST Resource: v1beta.projects.locations.backupCollections

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

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

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

    REST Resource: v1beta.projects.locations.instances

    Methods
    addTokenAuthUser POST /v1beta/{instance=projects/*/locations/*/instances/*}:addTokenAuthUser
    Adds a token auth user for a token based auth enabled instance.
    backup POST /v1beta/{name=projects/*/locations/*/instances/*}:backup
    Backup Instance.
    create POST /v1beta/{parent=projects/*/locations/*}/instances
    Creates a new Instance in a given project and location.
    delete DELETE /v1beta/{name=projects/*/locations/*/instances/*}
    Deletes a single Instance.
    finishMigration POST /v1beta/{name=projects/*/locations/*/instances/*}:finishMigration
    Finalizes the migration process.
    get GET /v1beta/{name=projects/*/locations/*/instances/*}
    Gets details of a single Instance.
    getCertificateAuthority GET /v1beta/{name=projects/*/locations/*/instances/*}/certificateAuthority
    Gets details about the certificate authority for an Instance.
    list GET /v1beta/{parent=projects/*/locations/*}/instances
    Lists Instances in a given project and location.
    patch PATCH /v1beta/{instance.name=projects/*/locations/*/instances/*}
    Updates the parameters of a single Instance.
    rescheduleMaintenance POST /v1beta/{name=projects/*/locations/*/instances/*}:rescheduleMaintenance
    Reschedules upcoming maintenance event.
    startMigration POST /v1beta/{name=projects/*/locations/*/instances/*}:startMigration
    Initiates the migration of a source instance to the target Memorystore instance.

    REST Resource: v1beta.projects.locations.instances.tokenAuthUsers

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

    REST Resource: v1beta.projects.locations.instances.tokenAuthUsers.authTokens

    Methods
    delete DELETE /v1beta/{name=projects/*/locations/*/instances/*/tokenAuthUsers/*/authTokens/*}
    Deletes a token for a user of a token based auth enabled instance.
    get GET /v1beta/{name=projects/*/locations/*/instances/*/tokenAuthUsers/*/authTokens/*}
    Gets a token based auth enabled instance's auth token for a given user.
    list GET /v1beta/{parent=projects/*/locations/*/instances/*/tokenAuthUsers/*}/authTokens
    Lists all the auth tokens for a specific token auth user.

    REST Resource: v1beta.projects.locations.operations

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

    REST Resource: v1alpha.projects.locations

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

    REST Resource: v1alpha.projects.locations.aclPolicies

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

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

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

    REST Resource: v1alpha.projects.locations.backupCollections

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

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

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

    REST Resource: v1alpha.projects.locations.instances

    Methods
    addTokenAuthUser POST /v1alpha/{instance=projects/*/locations/*/instances/*}:addTokenAuthUser
    Adds a token auth user for a token based auth enabled instance.
    backup POST /v1alpha/{name=projects/*/locations/*/instances/*}:backup
    Backup Instance.
    create POST /v1alpha/{parent=projects/*/locations/*}/instances
    Creates a new Instance in a given project and location.
    delete DELETE /v1alpha/{name=projects/*/locations/*/instances/*}
    Deletes a single Instance.
    finishMigration POST /v1alpha/{name=projects/*/locations/*/instances/*}:finishMigration
    Finalizes the migration process.
    get GET /v1alpha/{name=projects/*/locations/*/instances/*}
    Gets details of a single Instance.
    getCertificateAuthority GET /v1alpha/{name=projects/*/locations/*/instances/*}/certificateAuthority
    Gets details about the certificate authority for an Instance.
    list GET /v1alpha/{parent=projects/*/locations/*}/instances
    Lists Instances in a given project and location.
    patch PATCH /v1alpha/{instance.name=projects/*/locations/*/instances/*}
    Updates the parameters of a single Instance.
    rescheduleMaintenance POST /v1alpha/{name=projects/*/locations/*/instances/*}:rescheduleMaintenance
    Reschedules upcoming maintenance event.
    startMigration POST /v1alpha/{name=projects/*/locations/*/instances/*}:startMigration
    Initiates the migration of a source instance to the target Memorystore instance.

    REST Resource: v1alpha.projects.locations.instances.tokenAuthUsers

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

    REST Resource: v1alpha.projects.locations.instances.tokenAuthUsers.authTokens

    Methods
    delete DELETE /v1alpha/{name=projects/*/locations/*/instances/*/tokenAuthUsers/*/authTokens/*}
    Deletes a token for a user of a token based auth enabled instance.
    get GET /v1alpha/{name=projects/*/locations/*/instances/*/tokenAuthUsers/*/authTokens/*}
    Gets a token based auth enabled instance's auth token for a given user.
    list GET /v1alpha/{parent=projects/*/locations/*/instances/*/tokenAuthUsers/*}/authTokens
    Lists all the auth tokens for a specific token auth user.

    REST Resource: v1alpha.projects.locations.operations

    Methods
    cancel POST /v1alpha/{name=projects/*/locations/*/operations/*}:cancel
    Starts asynchronous cancellation on a long-running operation.
    delete DELETE /v1alpha/{name=projects/*/locations/*/operations/*}
    Deletes a long-running operation.
    get GET /v1alpha/{name=projects/*/locations/*/operations/*}
    Gets the latest state of a long-running operation.
    list GET /v1alpha/{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 shared regional certificate authority information for Memorystore instance.
    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 Memorystore 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.instances

    Methods
    addTokenAuthUser POST /v1/{instance=projects/*/locations/*/instances/*}:addTokenAuthUser
    Adds a token auth user for a token based auth enabled instance.
    backup POST /v1/{name=projects/*/locations/*/instances/*}:backup
    Backup Instance.
    create POST /v1/{parent=projects/*/locations/*}/instances
    Creates a new Instance in a given project and location.
    delete DELETE /v1/{name=projects/*/locations/*/instances/*}
    Deletes a single Instance.
    finishMigration POST /v1/{name=projects/*/locations/*/instances/*}:finishMigration
    Finalizes the migration process.
    get GET /v1/{name=projects/*/locations/*/instances/*}
    Gets details of a single Instance.
    getCertificateAuthority GET /v1/{name=projects/*/locations/*/instances/*}/certificateAuthority
    Gets details about the certificate authority for an Instance.
    list GET /v1/{parent=projects/*/locations/*}/instances
    Lists Instances in a given project and location.
    patch PATCH /v1/{instance.name=projects/*/locations/*/instances/*}
    Updates the parameters of a single Instance.
    rescheduleMaintenance POST /v1/{name=projects/*/locations/*/instances/*}:rescheduleMaintenance
    Reschedules upcoming maintenance event.
    startMigration POST /v1/{name=projects/*/locations/*/instances/*}:startMigration
    Initiates the migration of a source instance to the target Memorystore instance.

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

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

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

    Methods
    delete DELETE /v1/{name=projects/*/locations/*/instances/*/tokenAuthUsers/*/authTokens/*}
    Deletes a token for a user of a token based auth enabled instance.
    get GET /v1/{name=projects/*/locations/*/instances/*/tokenAuthUsers/*/authTokens/*}
    Gets a token based auth enabled instance's auth token for a given user.
    list GET /v1/{parent=projects/*/locations/*/instances/*/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.