Scalr Script Executions API

swagger: '2.0'
info:
  description: Manage Roles, Images, Environments and etc.
  title: Scalr Account Acl Roles Script Executions API
  version: 1.0.0
basePath: /api/v1beta0/account
produces:
- application/json
tags:
- name: Script Executions
paths:
  /{envId}/script-executions/{scriptExecutionId}/:
    parameters:
    - description: The ID of the Environment scoping this request.
      in: path
      name: envId
      required: true
      type: integer
    - description: The ID of a ScriptExecution object.
      in: path
      maxLength: 36
      minLength: 36
      name: scriptExecutionId
      pattern: '[A-Fa-f0-9]{8}-([A-Fa-f0-9]{4}-){3}[A-Fa-f0-9]{12}'
      required: true
      type: string
      x-references:
        $ref: '#/definitions/ScriptExecution'
    get:
      description: Describes detailed information about a state of the script execution.
      responses:
        200:
          description: The JSON representation of a ScriptExecution object.
          schema:
            $ref: '#/definitions/ScriptExecutionDetailsResponse'
        400:
          description: A client-side error was made.
          schema:
            $ref: '#/definitions/ApiErrorResponse'
          x-errorCodes:
          - description: The request was structurally incorrect, and was not understood by the API.
            name: InvalidStructure
          - description: The request was understood by the API, but included invalid data.
            name: InvalidValue
          - description: The request wasn't understood by the API.
            name: BadRequest
        401:
          description: The request was not authenticated.
          schema:
            $ref: '#/definitions/ApiErrorResponse'
          x-errorCodes:
          - description: The request was not properly authenticated.
            name: BadAuthentication
        403:
          description: Insufficient permissions.
          schema:
            $ref: '#/definitions/ApiErrorResponse'
          x-errorCodes:
          - description: This request should be made in a different Scope.
            name: ScopeViolation
          - description: You do not have the necessary permissions to perform this request.
            name: PermissionViolation
          - description: The maximum memory limit in GB has been reached.
            name: MemoryQuotaExceeded
          - description: The vCPUs limit has been reached.
            name: VcpusQuotaExceeded
          - description: The maximum number of the Servers that you can launch or resume has been reached.
            name: ServersQuotaExceeded
          - description: The maximum number of the Servers that you can launch or resume on current Farm has been reached.
            name: ServersPerFarmQuotaExceeded
        404:
          description: Resource not found.
          schema:
            $ref: '#/definitions/ApiErrorResponse'
          x-errorCodes:
          - description: This endpoint does not exist.
            name: EndpointNotFound
            noDoc: true
          - description: The object you are trying to access does not exist.
            name: ObjectNotFound
        409:
          description: Conflict with current state.
          schema:
            $ref: '#/definitions/ApiErrorResponse'
          x-errorCodes:
          - description: These changes aren't possible while this object is in use.
            name: ObjectInUse
          - description: These changes would violate a policy.
            name: PolicyViolation
          - description: These changes would violate a unicity constraint.
            name: UnicityViolation
          - description: Some of the objects being changed are locked and cannot be changed.
            name: Locked
          - description: This Cloud platform is not enabled.
            name: NotEnabledPlatform
          - description: The Operating System does not match.
            name: OperatingSystemMismatch
          - description: Some of the objects or actions being access are deprecated.
            name: Deprecated
          - description: The action can't be perfomed in the current object's state.
            name: UnacceptableState
          - description: The object that you are trying to access does not exist on the cloud.
            name: ObjectNotFoundOnCloud
          - description: Some of these settings cannot be applied, they either conflict with the current state or are invalid.
            name: UnacceptableObjectConfiguration
        422:
          description: This request was well-formed but was rejected due to semantic errors.
          schema:
            $ref: '#/definitions/ApiErrorResponse'
          x-errorCodes:
          - description: Some of the configuration settings cannot be applied because they conflict with the current state.
            name: ConfigurationMismatch
        500:
          description: A server-side error occurred.
          schema:
            $ref: '#/definitions/ApiErrorResponse'
        501:
          description: This feature is not implemented in Scalr.
          schema:
            $ref: '#/definitions/ApiErrorResponse'
        503:
          description: The service is currently unavailable.
          schema:
            $ref: '#/definitions/ApiErrorResponse'
      tags:
      - Script Executions
