Scalr website screenshot

Scalr

Scalr is an enterprise-grade, drop-in replacement for Terraform Cloud and a remote Terraform operations backend that provides cost estimation, policy enforcement, and collaborative infrastructure management. Scalr features a hierarchical account-environment-workspace model, full compatibility with the TFC API and Terraform/OpenTofu CLI, OIDC authentication, GitOps workflows, OPA policy enforcement, and a comprehensive REST API for managing infrastructure as code operations at scale.

4 APIs 0 Features
FinOpsGitOpsInfrastructure as CodeKubernetesOPAOpenTofuPolicyTerraform

APIs

Scalr User API

The Scalr User API provides programmatic access to user-level resources including farms, farm roles, servers, events, cloud locations, cost centers, and scaling metrics. This is...

Scalr Account API

The Scalr Account API provides programmatic access to account-level resources including environments, roles, images, orchestration rules, and account-wide configuration. This is...

Scalr Global API

The Scalr Global API provides programmatic access to global-level resources including images and roles that span the entire Scalr installation.

Scalr IaC Management API

The Scalr IaC Management API (TFC-compatible) provides programmatic control over workspaces, environments, runs, state, variables, policies, and provider configurations. Fully c...

Collections

Pricing Plans

Scalr Plans Pricing

2 plans

PLANS

Rate Limits

Scalr Rate Limits

1 limits

RATE LIMITS

FinOps

Scalr Finops

FINOPS

Semantic Vocabularies

Scalr Context

1 classes · 27 properties

JSON-LD

API Governance Rules

Scalr API Rules

10 rules · 2 errors 4 warnings 2 info

SPECTRAL

JSON Structure

Scalr Workspace Structure

0 properties

JSON STRUCTURE

Example Payloads

Scalr Create Run Example

2 fields

EXAMPLE

Resources

🔗
LinkedIn
LinkedIn
🔗
Website
Website
🔗
Documentation
Documentation
🔗
APIReference
APIReference
🔗
API Explorer
API Explorer
👥
GitHub
GitHub
📰
Blog
Blog
📄
ChangeLog
ChangeLog
🔗
MCP Server
MCP Server
🔗
Terraform Provider
Terraform Provider
🔗
Vocabulary
Vocabulary
🔗
JSONSchema
JSONSchema
🔗
JSONSchema
JSONSchema
🔗
JSONLDContext
JSONLDContext
🔗
SpectralRules
SpectralRules
🔗
LlmsText
LlmsText

Sources

Raw ↑
opencollection: 1.0.0
info:
  name: Scalr User API
  version: 1.0.0
items:
- info:
    name: GET /{envId}/clouds/{cloudPlatform}/cloud-locations/
    type: http
  http:
    method: GET
    url: '{{baseUrl}}/:envId/clouds/:cloudPlatform/cloud-locations/'
    params:
    - name: envId
      value: ''
      type: path
      description: The ID of the Environment scoping this request.
    - name: cloudPlatform
      value: ''
      type: path
      description: The Cloud Platform this resource resides in.
  docs: The list of the Cloud Locations.
- info:
    name: GET /{envId}/clouds/{cloudPlatform}/cloud-locations/{cloudLocation}/instance-types/
    type: http
  http:
    method: GET
    url: '{{baseUrl}}/:envId/clouds/:cloudPlatform/cloud-locations/:cloudLocation/instance-types/'
    params:
    - name: envId
      value: ''
      type: path
      description: The ID of the Environment scoping this request.
    - name: cloudPlatform
      value: ''
      type: path
      description: The Cloud Platform this resource resides in.
    - name: cloudLocation
      value: ''
      type: path
      description: 'Cloud Location, inside a given Cloud Platform, for this resource. May be null if this resource does not
        have a specific location. Note: if you would like to filter on this property, you **must** also filter on `cloudPlatform`.'
  docs: The list of all Instance Types available for the specified Cloud Location.
- info:
    name: GET /{envId}/cost-centers/{costCenterId}/
    type: http
  http:
    method: GET
    url: '{{baseUrl}}/:envId/cost-centers/:costCenterId/'
    params:
    - name: envId
      value: ''
      type: path
      description: The ID of the Environment scoping this request.
    - name: costCenterId
      value: ''
      type: path
      description: The ID of a CostCenter object.
  docs: Retrieve detailed information about a given Cost Center.
