Script object

Example JSON representation

{
  "added": "2013-01-01T12:34:56.789Z", 
  "blockingDefault": true, 
  "deprecated": true, 
  "description": "string", 
  "id": 1, 
  "lastChanged": "2013-01-01T12:34:56.789Z", 
  "name": "string", 
  "osType": "linux", 
  "requireAdminPrivileges": true, 
  "scope": "scalr", 
  "tags": [
    "string"
  ], 
  "timeoutDefault": 1
}

Properties

property attributes valid values description filter option
name
string
required
filterable

The name of the Script.

?name=...
osType
string
required
create-only
filterable
"linux"
"windows"
"cross-platform"

Type of OS this Script should execute on. This will influence Orchestration Rules, and will impact the validation rules applied to the ScriptVersions.

?osType=...
added
string
read-only
id
integer
read-only
filterable
?id=...
lastChanged
string
read-only
scope
string
read-only
filterable
"scalr"
"account"
"environment"
"farm"
"farmrole"
"role"
"server"
?scope=...
blockingDefault
boolean
optional
filterable

Whether this Script is blocking by default. This can be overridden in the Orchestration Rules that use this Script.

?blockingDefault=...
deprecated
boolean
optional
filterable

Whether the Script is deprecated.

?deprecated=...
description
string
optional
requireAdminPrivileges
boolean
optional
filterable

Whether the Script requires root/Administrator privileges to be executed.

?requireAdminPrivileges=...
tags
Array of string
optional

The list of tags that should be applied to the Script.

timeoutDefault
integer
optional

The time after which Scalr will abort the execution of this Script, in seconds. This can be overridden in the Orchestration Rules that use this Script.

Endpoints using this object