Render · Schema

keyValue

A Key Value instance

CloudPlatformDeploymentInfrastructureDevOpsWeb ServicesDatabasesHosting

Properties

Name Type Description
id string The ID of the Key Value instance
createdAt string The creation time of the Key Value instance
updatedAt string The last updated time of the Key Value instance
status object
region object
plan object
name string The name of the Key Value instance
owner object
options object
ipAllowList array The IP allow list for the Key Value instance
environmentId string The ID of the environment the Key Value instance is associated with
version string The version of Key Value
dashboardUrl string The URL to view the Key Value instance in the Render Dashboard
View JSON Schema on GitHub

JSON Schema

render-keyvalue-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/keyValue",
  "title": "keyValue",
  "type": "object",
  "description": "A Key Value instance",
  "required": [
    "id",
    "createdAt",
    "updatedAt",
    "status",
    "region",
    "plan",
    "name",
    "owner",
    "options",
    "ipAllowList",
    "version",
    "dashboardUrl"
  ],
  "properties": {
    "id": {
      "description": "The ID of the Key Value instance",
      "type": "string"
    },
    "createdAt": {
      "description": "The creation time of the Key Value instance",
      "type": "string",
      "format": "date-time"
    },
    "updatedAt": {
      "description": "The last updated time of the Key Value instance",
      "type": "string",
      "format": "date-time"
    },
    "status": {
      "$ref": "#/components/schemas/databaseStatus"
    },
    "region": {
      "$ref": "#/components/schemas/region"
    },
    "plan": {
      "$ref": "#/components/schemas/keyValuePlan"
    },
    "name": {
      "description": "The name of the Key Value instance",
      "type": "string"
    },
    "owner": {
      "$ref": "#/components/schemas/owner"
    },
    "options": {
      "$ref": "#/components/schemas/keyValueOptions"
    },
    "ipAllowList": {
      "description": "The IP allow list for the Key Value instance",
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/cidrBlockAndDescription"
      }
    },
    "environmentId": {
      "description": "The ID of the environment the Key Value instance is associated with",
      "type": "string"
    },
    "version": {
      "description": "The version of Key Value",
      "type": "string"
    },
    "dashboardUrl": {
      "type": "string",
      "description": "The URL to view the Key Value instance in the Render Dashboard"
    }
  }
}