Roku · Schema

SnapshotOut

SnapshotOut schema from Roku Nabu Cloud

StreamingTelevisionMediaEntertainmentConnected TVConsumer Electronics

Properties

Name Type Description
id integer
created_at string
parent_id object The ID of the parent Snapshot.
name string The name of the Snapshot.
description object Description of the Snapshot.
properties object Properties of the Snapshot.
rootfs_artifactory_path object The path of the rootfs image in artifactory.
started_at object
children array The IDs of the child Snapshots.
ready boolean Whether the snapshot is ready to use. Trying to start a device with a snapshot that is not ready will result in an error. Deleting the instance an unready snapshot is being taken from can cause the sn
View JSON Schema on GitHub

JSON Schema

nabu-cloud-snapshot-out-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/roku/refs/heads/main/json-schema/nabu-cloud-snapshot-out-schema.json",
  "title": "SnapshotOut",
  "description": "SnapshotOut schema from Roku Nabu Cloud",
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "minimum": 0,
      "title": "Id"
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "title": "Created At"
    },
    "parent_id": {
      "anyOf": [
        {
          "type": "integer",
          "minimum": 0
        },
        {
          "type": "null"
        }
      ],
      "title": "Parent Id",
      "description": "The ID of the parent Snapshot."
    },
    "name": {
      "type": "string",
      "maxLength": 255,
      "minLength": 3,
      "title": "Name",
      "description": "The name of the Snapshot."
    },
    "description": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 4096,
          "minLength": 0
        },
        {
          "type": "null"
        }
      ],
      "title": "Description",
      "description": "Description of the Snapshot."
    },
    "properties": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object",
          "maxProperties": 8192
        },
        {
          "type": "null"
        }
      ],
      "title": "Properties",
      "description": "Properties of the Snapshot.",
      "examples": [
        {
          "config_service_flags": {
            "fw.swup.channel-sync-enabled": "false"
          }
        }
      ]
    },
    "rootfs_artifactory_path": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 255,
          "minLength": 3,
          "pattern": "^[a-zA-Z0-9_-]*(\\/[a-zA-Z0-9._-]+)*(\\:[a-zA-Z0-9._-]+)?$"
        },
        {
          "type": "null"
        }
      ],
      "title": "Rootfs Artifactory Path",
      "description": "The path of the rootfs image in artifactory.",
      "examples": [
        "official/release/2024-h2/r14.0.4.122xx-rta/native_tv:latest",
        "premergeci/native_tv:4838657"
      ]
    },
    "started_at": {
      "anyOf": [
        {
          "type": "string",
          "format": "date-time"
        },
        {
          "type": "null"
        }
      ],
      "title": "Started At"
    },
    "children": {
      "items": {
        "type": "integer"
      },
      "type": "array",
      "title": "Children",
      "description": "The IDs of the child Snapshots.",
      "default": []
    },
    "ready": {
      "type": "boolean",
      "title": "Ready",
      "description": "\n        Whether the snapshot is ready to use. Trying to start a device with a\n        snapshot that is not ready will result in an error. Deleting the\n        instance an unready snapshot is being taken from can cause the snapshot\n        creation process to fail.\n    ",
      "default": false
    }
  },
  "required": [
    "id",
    "created_at"
  ]
}