Path parameters

• name string Required

  Minimum length is 0, maximum length is 63.

Responses

• 200 application/json

  200

  Hide response attributes Show response attributes object

  • updated-at string(date-time)

    Service last update timestamp (ISO 8601)

  • node-count integer(int64)

    Number of service nodes in the active plan

    Minimum value is 0.

  • connection-info object

    Redis connection information properties

    Hide connection-info attributes Show connection-info attributes object

    • uri array[string]
    • password string
    • slave array[string]
  • node-cpu-count integer(int64)

    Number of CPUs for each node

    Minimum value is 0.

  • prometheus-uri object Required

    Prometheus integration URI

    Hide prometheus-uri attributes Show prometheus-uri attributes object

    • host string
    • port integer(int64)

      Minimum value is 0, maximum value is 65535.

  • integrations array[object]

    Service integrations

    Hide integrations attributes Show integrations attributes object

    • description string

      Description of the integration

    • settings object

      Integration settings

    • type string

      Integration type

    • is-enabled boolean

      Whether the integration is enabled or not

    • source string

      Source service name

    • is-active boolean

      Whether the integration is active or not

    • status string

      Integration status

    • id string(uuid)

      Integration id

    • dest string

      Destination service name

  • zone string

    The zone where the service is running

  • node-states array[object]

    State of individual service nodes

    Automatic maintenance settings

    Hide node-states attributes Show node-states attributes object

    • name string Required

      Name of the service node

    • progress-updates array[object]

      Extra information regarding the progress for current state

      Extra information regarding the progress for current state

      Hide progress-updates attributes Show progress-updates attributes object

      • completed boolean Required

        Indicates whether this phase has been completed or not

      • current integer(int64)

        Current progress for this phase. May be missing or null.

        Minimum value is 0.

      • max integer(int64)

        Maximum progress value for this phase. May be missing or null. May change.

        Minimum value is 0.

      • min integer(int64)

        Minimum progress value for this phase. May be missing or null.

        Minimum value is 0.

      • phase string Required

        Key identifying this phase

        Values are stream, basebackup, prepare, or finalize.

      • unit string

        Unit for current/min/max values. New units may be added. If null should be treated as generic unit

    • role string

      Role of this node. Only returned for a subset of service types

      Values are standby, master, or read-replica.

    • state string Required

      Current state of the service node

      Values are leaving, running, syncing_data, setting_up_vm, or unknown.

  • name string Required

    Minimum length is 0, maximum length is 63.

  • redis-settings object
    Hide redis-settings attributes Show redis-settings attributes object

    • ssl boolean

      Default value is true.

    • lfu_log_factor integer

      Minimum value is 0, maximum value is 100. Default value is 10.

    • maxmemory_policy string | null

      Values are noeviction, allkeys-lru, volatile-lru, allkeys-random, volatile-random, volatile-ttl, volatile-lfu, or allkeys-lfu. Default value is noeviction.

    • io_threads integer

      Set Redis IO thread count. Changing this will cause a restart of the Redis service.

      Minimum value is 1, maximum value is 32.

    • lfu_decay_time integer

      Minimum value is 1, maximum value is 120. Default value is 1.

    • pubsub_client_output_buffer_limit integer

      Set output buffer limit for pub / sub clients in MB. The value is the hard limit, the soft limit is 1/4 of the hard limit. When setting the limit, be mindful of the available memory in the selected service plan.

      Minimum value is 32, maximum value is 512.

    • notify_keyspace_events string

      Maximum length is 32. Format should match the following pattern: ^[KEg\$lshzxentdmA]*$. Default value is empty.

    • persistence string

      When persistence is 'rdb', Redis does RDB dumps each 10 minutes if any key is changed. Also RDB dumps are done according to backup schedule for backup purposes. When persistence is 'off', no RDB dumps and backups are done, so data can be lost at any moment if service is restarted for any reason, or if service is powered off. Also service can't be forked.

      Values are off or rdb.

    • timeout integer

      Minimum value is 0, maximum value is 31536000. Default value is 300.

    • acl_channels_default string

      Determines default pub/sub channels' ACL for new users if ACL is not supplied. When this option is not defined, all_channels is assumed to keep backward compatibility. This option doesn't affect Redis configuration acl-pubsub-default.

      Values are allchannels or resetchannels.

    • number_of_databases integer

      Set number of Redis databases. Changing this will cause a restart of the Redis service.

      Minimum value is 1, maximum value is 128.

  • type string Required

    Minimum length is 0, maximum length is 64.

  • state string

    Values are running, rebuilding, rebalancing, or poweroff.

  • ip-filter array[string]

    Allowed CIDR address blocks for incoming connections

  • backups array[object]

    List of backups for the service

    List of backups for the service

    Hide backups attributes Show backups attributes object

    • backup-name string Required

      Internal name of this backup

    • backup-time string(date-time) Required

      Backup timestamp (ISO 8601)

    • data-size integer(int64) Required

      Backup's original size before compression

      Minimum value is 0.

  • termination-protection boolean

    Service is protected against termination and powering off

  • notifications array[object]

    Service notifications

    Service notifications

    Hide notifications attributes Show notifications attributes object

    • level string Required

      Notification level

      Values are warning or notice.

    • message string Required

      Human notification message

      Minimum length is 1, maximum length is 1024.

    • type string Required

      Notification type

      Values are service_powered_off_removal or service_end_of_life.

    • metadata object Required

      Notification type

  • components array[object]

    Service component information objects

    Hide components attributes Show components attributes object

    • component string Required

      Service component name

    • host string Required

      DNS name for connecting to the service component

    • port integer(int64) Required

      Port number for connecting to the service component

      Minimum value is 0, maximum value is 65535.

    • route string Required

      Values are dynamic, private, public, or privatelink.

    • ssl boolean

      Whether the endpoint is encrypted or accepts plaintext. By default endpoints are always encrypted and this property is only included for service components that may disable encryption.

    • usage string Required

      Values are primary or replica.

  • maintenance object

    Automatic maintenance settings

    Hide maintenance attributes Show maintenance attributes object

    • dow string Required

      Day of week for installing updates

      Values are saturday, tuesday, never, wednesday, sunday, friday, monday, or thursday.

    • time string Required

      Time for installing updates, UTC

      Minimum length is 8, maximum length is 8.

    • updates array[object] Required

      List of updates waiting to be installed

      Update waiting to be installed

      Hide updates attributes Show updates attributes object

      • description string

        Description of the update

      • deadline string(date-time)

        Deadline for installing the update

      • start-after string(date-time)

        The earliest time the update will be automatically applied

      • start-at string(date-time)

        The time when the update will be automatically applied

  • disk-size integer(int64)

    TODO UNIT disk space for data storage

    Minimum value is 0.

  • node-memory integer(int64)

    TODO UNIT of memory for each node

    Minimum value is 0.

  • uri string

    URI for connecting to the service (may be absent)

  • uri-params object

    service_uri parameterized into key-value pairs

  • version string

    Redis version

  • created-at string(date-time)

    Service creation timestamp (ISO 8601)

  • plan string Required

    Subscription plan

  • users array[object]

    List of service users

    Hide users attributes Show users attributes object

    • type string
    • username string
    • password string
    • access-control object
      Hide access-control attributes Show access-control attributes object

      • categories array[string]
      • channels array[string]
      • commands array[string]
      • keys array[string]