Method: projects.locations.instances.getAuthString

• HTTP request
• Path parameters
• Request body
• Response body
  • JSON representation
• Authorization scopes
• Examples
• Try it!

Gets 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 returned to instances.get.

HTTP request

GET https://redis.googleapis.com/v1beta1/{name=projects/*/locations/*/instances/*}/authString

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name	string Required. Redis instance resource name using the form: projects/{projectId}/locations/{locationId}/instances/{instanceId} where locationId refers to a GCP region.

Request body

The request body must be empty.

Response body

Instance AUTH string details.

If successful, the response body contains data with the following structure:

JSON representation
{ "authString": string }

Fields
authString	string AUTH string set on the instance.

Authorization scopes

Requires the following OAuth scope:

• https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.