- info:
    name: GET /{envId}/event-logs/
    type: http
  http:
    method: GET
    url: '{{baseUrl}}/:envId/event-logs/'
    params:
    - name: envId
      value: ''
      type: path
      description: The ID of the Environment scoping this request.
  docs: List of all Event logs.
- info:
    name: GET /{envId}/event-logs/{eventLogEntryId}/
    type: http
  http:
    method: GET
    url: '{{baseUrl}}/:envId/event-logs/:eventLogEntryId/'
    params:
    - name: envId
      value: ''
      type: path
      description: The ID of the Environment scoping this request.
    - name: eventLogEntryId
      value: ''
      type: path
      description: The ID of a EventLogEntry object.
  docs: Describes detailed information about the Event that has been fired.
- info:
    name: GET /{envId}/events/
    type: http
  http:
    method: GET
    url: '{{baseUrl}}/:envId/events/'
    params:
    - name: envId
      value: ''
      type: path
      description: The ID of the Environment scoping this request.
  docs: List all the Events available in this Environment.
- info:
    name: POST /{envId}/events/
    type: http
  http:
    method: POST
    url: '{{baseUrl}}/:envId/events/'
    params:
    - name: envId
      value: ''
      type: path
      description: The ID of the Environment scoping this request.
  docs: Create a new Custom Event in this Environment.
- info:
    name: GET /{envId}/events/{eventId}/
    type: http
  http:
    method: GET
    url: '{{baseUrl}}/:envId/events/:eventId/'
    params:
    - name: envId
      value: ''
      type: path
      description: The ID of the Environment scoping this request.
    - name: eventId
      value: ''
      type: path
      description: The ID of a Event object.
  docs: Retrieve detailed information about a given Event.
- info:
    name: PATCH /{envId}/events/{eventId}/
    type: http
  http:
    method: PATCH
    url: '{{baseUrl}}/:envId/events/:eventId/'
    params:
    - name: envId
      value: ''
      type: path
      description: The ID of the Environment scoping this request.
    - name: eventId
      value: ''
      type: path
      description: The ID of a Event object.
  docs: Modify the attributes of an Event.
- info:
    name: DELETE /{envId}/events/{eventId}/
    type: http
  http:
    method: DELETE
    url: '{{baseUrl}}/:envId/events/:eventId/'
    params:
    - name: envId
      value: ''
      type: path
      description: The ID of the Environment scoping this request.
    - name: eventId
      value: ''
      type: path
      description: The ID of a Event object.
  docs: Delete an Event from this Environment.
- info:
    name: POST /{envId}/events/{eventId}/actions/fire/
    type: http
  http:
    method: POST
    url: '{{baseUrl}}/:envId/events/:eventId/actions/fire/'
    params:
    - name: envId
      value: ''
      type: path
      description: The ID of the Environment scoping this request.
    - name: eventId
      value: ''
      type: path
      description: The ID of a Event object.
  docs: It fires the Custom Event on the Server.
- info:
    name: GET /{envId}/farm-roles/{farmRoleId}/
    type: http
  http:
    method: GET
    url: '{{baseUrl}}/:envId/farm-roles/:farmRoleId/'
    params:
    - name: envId
      value: ''
      type: path
      description: The ID of the Environment scoping this request.
    - name: farmRoleId
      value: ''
      type: path
      description: The ID of a FarmRole object.
  docs: Retrieve detailed information about a given Farm Role.
- info:
    name: PATCH /{envId}/farm-roles/{farmRoleId}/
    type: http
  http:
    method: PATCH
    url: '{{baseUrl}}/:envId/farm-roles/:farmRoleId/'
    params:
    - name: envId
      value: ''
      type: path
      description: The ID of the Environment scoping this request.
    - name: farmRoleId
      value: ''
      type: path
      description: The ID of a FarmRole object.
  docs: Modify the attributes of a Farm Role.
- info:
    name: DELETE /{envId}/farm-roles/{farmRoleId}/
    type: http
  http:
    method: DELETE
    url: '{{baseUrl}}/:envId/farm-roles/:farmRoleId/'
    params:
    - name: envId
      value: ''
      type: path
      description: The ID of the Environment scoping this request.
    - name: farmRoleId
      value: ''
      type: path
      description: The ID of a FarmRole object.
  docs: Remove a given Farm Role from its Farm.
