Redis (Deprecated)

Retrieve Redis instance

Changed on

Retrieve a Redis instance by ID. This API is deprecated in favor of the Key Value API.

get/redis/{redisId}

Request

  • Base URL
    https://api.render.com/v1
  • Auth
    HTTP bearer

Path parameters

redisIdstring required

Response

Successful response

idstring required

The ID of the Redis instance

createdAtstring date-time required

The creation time of the Redis instance

updatedAtstring date-time required

The last updated time of the Redis instance

status'creating' | 'available' | 'unavailable' | 'config_restart' | 'suspended' | 'maintenance_scheduled' | 'maintenance_in_progress' | 'recovery_failed' | 'recovery_in_progress' | 'unknown' | 'updating_instance' required
region'frankfurt' | 'oregon' | 'ohio' | 'singapore' | 'virginia' required

Defaults to "oregon"

plan'free' | 'starter' | 'standard' | 'pro' | 'pro_plus' | 'custom' | '256mb' | '1g' | '5g' | '10g' | '20g' | '40g' required
namestring required

The name of the Redis instance

environmentIdstring

The ID of the environment the Redis instance is associated with

versionstring required

The version of Redis

Changes

    • breaking

      the / response's property type changed from no type to string for status

    • warning

      added the new 10g enum value to the response property for the response status

    • warning

      added the new 1g enum value to the response property for the response status

    • warning

      added the new 20g enum value to the response property for the response status

    • warning

      added the new 256mb enum value to the response property for the response status

    • warning

      added the new 40g enum value to the response property for the response status

    • warning

      added the new 5g enum value to the response property for the response status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      the / response's property pattern ^mrn-[0-9a-z]{20}$ was added for the status