FarmDetailsResponse object
Example JSON representation
{
"data": {
"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"
},
"errors": [
{
"code": "string",
"message": "string"
}
],
"meta": {
"sample": "string"
},
"warnings": [
{
"code": "string",
"message": "string"
}
]
}
Properties
property | attributes | valid values | description | filter option |
---|---|---|---|---|
data Farm object |
read-only |
|||
errors Array of ApiMessage objects |
read-only |
|||
meta ApiMetaContainer object |
read-only |
|||
warnings Array of ApiMessage objects |
read-only |
Endpoints using this object
- User / Farms: List
- User / Farms: Create
- User / Farms: Delete
- User / Farms: Get
- User / Farms: Edit
- User / Farms / Actions: Clone
- User / Farms / Actions: Launch
- User / Farms / Actions: Lock
- User / Farms / Actions: Resume
- User / Farms / Actions: Suspend
- User / Farms / Actions: Terminate
- User / Farms / Actions: Unlock