- info:
    name: POST /{envId}/farm-roles/{farmRoleId}/actions/clone/
    type: http
  http:
    method: POST
    url: '{{baseUrl}}/:envId/farm-roles/:farmRoleId/actions/clone/'
    params:
    - name: envId
      value: ''
      type: path
      description: The ID of the Environment scoping this request.
    - name: farmRoleId
      value: ''
      type: path
      description: The ID of a FarmRole object.
  docs: Clone a given FarmRole within current Farm or to another Farm.
- info:
    name: GET /{envId}/farm-roles/{farmRoleId}/actions/generate-template/
    type: http
  http:
    method: GET
    url: '{{baseUrl}}/:envId/farm-roles/:farmRoleId/actions/generate-template/'
    params:
    - name: envId
      value: ''
      type: path
      description: The ID of the Environment scoping this request.
    - name: farmRoleId
      value: ''
      type: path
      description: The ID of a FarmRole object.
  docs: Get FarmRole Template body for given FarmRole.
- info:
    name: POST /{envId}/farm-roles/{farmRoleId}/actions/import-server/
    type: http
  http:
    method: POST
    url: '{{baseUrl}}/:envId/farm-roles/:farmRoleId/actions/import-server/'
    params:
    - name: envId
      value: ''
      type: path
      description: The ID of the Environment scoping this request.
    - name: farmRoleId
      value: ''
      type: path
      description: The ID of a FarmRole object.
  docs: Import a running server from a Cloud Platform to a Scalr Farm Role.
- info:
    name: GET /{envId}/farm-roles/{farmRoleId}/global-variables/
    type: http
  http:
    method: GET
    url: '{{baseUrl}}/:envId/farm-roles/:farmRoleId/global-variables/'
    params:
    - name: envId
      value: ''
      type: path
      description: The ID of the Environment scoping this request.
    - name: farmRoleId
      value: ''
      type: path
      description: The ID of a FarmRole object.
  docs: List all the Global Variables associated with this Farm Role.
- info:
    name: POST /{envId}/farm-roles/{farmRoleId}/global-variables/
    type: http
  http:
    method: POST
    url: '{{baseUrl}}/:envId/farm-roles/:farmRoleId/global-variables/'
    params:
    - name: envId
      value: ''
      type: path
      description: The ID of the Environment scoping this request.
    - name: farmRoleId
      value: ''
      type: path
      description: The ID of a FarmRole object.
  docs: Declare a new Global Variable for this Farm Role.
- info:
    name: GET /{envId}/farm-roles/{farmRoleId}/global-variables/{globalVariableName}/
    type: http
  http:
    method: GET
    url: '{{baseUrl}}/:envId/farm-roles/:farmRoleId/global-variables/:globalVariableName/'
    params:
    - name: envId
      value: ''
      type: path
      description: The ID of the Environment scoping this request.
    - name: farmRoleId
      value: ''
      type: path
      description: The ID of a FarmRole object.
    - name: globalVariableName
      value: ''
      type: path
      description: The name of the Global Variable being accessed.
  docs: Retrieve detailed information about a Global Variable in this Farm Role's scope.
- info:
    name: PATCH /{envId}/farm-roles/{farmRoleId}/global-variables/{globalVariableName}/
    type: http
  http:
    method: PATCH
    url: '{{baseUrl}}/:envId/farm-roles/:farmRoleId/global-variables/:globalVariableName/'
    params:
    - name: envId
      value: ''
      type: path
      description: The ID of the Environment scoping this request.
    - name: farmRoleId
      value: ''
      type: path
      description: The ID of a FarmRole object.
    - name: globalVariableName
      value: ''
      type: path
      description: The name of the Global Variable being accessed.
  docs: Modify the attributes of a Global Variable in this Farm Role's scope.
- info:
    name: DELETE /{envId}/farm-roles/{farmRoleId}/global-variables/{globalVariableName}/
    type: http
  http:
    method: DELETE
    url: '{{baseUrl}}/:envId/farm-roles/:farmRoleId/global-variables/:globalVariableName/'
    params:
    - name: envId
      value: ''
      type: path
      description: The ID of the Environment scoping this request.
    - name: farmRoleId
      value: ''
      type: path
      description: The ID of a FarmRole object.
    - name: globalVariableName
      value: ''
      type: path
      description: The name of the Global Variable being accessed.
  docs: Delete a Global Variable from this Farm Role's scope.
