CreateFarmRequest 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"
  }, 
  "name": "string", 
  "owner": {
    "email": "string", 
    "id": 1
  }, 
  "project": {
    "id": "string"
  }, 
  "teams": [
    {
      "id": 1, 
      "name": "string"
    }
  ], 
  "timezone": "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.

owner
ComposedUserIdentity object
optional
teams
Array of ComposedTeamIdentity objects
optional

List of the Teams that have access to this Farm.

timezone
string
optional