FarmTemplateContent object

Example JSON representation

{
  "description": "string",
  "launchOrder": "simultaneous",
  "lightsOut": {
    "autostart": true,
    "enabled": true,
    "notifications": [
      {
        "minutes": 1,
        "type": "LightsOutNotification"
      }
    ],
    "schedule": [
      {
        "daysOfWeek": [
          "sun"
        ],
        "end": "2013-01-01T12:34:56.789Z",
        "start": "2013-01-01T12:34:56.789Z"
      }
    ],
    "shutdownBehavior": "terminate"
  },
  "locked": {
    "comment": "string",
    "unlockPermission": "owner"
  },
  "name": "string",
  "owner": {
    "email": "string",
    "id": 1
  },
  "project": {
    "id": "string"
  },
  "teams": [
    {
      "id": 1,
      "name": "string"
    }
  ],
  "timezone": "string",
  "variables": [
    {
      "category": "string",
      "computedValue": "string",
      "declaredIn": "scalr",
      "definedIn": "scalr",
      "description": "string",
      "hidden": true,
      "locked": true,
      "name": "string",
      "requiredIn": "scalr",
      "type": "GlobalVariable",
      "value": "string"
    }
  ]
}

Properties

property	attributes	valid values	description	filter option
name string	required
project ProjectForeignKey object	required
description string	optional
launchOrder string	optional	"simultaneous" "sequential"
lightsOut FarmLightsOutConfiguration object	optional		Farm launch and shutdown schedule management.
locked FarmTemplateContentLockOptions object	create-only		Farm lock options.
owner ComposedUserIdentity object	optional
teams Array of ComposedTeamIdentity objects	optional		List of the Teams that have access to this Farm.
timezone string	optional
variables Array of GlobalVariable objects	optional		Farm Global variable.