- info:
    name: GET /{envId}/farm-roles/{farmRoleId}/orchestration-rules/
    type: http
  http:
    method: GET
    url: '{{baseUrl}}/:envId/farm-roles/:farmRoleId/orchestration-rules/'
    params:
    - name: envId
      value: ''
      type: path
      description: The ID of the Environment scoping this request.
    - name: farmRoleId
      value: ''
      type: path
      description: The ID of a FarmRole object.
  docs: List all Orchestration Rules associated with this Farm Role, including Rules from higher Scopes (those are read-only).
- info:
    name: POST /{envId}/farm-roles/{farmRoleId}/orchestration-rules/
    type: http
  http:
    method: POST
    url: '{{baseUrl}}/:envId/farm-roles/:farmRoleId/orchestration-rules/'
    params:
    - name: envId
      value: ''
      type: path
      description: The ID of the Environment scoping this request.
    - name: farmRoleId
      value: ''
      type: path
      description: The ID of a FarmRole object.
  docs: Create a new Orchestration Rule associated to this Farm Role.
- info:
    name: GET /{envId}/farm-roles/{farmRoleId}/orchestration-rules/{orchestrationRuleId}/
    type: http
  http:
    method: GET
    url: '{{baseUrl}}/:envId/farm-roles/:farmRoleId/orchestration-rules/:orchestrationRuleId/'
    params:
    - name: envId
      value: ''
      type: path
      description: The ID of the Environment scoping this request.
    - name: farmRoleId
      value: ''
      type: path
      description: The ID of a FarmRole object.
    - name: orchestrationRuleId
      value: ''
      type: path
      description: The ID of a OrchestrationRule object.
  docs: Retrieve detailed information about an Orchestration Rule associated to this Farm Role.
- info:
    name: PATCH /{envId}/farm-roles/{farmRoleId}/orchestration-rules/{orchestrationRuleId}/
    type: http
  http:
    method: PATCH
    url: '{{baseUrl}}/:envId/farm-roles/:farmRoleId/orchestration-rules/:orchestrationRuleId/'
    params:
    - name: envId
      value: ''
      type: path
      description: The ID of the Environment scoping this request.
    - name: farmRoleId
      value: ''
      type: path
      description: The ID of a FarmRole object.
    - name: orchestrationRuleId
      value: ''
      type: path
      description: The ID of a OrchestrationRule object.
  docs: Modify the attributes of an Orchestration Rule associated to this Farm Role.
- info:
    name: DELETE /{envId}/farm-roles/{farmRoleId}/orchestration-rules/{orchestrationRuleId}/
    type: http
  http:
    method: DELETE
    url: '{{baseUrl}}/:envId/farm-roles/:farmRoleId/orchestration-rules/:orchestrationRuleId/'
    params:
    - name: envId
      value: ''
      type: path
      description: The ID of the Environment scoping this request.
    - name: farmRoleId
      value: ''
      type: path
      description: The ID of a FarmRole object.
    - name: orchestrationRuleId
      value: ''
      type: path
      description: The ID of a OrchestrationRule object.
  docs: Delete an Orchestration Rule from this Farm Role.
- info:
    name: Get Scaling Configuration
    type: http
  http:
    method: GET
    url: '{{baseUrl}}/:envId/farm-roles/:farmRoleId/scaling/'
    params:
    - name: envId
      value: ''
      type: path
      description: The ID of the Environment scoping this request.
    - name: farmRoleId
      value: ''
      type: path
      description: The ID of a FarmRole object.
  docs: Retrieve the Scaling configuration of a Farm Role.
- info:
    name: Create Rule
    type: http
  http:
    method: POST
    url: '{{baseUrl}}/:envId/farm-roles/:farmRoleId/scaling/'
    params:
    - name: envId
      value: ''
      type: path
      description: The ID of the Environment scoping this request.
    - name: farmRoleId
      value: ''
      type: path
      description: The ID of a FarmRole object.
  docs: Add a new Scaling Rule to a Farm Role.
- info:
    name: Edit Scaling Configuration
    type: http
  http:
    method: PATCH
    url: '{{baseUrl}}/:envId/farm-roles/:farmRoleId/scaling/'
    params:
    - name: envId
      value: ''
      type: path
      description: The ID of the Environment scoping this request.
    - name: farmRoleId
      value: ''
      type: path
      description: The ID of a FarmRole object.
  docs: Modify the Scaling configuration of a Farm Role.
