How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Scalr

Scalr Farms API

The Farms API from Scalr — 16 operation(s) for farms.

Documentation Provider Profile APIs.io OpenAPI GitHub

Scalr Farms API is one of 26 APIs that Scalr publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Farms. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 26 operations across 16 paths, and defines 163 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against a single base URL, /api/v1beta0/user.

26 operations 16 paths 163 schemas 3 DELETE9 GET3 PATCH11 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Server
/api/v1beta0/user
Resource Areas
1

Paths & Operations 26

Across 16 paths, the API surfaces 26 operations — 3 DELETE, 9 GET, 3 PATCH, 11 POST. Each is listed below with its method, path, parameters, and response codes.

Farms 26
GET
/{envId}/farms/
Get by env id farms
getByEnvIdFarms 1 param → 200400401403404409422500
POST
/{envId}/farms/
Create by env id farms
postByEnvIdFarms 1 param body → 201400401403404409422500
DELETE
/{envId}/farms/{farmId}/
Delete by env id farms by farm id
deleteByEnvIdFarmsByFarmId 2 params → 204400401403404409422500
GET
/{envId}/farms/{farmId}/
Get by env id farms by farm id
getByEnvIdFarmsByFarmId 2 params → 200400401403404409422500
PATCH
/{envId}/farms/{farmId}/
Update by env id farms by farm id
patchByEnvIdFarmsByFarmId 2 params body → 200400401403404409422500
POST
/{envId}/farms/{farmId}/actions/clone/
Create by env id farms by farm id actions clone
postByEnvIdFarmsByFarmIdActionsClone 2 params body → 201400401403404409422500
GET
/{envId}/farms/{farmId}/actions/generate-template/
Get by env id farms by farm id actions generate template
getByEnvIdFarmsByFarmIdActionsGenerateTemplate 2 params → 200400401403404409422500
POST
/{envId}/farms/{farmId}/actions/launch/
Create by env id farms by farm id actions launch
postByEnvIdFarmsByFarmIdActionsLaunch 2 params → 200400401403404409422500
POST
/{envId}/farms/{farmId}/actions/lock/
Create by env id farms by farm id actions lock
postByEnvIdFarmsByFarmIdActionsLock 2 params body → 200400401403404409422500
POST
/{envId}/farms/{farmId}/actions/resume/
Create by env id farms by farm id actions resume
postByEnvIdFarmsByFarmIdActionsResume 2 params → 200400401403404409422500
POST
/{envId}/farms/{farmId}/actions/suspend/
Create by env id farms by farm id actions suspend
postByEnvIdFarmsByFarmIdActionsSuspend 2 params → 200400401403404409422500
POST
/{envId}/farms/{farmId}/actions/terminate/
Create by env id farms by farm id actions terminate
postByEnvIdFarmsByFarmIdActionsTerminate 2 params body → 200400401403404409422500
POST
/{envId}/farms/{farmId}/actions/unlock/
Create by env id farms by farm id actions unlock
postByEnvIdFarmsByFarmIdActionsUnlock 2 params → 200400401403404409422500
GET
/{envId}/farms/{farmId}/cloud-services/
Get by env id farms by farm id cloud services
getByEnvIdFarmsByFarmIdCloudServices 2 params → 200400401403404409422500
POST
/{envId}/farms/{farmId}/cloud-services/
Create by env id farms by farm id cloud services
postByEnvIdFarmsByFarmIdCloudServices 2 params body → 201400401403404409422500
DELETE
/{envId}/farms/{farmId}/cloud-services/{farmCloudServiceLinkId}/
Delete by env id farms by farm id cloud services by farm cloud service link id
deleteByEnvIdFarmsByFarmIdCloudServicesByFarmCloudServiceLinkId 3 params → 204400401403404409422500
GET
/{envId}/farms/{farmId}/cloud-services/{farmCloudServiceLinkId}/
Get by env id farms by farm id cloud services by farm cloud service link id
getByEnvIdFarmsByFarmIdCloudServicesByFarmCloudServiceLinkId 3 params → 200400401403404409422500
PATCH
/{envId}/farms/{farmId}/cloud-services/{farmCloudServiceLinkId}/
Update by env id farms by farm id cloud services by farm cloud service link id
patchByEnvIdFarmsByFarmIdCloudServicesByFarmCloudServiceLinkId 3 params body → 200400401403404409422500
GET
/{envId}/farms/{farmId}/farm-roles/
Get by env id farms by farm id farm roles
getByEnvIdFarmsByFarmIdFarmRoles 2 params → 200400401403404409422500
POST
/{envId}/farms/{farmId}/farm-roles/
Create by env id farms by farm id farm roles
postByEnvIdFarmsByFarmIdFarmRoles 2 params body → 201400401403404409422500
GET
/{envId}/farms/{farmId}/global-variables/
Get by env id farms by farm id global variables
getByEnvIdFarmsByFarmIdGlobalVariables 2 params → 200400401403404409422500
POST
/{envId}/farms/{farmId}/global-variables/
Create by env id farms by farm id global variables
postByEnvIdFarmsByFarmIdGlobalVariables 2 params body → 201400401403404409422500
DELETE
/{envId}/farms/{farmId}/global-variables/{globalVariableName}/
Delete by env id farms by farm id global variables by global variable name
deleteByEnvIdFarmsByFarmIdGlobalVariablesByGlobalVariableName 3 params → 204400401403404409422500
GET
/{envId}/farms/{farmId}/global-variables/{globalVariableName}/
Get by env id farms by farm id global variables by global variable name
getByEnvIdFarmsByFarmIdGlobalVariablesByGlobalVariableName 3 params → 200400401403404409422500
PATCH
/{envId}/farms/{farmId}/global-variables/{globalVariableName}/
Update by env id farms by farm id global variables by global variable name
patchByEnvIdFarmsByFarmIdGlobalVariablesByGlobalVariableName 3 params body → 200400401403404409422500
GET
/{envId}/farms/{farmId}/servers/
Get by env id farms by farm id servers
getByEnvIdFarmsByFarmIdServers 2 params → 200400401403404409422500

