Farm object

Example JSON representation

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

Properties

property attributes valid values description filter option
name
string
required
filterable
?name=...
project
ProjectForeignKey object
required
filterable
Pass the id of the object you are referencing in:
?project=...
id
integer
read-only
filterable

Identifier of the Farm.

?id=...
locked
FarmLockOptions object
read-only

This property available only for locked Farm and included options with which the Farm has been locked.

status
string
read-only
filterable
"running"
"suspended"
"terminated"
"pending_terminate"
"pending_launch"

Farm status.

?status=...
description
string
optional
launchOrder
string
optional
filterable
"simultaneous"
"sequential"
?launchOrder=...
lightsOut
FarmLightsOutConfiguration object
optional

Farm launch and shutdown schedule management.

owner
ComposedUserIdentity object
optional
filterable
Pass the id of the object you are referencing in:
?owner=...
teams
Array of ComposedTeamIdentity objects
optional
filterable

List of the Teams that have access to this Farm.

?teams=...
timezone
string
optional
filterable
?timezone=...

Endpoints using this object