Scalr Farm Roles API
The Farm Roles API from Scalr — 13 operation(s) for farm roles.
Scalr Farm Roles API is one of 26 APIs that Scalr publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Farm Roles. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes 29 operations across 13 paths, and defines 150 schemas. It is described by OpenAPI 2.0, at version 1.0.0.
29 operations
13 paths
150 schemas
5 DELETE11 GET6 PATCH7 POST
Metadata
The identity and technical contract details declared by the specification.
Paths & Operations 29
Across 13 paths, the API surfaces 29 operations — 5 DELETE, 11 GET, 6 PATCH, 7 POST. Each is listed below with its method, path, parameters, and response codes.
Farm Roles 29
DELETE
/{envId}/farm-roles/{farmRoleId}/
Remove a given Farm Role from its Farm.
GET
/{envId}/farm-roles/{farmRoleId}/
Retrieve detailed information about a given Farm Role.
PATCH
/{envId}/farm-roles/{farmRoleId}/
Modify the attributes of a Farm Role.
POST
/{envId}/farm-roles/{farmRoleId}/actions/clone/
Clone a given FarmRole within current Farm or to another Farm.
GET
/{envId}/farm-roles/{farmRoleId}/actions/generate-template/
Get FarmRole Template body for given FarmRole.
POST
/{envId}/farm-roles/{farmRoleId}/actions/import-server/
Import a running server from a Cloud Platform to a Scalr Farm Role.
GET
/{envId}/farm-roles/{farmRoleId}/global-variables/
List all the Global Variables associated with this Farm Role.
POST
/{envId}/farm-roles/{farmRoleId}/global-variables/
Declare a new Global Variable for this Farm Role.
DELETE
/{envId}/farm-roles/{farmRoleId}/global-variables/{globalVariableName}/
Delete a Global Variable from this Farm Role's scope.
GET
/{envId}/farm-roles/{farmRoleId}/global-variables/{globalVariableName}/
Retrieve detailed information about a Global Variable in this Farm Role's scope.
PATCH
/{envId}/farm-roles/{farmRoleId}/global-variables/{globalVariableName}/
Modify the attributes of a Global Variable in this Farm Role's scope.
GET
/{envId}/farm-roles/{farmRoleId}/orchestration-rules/
List all Orchestration Rules associated with this Farm Role, including Rules from higher Scopes (those are read-only).
POST
/{envId}/farm-roles/{farmRoleId}/orchestration-rules/
Create a new Orchestration Rule associated to this Farm Role.
DELETE
/{envId}/farm-roles/{farmRoleId}/orchestration-rules/{orchestrationRuleId}/
Delete an Orchestration Rule from this Farm Role.
GET
/{envId}/farm-roles/{farmRoleId}/orchestration-rules/{orchestrationRuleId}/
Retrieve detailed information about an Orchestration Rule associated to this Farm Role.
PATCH
/{envId}/farm-roles/{farmRoleId}/orchestration-rules/{orchestrationRuleId}/
Modify the attributes of an Orchestration Rule associated to this Farm Role.
GET
/{envId}/farm-roles/{farmRoleId}/scaling/
Get Scaling Configuration
PATCH
/{envId}/farm-roles/{farmRoleId}/scaling/
Edit Scaling Configuration
POST
/{envId}/farm-roles/{farmRoleId}/scaling/
Create Rule
DELETE
/{envId}/farm-roles/{farmRoleId}/scaling/{metricName}/
Delete Rule
GET
/{envId}/farm-roles/{farmRoleId}/scaling/{metricName}/
Get Rule
PATCH
/{envId}/farm-roles/{farmRoleId}/scaling/{metricName}/
Edit Rule
GET
/{envId}/farm-roles/{farmRoleId}/servers/
Describes all the Servers associated to a Farm Role.
POST
/{envId}/farm-roles/{farmRoleId}/servers/
Launch a new Server for the specified Farm Role.
GET
/{envId}/farm-roles/{farmRoleId}/storage/
Describe the Storage configuration of the Farm Role.
POST
/{envId}/farm-roles/{farmRoleId}/storage/
Add a new storage configuration to the Farm Role.
DELETE
/{envId}/farm-roles/{farmRoleId}/storage/{storageConfigurationId}/
Delete the storage configuration from the Farm Role.
GET
/{envId}/farm-roles/{farmRoleId}/storage/{storageConfigurationId}/
Retrieve a specific storage configuration of the Farm Role.
PATCH
/{envId}/farm-roles/{farmRoleId}/storage/{storageConfigurationId}/
Modify the storage configuration of the Farm Role.
Schemas 150
The contract defines 150 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.
OrchestrationRuleCondition
object
1 property
1 required
FarmForeignKey
object
1 property
1 required
OsCondition
object
2 properties
2 required
StorageConfigurationDetailsResponse
object
4 properties
ScriptVariableRemoteList
object
9 properties
3 required
ScalingConfigurationDetailsResponse
object
4 properties
TriggeringServerTarget
object
Select only the Server that triggered the Event.
2 properties
1 required
GlobalVariableList
object
12 properties
3 required
ComposedUserIdentity
object
2 properties
1 required
SqsQueueSizeScalingRule
object
It is used in combination with the user defined Scaling Metrics.
5 properties
5 required
VmwareStorageTemplateCloudFeatures
object
Cloud specifics template configuration.
4 properties
1 required
FarmRoleIdentity
object
2 properties
1 required
HostnameConfiguration
object
Farm Role hostname configuration.
2 properties
1 required
FarmLightsOutConfiguration
object
LightsOut configuration for a Farm.
5 properties
3 required
NetworkCloudFeatures
object
Cloud specifics Farm Role Network configuration.
1 property
1 required
CloudFeatures
object
Cloud specifics Farm Role configuration.
1 property
1 required
ScriptVariable
object
8 properties
2 required
TemplateHostnameConfiguration
object
Template for hostname generation.
3 properties
1 required
UrlResponseTimeScalingRule
object
It is used in combination with the user defined Scaling Metrics.
5 properties
5 required
FarmRoleAnsibleTowerConfiguration
object
4 properties
PersistentStorageConfiguration
object
6 properties
2 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
TriggeringFarmRoleTarget
object
Selects all the Servers that belong to the same Farm Role as the Server that triggered the Event.
1 property
1 required
ScalingRule
object
2 properties
2 required
StorageConfigurationListResponse
object
5 properties
CloudNetworkForeignKey
object
1 property
1 required
GlobalVariableRemoteList
object
12 properties
3 required
GlobalVariableString
object
13 properties
2 required
SecurityGroupIdentity
object
2 properties
1 required
Target
object
1 property
1 required
ScalingRuleDetailsResponse
object
4 properties
FarmLockOptions
object
3 properties
RemoteScriptAction
object
2 properties
2 required
ScalingTemplateContent
object
6 properties
LightsOutTimeFrame
object
Time frame for the LightsOut schedule.
3 properties
1 required
AwsCloudFeatures
object
AWS Farm Role configuration. Available only for AWS Farm Roles.
5 properties
1 required
LightsOutNotification
object
2 properties
2 required
MountConfiguration
object
4 properties
RoleCategory
object
3 properties
1 required
Action
object
1 property
1 required
ChefServerForeignKey
object
1 property
1 required
ApiPagination
object
4 properties
RoleDeprecatedOptions
object
2 properties
AwsSpotInstanceConfiguration
object
EC2 Spot instance configuration.
2 properties
1 required
CloudSubnetForeignKey
object
1 property
1 required
OrchestrationRuleListResponse
object
5 properties
ApplicationGroupForeignKey
object
1 property
1 required
WebhookEndpoint
object
Webhook endpoint summary.
3 properties
ServerAlert
object
Alerts about server state
4 properties
3 required
VmwareCloudFeatures
object
VMware Farm Role configuration. Required for VMware Farm Roles.
8 properties
2 required
ServerSummary
object
A Scalr Server.
19 properties
ScalingConfiguration
object
6 properties
FarmRolesCondition
object
2 properties
1 required
SecurityConfiguration
object
1 property
1 required
NetworkConfiguration
object
Farm Role network configuration.
3 properties
IpPoolForeignKey
object
1 property
1 required
ScalrAgent
object
The information about Scalr Agent.
4 properties
InstanceType
object
6 properties
LightsOutEmailNotification
object
3 properties
3 required
InstanceTypeForeignKey
object
1 property
1 required
ReachabilityStatus
object
2 properties
StorageTemplateCloudFeatures
object
Cloud specifics template configuration.
1 property
1 required
ChefAction
object
1 property
1 required
ScalingRuleTimeFrame
object
4 properties
4 required
RoleForeignKey
object
1 property
1 required
CloudSubnet
object
2 properties
1 required
ServerSummaryDetailsResponse
object
4 properties
EphemeralStorageTemplate
object
Storage Template configuration.
2 properties
ScriptVersionIdentity
object
3 properties
EventForeignKey
object
1 property
1 required
InstanceTypeCloudFeatures
object
Cloud specific Instance type configuration.
1 property
1 required
UserForeignKey
object
1 property
1 required
AnsibleTowerAction
object
4 properties
3 required
FarmTarget
object
Selects all the Servers that belong to the triggering Server's Farm.
2 properties
1 required
AllEventsTrigger
object
Triggers when any Event fires.
1 property
1 required
ComposedTeamIdentity
object
2 properties
1 required
Trigger
object
1 property
1 required
DateAndTimeScalingRule
object
This Scaling Rule defines the number of instances that should be running during specified time frames.
3 properties
3 required
IpAddressConfiguration
object
The Farm Role network ip configuration
3 properties
LocalScriptAction
object
2 properties
2 required
Role
object
12 properties
3 required
AwsStorageTemplateCloudFeatures
object
Cloud specifics template configuration.
4 properties
1 required
OrchestrationRuleTemplateContent
object
8 properties
ServerSummaryListResponse
object
5 properties
BandWidthScalingRule
object
It is used in combination with the user defined Scaling Metrics.
5 properties
5 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
FarmRoleTemplateDetailsResponse
object
4 properties
FarmRoleTemplate
object
16 properties
OsForeignKey
object
1 property
1 required
ScalrScriptAction
object
2 properties
2 required
OpenstackNetworkCloudFeatures
object
Cloud specifics Farm Role Network configuration.
2 properties
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
GceCloudFeatures
object
GCE Farm Role configuration. Available only for GCE Farm Roles.
3 properties
1 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
OrchestrationRule
object
10 properties
3 required
GlobalVariableJson
object
11 properties
2 required
AzureNetworkCloudFeatures
object
Cloud specifics Farm Role Network configuration.
2 properties
1 required
GlobalVariableListResponse
object
5 properties
LoadAveragesScalingRule
object
It is used in combination with the user defined Scaling Metrics.
5 properties
5 required
FarmRoleDetailsResponse
object
4 properties
EphemeralStorageConfiguration
object
4 properties
2 required
FarmRoleNetwork
object
7 properties
1 required
LightsOutFarmOwnerNotification
object
2 properties
2 required
DatastoreCloudIdentity
object
2 properties
ApiMessage
object
2 properties
GceServiceAccount
object
1 property
1 required
GlobalVariable
object
11 properties
2 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
TagsCondition
object
2 properties
2 required
RootStorageConfiguration
object
3 properties
2 required
InitializationStatus
object
2 properties
ScriptVariableList
object
9 properties
3 required
AzureStorageTemplateCloudFeatures
object
Cloud specifics template configuration.
3 properties
1 required
FarmRole
object
15 properties
5 required
CloudSnapshotForeignKey
object
1 property
1 required
Os
object
5 properties
5 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
AwsInstanceTypeCloudFeatures
object
AWS instance type configuration.
6 properties
1 required
OrchestrationTemplateContent
object
1 property
RoleIdentityTemplateContent
object
2 properties
1 required
AnsibleTowerConfigurationIdentity
object
2 properties
PersistentStorageTemplate
object
Storage Template configuration.
4 properties
1 required
ApiErrorResponse
object
Common response for erroneous requests.
3 properties
BasicScalingRule
object
It is used in combination with the user defined Scaling Metrics.
4 properties
4 required
ApiMetaContainer
object
1 property
StorageConfiguration
object
2 properties
1 required
FarmRoleNetworkTemplate
object
6 properties
1 required
ScriptIdentity
object
2 properties
1 required
AzureCloudFeatures
object
Azure Farm Role configuration. Required for Azure Farm Roles.
4 properties
2 required
FarmRoleAdvancedConfiguration
object
6 properties
ScriptVariableString
object
10 properties
2 required
VariableAllowedValue
object
2 properties
1 required
WebhookHostnameConfiguration
object
Webhook endpoint configuration to obtain hostname.
3 properties
2 required
Tag
object
A Tag object.
2 properties
1 required
GlobalVariableDetailsResponse
object
4 properties
NetworkConfigurationTemplate
object
Farm Role template network configuration.
3 properties
Script
object
13 properties
2 required
RoleCategoryForeignKey
object
1 property
1 required
RoleIdentity
object
2 properties
1 required
Event
object
3 properties
1 required
SpecificEventTrigger
object
Triggers when a specific Event fires.
2 properties
1 required
OpenstackCloudFeatures
object
OpenStack Farm Role configuration. Available only for OpenStack Farm Roles.
2 properties
1 required
ScriptVariableJson
object
8 properties
2 required
JobTemplateIdentity
object
3 properties
FreeRamScalingRule
object
It is used in combination with the user defined Scaling Metrics.
5 properties
4 required
ScriptVariableValue
object
2 properties
1 required
FarmRoleForeignKey
object
1 property
1 required
Farm
object
10 properties
1 required
WebhookEndpointForeignKey
object
1 property
1 required
OrchestrationRuleDetailsResponse
object
4 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Scalr 12
Other APIs Scalr publishes across the network.
Scalr IaC Management API
Scalr Acl Roles API
Scalr Ansible Tower API
Scalr Cloud Credentials API
Scalr Clouds API
Scalr Cost Centers API
Scalr Environments API
Scalr Event Logs API
Scalr Events API
Scalr Farms API
Scalr Global Variables API
Scalr Images API
#Farm Roles
Where this information came from
This is an independent, third-party profile of Scalr Farm Roles 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.