- info:
    name: Get Rule
    type: http
  http:
    method: GET
    url: '{{baseUrl}}/:envId/farm-roles/:farmRoleId/scaling/:metricName/'
    params:
    - name: envId
      value: ''
      type: path
      description: The ID of the Environment scoping this request.
    - name: farmRoleId
      value: ''
      type: path
      description: The ID of a FarmRole object.
    - name: metricName
      value: ''
      type: path
      description: The name of the Scaling Metric.
  docs: Retrieve the Scaling rules of the Farm Role.
- info:
    name: Edit Rule
    type: http
  http:
    method: PATCH
    url: '{{baseUrl}}/:envId/farm-roles/:farmRoleId/scaling/:metricName/'
    params:
    - name: envId
      value: ''
      type: path
      description: The ID of the Environment scoping this request.
    - name: farmRoleId
      value: ''
      type: path
      description: The ID of a FarmRole object.
    - name: metricName
      value: ''
      type: path
      description: The name of the Scaling Metric.
  docs: Modify a Scaling Rule of a Farm Role.
- info:
    name: Delete Rule
    type: http
  http:
    method: DELETE
    url: '{{baseUrl}}/:envId/farm-roles/:farmRoleId/scaling/:metricName/'
    params:
    - name: envId
      value: ''
      type: path
      description: The ID of the Environment scoping this request.
    - name: farmRoleId
      value: ''
      type: path
      description: The ID of a FarmRole object.
    - name: metricName
      value: ''
      type: path
      description: The name of the Scaling Metric.
  docs: Delete a Scaling Rule from a Farm Role.
- info:
    name: GET /{envId}/farm-roles/{farmRoleId}/servers/
    type: http
  http:
    method: GET
    url: '{{baseUrl}}/:envId/farm-roles/:farmRoleId/servers/'
    params:
    - name: envId
      value: ''
      type: path
      description: The ID of the Environment scoping this request.
    - name: farmRoleId
      value: ''
      type: path
      description: The ID of a FarmRole object.
  docs: Describes all the Servers associated to a Farm Role.
- info:
    name: POST /{envId}/farm-roles/{farmRoleId}/servers/
    type: http
  http:
    method: POST
    url: '{{baseUrl}}/:envId/farm-roles/:farmRoleId/servers/'
    params:
    - name: envId
      value: ''
      type: path
      description: The ID of the Environment scoping this request.
    - name: farmRoleId
      value: ''
      type: path
      description: The ID of a FarmRole object.
  docs: Launch a new Server for the specified Farm Role.
- info:
    name: GET /{envId}/farm-roles/{farmRoleId}/storage/
    type: http
  http:
    method: GET
    url: '{{baseUrl}}/:envId/farm-roles/:farmRoleId/storage/'
    params:
    - name: envId
      value: ''
      type: path
      description: The ID of the Environment scoping this request.
    - name: farmRoleId
      value: ''
      type: path
      description: The ID of a FarmRole object.
  docs: Describe the Storage configuration of the Farm Role.
- info:
    name: POST /{envId}/farm-roles/{farmRoleId}/storage/
    type: http
  http:
    method: POST
    url: '{{baseUrl}}/:envId/farm-roles/:farmRoleId/storage/'
    params:
    - name: envId
      value: ''
      type: path
      description: The ID of the Environment scoping this request.
    - name: farmRoleId
      value: ''
      type: path
      description: The ID of a FarmRole object.
  docs: Add a new storage configuration to the Farm Role.
- info:
    name: GET /{envId}/farm-roles/{farmRoleId}/storage/{storageConfigurationId}/
    type: http
  http:
    method: GET
    url: '{{baseUrl}}/:envId/farm-roles/:farmRoleId/storage/:storageConfigurationId/'
    params:
    - name: envId
      value: ''
      type: path
      description: The ID of the Environment scoping this request.
    - name: farmRoleId
      value: ''
      type: path
      description: The ID of a FarmRole object.
    - name: storageConfigurationId
      value: ''
      type: path
      description: The ID of a StorageConfiguration object.
  docs: Retrieve a specific storage configuration of the Farm Role.
- info:
    name: PATCH /{envId}/farm-roles/{farmRoleId}/storage/{storageConfigurationId}/
    type: http
  http:
    method: PATCH
    url: '{{baseUrl}}/:envId/farm-roles/:farmRoleId/storage/:storageConfigurationId/'
    params:
    - name: envId
      value: ''
      type: path
      description: The ID of the Environment scoping this request.
    - name: farmRoleId
      value: ''
      type: path
      description: The ID of a FarmRole object.
    - name: storageConfigurationId
      value: ''
      type: path
      description: The ID of a StorageConfiguration object.
  docs: Modify the storage configuration of the Farm Role.
