Scalr Event Logs API

swagger: '2.0'
info:
  description: Manage Roles, Images, Environments and etc.
  title: Scalr Account Acl Roles Event Logs API
  version: 1.0.0
basePath: /api/v1beta0/account
produces:
- application/json
tags:
- name: Event Logs
paths:
  /{envId}/event-logs/:
    parameters:
    - description: The ID of the Environment scoping this request.
      in: path
      name: envId
      required: true
      type: integer
    get:
      description: List of all Event logs.
      responses:
        200:
          description: A list of EventLogEntry objects.
          schema:
            $ref: '#/definitions/EventLogEntryListResponse'
        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:
      - Event Logs
  /{envId}/event-logs/{eventLogEntryId}/:
    parameters:
    - description: The ID of the Environment scoping this request.
      in: path
      name: envId
      required: true
      type: integer
    - description: The ID of a EventLogEntry object.
      in: path
      maxLength: 36
      minLength: 36
      name: eventLogEntryId
      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/EventLogEntry'
    get:
      description: Describes detailed information about the Event that has been fired.
      responses:
        200:
          description: The JSON representation of a EventLogEntry object.
          schema:
            $ref: '#/definitions/EventLogEntryDetailsResponse'
        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:
      - Event Logs
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
  EventLogEntryListResponse:
    properties:
      data:
        items:
          $ref: '#/definitions/EventLogEntry'
        readOnly: true
        type: array
      errors:
        items:
          $ref: '#/definitions/ApiMessage'
        readOnly: true
        type: array
      meta:
        $ref: '#/definitions/ApiMetaContainer'
        readOnly: true
      pagination:
        $ref: '#/definitions/ApiPagination'
        readOnly: true
      warnings:
        items:
          $ref: '#/definitions/ApiMessage'
        readOnly: true
        type: array
    x-derived:
      $ref: '#/definitions/EventLogEntry'
    x-usedIn:
    - /user/{envId}/event-logs/
  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'
  EventLogEntryDetailsResponse:
    properties:
      data:
        $ref: '#/definitions/EventLogEntry'
        readOnly: true
      errors:
        items:
          $ref: '#/definitions/ApiMessage'
        readOnly: true
        type: array
      meta:
        $ref: '#/definitions/ApiMetaContainer'
        readOnly: true
      warnings:
        items:
          $ref: '#/definitions/ApiMessage'
        readOnly: true
        type: array
    x-derived:
      $ref: '#/definitions/EventLogEntry'
    x-usedIn:
    - /user/{envId}/event-logs/{eventLogEntryId}/
    - /user/{envId}/events/{eventId}/actions/fire/
  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/
  EventLogEntry:
    properties:
      event:
        $ref: '#/definitions/EventForeignKey'
        description: Identifier of the Event.
        readOnly: true
      farm:
        $ref: '#/definitions/FarmForeignKey'
        description: Identifier of the Farm that triggered the Server is related to.
        readOnly: true
      farmRole:
        $ref: '#/definitions/FarmRoleForeignKey'
        description: Identifier of the Farm Role that triggered the Server is related to.
        readOnly: true
      firedBy:
        description: The context that caused fire of the Event.
        enum:
        - ui
        - api
        - system
        readOnly: true
        type: string
      id:
        description: Event 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
      logEntries:
        description: Orchestration log entry identifiers.
        items:
          $ref: '#/definitions/LogEntryForeignKey'
        readOnly: true
        type: array
      server:
        $ref: '#/definitions/ServerForeignKey'
        description: Identifier of the triggered Server.
        readOnly: true
    x-filterable:
    - id
    - server
    - farm
    - event
    - firedBy
    x-usedIn:
    - /user/{envId}/event-logs/{eventLogEntryId}/
  ChefServerForeignKey:
    properties:
      id:
        type: integer
    required:
    - id
  ApiPagination:
    properties:
      first:
        readOnly: true
        type: string
      last:
        readOnly: true
        type: string
      next:
        readOnly: true
        type: string
      prev:
        readOnly: true
        type: string
  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 hos

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