Render · Schema

redisDetail

A Redis instance

CloudPlatformDeploymentInfrastructureDevOpsWeb ServicesDatabasesHosting

Properties

Name Type Description
id string The ID of the Redis instance
createdAt string The creation time of the Redis instance
updatedAt string The last updated time of the Redis instance
status object
region object
plan object
name string The name of the Redis instance
owner object
options object
ipAllowList array The IP allow list for the Redis instance
environmentId string The ID of the environment the Redis instance is associated with
version string The version of Redis
maintenance object
View JSON Schema on GitHub

JSON Schema

render-redisdetail-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/redisDetail",
  "title": "redisDetail",
  "type": "object",
  "description": "A Redis instance",
  "required": [
    "id",
    "createdAt",
    "updatedAt",
    "status",
    "region",
    "plan",
    "name",
    "owner",
    "options",
    "ipAllowList",
    "version"
  ],
  "properties": {
    "id": {
      "description": "The ID of the Redis instance",
      "type": "string"
    },
    "createdAt": {
      "description": "The creation time of the Redis instance",
      "type": "string",
      "format": "date-time"
    },
    "updatedAt": {
      "description": "The last updated time of the Redis instance",
      "type": "string",
      "format": "date-time"
    },
    "status": {
      "$ref": "#/components/schemas/databaseStatus"
    },
    "region": {
      "$ref": "#/components/schemas/region"
    },
    "plan": {
      "$ref": "#/components/schemas/redisPlan"
    },
    "name": {
      "description": "The name of the Redis instance",
      "type": "string"
    },
    "owner": {
      "$ref": "#/components/schemas/owner"
    },
    "options": {
      "$ref": "#/components/schemas/redisOptions"
    },
    "ipAllowList": {
      "description": "The IP allow list for the Redis instance",
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/cidrBlockAndDescription"
      }
    },
    "environmentId": {
      "description": "The ID of the environment the Redis instance is associated with",
      "type": "string"
    },
    "version": {
      "description": "The version of Redis",
      "type": "string"
    },
    "maintenance": {
      "type": "object",
      "required": [
        "id",
        "type",
        "scheduledAt",
        "state"
      ],
      "properties": {
        "id": {
          "$ref": "#/paths/~1maintenance~1%7BmaintenanceRunParam%7D/get/parameters/0/schema"
        },
        "type": {
          "type": "string"
        },
        "scheduledAt": {
          "type": "string",
          "format": "date-time"
        },
        "pendingMaintenanceBy": {
          "type": "string",
          "format": "date-time",
          "description": "If present, the maintenance run cannot be scheduled for later than this date-time."
        },
        "state": {
          "$ref": "#/paths/~1maintenance/get/parameters/2/schema/items"
        }
      }
    }
  }
}