- info:
    name: DELETE /{envId}/farm-roles/{farmRoleId}/storage/{storageConfigurationId}/
    type: http
  http:
    method: DELETE
    url: '{{baseUrl}}/:envId/farm-roles/:farmRoleId/storage/:storageConfigurationId/'
    params:
    - name: envId
      value: ''
      type: path
      description: The ID of the Environment scoping this request.
    - name: farmRoleId
      value: ''
      type: path
      description: The ID of a FarmRole object.
    - name: storageConfigurationId
      value: ''
      type: path
      description: The ID of a StorageConfiguration object.
  docs: Delete the storage configuration from the Farm Role.
- info:
    name: GET /{envId}/farms/
    type: http
  http:
    method: GET
    url: '{{baseUrl}}/:envId/farms/'
    params:
    - name: envId
      value: ''
      type: path
      description: The ID of the Environment scoping this request.
  docs: List all the Farms available in this Environment.
- info:
    name: POST /{envId}/farms/
    type: http
  http:
    method: POST
    url: '{{baseUrl}}/:envId/farms/'
    params:
    - name: envId
      value: ''
      type: path
      description: The ID of the Environment scoping this request.
  docs: Create a new Farm in this Environment. Farm and FarmTemplate objects are acceptable.
- info:
    name: GET /{envId}/farms/{farmId}/
    type: http
  http:
    method: GET
    url: '{{baseUrl}}/:envId/farms/:farmId/'
    params:
    - name: envId
      value: ''
      type: path
      description: The ID of the Environment scoping this request.
    - name: farmId
      value: ''
      type: path
      description: The ID of a Farm object.
  docs: Retrieve detailed information about a given Farm.
- info:
    name: PATCH /{envId}/farms/{farmId}/
    type: http
  http:
    method: PATCH
    url: '{{baseUrl}}/:envId/farms/:farmId/'
    params:
    - name: envId
      value: ''
      type: path
      description: The ID of the Environment scoping this request.
    - name: farmId
      value: ''
      type: path
      description: The ID of a Farm object.
  docs: Modify the attributes of a Farm.
- info:
    name: DELETE /{envId}/farms/{farmId}/
    type: http
  http:
    method: DELETE
    url: '{{baseUrl}}/:envId/farms/:farmId/'
    params:
    - name: envId
      value: ''
      type: path
      description: The ID of the Environment scoping this request.
    - name: farmId
      value: ''
      type: path
      description: The ID of a Farm object.
  docs: Delete a Farm from this Environment.
- info:
    name: POST /{envId}/farms/{farmId}/actions/clone/
    type: http
  http:
    method: POST
    url: '{{baseUrl}}/:envId/farms/:farmId/actions/clone/'
    params:
    - name: envId
      value: ''
      type: path
      description: The ID of the Environment scoping this request.
    - name: farmId
      value: ''
      type: path
      description: The ID of a Farm object.
  docs: Clone a given Farm.
- info:
    name: GET /{envId}/farms/{farmId}/actions/generate-template/
    type: http
  http:
    method: GET
    url: '{{baseUrl}}/:envId/farms/:farmId/actions/generate-template/'
    params:
    - name: envId
      value: ''
      type: path
      description: The ID of the Environment scoping this request.
    - name: farmId
      value: ''
      type: path
      description: The ID of a Farm object.
  docs: Get Farm Template body for given Farm.
- info:
    name: POST /{envId}/farms/{farmId}/actions/launch/
    type: http
  http:
    method: POST
    url: '{{baseUrl}}/:envId/farms/:farmId/actions/launch/'
    params:
    - name: envId
      value: ''
      type: path
      description: The ID of the Environment scoping this request.
    - name: farmId
      value: ''
      type: path
      description: The ID of a Farm object.
  docs: Launch a Farm.
- info:
    name: POST /{envId}/farms/{farmId}/actions/lock/
    type: http
  http:
    method: POST
    url: '{{baseUrl}}/:envId/farms/:farmId/actions/lock/'
    params:
    - name: envId
      value: ''
      type: path
      description: The ID of the Environment scoping this request.
    - name: farmId
      value: ''
      type: path
      description: The ID of a Farm object.
  docs: Lock a Farm.
