Farms / Actions: Lock

Description

Lock a Farm.

HTTP Request

POST /api/v1beta0/user/envId/farms/farmId/actions/lock/

Parameters

Name Required Description Location
envId
integer		 Yes

The ID of the Environment scoping this request.

 path
farmId
integer		 Yes

The ID of a Farm object.

 path

Request body

Lock Farm options.

Example value: 

{
  "lockComment": "string",
  "unlockPermission": "owner"
}

Fields description:

Name Required Description
lockComment
string		 Yes

Comment to lock Farm.
unlockPermission
string		 No

If you would like to prevent other users unlocking the Farm you should set 'owner' options. With 'team' options only members of the Farm's Teams can unlock this Farm. Default value 'anyone' means that anyone with access can unlock this Farm.

Successful Response (Status 200)

The JSON representation of a Farm object.

The API replies with a FarmDetailsResponse object. Example response body: 

{
  "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"
    }
  ]
}

Other Response Messages

HTTP Status Code Reason Response Model
400

A client-side error was made.

 An ApiErrorResponse object
401

The request was not authenticated.

 An ApiErrorResponse object
403

Insufficient permissions.

 An ApiErrorResponse object
404

Resource not found.

 An ApiErrorResponse object
409

Conflict with current state.

 An ApiErrorResponse object
422

This request was well-formed but was rejected due to semantic errors.

 An ApiErrorResponse object
500

A server-side error occurred.

 An ApiErrorResponse object
501

This feature is not implemented in Scalr.

 An ApiErrorResponse object
503

The service is currently unavailable.

 An ApiErrorResponse object

Try it out!

Parameter Value Description
envId

The ID of the Environment scoping this request.
farmId

The ID of a Farm object.
body

Lock Farm options.