definitions:
  FarmForeignKey:
    properties:
      id:
        description: Identifier of the Farm.
        type: integer
    required:
    - id
    x-derived:
      $ref: '#/definitions/Farm'
    x-references:
      $ref: '#/definitions/Farm'
  ScriptVariableRemoteList:
    properties:
      category:
        description: The category of this Variable.
        type: string
      description:
        description: A description that explains what this Global Variable is used for.
        type: string
      hidden:
        description: Whether this Script Variable is hidden in Orchestration Rules or execute Script action.
        type: boolean
      integrationEndpoint:
        $ref: '#/definitions/WebhookEndpointForeignKey'
      locked:
        description: Whether this Script Variable value is locked in Orchestration Rules or execute Script action.
        type: boolean
      name:
        description: The Variable Name
        type: string
      required:
        description: Whether this Script Variable value is required in Orchestration Rules or execute Script action.
        type: boolean
      type:
        description: The type of Script Variable.
        enum:
        - ScriptVariableJson
        - ScriptVariableString
        - ScriptVariableList
        - ScriptVariableRemoteList
        type: string
      value:
        description: The value declared in the script level. This property can be redefined for not locked variables in Orhestration Rules or execute Script action. Also this field supports Global Variable interpolation.
        type: string
    required:
    - name
    - type
    - integrationEndpoint
    x-abstractType:
      $ref: '#/definitions/ScriptVariable'
    x-createOnly:
    - name
    x-discriminator: type
  ComposedUserIdentity:
    properties:
      email:
        description: Email of the User.
        format: email
        readOnly: true
        type: string
      id:
        description: Unique identifier of the User.
        type: integer
    required:
    - id
  ServerForeignKey:
    properties:
      id:
        description: Unique identifier for this Server.
        type: string
    required:
    - id
    x-derived:
      $ref: '#/definitions/Server'
    x-references:
      $ref: '#/definitions/Server'
  HostnameConfiguration:
    description: Farm Role hostname configuration.
    discriminator: type
    properties:
      domainName:
        description: Domain name template. This field supports Global Variable interpolation. Please note this property is available for AWS, Azure, VMware. For VMware it is not editable and set from IP Pool associated with primary network.
        type: string
      type:
        description: Hostname configuration type.
        enum:
        - TemplateHostnameConfiguration
        - WebhookHostnameConfiguration
        type: string
    required:
    - type
    x-concreteTypes:
    - $ref: '#/definitions/TemplateHostnameConfiguration'
    - $ref: '#/definitions/WebhookHostnameConfiguration'
  FarmLightsOutConfiguration:
    description: LightsOut configuration for a Farm.
    properties:
      autostart:
        description: Start a Farm automatically at the beginning of the allowed timeFrame.
        type: boolean
      enabled:
        description: Whether the LightsOut should be used or not.
        type: boolean
      notifications:
        description: Sends notification before Light-Out execution.
        items:
          $ref: '#/definitions/LightsOutNotification'
        type: array
      schedule:
        description: A schedule to run the Farm.
        items:
          $ref: '#/definitions/LightsOutTimeFrame'
        type: array
      shutdownBehavior:
        description: The method to shutdown a Farm.
        enum:
        - terminate
        - suspend
        type: string
    required:
    - shutdownBehavior
    - schedule
    - notifications
  NetworkCloudFeatures:
    description: Cloud specifics Farm Role Network configuration.
    discriminator: type
    properties:
      type:
        enum:
        - OpenstackNetworkCloudFeatures
        - AzureNetworkCloudFeatures
        type: string
    required:
    - type
    x-concreteTypes:
    - $ref: '#/definitions/OpenstackNetworkCloudFeatures'
    - $ref: '#/definitions/AzureNetworkCloudFeatures'
  CloudFeatures:
    description: Cloud specifics Farm Role configuration.
    discriminator: type
    properties:
      type:
        enum:
        - AwsCloudFeatures
        - AzureCloudFeatures
        - VmwareCloudFeatures
        - GceCloudFeatures
        - OpenstackCloudFeatures
        type: string
    required:
    - type
    x-concreteTypes:
    - $ref: '#/definitions/AwsCloudFeatures'
    - $ref: '#/definitions/AzureCloudFeatures'
    - $ref: '#/definitions/VmwareCloudFeatures'
    - $ref: '#/definitions/GceCloudFeatures'
    - $ref: '#/definitions/OpenstackCloudFeatures'
    x-createOnly:
    - type
  ScriptVariable:
    discriminator: type
    properties:
      category:
        description: The category of this Variable.
        type: string
      description:
        description: A description that explains what this Global Variable is used for.
        type: string
      hidden:
        description: Whether this Script Variable is hidden in Orchestration Rules or execute Script action.
        type: boolean
      locked:
        description: Whether this Script Variable value is locked in Orchestration Rules or execute Script action.
        type: boolean
      name:
        description: The Variable Name
        type: string
      required:
        description: Whether this Script Variable value is required in Orchestration Rules or execute Script action.
        type: boolean
      type:
        description: The type of Script Variable.
        enum:
        - ScriptVariableJson
        - ScriptVariableString
        - ScriptVariableList
        - ScriptVariableRemoteList
        type: string
      value:
        description: The value declared in the script level. This property can be redefined for not locked variables in Orhestration Rules or execute Script action. Also this field supports Global Variable interpolation.
        type: string
    required:
    - name
    - type
    x-concreteTypes:
    - $ref: '#/definitions/ScriptVariableString'
    - $ref: '#/definitions/ScriptVariableJson'
    - $ref: '#/definitions/ScriptVariableList'
    - $ref: '#/definitions/ScriptVariableRemoteList'
    x-createOnly:
    - name
  TemplateHostnameConfiguration:
    description: Template for hostname generation.
    properties:
      domainName:
        description: Domain name template. This field supports Global Variable interpolation. Please note this property is available for AWS, Azure, VMware. For VMware it is not editable and set from IP Pool associated with primary network.
        type: string
      template:
        description: Hostname template. This field supports Global Variable interpolation.
        type: string
      type:
        description: Hostname configuration type.
        enum:
        - TemplateHostnameConfiguration
        - WebhookHostnameConfiguration
        type: string
    required:
    - type
    x-abstractType:
      $ref: '#/definitions/HostnameConfiguration'
    x-discriminator: type
  FarmRoleAnsibleTowerConfiguration:
    properties:
      id:
        description: The Ansible Tower configuration identifier.
        maxLength: 36
        minLength: 36
        pattern: '[A-Fa-f0-9]{8}-([A-Fa-f0-9]{4}-){3}[A-Fa-f0-9]{12}'
        type: string
      name:
        description: The Ansible Tower configuration name.
        type: string
      scope:
        description: The scope of AnsiblTower bootstrap configuration. Property is returned only with FarmTemplates.
        enum:
        - role
        - farmrole
        readOnly: true
        type: string
      variables:
        description: The Ansible Tower variables to override. JSON or YAML representation.
        type: string
  ChefServerBootstrapConfiguration:
    description: Farm Role Chef server configuration. Please note that almost all properties are read-only if Chef is configured at higher scope and it is only possible to override "environment" and "attributes" properties.
    properties:
      attributes:
        description: The attributes are specific details about a node.
        type: string
      daemonize:
        description: Whether Run Chef client as a daemon.
        type: boolean
      enabled:
        default: false
        type: boolean
      environment:
        default: _default
        description: Identifier of the Chef Environment.
        type: string
      logLevel:
        default: auto
        description: The level of the chef log.
        enum:
        - auto
        - debug
        - info
        - warn
        - error
        - fatal
        type: string
      node:
        description: The Chef node name.
        type: string
      roleName:
        description: A Chef role which to be applied for bootstrapping. Please note that this property can not be set simultaneously with runList property.
        type: string
      runList:
        description: A list of Chef recipes / roles which is applied. It defines all information necessary for Chef to configure a node.
        type: string
      scope:
        enum:
        - scalr
        - account
        - environment
        - farm
        - farmrole
        - role
        - server
        readOnly: true
        type: string
      server:
        $ref: '#/definitions/ChefServerForeignKey'
        description: Identifier of the Chef Server.
      sslVerificationMode:
        default: none
        enum:
        - auto
        - peer
        - none
        type: string
      template:
        description: A cookbook template is an Embedded Ruby template that is used to dynamically generate static text files.
        type: string
      type:
        description: Bootstrap configuration type.
        enum:
        - ChefServerBootstrapConfiguration
        - ChefSoloBootstrapConfiguration
        - AnsibleTowerBootstrapConfiguration
        type: string
      workflow:
        default: classic
        description: Chef workflow.
        enum:
        - classic
        - policyfiles
        type: string
    required:
    - type
    - server
    x-abstractType:
      $ref: '#/definitions/ChefBootstrapConfiguration'
    x-discriminator: type
  CloudNetworkForeignKey:
    properties:
      id:
        type: string
    required:
    - id
  SecurityGroupIdentity:
    properties:
      id:
        description: Identifier of the SecurityGroup object.
        type: string
      name:
        description: The name of the Security Group which can be used to set a default Security Group when ID is unknown.
        type: string
    required:
    - id
  FarmLockOptions:
    properties:
      comment:
        description: A brief comment or explanation.
        readOnly: true
        type: string
      unlockPermission:
        description: 'The field may have a three possible values: ''owner'', ''team'' or ''anyone''. Owner - operation is allowed only for the owner of the Farm Team - operation is allowed only for the members of the Farm''s Team. Anyone - operation is allowed for anybody who has access permissions to Farms.'
        enum:
        - owner
        - team
        - anyone
        readOnly: true
        type: string
      user:
        $ref: '#/definitions/UserForeignKey'
        description: The identifier of the User who locked a Farm.
        readOnly: true
  LightsOutTimeFrame:
    description: Time frame for the LightsOut schedule.
    properties:
      daysOfWeek:
        items:
          description: The days this rule is applied on.
          enum:
          - sun
          - mon
          - tue
          - wed
          - thu
          - fri
          - sat
          type: string
        type: array
      end:
        description: End of the frame.
        format: date-time
        type: string
      start:
        description: Start time.
        format: date-time
        type: string
    required:
    - daysOfWeek
  AwsCloudFeatures:
    description: AWS Farm Role configuration. Available only for AWS Farm Roles.
    properties:
      backupInstanceTypes:
        description: 'The list of instance types to use as a backup when Amazon capacity reached. Note: Instances will be used in order they have been passed.'
        items:
          $ref: '#/definitions/InstanceTypeForeignKey'
        type: array
      ebsOptimized:
        description: Enable EBS optimization for all instances of this Farm Role. Note that this option is available only for EBS-optimized instance types.
        type: boolean
      iamInstanceProfile:
        description: The Specific Amazon IAM instance profile.
        type: string
      spotInstances:
        $ref: '#/definitions/AwsSpotInstanceConfiguration'
        description: Spot Instance configuration for this Farm Role.
      type:
        enum:
        - AwsCloudFeatures
        - AzureCloudFeatures
        - VmwareCloudFeatures
        - GceCloudFeatures
        - OpenstackCloudFeatures
        type: string
    required:
    - type
    x-abstractType:
      $ref: '#/definitions/CloudFeatures'
    x-createOnly:
    - type
    x-discriminator: type
  LightsOutNotification:
    discriminator: type
    properties:
      minutes:
        description: A time prior to Lights-out execution the notification to be sent.
        type: integer
      type:
        description: A type of the notification to send.
        enum:
        - LightsOutEmailNotification
        - LightsOutFarmOwnerNotification
        type: string
    required:
    - type
    - minutes
    x-concreteTypes:
    - $ref: '#/definitions/LightsOutEmailNotification'
    - $ref: '#/definitions/LightsOutFarmOwnerNotification'
  RoleCategory:
    properties:
      id:
        description: Identifier of the Role Category.
        readOnly: true
        type: integer
      name:
        description: The name of the Role Category.
        type: string
      scope:
        description: The Scope in which this Role Category is defined.
        enum:
        - scalr
        - account
        - environment
        - farm
        - farmrole
        - role
        - server
        readOnly: true
        type: string
    required:
    - name
    x-filterable:
    - id
    - name
    - scope
    x-usedIn:
    - /user/{envId}/role-categories/
    - /user/{envId}/role-categories/{roleCategoryId}/
  Farm:
    properties:
      description:
        type: string
      id:
        description: Identifier of the Farm.
        readOnly: true
        type: integer
      launchOrder:
        default: simultaneous
        enum:
        - simultaneous
        - sequential
        type: string
      lightsOut:
        $ref: '#/definitions/FarmLightsOutConfiguration'
        description: Farm launch and shutdown schedule management.
      locked:
        $ref: '#/definitions/FarmLockOptions'
        description: This property available only for locked Farm and included options with which the Farm has been locked.
        readOnly: true
      name:
        type: string
      owner:
        $ref: '#/definitions/ComposedUserIdentity'
      status:
        description: Farm status.
        enum:
        - running
        - suspended
        - terminated
        - pending_terminate
        - pending_launch
        readOnly: true
        type: string
      teams:
        description: List of the Teams that have access to this Farm.
        items:
          $ref: '#/definitions/ComposedTeamIdentity'
        type: array
      timezone:
        type: string
    required:
    - name
    x-filterable:
    - id
    - name
    - project
    - launchOrder
    - owner
    - teams
    - timezone
    - status
    x-usedIn:
    - /user/{envId}/farms/{farmId}/servers/
    - /user/{envId}/farms/
    - /user/{envId}/farms/{farmId}/
    - /user/{envId}/farms/{farmId}/cloud-services/
    - /user/{envId}/farms/{farmId}/cloud-services/{farmCloudServiceLinkId}/
    - /user/{envId}/farms/{farmId}/actions/generate-template/
    - /user/{envId}/farms/{farmId}/actions/launch/
    - /user/{envId}/farms/{farmId}/actions/suspend/
    - /user/{envId}/farms/{farmId}/actions/resume/
    - /user/{envId}/farms/{farmId}/actions/terminate/
    - /user/{envId}/farms/{farmId}/actions/lock/
    - /user/{envId}/farms/{farmId}/actions/unlock/
    - /user/{envId}/farms/{farmId}/actions/clone/
    - /user/{envId}/farms/{farmId}/global-variables/
    - /user/{envId}/farms/{farmId}/global-variables/{globalVariableName}/
    - /user/{envId}/farms/{farmId}/farm-roles/
  ChefServerForeignKey:
    properties:
      id:
        type: integer
    required:
    - id
  RoleDeprecatedOptions:
    properties:
      deprecated:
        description: The timestamp at which this Role was deprecated.
        format: date-time
        readOnly: true
        type: string
      replacement:
        $ref: '#/definitions/RoleForeignKey'
        description: The suggested replacement Role foreign key for the current Role.
        readOnly: true
  AwsSpotInstanceConfiguration:
    description: EC2 Spot instance configuration.
    properties:
      enabled:
        description: Set to TRUE to enable launch the Farm Role Server as a Spot Instance.
        type: boolean
      maxPrice:
        description: The maximum price per hour that you are willing to pay for a Spot Instance. If empty, On-Demand price will be used.
        type: number
    required:
    - enabled
  ScriptVersionForeignKey:
    properties:
      script:
        $ref: '#/definitions/ScriptForeignKey'
        description: The Script this ScriptVersion is a version of.
      version:
        description: The Script version number. null is interpreted as the latest Version.
        type: string
    required:
    - script
  CloudSubnetForeignKey:
    properties:
      id:
        type: string
    required:
    - id
  ApplicationGroupForeignKey:
    properties:
      id:
        description: Identifier of the SecurityGroup object.
        type: string
    required:
    - id
  WebhookEndpoint:
    description: Webhook endpoint summary.
    properties:
      id:
        description: Webhook endpoint identifier.
        maxLength: 36
        minLength: 36
        pattern: '[A-Fa-f0-9]{8}-([A-Fa-f0-9]{4}-){3}[A-Fa-f0-9]{12}'
        type: string
      scope:
        enum:
        - scalr
        - account
        - environment
        - farm
        - farmrole
        - role
        - server
        type: string
      url:
        description: Endpoint URL.
        type: string
  ServerAlert:
    description: Alerts about server state
    properties:
      message:
        description: Full error message
        type: string
      occurred:
        description: Datetime alert occurred at
        format: date-time
        type: string
      status:
        description: Status of an alert
        enum:
        - failed
        - warning
        type: string
      type:
        description: Type of alert
        enum:
        - SCALARIZR_CONNECT
        - SCALARIZR_UPD_CLIENT_CONNECT
        - AWS_SYSTEM_STATUS
        - AWS_INSTANCE_STATUS
        - AWS_RETIREMENT
        type: string
    required:
    - type
    - occurred
    - status
  VmwareCloudFeatures:
    description: VMware Farm Role configuration. Required for VMware Farm Roles.
    properties:
      computeResource:
        description: Identifier of the VMware compute resource.
        type: string
      customizationSpec:
        description: Unique name of the specification.
        type: string
      dataStore:
        description: The data storage or storage pod identifier. Storage pod with enabled SDRS is allowed to pass only.
        type: string
      folder:
        description: A VMware folder.
        type: string
      hosts:
        description: The machine host addresses. If property is empty or not specified, host will be chosen by the Distributed Resource Scheduler.
        items:
          type: string
        type: array
      placementStrategy:
        default: manual
        description: Passing with scalr-auto value means enabling 'auto' mode  (Compute resource will be selected by Scalr). The next properties computeResource, resourcePool, dataStore and hosts have to be empty or omitted.
        enum:
        - manual
        - scalr-auto
        type: string
      resourcePool:
        description: The resource pool identifier.
        type: string
      type:
        enum:
        - AwsCloudFeatures
        - AzureCloudFeatures
        - VmwareCloudFeatures
        - GceCloudFeatures
        - OpenstackCloudFeatures
        type: string
    required:
    - type
    - folder
    x-abstractType:
      $ref: '#/definitions/CloudFeatures'
    x-createOnly:
    - type
    x-discriminator: type
  ScalingConfiguration:
    properties:
      considerSuspendedServers:
        default: running
        description: By default Scalr considers all suspended servers as running when calculating the number of running instances to make a scaling decision.
        enum:
        - running
        - terminated
        type: string
      enabled:
        default: false
        type: boolean
      maxInstances:
        default: 2
        type: integer
      minInstances:
        default: 1
        type: integer
      rules:
        items:
          description: A list of Scaling Metrics' names.
          type: string
        readOnly: true
        type: array
      scalingBehavior:
        default: launch-terminate
        description: By default value is 'launch-terminate', Scalr autoscales by launching and terminating servers. If you change this options to 'suspend-resume' Scalr will automatically scale servers by suspending and resuming servers.
        enum:
        - suspend-resume
        - launch-terminate
        type: string
    x-usedIn:
    - /user/{envId}/farm-roles/{farmRoleId}/scaling/
  SecurityConfiguration:
    properties:
      securityGroups:
        description: The list of the Security Groups associated to the Farm Role. Please note that this property is not available for GCE and VMware Farm Roles. It is required for AWS Farm Roles were was launched inside Amazon VPC.
        items:
          $ref: '#/definitions/SecurityGroupIdentity'
        type: array
    required:
    - securityGroups
  NetworkConfiguration:
    description: Farm Role network configuration.
    properties:
      hostname:
        $ref: '#/definitions/HostnameConfiguration'
        description: Hostname configuration
      networks:
        description: The network identifiers.
        items:
          $ref: '#/definitions/FarmRoleNetwork'
        type: array
      subnets:
        description: The subnet identifiers.
        items:
          $ref: '#/definitions/CloudSubnet'
        type: array
  IpPoolForeignKey:
    properties:
      id:
        description: Identifier of the IpPool configuration.
        maxLength: 36
        minLength: 36
        pattern: '[A-Fa-f0-9]{8}-([A-Fa-f0-9]{4}-){3}[A-Fa-f0-9]{12}'
        type: string
    required:
    - id
  LogEntry:
    properties:
      executionExitCode:
        description: The exit status code of the Script. The value is zero when the script is executed successfully and non-zero when it fails.
        readOnly: true
        type: integer
      executionTime:
        description: Total Script execution time in seconds.
        readOnly: true
        type: integer
      farm:
        $ref: '#/definitions/FarmForeignKey'
        description: Identifier of the Farm that the target Server is related to.
        readOnly: true
      farmRole:
        $ref: '#/definitions/FarmRoleForeignKey'
        description: Identifier of the Farm Role that the target Server is related to.
        readOnly: true
      id:
        description: Orchestration log entry identifier.
        maxLength: 36
        minLength: 36
        pattern: '[A-Fa-f0-9]{8}-([A-Fa-f0-9]{4}-){3}[A-Fa-f0-9]{12}'
        readOnly: true
        type: string
      result:
        description: The result of the Script execution.
        readOnly: true
        type: string
      scriptName:
        description: The name of the Script that is executed.
        readOnly: true
        type: string
      scriptVersion:
        $ref: '#/definitions/ScriptVersionForeignKey'
        description: The version of the Script that is executed.
        readOnly: true
      server:
        $ref: '#/definitions/ServerForeignKey'
        description: Identifier of the target Server.
        readOnly: true
      triggeredBy:
        description: The context that caused excecution of the Script.
        enum:
        - ui
        - api
        - system
        readOnly: true
        type: string
    x-filterable:
    - id
    - server
    - farm
    - triggeredBy
    x-usedIn:
    - /user/{envId}/orchestration-logs/{logEntryId}/
  ScalrAgent:
    description: The information about Scalr Agent.
    properties:
      deployCommand:
        description: Command to launch Scalr Agent on your Server.
        readOnly: true
        type: string
      initializationStatus:
        $ref: '#/definitions/InitializationStatus'
        description: The detailed information about Scalr Agent initialization status.
        readOnly: true
      reachabilityStatus:
        $ref: '#/definitions/ReachabilityStatus'
        description: The detailed information about Scalr Agent reachability status check.
        readOnly: true
      version:
        description: The installed version of the Scalr Agent.
        readOnly: true
        type: string
  InstanceType:
    properties:
      cloudFeatures:
        $ref: '#/definitions/InstanceTypeCloudFeatures'
        description: Cloud specific parameters related to Instance Type.
        readOnly: true
      id:
        description: Identifier of the InstanceType object.
        readOnly: true
        type: string
      memory:
        description: Memory in GB allocated for the Instance.
        readOnly: true
        type: number
      name:
        description: The Instance Type Name in the Cloud.
        readOnly: true
        type: string
      storage:
        description: Total disks size in GB.
        readOnly: true
        type: integer
      vcpus:
        description: Virtual CPUs count.
        readOnly: true
        type: integer
    x-filterable:
    - id
    - name
    - storage
  LightsOutEmailNotification:
    properties:
      email:
        description: The email address to send the notification.
        format: email
        type: string
      minutes:
        description: A time prior to Lights-out execution the notification to be sent.
        type: integer
      type:
        description: A type of the notification to send.
        enum:
        - LightsOutEmailNotification
        - LightsOutFarmOwnerNotification
        type: string
    required:
    - type
    - minutes
    - email
    x-abstractType:
      $ref: '#/definitions/LightsOutNotification'
    x-discriminator: type
  InstanceTypeForeignKey:
    properties:
      id:
        description: Identifier of the InstanceType object.
        type: string
    required:
    - id
    x-derived:
      $ref: '#/definitions/InstanceType'
    x-references:
      $ref: '#/definitions/InstanceType'
  ReachabilityStatus:
    properties:
     

# --- truncated at 32 KB (75 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/scalr/refs/heads/main/openapi/scalr-script-executions-api-openapi.yml