- info:
    name: POST /{envId}/farms/{farmId}/actions/resume/
    type: http
  http:
    method: POST
    url: '{{baseUrl}}/:envId/farms/:farmId/actions/resume/'
    params:
    - name: envId
      value: ''
      type: path
      description: The ID of the Environment scoping this request.
    - name: farmId
      value: ''
      type: path
      description: The ID of a Farm object.
  docs: Resume a suspended Farm.
- info:
    name: POST /{envId}/farms/{farmId}/actions/suspend/
    type: http
  http:
    method: POST
    url: '{{baseUrl}}/:envId/farms/:farmId/actions/suspend/'
    params:
    - name: envId
      value: ''
      type: path
      description: The ID of the Environment scoping this request.
    - name: farmId
      value: ''
      type: path
      description: The ID of a Farm object.
  docs: Suspend a Farm.
- info:
    name: POST /{envId}/farms/{farmId}/actions/terminate/
    type: http
  http:
    method: POST
    url: '{{baseUrl}}/:envId/farms/:farmId/actions/terminate/'
    params:
    - name: envId
      value: ''
      type: path
      description: The ID of the Environment scoping this request.
    - name: farmId
      value: ''
      type: path
      description: The ID of a Farm object.
  docs: Terminate a Farm.
- info:
    name: POST /{envId}/farms/{farmId}/actions/unlock/
    type: http
  http:
    method: POST
    url: '{{baseUrl}}/:envId/farms/:farmId/actions/unlock/'
    params:
    - name: envId
      value: ''
      type: path
      description: The ID of the Environment scoping this request.
    - name: farmId
      value: ''
      type: path
      description: The ID of a Farm object.
  docs: Unlock a Farm.
- info:
    name: GET /{envId}/farms/{farmId}/cloud-services/
    type: http
  http:
    method: GET
    url: '{{baseUrl}}/:envId/farms/:farmId/cloud-services/'
    params:
    - name: envId
      value: ''
      type: path
      description: The ID of the Environment scoping this request.
    - name: farmId
      value: ''
      type: path
      description: The ID of a Farm object.
  docs: List of the Cloud Services linked to the current Farm.
- info:
    name: POST /{envId}/farms/{farmId}/cloud-services/
    type: http
  http:
    method: POST
    url: '{{baseUrl}}/:envId/farms/:farmId/cloud-services/'
    params:
    - name: envId
      value: ''
      type: path
      description: The ID of the Environment scoping this request.
    - name: farmId
      value: ''
      type: path
      description: The ID of a Farm object.
  docs: Link Cloud Service to the current Farm.
- info:
    name: GET /{envId}/farms/{farmId}/cloud-services/{farmCloudServiceLinkId}/
    type: http
  http:
    method: GET
    url: '{{baseUrl}}/:envId/farms/:farmId/cloud-services/:farmCloudServiceLinkId/'
    params:
    - name: envId
      value: ''
      type: path
      description: The ID of the Environment scoping this request.
    - name: farmId
      value: ''
      type: path
      description: The ID of a Farm object.
    - name: farmCloudServiceLinkId
      value: ''
      type: path
      description: The ID of a FarmCloudServiceLink object.
  docs: Retrieve detailed information about linked Cloud Service to the current Farm.
- info:
    name: PATCH /{envId}/farms/{farmId}/cloud-services/{farmCloudServiceLinkId}/
    type: http
  http:
    method: PATCH
    url: '{{baseUrl}}/:envId/farms/:farmId/cloud-services/:farmCloudServiceLinkId/'
    params:
    - name: envId
      value: ''
      type: path
      description: The ID of the Environment scoping this request.
    - name: farmId
      value: ''
      type: path
      description: The ID of a Farm object.
    - name: farmCloudServiceLinkId
      value: ''
      type: path
      description: The ID of a FarmCloudServiceLink object.
  docs: Modify Cloud Service attributes.
- info:
    name: DELETE /{envId}/farms/{farmId}/cloud-services/{farmCloudServiceLinkId}/
    type: http
  http:
    method: DELETE
    url: '{{baseUrl}}/:envId/farms/:farmId/cloud-services/:farmCloudServiceLinkId/'
    params:
    - name: envId
      value: ''
      type: path
      description: The ID of the Environment scoping this request.
    - name: farmId
      value: ''
      type: path
      description: The ID of a Farm object.
    - name: farmCloudServiceLinkId
      value: ''
      type: path
      description: The ID of a FarmCloudServiceLink object.
  docs: Unlink Cloud Service from the current Farm.
