script_execution_filter_options_get

_^Tech

Returns available options that can be passed to the script_execution_get method.

Note

A script instance is a script configuration defining start / stop triggers and a specific set of flags and arguments for it to be started with. Each script instance can only run in at most one instance at any given time.

Only scripts and script instances that were executed at least once are returned.

Params

attribute	description
include_outdated bool	Indicates if the result should include executions that were executed with a script source version that has been changed since. If omitted false is assumed.

Example

{
  "include_outdated": true
}

Return

attribute	description
scripts* [Script]	The scripts that are valid filter values for the scripts parameter of the script_execution_get method
exit_codes [int]	The exit codes that were returned by an executed scripts

Script

attribute	description
name* string	The name of the script
instances* [Instance]	The script instances

Instance

attribute	description
name* string	The name of the script instance

Example

{
  "scripts": [
    {
      "name": "hello_world",
      "instances": [
        {
          "name": "manual",
        },
        {
          "name": "daily"
        }
      ]
    }
  ],
  "exit_codes": [0, 1, 2]
}