Key Value

Create Key Value instance

Changed on

Create a new Key Value instance.

post/key-value

Request

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

Request body

namestring required

The name of the Key Value instance

ownerIdstring required

The ID of the owner of the Key Value instance

plan'free' | 'starter' | 'standard' | 'pro' | 'pro_plus' | 'custom' | '256mb' | '1g' | '5g' | '10g' | '20g' | '40g' required
region'frankfurt' | 'oregon' | 'ohio' | 'singapore' | 'virginia'

Defaults to "oregon"

environmentIdstring
maxmemoryPolicy'noeviction' | 'allkeys_lfu' | 'allkeys_lru' | 'allkeys_random' | 'volatile_lfu' | 'volatile_lru' | 'volatile_random' | 'volatile_ttl'

The eviction policy for the Key Value instance

persistenceMode'journal_snapshot' | 'snapshot' | 'off'

The persistence mode for the Key Value instance. The default for paid instances is journal_snapshot (both journaling and snapshots). Only turn off persistence if you're using this Key Value instance as a cache and are okay with losing data. Free instances do not have persistence.

Response

Created

idstring required

The ID of the Key Value instance

createdAtstring date-time required

The creation time of the Key Value instance

updatedAtstring date-time required

The last updated time of the Key Value 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 Key Value instance

environmentIdstring

The ID of the environment the Key Value instance is associated with

versionstring required

The version of Key Value

maintenanceMaintenance (unresolved $ref)

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 new 10g enum value to the request property

    • info

      added the new 1g enum value to the request property

    • info

      added the new 20g enum value to the request property

    • info

      added the new 256mb enum value to the request property

    • info

      added the new 40g enum value to the request property

    • info

      added the new 5g enum value to the request property

    • 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