- info:
    name: GET /{envId}/farms/{farmId}/farm-roles/
    type: http
  http:
    method: GET
    url: '{{baseUrl}}/:envId/farms/:farmId/farm-roles/'
    params:
    - name: envId
      value: ''
      type: path
      description: The ID of the Environment scoping this request.
    - name: farmId
      value: ''
      type: path
      description: The ID of a Farm object.
  docs: List all the Farm Roles in a Farm.
- info:
    name: POST /{envId}/farms/{farmId}/farm-roles/
    type: http
  http:
    method: POST
    url: '{{baseUrl}}/:envId/farms/:farmId/farm-roles/'
    params:
    - name: envId
      value: ''
      type: path
      description: The ID of the Environment scoping this request.
    - name: farmId
      value: ''
      type: path
      description: The ID of a Farm object.
  docs: Create a new Farm Role in a Farm. FarmRole and FarmRoleTemplate objects are acceptable.
- info:
    name: GET /{envId}/farms/{farmId}/global-variables/
    type: http
  http:
    method: GET
    url: '{{baseUrl}}/:envId/farms/:farmId/global-variables/'
    params:
    - name: envId
      value: ''
      type: path
      description: The ID of the Environment scoping this request.
    - name: farmId
      value: ''
      type: path
      description: The ID of a Farm object.
  docs: List all Global Variables associated to a Farm.
- info:
    name: POST /{envId}/farms/{farmId}/global-variables/
    type: http
  http:
    method: POST
    url: '{{baseUrl}}/:envId/farms/:farmId/global-variables/'
    params:
    - name: envId
      value: ''
      type: path
      description: The ID of the Environment scoping this request.
    - name: farmId
      value: ''
      type: path
      description: The ID of a Farm object.
  docs: Declare a new Global Variable for this Farm.
- info:
    name: GET /{envId}/farms/{farmId}/global-variables/{globalVariableName}/
    type: http
  http:
    method: GET
    url: '{{baseUrl}}/:envId/farms/:farmId/global-variables/:globalVariableName/'
    params:
    - name: envId
      value: ''
      type: path
      description: The ID of the Environment scoping this request.
    - name: farmId
      value: ''
      type: path
      description: The ID of a Farm object.
    - name: globalVariableName
      value: ''
      type: path
      description: The name of the Global Variable being accessed.
  docs: Retrieve detailed information about a Global Variable in the Farm's scope
- info:
    name: PATCH /{envId}/farms/{farmId}/global-variables/{globalVariableName}/
    type: http
  http:
    method: PATCH
    url: '{{baseUrl}}/:envId/farms/:farmId/global-variables/:globalVariableName/'
    params:
    - name: envId
      value: ''
      type: path
      description: The ID of the Environment scoping this request.
    - name: farmId
      value: ''
      type: path
      description: The ID of a Farm object.
    - name: globalVariableName
      value: ''
      type: path
      description: The name of the Global Variable being accessed.
  docs: Modify the attributes of a Global Variable's in the Farm's scope.
- info:
    name: DELETE /{envId}/farms/{farmId}/global-variables/{globalVariableName}/
    type: http
  http:
    method: DELETE
    url: '{{baseUrl}}/:envId/farms/:farmId/global-variables/:globalVariableName/'
    params:
    - name: envId
      value: ''
      type: path
      description: The ID of the Environment scoping this request.
    - name: farmId
      value: ''
      type: path
      description: The ID of a Farm object.
    - name: globalVariableName
      value: ''
      type: path
      description: The name of the Global Variable being accessed.
  docs: Delete a Global Variable from a given Farm's scope.
- info:
    name: GET /{envId}/farms/{farmId}/servers/
    type: http
  http:
    method: GET
    url: '{{baseUrl}}/:envId/farms/:farmId/servers/'
    params:
    - name: envId
      value: ''
      type: path
      description: The ID of the Environment scoping this request.
    - name: farmId
      value: ''
      type: path
      description: The ID of a Farm object.
  docs: List all the Servers associated to a Farm.
- info:
    name: GET /{envId}/global-variables/
    type: http
  http:
    method: GET
    url: '{{baseUrl}}/:envId/global-variables/'
    params:
    - name: envId
      value: ''
      type: path
      desc

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