Scalr Servers API is one of 26 APIs that Scalr publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Servers. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes
14 operations
across 9 paths,
and defines 81 schemas.
It is described by OpenAPI 2.0, at version 1.0.0.
14 operations9 paths81 schemas1 DELETE4 GET2 PATCH7 POST
Metadata
The identity and technical contract details declared by the specification.
Specification
OpenAPI 2.0
API Version
1.0.0
Resource Areas
1
Paths & Operations 14
Across 9 paths, the API surfaces 14 operations — 1 DELETE, 4 GET, 2 PATCH, 7 POST. Each is listed below with its method, path, parameters, and response codes.
Servers 14
GET
/{envId}/servers/
List all the Servers that exist in this Environment.
1 param→ 200400401403404409422500
POST
/{envId}/servers/
Launch a new Server for the specified Farm Role.
2 params→ 201400401403404409422500
GET
/{envId}/servers/{serverId}/
Retrieve detailed information about a Server.
2 params→ 200400401403404409422500
PATCH
/{envId}/servers/{serverId}/
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 instan…
3 params→ 200202400401403404409422
POST
/{envId}/servers/{serverId}/actions/reboot/
Reboot a Server.
3 params→ 200400401403404409422500
POST
/{envId}/servers/{serverId}/actions/resume/
Resume a suspended Server.
2 params→ 200400401403404409422500
POST
/{envId}/servers/{serverId}/actions/suspend/
Suspend a Server.
2 params→ 200400401403404409422500
POST
/{envId}/servers/{serverId}/actions/sync/
Sync the Ansible Tower Configuration on the Server.
2 params→ 202400401403404409422500
POST
/{envId}/servers/{serverId}/actions/terminate/
Terminate a Server.
3 params→ 200400401403404409422500
GET
/{envId}/servers/{serverId}/global-variables/
List all the Global Variables associated with this Server.
Modify the attributes of a Global Variable in this Server's scope.
4 params→ 200400401403404409422500
Schemas 81
The contract defines 81 schemas that model the data the API accepts and returns. The most detailed are Server (19 properties), ServerSummary (19 properties), FarmRole (15 properties), ChefServerBootstrapConfiguration (14 properties). Each schema is shown below with its type and property counts.
FarmForeignKey
object
1 property1 required
GlobalVariableList
object
12 properties3 required
ComposedUserIdentity
object
2 properties1 required
HostnameConfiguration
object
Farm Role hostname configuration.
2 properties1 required
FarmLightsOutConfiguration
object
LightsOut configuration for a Farm.
5 properties3 required
NetworkCloudFeatures
object
Cloud specifics Farm Role Network configuration.
1 property1 required
CloudFeatures
object
Cloud specifics Farm Role configuration.
1 property1 required
TemplateHostnameConfiguration
object
Template for hostname generation.
3 properties1 required
FarmRoleAnsibleTowerConfiguration
object
4 properties
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 properties2 required
CloudNetworkForeignKey
object
1 property1 required
GlobalVariableRemoteList
object
12 properties3 required
GlobalVariableString
object
13 properties2 required
SecurityGroupIdentity
object
2 properties1 required
FarmLockOptions
object
3 properties
LightsOutTimeFrame
object
Time frame for the LightsOut schedule.
3 properties1 required
AwsCloudFeatures
object
AWS Farm Role configuration. Available only for AWS Farm Roles.
5 properties1 required
LightsOutNotification
object
2 properties2 required
RoleCategory
object
3 properties1 required
ChefServerForeignKey
object
1 property1 required
ApiPagination
object
4 properties
RoleDeprecatedOptions
object
2 properties
AwsSpotInstanceConfiguration
object
EC2 Spot instance configuration.
2 properties1 required
CloudSubnetForeignKey
object
1 property1 required
ApplicationGroupForeignKey
object
1 property1 required
WebhookEndpoint
object
Webhook endpoint summary.
3 properties
ServerAlert
object
Alerts about server state
4 properties3 required
VmwareCloudFeatures
object
VMware Farm Role configuration. Required for VMware Farm Roles.
8 properties2 required
ServerSummary
object
A Scalr Server.
19 properties
ScalingConfiguration
object
6 properties
SecurityConfiguration
object
1 property1 required
NetworkConfiguration
object
Farm Role network configuration.
3 properties
IpPoolForeignKey
object
1 property1 required
ScalrAgent
object
The information about Scalr Agent.
4 properties
InstanceType
object
6 properties
LightsOutEmailNotification
object
3 properties3 required
InstanceTypeForeignKey
object
1 property1 required
ReachabilityStatus
object
2 properties
RoleForeignKey
object
1 property1 required
CloudSubnet
object
2 properties1 required
ServerSummaryDetailsResponse
object
4 properties
InstanceTypeCloudFeatures
object
Cloud specific Instance type configuration.
1 property1 required
UserForeignKey
object
1 property1 required
ComposedTeamIdentity
object
2 properties1 required
IpAddressConfiguration
object
The Farm Role network ip configuration
3 properties
Role
object
12 properties3 required
ServerSummaryListResponse
object
5 properties
ServerOperations
object
List of the temporary operations being processed in the Cloud Server by one or a number of requests.
1 property1 required
OsForeignKey
object
1 property1 required
OpenstackNetworkCloudFeatures
object
Cloud specifics Farm Role Network configuration.
2 properties1 required
ChefBootstrapConfiguration
object
Farm Role bootstrap configuration. Please note that this configuration is available only for Roles configured with Chef built-in automation.
6 properties1 required
GceCloudFeatures
object
GCE Farm Role configuration. Available only for GCE Farm Roles.
3 properties1 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 properties2 required
GlobalVariableJson
object
11 properties2 required
AzureNetworkCloudFeatures
object
Cloud specifics Farm Role Network configuration.
2 properties1 required
GlobalVariableListResponse
object
5 properties
FarmRoleNetwork
object
7 properties1 required
LightsOutFarmOwnerNotification
object
2 properties2 required
ApiMessage
object
2 properties
GceServiceAccount
object
1 property1 required
GlobalVariable
object
11 properties2 required
BootstrapConfiguration
object
Farm Role bootstrap configuration. Please note that this configuration is available only for Roles configured with Chef built-in automation.
2 properties1 required
InitializationStatus
object
2 properties
FarmRole
object
15 properties5 required
Os
object
5 properties5 required
AnsibleTowerBootstrapConfiguration
object
Farm Role bootstrap configuration. Please note that this configuration is available only for Roles configured with Chef built-in automation.
4 properties2 required
Server
object
A Scalr Server.
19 properties
AwsInstanceTypeCloudFeatures
object
AWS instance type configuration.
6 properties1 required
ApiErrorResponse
object
Common response for erroneous requests.
3 properties
ApiMetaContainer
object
1 property
AzureCloudFeatures
object
Azure Farm Role configuration. Required for Azure Farm Roles.
4 properties2 required
FarmRoleAdvancedConfiguration
object
6 properties
WebhookHostnameConfiguration
object
Webhook endpoint configuration to obtain hostname.
3 properties2 required
VariableAllowedValue
object
2 properties1 required
GlobalVariableDetailsResponse
object
4 properties
RoleCategoryForeignKey
object
1 property1 required
RoleIdentity
object
2 properties1 required
OpenstackCloudFeatures
object
OpenStack Farm Role configuration. Available only for OpenStack Farm Roles.
2 properties1 required
FarmRoleForeignKey
object
1 property1 required
Farm
object
10 properties1 required
WebhookEndpointForeignKey
object
1 property1 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
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.
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 Servers 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.