Scalr Servers API

openapi: 3.2.0
info:
  description: Manage Roles, Images, Environments and etc.
  title: Scalr Account Acl Roles Servers API
  version: 1.0.0
servers:
- url: /api/v1beta0/account
tags:
- name: Servers
paths:
  /{envId}/servers/:
    parameters:
    - description: The ID of the Environment scoping this request.
      in: path
      name: envId
      required: true
      schema:
        type: integer
    get:
      description: List all the Servers that exist in this Environment.
      responses:
        200:
          description: A list of ServerSummary objects.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerSummaryListResponse'
        400:
          description: A client-side error was made.
          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
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        401:
          description: The request was not authenticated.
          x-errorCodes:
          - description: The request was not properly authenticated.
            name: BadAuthentication
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        403:
          description: Insufficient permissions.
          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
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        404:
          description: Resource not found.
          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
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        409:
          description: Conflict with current state.
          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
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        422:
          description: This request was well-formed but was rejected due to semantic errors.
          x-errorCodes:
          - description: Some of the configuration settings cannot be applied because they conflict with the current state.
            name: ConfigurationMismatch
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        500:
          description: A server-side error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        501:
          description: This feature is not implemented in Scalr.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        503:
          description: The service is currently unavailable.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
      tags:
      - Servers
    post:
      description: Launch a new Server for the specified Farm Role.
      responses:
        201:
          description: The JSON representation of a ServerSummary object.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerSummaryDetailsResponse'
        400:
          description: A client-side error was made.
          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
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        401:
          description: The request was not authenticated.
          x-errorCodes:
          - description: The request was not properly authenticated.
            name: BadAuthentication
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        403:
          description: Insufficient permissions.
          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
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        404:
          description: Resource not found.
          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
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        409:
          description: Conflict with current state.
          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
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        422:
          description: This request was well-formed but was rejected due to semantic errors.
          x-errorCodes:
          - description: Some of the configuration settings cannot be applied because they conflict with the current state.
            name: ConfigurationMismatch
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        500:
          description: A server-side error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        501:
          description: This feature is not implemented in Scalr.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        503:
          description: The service is currently unavailable.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
      tags:
      - Servers
      requestBody:
        content:
          application/json:
            schema:
              properties:
                farmRole:
                  $ref: '#/components/schemas/FarmRoleForeignKey'
              required:
              - farmRole
        description: Server launch options.
        required: true
  /{envId}/servers/{serverId}/:
    parameters:
    - description: The ID of the Environment scoping this request.
      in: path
      name: envId
      required: true
      schema:
        type: integer
    - description: The ID of a Server object.
      in: path
      name: serverId
      required: true
      x-references:
        $ref: '#/components/schemas/Server'
      schema:
        type: string
        maxLength: 36
        minLength: 36
        pattern: '[A-Fa-f0-9]{8}-([A-Fa-f0-9]{4}-){3}[A-Fa-f0-9]{12}'
    get:
      description: Retrieve detailed information about a Server.
      responses:
        200:
          description: The JSON representation of a ServerSummary object.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerSummaryDetailsResponse'
        400:
          description: A client-side error was made.
          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
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        401:
          description: The request was not authenticated.
          x-errorCodes:
          - description: The request was not properly authenticated.
            name: BadAuthentication
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        403:
          description: Insufficient permissions.
          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
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        404:
          description: Resource not found.
          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
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        409:
          description: Conflict with current state.
          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
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        422:
          description: This request was well-formed but was rejected due to semantic errors.
          x-errorCodes:
          - description: Some of the configuration settings cannot be applied because they conflict with the current state.
            name: ConfigurationMismatch
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        500:
          description: A server-side error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        501:
          description: This feature is not implemented in Scalr.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        503:
          description: The service is currently unavailable.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
      tags:
      - Servers
    patch:
      description: 'Modify the Instance type of the Server. Server status before this action depends on CloudPlatform: - For EC2 and OpenStack instance type change requires server status "suspended". - For VMware instance type change requires server status "running" or "suspended".'
      responses:
        200:
          description: The JSON representation of a ServerSummary object.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerSummaryDetailsResponse'
        202:
          description: The JSON representation of a ServerSummary object.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerSummaryDetailsResponse'
        400:
          description: A client-side error was made.
          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
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        401:
          description: The request was not authenticated.
          x-errorCodes:
          - description: The request was not properly authenticated.
            name: BadAuthentication
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        403:
          description: Insufficient permissions.
          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
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        404:
          description: Resource not found.
          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
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        409:
          description: Conflict with current state.
          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
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        422:
          description: This request was well-formed but was rejected due to semantic errors.
          x-errorCodes:
          - description: Some of the configuration settings cannot be applied because they conflict with the current state.
            name: ConfigurationMismatch
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        500:
          description: A server-side error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        501:
          description: This feature is not implemented in Scalr.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        503:
          description: The service is currently unavailable.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
      tags:
      - Servers
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Server'
        description: The JSON representation of a Server object.
        required: true
  /{envId}/servers/{serverId}/actions/reboot/:
    parameters:
    - description: The ID of the Environment scoping this request.
      in: path
      name: envId
      required: true
      schema:
        type: integer
    - description: The ID of a Server object.
      in: path
      name: serverId
      required: true
      x-references:
        $ref: '#/components/schemas/Server'
      schema:
        type: string
        maxLength: 36
        minLength: 36
        pattern: '[A-Fa-f0-9]{8}-([A-Fa-f0-9]{4}-){3}[A-Fa-f0-9]{12}'
    post:
      description: Reboot a Server.
      responses:
        200:
          description: The JSON representation of a ServerSummary object.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerSummaryDetailsResponse'
        400:
          description: A client-side error was made.
          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
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        401:
          description: The request was not authenticated.
          x-errorCodes:
          - description: The request was not properly authenticated.
            name: BadAuthentication
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        403:
          description: Insufficient permissions.
          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
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        404:
          description: Resource not found.
          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
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        409:
          description: Conflict with current state.
          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
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        422:
          description: This request was well-formed but was rejected due to semantic errors.
          x-errorCodes:
          - description: Some of the configuration settings cannot be applied because they conflict with the current state.
            name: ConfigurationMismatch
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        500:
          description: A server-side error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        501:
          description: This feature is not implemented in Scalr.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        503:
          description: The service is currently unavailable.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
      tags:
      - Servers
      requestBody:
        content:
          application/json:
            schema:
              properties:
                hard:
                  description: 'Reboot type. A soft reboot is performed unless this option is set to true. Note: some instance types do not support soft reboots.'
                  type: boolean
        description: Additional options for the Server reboot.
  /{envId}/servers/{serverId}/actions/resume/:
    parameters:
    - description: The ID of the Environment scoping this request.
      in: path
      name: envId
      required: true
      schema:
        type: integer
    - description: The ID of a Server object.
      in: path
      name: serverId
      required: true
      x-references:
        $ref: '#/components/schemas/Server'
      schema:
        type: string
        maxLength: 36
        minLength: 36
        pattern: '[A-Fa-f0-9]{8}-([A-Fa-f0-9]{4}-){3}[A-Fa-f0-9]{12}'
    post:
      description: Resume a suspended Server.
      responses:
        200:
          description: The JSON representation of a ServerSummary object.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerSummaryDetailsResponse'
        400:
          description: A client-side error was made.
          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
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        401:
          description: The request was not authenticated.
          x-errorCodes:
          - description: The request was not properly authenticated.
            name: BadAuthentication
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        403:
          description: Insufficient permissions.
          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
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        404:
          description: Resource not found.
          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
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        409:
          description: Conflict with current state.
          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 set

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