Schemas 163

The contract defines 163 schemas that model the data the API accepts and returns. The most detailed are ServerSummary (19 properties), FarmRoleTemplate (16 properties), FarmRole (15 properties), ChefServerBootstrapConfiguration (14 properties). Each schema is shown below with its type and property counts.

ChefAction
object
1 property 1 required
NetworkConfigurationTemplate
object
Farm Role template network configuration.
3 properties
LightsOutTimeFrame
object
Time frame for the LightsOut schedule.
3 properties 1 required
CloudSubnet
object
2 properties 1 required
AwsRdsClusterLink
object
5 properties 2 required
Os
object
5 properties 5 required
WebhookEndpointForeignKey
object
1 property 1 required
ScalingTemplateContent
object
6 properties
RoleDeprecatedOptions
object
2 properties
ScalrAgent
object
The information about Scalr Agent.
4 properties
AwsCloudFeatures
object
AWS Farm Role configuration. Available only for AWS Farm Roles.
5 properties 1 required
VariableAllowedValue
object
2 properties 1 required
FarmTarget
object
Selects all the Servers that belong to the triggering Server's Farm.
2 properties 1 required
GlobalVariableJson
object
11 properties 2 required
FarmRoleAdvancedConfiguration
object
6 properties
OsCondition
object
2 properties 2 required
FarmTemplateContent
object
10 properties 2 required
SpecificEventTrigger
object
Triggers when a specific Event fires.
2 properties 1 required
SecurityGroupIdentity
object
2 properties 1 required
ScriptVersionIdentity
object
3 properties
ComposedTeamIdentity
object
2 properties 1 required
EventForeignKey
object
1 property 1 required
LightsOutNotification
object
2 properties 2 required
InstanceType
object
6 properties
LocalScriptAction
object
2 properties 2 required
ApiMetaContainer
object
1 property
RoleForeignKey
object
1 property 1 required
GlobalVariableListResponse
object
5 properties
UrlResponseTimeScalingRule
object
It is used in combination with the user defined Scaling Metrics.
5 properties 5 required
TemplateMetadata
object
1 property
FarmTemplate
object
3 properties
OrchestrationRuleCondition
object
1 property 1 required
IpPoolForeignKey
object
1 property 1 required
SqsQueueSizeScalingRule
object
It is used in combination with the user defined Scaling Metrics.
5 properties 5 required
BasicScalingRule
object
It is used in combination with the user defined Scaling Metrics.
4 properties 4 required
Trigger
object
1 property 1 required
AnsibleTowerConfigurationIdentity
object
2 properties
AwsNlbLink
object
6 properties 2 required
FarmRoleSummary
object
8 properties 5 required
Script
object
13 properties 2 required
ChefServerForeignKey
object
1 property 1 required
FarmRoleIdentity
object
2 properties 1 required
ScriptVariableRemoteList
object
9 properties 3 required
OrchestrationTemplateContent
object
1 property
GlobalVariableRemoteList
object
12 properties 3 required
ScriptVariableJson
object
8 properties 2 required
DateAndTimeScalingRule
object
This Scaling Rule defines the number of instances that should be running during specified time frames.
3 properties 3 required
Action
object
1 property 1 required
NetworkCloudFeatures
object
Cloud specifics Farm Role Network configuration.
1 property 1 required
SecurityConfiguration
object
1 property 1 required
ScriptVariableValue
object
2 properties 1 required
FarmRoleForeignKey
object
1 property 1 required
ServerOperations
object
List of the temporary operations being processed in the Cloud Server by one or a number of requests.
1 property 1 required
CloudSnapshotForeignKey
object
1 property 1 required
OrchestrationRuleTemplateContent
object
8 properties
ReachabilityStatus
object
2 properties
GceServiceAccount
object
1 property 1 required
ChefBootstrapConfiguration
object
Farm Role bootstrap configuration. Please note that this configuration is available only for Roles configured with Chef built-in automation.
6 properties 1 required
BandWidthScalingRule
object
It is used in combination with the user defined Scaling Metrics.
5 properties 5 required
ApiPagination
object
4 properties
MountConfiguration
object
4 properties
InitializationStatus
object
2 properties
UserForeignKey
object
1 property 1 required
StorageConfiguration
object
2 properties 1 required
RoleCategory
object
3 properties 1 required
ScriptVariableList
object
9 properties 3 required
ChefSoloBootstrapConfiguration
object
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 over…
10 properties 2 required
OsForeignKey
object
1 property 1 required
ScalingRule
object
2 properties 2 required
JobTemplateIdentity
object
3 properties
ScalingRuleTimeFrame
object
4 properties 4 required
AwsStorageTemplateCloudFeatures
object
Cloud specifics template configuration.
4 properties 1 required
RoleIdentity
object
2 properties 1 required
PersistentStorageConfiguration
object
6 properties 2 required
AllEventsTrigger
object
Triggers when any Event fires.
1 property 1 required
RemoteScriptAction
object
2 properties 2 required
LoadAveragesScalingRule
object
It is used in combination with the user defined Scaling Metrics.
5 properties 5 required
RoleCategoryForeignKey
object
1 property 1 required
OpenstackCloudFeatures
object
OpenStack Farm Role configuration. Available only for OpenStack Farm Roles.
2 properties 1 required
TemplateHostnameConfiguration
object
Template for hostname generation.
3 properties 1 required
ScalingConfiguration
object
6 properties
LightsOutEmailNotification
object
3 properties 3 required
ServerSummaryListResponse
object
5 properties
FarmRolesCondition
object
2 properties 1 required
FarmRoleNetwork
object
7 properties 1 required
OpenstackNetworkCloudFeatures
object
Cloud specifics Farm Role Network configuration.
2 properties 1 required
AnsibleTowerAction
object
4 properties 3 required
FarmRoleNetworkTemplate
object
6 properties 1 required
ApiErrorResponse
object
Common response for erroneous requests.
3 properties
FarmForeignKey
object
1 property 1 required
Role
object
12 properties 3 required
StorageTemplateCloudFeatures
object
Cloud specifics template configuration.
1 property 1 required
ScriptVariable
object
8 properties 2 required
EphemeralStorageConfiguration
object
4 properties 2 required
AwsSpotInstanceConfiguration
object
EC2 Spot instance configuration.
2 properties 1 required
GlobalVariableString
object
13 properties 2 required
PersistentStorageTemplate
object
Storage Template configuration.
4 properties 1 required
Event
object
3 properties 1 required
TriggeringFarmRoleTarget
object
Selects all the Servers that belong to the same Farm Role as the Server that triggered the Event.
1 property 1 required
FarmLockOptions
object
3 properties
TargetGroupLink
object
2 properties 1 required
AwsAlbLink
object
6 properties 2 required
AwsS3BucketLink
object
5 properties 2 required
TagsCondition
object
2 properties 2 required
AwsEfsLink
object
5 properties 2 required
RoleIdentityTemplateContent
object
2 properties 1 required
BootstrapConfiguration
object
Farm Role bootstrap configuration. Please note that this configuration is available only for Roles configured with Chef built-in automation.
2 properties 1 required
EphemeralStorageTemplate
object
Storage Template configuration.
2 properties
GlobalVariableDetailsResponse
object
4 properties
GlobalVariableList
object
12 properties 3 required
CloudSubnetForeignKey
object
1 property 1 required
VmwareCloudFeatures
object
VMware Farm Role configuration. Required for VMware Farm Roles.
8 properties 2 required
CloudNetworkForeignKey
object
1 property 1 required
FarmTemplateDetailsResponse
object
4 properties
ScriptIdentity
object
2 properties 1 required
InstanceTypeCloudFeatures
object
Cloud specific Instance type configuration.
1 property 1 required
Farm
object
10 properties 1 required
FarmRoleSummaryListResponse
object
5 properties
WebhookEndpoint
object
Webhook endpoint summary.
3 properties
AwsInstanceTypeCloudFeatures
object
AWS instance type configuration.
6 properties 1 required
FarmRoleDetailsResponse
object
4 properties
FarmRoleTemplate
object
16 properties
ScriptVariableString
object
10 properties 2 required
HostnameConfiguration
object
Farm Role hostname configuration.
2 properties 1 required
AzureStorageTemplateCloudFeatures
object
Cloud specifics template configuration.
3 properties 1 required
ChefServerBootstrapConfiguration
object
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 over…
14 properties 2 required
ServerAlert
object
Alerts about server state
4 properties 3 required
FarmLightsOutConfiguration
object
LightsOut configuration for a Farm.
5 properties 3 required
WebhookHostnameConfiguration
object
Webhook endpoint configuration to obtain hostname.
3 properties 2 required
AwsEmrClusterLink
object
5 properties 2 required
LightsOutFarmOwnerNotification
object
2 properties 2 required
GceCloudFeatures
object
GCE Farm Role configuration. Available only for GCE Farm Roles.
3 properties 1 required
AwsElbLink
object
6 properties 2 required
AnsibleTowerBootstrapConfiguration
object
Farm Role bootstrap configuration. Please note that this configuration is available only for Roles configured with Chef built-in automation.
4 properties 2 required
GlobalVariable
object
11 properties 2 required
AwsCloudFrontDistributionLink
object
5 properties 2 required
FarmRole
object
15 properties 5 required
FarmTemplateContentLockOptions
object
2 properties 1 required
IpAddressConfiguration
object
The Farm Role network ip configuration
3 properties
FarmDetailsResponse
object
4 properties
TriggeringServerTarget
object
Select only the Server that triggered the Event.
2 properties 1 required
Target
object
1 property 1 required
ServerSummary
object
A Scalr Server.
19 properties
FarmCloudServiceLink
object
5 properties 2 required
TargetFarmRoleIdentity
object
2 properties 1 required
FreeRamScalingRule
object
It is used in combination with the user defined Scaling Metrics.
5 properties 4 required
FarmCloudServiceLinkDetailsResponse
object
4 properties
ApiMessage
object
2 properties
AzureCloudFeatures
object
Azure Farm Role configuration. Required for Azure Farm Roles.
4 properties 2 required
AwsRdsInstanceLink
object
5 properties 2 required
AzureNetworkCloudFeatures
object
Cloud specifics Farm Role Network configuration.
2 properties 1 required
ScalrScriptAction
object
2 properties 2 required
RootStorageConfiguration
object
3 properties 2 required
ComposedUserIdentity
object
2 properties 1 required
FarmCloudServiceLinkListResponse
object
5 properties
CloudFeatures
object
Cloud specifics Farm Role configuration.
1 property 1 required
FarmRoleAnsibleTowerConfiguration
object
4 properties
VmwareStorageTemplateCloudFeatures
object
Cloud specifics template configuration.
4 properties 1 required
NetworkConfiguration
object
Farm Role network configuration.
3 properties
InstanceTypeForeignKey
object
1 property 1 required
FarmListResponse
object
5 properties
DatastoreCloudIdentity
object
2 properties
ApplicationGroupForeignKey
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

scalr-farms-api-openapi.yml Raw ↑

Other APIs Scalr publishes across the network.

Scalr IaC Management API
AE Profile APIs.io
Scalr Acl Roles API
AE Profile APIs.io
Scalr Ansible Tower API
AE Profile APIs.io
Scalr Cloud Credentials API
AE Profile APIs.io
Scalr Clouds API
AE Profile APIs.io
Scalr Cost Centers API
AE Profile APIs.io
Scalr Environments API
AE Profile APIs.io
Scalr Event Logs API
AE Profile APIs.io
Scalr Events API
AE Profile APIs.io
Scalr Farm Roles API
AE Profile APIs.io
Scalr Global Variables API
AE Profile APIs.io
Scalr Images API
AE Profile APIs.io
#Farms
← Back to S APIs
API Details
ID
scalr:scalr-farms-api
Server
/api/v1beta0/user
Docs
https://api-explorer.scalr.com/
Provider
Scalr
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=scalr-farms-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/scalr-farms-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Scalr Farms API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.