Scalr · Capability

Scalr User API

Scalr User API. 148 operations. Lead operation: Get Scaling Configuration. Self-contained Naftiko capability covering one Scalr business surface.

Run with Naftiko ScalrScalr User API

What You Can Do

GET
Get — The list of the Cloud Locations.
/v1/{envid}/clouds/{cloudplatform}/cloud-locations
GET
Get — The list of all Instance Types available for the specified Cloud Location.
/v1/{envid}/clouds/{cloudplatform}/cloud-locations/{cloudlocation}/instance-types
GET
Get — Retrieve detailed information about a given Cost Center.
/v1/{envid}/cost-centers/{costcenterid}
GET
Get — List of all Event logs.
/v1/{envid}/event-logs
GET
Get — Describes detailed information about the Event that has been fired.
/v1/{envid}/event-logs/{eventlogentryid}
GET
Get — List all the Events available in this Environment.
/v1/{envid}/events
POST
Post — Create a new Custom Event in this Environment.
/v1/{envid}/events
DELETE
Delete — Delete an Event from this Environment.
/v1/{envid}/events/{eventid}
GET
Get — Retrieve detailed information about a given Event.
/v1/{envid}/events/{eventid}
PATCH
Patch — Modify the attributes of an Event.
/v1/{envid}/events/{eventid}
POST
Post — It fires the Custom Event on the Server.
/v1/{envid}/events/{eventid}/actions/fire
DELETE
Delete — Remove a given Farm Role from its Farm.
/v1/{envid}/farm-roles/{farmroleid}
GET
Get — Retrieve detailed information about a given Farm Role.
/v1/{envid}/farm-roles/{farmroleid}
PATCH
Patch — Modify the attributes of a Farm Role.
/v1/{envid}/farm-roles/{farmroleid}
POST
Post — Clone a given FarmRole within current Farm or to another Farm.
/v1/{envid}/farm-roles/{farmroleid}/actions/clone
GET
Get — Get FarmRole Template body for given FarmRole.
/v1/{envid}/farm-roles/{farmroleid}/actions/generate-template
POST
Post — Import a running server from a Cloud Platform to a Scalr Farm Role.
/v1/{envid}/farm-roles/{farmroleid}/actions/import-server
GET
Get — List all the Global Variables associated with this Farm Role.
/v1/{envid}/farm-roles/{farmroleid}/global-variables
POST
Post — Declare a new Global Variable for this Farm Role.
/v1/{envid}/farm-roles/{farmroleid}/global-variables
DELETE
Delete — Delete a Global Variable from this Farm Role's scope.
/v1/{envid}/farm-roles/{farmroleid}/global-variables/{globalvariablename}
GET
Get — Retrieve detailed information about a Global Variable in this Farm Role's scope.
/v1/{envid}/farm-roles/{farmroleid}/global-variables/{globalvariablename}
PATCH
Patch — Modify the attributes of a Global Variable in this Farm Role's scope.
/v1/{envid}/farm-roles/{farmroleid}/global-variables/{globalvariablename}
GET
Get — List all Orchestration Rules associated with this Farm Role, including Rules from higher Scopes (those are read-only).
/v1/{envid}/farm-roles/{farmroleid}/orchestration-rules
POST
Post — Create a new Orchestration Rule associated to this Farm Role.
/v1/{envid}/farm-roles/{farmroleid}/orchestration-rules
DELETE
Delete — Delete an Orchestration Rule from this Farm Role.
/v1/{envid}/farm-roles/{farmroleid}/orchestration-rules/{orchestrationruleid}
GET
Get — Retrieve detailed information about an Orchestration Rule associated to this Farm Role.
/v1/{envid}/farm-roles/{farmroleid}/orchestration-rules/{orchestrationruleid}
PATCH
Patch — Modify the attributes of an Orchestration Rule associated to this Farm Role.
/v1/{envid}/farm-roles/{farmroleid}/orchestration-rules/{orchestrationruleid}
GET
Get — Get Scaling Configuration
/v1/{envid}/farm-roles/{farmroleid}/scaling
PATCH
Patch — Edit Scaling Configuration
/v1/{envid}/farm-roles/{farmroleid}/scaling
POST
Post — Create Rule
/v1/{envid}/farm-roles/{farmroleid}/scaling
DELETE
Delete — Delete Rule
/v1/{envid}/farm-roles/{farmroleid}/scaling/{metricname}
GET
Get — Get Rule
/v1/{envid}/farm-roles/{farmroleid}/scaling/{metricname}
PATCH
Patch — Edit Rule
/v1/{envid}/farm-roles/{farmroleid}/scaling/{metricname}
GET
Get — Describes all the Servers associated to a Farm Role.
/v1/{envid}/farm-roles/{farmroleid}/servers
POST
Post — Launch a new Server for the specified Farm Role.
/v1/{envid}/farm-roles/{farmroleid}/servers
GET
Get — Describe the Storage configuration of the Farm Role.
/v1/{envid}/farm-roles/{farmroleid}/storage
POST
Post — Add a new storage configuration to the Farm Role.
/v1/{envid}/farm-roles/{farmroleid}/storage
DELETE
Delete — Delete the storage configuration from the Farm Role.
/v1/{envid}/farm-roles/{farmroleid}/storage/{storageconfigurationid}
GET
Get — Retrieve a specific storage configuration of the Farm Role.
/v1/{envid}/farm-roles/{farmroleid}/storage/{storageconfigurationid}
PATCH
Patch — Modify the storage configuration of the Farm Role.
/v1/{envid}/farm-roles/{farmroleid}/storage/{storageconfigurationid}
GET
Get — List all the Farms available in this Environment.
/v1/{envid}/farms
POST
Post — Create a new Farm in this Environment. Farm and FarmTemplate objects are acceptable.
/v1/{envid}/farms
DELETE
Delete — Delete a Farm from this Environment.
/v1/{envid}/farms/{farmid}
GET
Get — Retrieve detailed information about a given Farm.
/v1/{envid}/farms/{farmid}
PATCH
Patch — Modify the attributes of a Farm.
/v1/{envid}/farms/{farmid}
POST
Post — Clone a given Farm.
/v1/{envid}/farms/{farmid}/actions/clone
GET
Get — Get Farm Template body for given Farm.
/v1/{envid}/farms/{farmid}/actions/generate-template
POST
Post — Launch a Farm.
/v1/{envid}/farms/{farmid}/actions/launch
POST
Post — Lock a Farm.
/v1/{envid}/farms/{farmid}/actions/lock
POST
Post — Resume a suspended Farm.
/v1/{envid}/farms/{farmid}/actions/resume
POST
Post — Suspend a Farm.
/v1/{envid}/farms/{farmid}/actions/suspend
POST
Post — Terminate a Farm.
/v1/{envid}/farms/{farmid}/actions/terminate
POST
Post — Unlock a Farm.
/v1/{envid}/farms/{farmid}/actions/unlock
GET
Get — List of the Cloud Services linked to the current Farm.
/v1/{envid}/farms/{farmid}/cloud-services
POST
Post — Link Cloud Service to the current Farm.
/v1/{envid}/farms/{farmid}/cloud-services
DELETE
Delete — Unlink Cloud Service from the current Farm.
/v1/{envid}/farms/{farmid}/cloud-services/{farmcloudservicelinkid}
GET
Get — Retrieve detailed information about linked Cloud Service to the current Farm.
/v1/{envid}/farms/{farmid}/cloud-services/{farmcloudservicelinkid}
PATCH
Patch — Modify Cloud Service attributes.
/v1/{envid}/farms/{farmid}/cloud-services/{farmcloudservicelinkid}
GET
Get — List all the Farm Roles in a Farm.
/v1/{envid}/farms/{farmid}/farm-roles
POST
Post — Create a new Farm Role in a Farm. FarmRole and FarmRoleTemplate objects are acceptable.
/v1/{envid}/farms/{farmid}/farm-roles
GET
Get — List all Global Variables associated to a Farm.
/v1/{envid}/farms/{farmid}/global-variables
POST
Post — Declare a new Global Variable for this Farm.
/v1/{envid}/farms/{farmid}/global-variables
DELETE
Delete — Delete a Global Variable from a given Farm's scope.
/v1/{envid}/farms/{farmid}/global-variables/{globalvariablename}
GET
Get — Retrieve detailed information about a Global Variable in the Farm's scope
/v1/{envid}/farms/{farmid}/global-variables/{globalvariablename}
PATCH
Patch — Modify the attributes of a Global Variable's in the Farm's scope.
/v1/{envid}/farms/{farmid}/global-variables/{globalvariablename}
GET
Get — List all the Servers associated to a Farm.
/v1/{envid}/farms/{farmid}/servers
GET
Get — List Global Variables declared in environment scope.
/v1/{envid}/global-variables
POST
Post — Declare a new Global Variable for this environment scope.
/v1/{envid}/global-variables
DELETE
Delete — Delete a Global Variable from environment scope.
/v1/{envid}/global-variables/{globalvariablename}
GET
Get — Retrieve detailed information about a Global Variable declared in environment scope.
/v1/{envid}/global-variables/{globalvariablename}
PATCH
Patch — Modify the attributes of a Global Variable declared in environment scope.
/v1/{envid}/global-variables/{globalvariablename}
GET
Get — List all the Images available in the Environment.
/v1/{envid}/images
POST
Post — Register a new Image in this Environment.
/v1/{envid}/images
DELETE
Delete — Remove an Image from the Environment. By default this does not delete the underlying machine image from the Cloud it resides in.
/v1/{envid}/images/{imageid}
GET
Get — Retrieve detailed information about an Image.
/v1/{envid}/images/{imageid}
PATCH
Patch — Modify the attributes of an Images. Currently only the name of the Image be can changed.
/v1/{envid}/images/{imageid}
POST
Post — Copy an Image from one EC2 region to another.
/v1/{envid}/images/{imageid}/actions/copy
POST
Post — Replace the current Image with a specified one for all Roles which use this Image. The Image will be replaced only within the Environment scope.
/v1/{envid}/images/{imageid}/actions/replace
GET
Get — List of all Orchestration logs.
/v1/{envid}/orchestration-logs
GET
Get — Describes detailed information about a result of the orchestration.
/v1/{envid}/orchestration-logs/{logentryid}
GET
Get — List the Orchestration Rules in this Environment.
/v1/{envid}/orchestration-rules
POST
Post — Create a new Orchestration Rule for this Environment.
/v1/{envid}/orchestration-rules
DELETE
Delete — Delete an Orchestration Rule from this Environment.
/v1/{envid}/orchestration-rules/{orchestrationruleid}
GET
Get — Retrieve detailed information about a given Orchestration Rule.
/v1/{envid}/orchestration-rules/{orchestrationruleid}
PATCH
Patch — Modify an Orchestration Rule.
/v1/{envid}/orchestration-rules/{orchestrationruleid}
GET
Get — List all the Operating Systems definitions available in this Environment.
/v1/{envid}/os
GET
Get — Retrieve detailed information about a given OS.
/v1/{envid}/os/{osid}
GET
Get — List the Role Categories available in this Environment.
/v1/{envid}/role-categories
POST
Post — Create a new Role Category in this Environment.
/v1/{envid}/role-categories
DELETE
Delete — Delete a Role Category from this Environment.
/v1/{envid}/role-categories/{rolecategoryid}
GET
Get — Retrieve detailed information about a given Role Category.
/v1/{envid}/role-categories/{rolecategoryid}
PATCH
Patch — Modify the attributes of a given Role Category.
/v1/{envid}/role-categories/{rolecategoryid}
GET
Get — List all the Roles available in this Environment.
/v1/{envid}/roles
POST
Post — Create a new Role in this Environment.
/v1/{envid}/roles
DELETE
Delete — Delete a Role from this Environment.
/v1/{envid}/roles/{roleid}
GET
Get — Retrieve detailed information about a given Role.
/v1/{envid}/roles/{roleid}
PATCH
Patch — Modify the attributes of a given Role.
/v1/{envid}/roles/{roleid}
POST
Post — Make a copy of an existing Role by cloning it.
/v1/{envid}/roles/{roleid}/actions/clone
POST
Post — Deprecate a Role and set another Role to replace it.
/v1/{envid}/roles/{roleid}/actions/deprecate
POST
Post — Promote Role to account scope.
/v1/{envid}/roles/{roleid}/actions/promote
GET
Get — List all the Global Variables associated with a given Role.
/v1/{envid}/roles/{roleid}/global-variables
POST
Post — Declares a new Global Variable for this Role.
/v1/{envid}/roles/{roleid}/global-variables
DELETE
Delete — Deletes a Global Variable from this Role's scope.
/v1/{envid}/roles/{roleid}/global-variables/{globalvariablename}
GET
Get — Retrieve detailed information about Global Variable in the Role's scope.
/v1/{envid}/roles/{roleid}/global-variables/{globalvariablename}
PATCH
Patch — Modify the attributes of a Global Variable in the Role's scope.
/v1/{envid}/roles/{roleid}/global-variables/{globalvariablename}
GET
Get — List all Images associated with a given Role.
/v1/{envid}/roles/{roleid}/images
POST
Post — Associates a new Image with a given Role. This will fail if an Image associated to the Role is in the same location than the Image you are trying to add.
/v1/{envid}/roles/{roleid}/images
DELETE
Delete — Dis-associates an Image from a given Role.
/v1/{envid}/roles/{roleid}/images/{imageid}
GET
Get — Retrieve detailed information about an Image.
/v1/{envid}/roles/{roleid}/images/{imageid}
POST
Post — Replace an Image in-place in a given Role. This allows to replace an Image without having to dis-associate it and then associate a new one, which may not be possible if a Farm Role is currently using this Image.
/v1/{envid}/roles/{roleid}/images/{imageid}/actions/replace
GET
Get — List the Orchestration Rules associated with a given Role, including Rules from higher Scopes (those are read-only).
/v1/{envid}/roles/{roleid}/orchestration-rules
POST
Post — Create a new Orchestration Rule associated to a Role.
/v1/{envid}/roles/{roleid}/orchestration-rules
DELETE
Delete — Delete the specified Orchestration Rule from the Role.
/v1/{envid}/roles/{roleid}/orchestration-rules/{orchestrationruleid}
GET
Get — Retrieve a given Orchestration Rule associated to a Role.
/v1/{envid}/roles/{roleid}/orchestration-rules/{orchestrationruleid}
PATCH
Patch — Modify the attributes of a given Orchestration Rule.
/v1/{envid}/roles/{roleid}/orchestration-rules/{orchestrationruleid}
GET
Get — List all Scaling metrics available in this Environment.
/v1/{envid}/scaling-metrics
POST
Post — Add a new custom Scaling metric to this Environment.
/v1/{envid}/scaling-metrics
DELETE
Delete — Delete a Scaling metric.
/v1/{envid}/scaling-metrics/{metricname}
GET
Get — Retrieve detailed information about a given Scaling metric.
/v1/{envid}/scaling-metrics/{metricname}
PATCH
Patch — Modify the attributes of a Scaling metric.
/v1/{envid}/scaling-metrics/{metricname}
GET
Get — Describes detailed information about a state of the script execution.
/v1/{envid}/script-executions/{scriptexecutionid}
GET
Get — List all the Scripts available in this Environment.
/v1/{envid}/scripts
POST
Post — Create a new Script in this Environment.
/v1/{envid}/scripts
DELETE
Delete — Deletes a given Script from this Environment.
/v1/{envid}/scripts/{scriptid}
GET
Get — Retrieve detailed information about a Script.
/v1/{envid}/scripts/{scriptid}
PATCH
Patch — Modify the attributes of a Script.
/v1/{envid}/scripts/{scriptid}
POST
Post — It executes the latest version of the Script on the Server.
/v1/{envid}/scripts/{scriptid}/actions/execute
GET
Get — List all Script Versions for the specified Script.
/v1/{envid}/scripts/{scriptid}/script-versions
POST
Post — Create a new Script Version for a given Script.
/v1/{envid}/scripts/{scriptid}/script-versions
DELETE
Delete — Delete a Script Version from this Script.
/v1/{envid}/scripts/{scriptid}/script-versions/{scriptversionnumber}
GET
Get — Retrieve detailed information about a specified Script Version.
/v1/{envid}/scripts/{scriptid}/script-versions/{scriptversionnumber}
PATCH
Patch — Modify the attributes of a Script Version.
/v1/{envid}/scripts/{scriptid}/script-versions/{scriptversionnumber}
POST
Post — It executes the specified version of the Script on the Server.
/v1/{envid}/scripts/{scriptid}/script-versions/{scriptversionnumber}/actions/execute
GET
Get — List all the Servers that exist in this Environment.
/v1/{envid}/servers
POST
Post — Launch a new Server for the specified Farm Role.
/v1/{envid}/servers
GET
Get — Retrieve detailed information about a Server.
/v1/{envid}/servers/{serverid}
PATCH
Patch — 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 "ru
/v1/{envid}/servers/{serverid}
POST
Post — Reboot a Server.
/v1/{envid}/servers/{serverid}/actions/reboot
POST
Post — Resume a suspended Server.
/v1/{envid}/servers/{serverid}/actions/resume
POST
Post — Suspend a Server.
/v1/{envid}/servers/{serverid}/actions/suspend
POST
Post — Sync the Ansible Tower Configuration on the Server.
/v1/{envid}/servers/{serverid}/actions/sync
POST
Post — Terminate a Server.
/v1/{envid}/servers/{serverid}/actions/terminate
GET
Get — List all the Global Variables associated with this Server.
/v1/{envid}/servers/{serverid}/global-variables
POST
Post — Declare a new Global Variable for this Server.
/v1/{envid}/servers/{serverid}/global-variables
DELETE
Delete — Delete a Global Variable from this Server's scope.
/v1/{envid}/servers/{serverid}/global-variables/{globalvariablename}
GET
Get — Retrieve detailed information about a Global Variable in this Server's scope.
/v1/{envid}/servers/{serverid}/global-variables/{globalvariablename}
PATCH
Patch — Modify the attributes of a Global Variable in this Server's scope.
/v1/{envid}/servers/{serverid}/global-variables/{globalvariablename}
GET
Get — List all the Webhook endpoints available in this Environment.
/v1/{envid}/webhook-endpoints

MCP Tools

list-cloud-locations

The list of the Cloud Locations.

read-only idempotent
list-all-instance-types-available

The list of all Instance Types available for the specified Cloud Location.

read-only idempotent
retrieve-detailed-information-about-given

Retrieve detailed information about a given Cost Center.

read-only idempotent
list-all-event-logs

List of all Event logs.

read-only idempotent
describes-detailed-information-about-event

Describes detailed information about the Event that has been fired.

read-only idempotent
list-all-events-available-this

List all the Events available in this Environment.

read-only idempotent
create-new-custom-event-this

Create a new Custom Event in this Environment.

delete-event-this-environment

Delete an Event from this Environment.

idempotent
retrieve-detailed-information-about-given-2

Retrieve detailed information about a given Event.

read-only idempotent
modify-attributes-event

Modify the attributes of an Event.

idempotent
it-fires-custom-event-server

It fires the Custom Event on the Server.

remove-given-farm-role-its

Remove a given Farm Role from its Farm.

idempotent
retrieve-detailed-information-about-given-3

Retrieve detailed information about a given Farm Role.

read-only idempotent
modify-attributes-farm-role

Modify the attributes of a Farm Role.

idempotent
clone-given-farmrole-within-current

Clone a given FarmRole within current Farm or to another Farm.

get-farmrole-template-body-given

Get FarmRole Template body for given FarmRole.

read-only idempotent
import-running-server-cloud-platform

Import a running server from a Cloud Platform to a Scalr Farm Role.

list-all-global-variables-associated

List all the Global Variables associated with this Farm Role.

read-only idempotent
declare-new-global-variable-this

Declare a new Global Variable for this Farm Role.

delete-global-variable-this-farm

Delete a Global Variable from this Farm Role's scope.

idempotent
retrieve-detailed-information-about-global

Retrieve detailed information about a Global Variable in this Farm Role's scope.

read-only idempotent
modify-attributes-global-variable-this

Modify the attributes of a Global Variable in this Farm Role's scope.

idempotent
list-all-orchestration-rules-associated

List all Orchestration Rules associated with this Farm Role, including Rules from higher Scopes (those are read-only).

read-only idempotent
create-new-orchestration-rule-associated

Create a new Orchestration Rule associated to this Farm Role.

delete-orchestration-rule-this-farm

Delete an Orchestration Rule from this Farm Role.

idempotent
retrieve-detailed-information-about-orchestration

Retrieve detailed information about an Orchestration Rule associated to this Farm Role.

read-only idempotent
modify-attributes-orchestration-rule-associated

Modify the attributes of an Orchestration Rule associated to this Farm Role.

idempotent
get-scaling-configuration

Get Scaling Configuration

read-only idempotent
edit-scaling-configuration

Edit Scaling Configuration

idempotent
create-rule

Create Rule

delete-rule

Delete Rule

idempotent
get-rule

Get Rule

read-only idempotent
edit-rule

Edit Rule

idempotent
describes-all-servers-associated-farm

Describes all the Servers associated to a Farm Role.

read-only idempotent
launch-new-server-specified-farm

Launch a new Server for the specified Farm Role.

describe-storage-configuration-farm-role

Describe the Storage configuration of the Farm Role.

read-only idempotent
add-new-storage-configuration-farm

Add a new storage configuration to the Farm Role.

delete-storage-configuration-farm-role

Delete the storage configuration from the Farm Role.

idempotent
retrieve-specific-storage-configuration-farm

Retrieve a specific storage configuration of the Farm Role.

read-only idempotent
modify-storage-configuration-farm-role

Modify the storage configuration of the Farm Role.

idempotent
list-all-farms-available-this

List all the Farms available in this Environment.

read-only idempotent
create-new-farm-this-environment

Create a new Farm in this Environment. Farm and FarmTemplate objects are acceptable.

delete-farm-this-environment

Delete a Farm from this Environment.

idempotent
retrieve-detailed-information-about-given-4

Retrieve detailed information about a given Farm.

read-only idempotent
modify-attributes-farm

Modify the attributes of a Farm.

idempotent
clone-given-farm

Clone a given Farm.

get-farm-template-body-given

Get Farm Template body for given Farm.

read-only idempotent
launch-farm

Launch a Farm.

lock-farm

Lock a Farm.

resume-suspended-farm

Resume a suspended Farm.

suspend-farm

Suspend a Farm.

terminate-farm

Terminate a Farm.

unlock-farm

Unlock a Farm.

list-cloud-services-linked-current

List of the Cloud Services linked to the current Farm.

read-only idempotent
link-cloud-service-current-farm

Link Cloud Service to the current Farm.

unlink-cloud-service-current-farm

Unlink Cloud Service from the current Farm.

idempotent
retrieve-detailed-information-about-linked

Retrieve detailed information about linked Cloud Service to the current Farm.

read-only idempotent
modify-cloud-service-attributes

Modify Cloud Service attributes.

idempotent
list-all-farm-roles-farm

List all the Farm Roles in a Farm.

read-only idempotent
create-new-farm-role-farm

Create a new Farm Role in a Farm. FarmRole and FarmRoleTemplate objects are acceptable.

list-all-global-variables-associated-2

List all Global Variables associated to a Farm.

read-only idempotent
declare-new-global-variable-this-2

Declare a new Global Variable for this Farm.

delete-global-variable-given-farm-s

Delete a Global Variable from a given Farm's scope.

idempotent
retrieve-detailed-information-about-global-2

Retrieve detailed information about a Global Variable in the Farm's scope

read-only idempotent
modify-attributes-global-variable-s-farm-s

Modify the attributes of a Global Variable's in the Farm's scope.

idempotent
list-all-servers-associated-farm

List all the Servers associated to a Farm.

read-only idempotent
list-global-variables-declared-environment

List Global Variables declared in environment scope.

read-only idempotent
declare-new-global-variable-this-3

Declare a new Global Variable for this environment scope.

delete-global-variable-environment-scope

Delete a Global Variable from environment scope.

idempotent
retrieve-detailed-information-about-global-3

Retrieve detailed information about a Global Variable declared in environment scope.

read-only idempotent
modify-attributes-global-variable-declared

Modify the attributes of a Global Variable declared in environment scope.

idempotent
list-all-images-available-environment

List all the Images available in the Environment.

read-only idempotent
register-new-image-this-environment

Register a new Image in this Environment.

remove-image-environment-default-this

Remove an Image from the Environment. By default this does not delete the underlying machine image from the Cloud it resides in.

idempotent
retrieve-detailed-information-about-image

Retrieve detailed information about an Image.

read-only idempotent
modify-attributes-images-currently-only

Modify the attributes of an Images. Currently only the name of the Image be can changed.

idempotent
copy-image-one-ec2-region

Copy an Image from one EC2 region to another.

replace-current-image-specified-one

Replace the current Image with a specified one for all Roles which use this Image. The Image will be replaced only within the Environment scope.

list-all-orchestration-logs

List of all Orchestration logs.

read-only idempotent
describes-detailed-information-about-result

Describes detailed information about a result of the orchestration.

read-only idempotent
list-orchestration-rules-this-environment

List the Orchestration Rules in this Environment.

read-only idempotent
create-new-orchestration-rule-this

Create a new Orchestration Rule for this Environment.

delete-orchestration-rule-this-environment

Delete an Orchestration Rule from this Environment.

idempotent
retrieve-detailed-information-about-given-5

Retrieve detailed information about a given Orchestration Rule.

read-only idempotent
modify-orchestration-rule

Modify an Orchestration Rule.

idempotent
list-all-operating-systems-definitions

List all the Operating Systems definitions available in this Environment.

read-only idempotent
retrieve-detailed-information-about-given-6

Retrieve detailed information about a given OS.

read-only idempotent
list-role-categories-available-this

List the Role Categories available in this Environment.

read-only idempotent
create-new-role-category-this

Create a new Role Category in this Environment.

delete-role-category-this-environment

Delete a Role Category from this Environment.

idempotent
retrieve-detailed-information-about-given-7

Retrieve detailed information about a given Role Category.

read-only idempotent
modify-attributes-given-role-category

Modify the attributes of a given Role Category.

idempotent
list-all-roles-available-this

List all the Roles available in this Environment.

read-only idempotent
create-new-role-this-environment

Create a new Role in this Environment.

delete-role-this-environment

Delete a Role from this Environment.

idempotent
retrieve-detailed-information-about-given-8

Retrieve detailed information about a given Role.

read-only idempotent
modify-attributes-given-role

Modify the attributes of a given Role.

idempotent
make-copy-existing-role-cloning

Make a copy of an existing Role by cloning it.

deprecate-role-and-set-another

Deprecate a Role and set another Role to replace it.

promote-role-account-scope

Promote Role to account scope.

list-all-global-variables-associated-3

List all the Global Variables associated with a given Role.

read-only idempotent
declares-new-global-variable-this

Declares a new Global Variable for this Role.

deletes-global-variable-this-role-s

Deletes a Global Variable from this Role's scope.

idempotent
retrieve-detailed-information-about-global-4

Retrieve detailed information about Global Variable in the Role's scope.

read-only idempotent
modify-attributes-global-variable-role-s

Modify the attributes of a Global Variable in the Role's scope.

idempotent
list-all-images-associated-given

List all Images associated with a given Role.

read-only idempotent
associates-new-image-given-role

Associates a new Image with a given Role. This will fail if an Image associated to the Role is in the same location than the Image you are trying to add.

dis-associates-image-given-role

Dis-associates an Image from a given Role.

idempotent
retrieve-detailed-information-about-image-2

Retrieve detailed information about an Image.

read-only idempotent
replace-image-place-given-role

Replace an Image in-place in a given Role. This allows to replace an Image without having to dis-associate it and then associate a new one, which may not be possible if a Farm Role is currently using this Image.

list-orchestration-rules-associated-given

List the Orchestration Rules associated with a given Role, including Rules from higher Scopes (those are read-only).

read-only idempotent
create-new-orchestration-rule-associated-2

Create a new Orchestration Rule associated to a Role.

delete-specified-orchestration-rule-role

Delete the specified Orchestration Rule from the Role.

idempotent
retrieve-given-orchestration-rule-associated

Retrieve a given Orchestration Rule associated to a Role.

read-only idempotent
modify-attributes-given-orchestration-rule

Modify the attributes of a given Orchestration Rule.

idempotent
list-all-scaling-metrics-available

List all Scaling metrics available in this Environment.

read-only idempotent
add-new-custom-scaling-metric

Add a new custom Scaling metric to this Environment.

delete-scaling-metric

Delete a Scaling metric.

idempotent
retrieve-detailed-information-about-given-9

Retrieve detailed information about a given Scaling metric.

read-only idempotent
modify-attributes-scaling-metric

Modify the attributes of a Scaling metric.

idempotent
describes-detailed-information-about-state

Describes detailed information about a state of the script execution.

read-only idempotent
list-all-scripts-available-this

List all the Scripts available in this Environment.

read-only idempotent
create-new-script-this-environment

Create a new Script in this Environment.

deletes-given-script-this-environment

Deletes a given Script from this Environment.

idempotent
retrieve-detailed-information-about-script

Retrieve detailed information about a Script.

read-only idempotent
modify-attributes-script

Modify the attributes of a Script.

idempotent
it-executes-latest-version-script

It executes the latest version of the Script on the Server.

read-only
list-all-script-versions-specified

List all Script Versions for the specified Script.

read-only idempotent
create-new-script-version-given

Create a new Script Version for a given Script.

delete-script-version-this-script

Delete a Script Version from this Script.

idempotent
retrieve-detailed-information-about-specified

Retrieve detailed information about a specified Script Version.

read-only idempotent
modify-attributes-script-version

Modify the attributes of a Script Version.

idempotent
it-executes-specified-version-script

It executes the specified version of the Script on the Server.

list-all-servers-that-exist

List all the Servers that exist in this Environment.

read-only idempotent
launch-new-server-specified-farm-2

Launch a new Server for the specified Farm Role.

retrieve-detailed-information-about-server

Retrieve detailed information about a Server.

read-only idempotent
modify-instance-type-server-server

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 "ru

idempotent
reboot-server

Reboot a Server.

resume-suspended-server

Resume a suspended Server.

suspend-server

Suspend a Server.

sync-ansible-tower-configuration-server

Sync the Ansible Tower Configuration on the Server.

terminate-server

Terminate a Server.

list-all-global-variables-associated-4

List all the Global Variables associated with this Server.

read-only idempotent
declare-new-global-variable-this-4

Declare a new Global Variable for this Server.

delete-global-variable-this-server-s

Delete a Global Variable from this Server's scope.

idempotent
retrieve-detailed-information-about-global-5

Retrieve detailed information about a Global Variable in this Server's scope.

read-only idempotent
modify-attributes-global-variable-this-2

Modify the attributes of a Global Variable in this Server's scope.

idempotent
list-all-webhook-endpoints-available

List all the Webhook endpoints available in this Environment.

read-only idempotent

Capability Spec

user.yaml Raw ↑ 
naftiko: 1.0.0-alpha2
info:
  label: Scalr User API
  description: 'Scalr User API. 148 operations. Lead operation: Get Scaling Configuration. Self-contained Naftiko capability
    covering one Scalr business surface.'
  tags:
  - Scalr
  - Scalr User API
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    SCALR_API_KEY: SCALR_API_KEY
capability:
  consumes:
  - type: http
    namespace: user
    baseUri: ''
    description: Scalr User API business capability. Self-contained, no shared references.
    resources:
    - name: envId-clouds-cloudPlatform-cloud-locations
      path: /{envId}/clouds/{cloudPlatform}/cloud-locations/
      operations:
      - name: get
        method: GET
        description: The list of the Cloud Locations.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: envId-clouds-cloudPlatform-cloud-locations-cloudLocation-instance-types
      path: /{envId}/clouds/{cloudPlatform}/cloud-locations/{cloudLocation}/instance-types/
      operations:
      - name: get
        method: GET
        description: The list of all Instance Types available for the specified Cloud Location.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: envId-cost-centers-costCenterId
      path: /{envId}/cost-centers/{costCenterId}/
      operations:
      - name: get
        method: GET
        description: Retrieve detailed information about a given Cost Center.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: envId-event-logs
      path: /{envId}/event-logs/
      operations:
      - name: get
        method: GET
        description: List of all Event logs.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: envId-event-logs-eventLogEntryId
      path: /{envId}/event-logs/{eventLogEntryId}/
      operations:
      - name: get
        method: GET
        description: Describes detailed information about the Event that has been fired.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: envId-events
      path: /{envId}/events/
      operations:
      - name: get
        method: GET
        description: List all the Events available in this Environment.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: post
        method: POST
        description: Create a new Custom Event in this Environment.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: eventObject
          in: body
          type: string
          description: The JSON representation of a Event object.
          required: true
    - name: envId-events-eventId
      path: /{envId}/events/{eventId}/
      operations:
      - name: delete
        method: DELETE
        description: Delete an Event from this Environment.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: get
        method: GET
        description: Retrieve detailed information about a given Event.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: patch
        method: PATCH
        description: Modify the attributes of an Event.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: eventObject
          in: body
          type: string
          description: The JSON representation of a Event object.
          required: true
    - name: envId-events-eventId-actions-fire
      path: /{envId}/events/{eventId}/actions/fire/
      operations:
      - name: post
        method: POST
        description: It fires the Custom Event on the Server.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: fireEventRequest
          in: body
          type: string
          description: Fire Event options.
          required: true
    - name: envId-farm-roles-farmRoleId
      path: /{envId}/farm-roles/{farmRoleId}/
      operations:
      - name: delete
        method: DELETE
        description: Remove a given Farm Role from its Farm.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: get
        method: GET
        description: Retrieve detailed information about a given Farm Role.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: patch
        method: PATCH
        description: Modify the attributes of a Farm Role.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: farmRoleObject
          in: body
          type: string
          description: The JSON representation of a FarmRole object.
          required: true
    - name: envId-farm-roles-farmRoleId-actions-clone
      path: /{envId}/farm-roles/{farmRoleId}/actions/clone/
      operations:
      - name: post
        method: POST
        description: Clone a given FarmRole within current Farm or to another Farm.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: cloneFarmRoleRequest
          in: body
          type: string
          description: FarmRole cloning options.
          required: true
    - name: envId-farm-roles-farmRoleId-actions-generate-template
      path: /{envId}/farm-roles/{farmRoleId}/actions/generate-template/
      operations:
      - name: get
        method: GET
        description: Get FarmRole Template body for given FarmRole.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: envId-farm-roles-farmRoleId-actions-import-server
      path: /{envId}/farm-roles/{farmRoleId}/actions/import-server/
      operations:
      - name: post
        method: POST
        description: Import a running server from a Cloud Platform to a Scalr Farm Role.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: importServerRequest
          in: body
          type: string
          description: Server import settings.
          required: true
    - name: envId-farm-roles-farmRoleId-global-variables
      path: /{envId}/farm-roles/{farmRoleId}/global-variables/
      operations:
      - name: get
        method: GET
        description: List all the Global Variables associated with this Farm Role.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: post
        method: POST
        description: Declare a new Global Variable for this Farm Role.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: globalVariableObject
          in: body
          type: string
          description: The JSON representation of a GlobalVariable object.
          required: true
    - name: envId-farm-roles-farmRoleId-global-variables-globalVariableName
      path: /{envId}/farm-roles/{farmRoleId}/global-variables/{globalVariableName}/
      operations:
      - name: delete
        method: DELETE
        description: Delete a Global Variable from this Farm Role's scope.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: get
        method: GET
        description: Retrieve detailed information about a Global Variable in this Farm Role's scope.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: patch
        method: PATCH
        description: Modify the attributes of a Global Variable in this Farm Role's scope.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: globalVariableObject
          in: body
          type: string
          description: The JSON representation of a GlobalVariable object.
          required: true
    - name: envId-farm-roles-farmRoleId-orchestration-rules
      path: /{envId}/farm-roles/{farmRoleId}/orchestration-rules/
      operations:
      - name: get
        method: GET
        description: List all Orchestration Rules associated with this Farm Role, including Rules from higher Scopes (those
          are read-only).
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: post
        method: POST
        description: Create a new Orchestration Rule associated to this Farm Role.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: orchestrationRuleObject
          in: body
          type: string
          description: The JSON representation of a OrchestrationRule object.
          required: true
    - name: envId-farm-roles-farmRoleId-orchestration-rules-orchestrationRuleId
      path: /{envId}/farm-roles/{farmRoleId}/orchestration-rules/{orchestrationRuleId}/
      operations:
      - name: delete
        method: DELETE
        description: Delete an Orchestration Rule from this Farm Role.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: get
        method: GET
        description: Retrieve detailed information about an Orchestration Rule associated to this Farm Role.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: patch
        method: PATCH
        description: Modify the attributes of an Orchestration Rule associated to this Farm Role.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: orchestrationRuleObject
          in: body
          type: string
          description: The JSON representation of a OrchestrationRule object.
          required: true
    - name: envId-farm-roles-farmRoleId-scaling
      path: /{envId}/farm-roles/{farmRoleId}/scaling/
      operations:
      - name: get
        method: GET
        description: Get Scaling Configuration
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: patch
        method: PATCH
        description: Edit Scaling Configuration
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: scalingConfigurationObject
          in: body
          type: string
          description: The JSON representation of a ScalingConfiguration object.
          required: true
      - name: post
        method: POST
        description: Create Rule
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: scalingRuleObject
          in: body
          type: string
          description: The JSON representation of a ScalingRule object.
          required: true
    - name: envId-farm-roles-farmRoleId-scaling-metricName
      path: /{envId}/farm-roles/{farmRoleId}/scaling/{metricName}/
      operations:
      - name: delete
        method: DELETE
        description: Delete Rule
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: get
        method: GET
        description: Get Rule
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: patch
        method: PATCH
        description: Edit Rule
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: scalingRuleObject
          in: body
          type: string
          description: The JSON representation of a ScalingRule object.
          required: true
    - name: envId-farm-roles-farmRoleId-servers
      path: /{envId}/farm-roles/{farmRoleId}/servers/
      operations:
      - name: get
        method: GET
        description: Describes all the Servers associated to a Farm Role.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: post
        method: POST
        description: Launch a new Server for the specified Farm Role.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: envId-farm-roles-farmRoleId-storage
      path: /{envId}/farm-roles/{farmRoleId}/storage/
      operations:
      - name: get
        method: GET
        description: Describe the Storage configuration of the Farm Role.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: post
        method: POST
        description: Add a new storage configuration to the Farm Role.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: storageConfigurationObject
          in: body
          type: string
          description: The JSON representation of a StorageConfiguration object.
          required: true
    - name: envId-farm-roles-farmRoleId-storage-storageConfigurationId
      path: /{envId}/farm-roles/{farmRoleId}/storage/{storageConfigurationId}/
      operations:
      - name: delete
        method: DELETE
        description: Delete the storage configuration from the Farm Role.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: get
        method: GET
        description: Retrieve a specific storage configuration of the Farm Role.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: patch
        method: PATCH
        description: Modify the storage configuration of the Farm Role.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: storageConfigurationObject
          in: body
          type: string
          description: The JSON representation of a StorageConfiguration object.
          required: true
    - name: envId-farms
      path: /{envId}/farms/
      operations:
      - name: get
        method: GET
        description: List all the Farms available in this Environment.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: post
        method: POST
        description: Create a new Farm in this Environment. Farm and FarmTemplate objects are acceptable.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: farmObject
          in: body
          type: string
          description: The JSON representation of a Farm object.
          required: true
    - name: envId-farms-farmId
      path: /{envId}/farms/{farmId}/
      operations:
      - name: delete
        method: DELETE
        description: Delete a Farm from this Environment.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: get
        method: GET
        description: Retrieve detailed information about a given Farm.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: patch
        method: PATCH
        description: Modify the attributes of a Farm.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: farmObject
          in: body
          type: string
          description: The JSON representation of a Farm object.
          required: true
    - name: envId-farms-farmId-actions-clone
      path: /{envId}/farms/{farmId}/actions/clone/
      operations:
      - name: post
        method: POST
        description: Clone a given Farm.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: cloneFarmRequest
          in: body
          type: string
          description: Farm cloning options.
          required: true
    - name: envId-farms-farmId-actions-generate-template
      path: /{envId}/farms/{farmId}/actions/generate-template/
      operations:
      - name: get
        method: GET
        description: Get Farm Template body for given Farm.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: envId-farms-farmId-actions-launch
      path: /{envId}/farms/{farmId}/actions/launch/
      operations:
      - name: post
        method: POST
        description: Launch a Farm.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: envId-farms-farmId-actions-lock
      path: /{envId}/farms/{farmId}/actions/lock/
      operations:
      - name: post
        method: POST
        description: Lock a Farm.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: lockFarmRequest
          in: body
          type: string
          description: Lock Farm options.
          required: true
    - name: envId-farms-farmId-actions-resume
      path: /{envId}/farms/{farmId}/actions/resume/
      operations:
      - name: post
        method: POST
        description: Resume a suspended Farm.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: envId-farms-farmId-actions-suspend
      path: /{envId}/farms/{farmId}/actions/suspend/
      operations:
      - name: post
        method: POST
        description: Suspend a Farm.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: envId-farms-farmId-actions-terminate
      path: /{envId}/farms/{farmId}/actions/terminate/
      operations:
      - name: post
        method: POST
        description: Terminate a Farm.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: terminateFarmRequest
          in: body
          type: string
          description: Terminate Farm options.
    - name: envId-farms-farmId-actions-unlock
      path: /{envId}/farms/{farmId}/actions/unlock/
      operations:
      - name: post
        method: POST
        description: Unlock a Farm.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: envId-farms-farmId-cloud-services
      path: /{envId}/farms/{farmId}/cloud-services/
      operations:
      - name: get
        method: GET
        description: List of the Cloud Services linked to the current Farm.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: post
        method: POST
        description: Link Cloud Service to the current Farm.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: farmCloudServiceLinkObject
          in: body
          type: string
          description: The JSON representation of a FarmCloudServiceLink object.
          required: true
    - name: envId-farms-farmId-cloud-services-farmCloudServiceLinkId
      path: /{envId}/farms/{farmId}/cloud-services/{farmCloudServiceLinkId}/
      operations:
      - name: delete
        method: DELETE
        description: Unlink Cloud Service from the current Farm.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: get
        method: GET
        description: Retrieve detailed information about linked Cloud Service to the current Farm.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: patch
        method: PATCH
        description: Modify Cloud Service attributes.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: farmCloudServiceLinkObject
          in: body
          type: string
          description: The JSON representation of a FarmCloudServiceLink object.
          required: true
    - name: envId-farms-farmId-farm-roles
      path: /{envId}/farms/{farmId}/farm-roles/
      operations:
      - name: get
        method: GET
        description: List all the Farm Roles in a Farm.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: post
        method: POST
        description: Create a new Farm Role in a Farm. FarmRole and FarmRoleTemplate objects are acceptable.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: farmRoleObject
          in: body
          type: string
          description: The JSON representation of a FarmRole object.
          required: true
    - name: envId-farms-farmId-global-variables
      path: /{envId}/farms/{farmId}/global-variables/
      operations:
      - name: get
        method: GET
        description: List all Global Variables associated to a Farm.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: post
        method: POST
        description: Declare a new Global Variable for this Farm.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: globalVariableObject
          in: body
          type: string
          description: The JSON representation of a GlobalVariable object.
          required: true
    - name: envId-farms-farmId-global-variables-globalVariableName
      path: /{envId}/farms/{farmId}/global-variables/{globalVariableName}/
      operations:
      - name: delete
        method: DELETE
        description: Delete a Global Variable from a given Farm's scope.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: get
        method: GET
        description: Retrieve detailed information about a Global Variable in the Farm's scope
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: patch
        method: PATCH
        description: Modify the attributes of a Global Variable's in the Farm's scope.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: globalVariableObject
          in: body
          type: string
          description: The JSON representation of a GlobalVariable object.
          required: true
    - name: envId-farms-farmId-servers
      path: /{envId}/farms/{farmId}/servers/
      operations:
      - name: get
        method: GET
        description: List all the Servers associated to a Farm.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: envId-global-variables
      path: /{envId}/global-variables/
      operations:
      - name: get
        method: GET
        description: List Global Variables declared in environment scope.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: post
        method: POST
        description: Declare a new Global Variable for this environment scope.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: globalVariableObject
          in: body
          type: string
          description: The JSON representation of a GlobalVariable object.
          required: true
    - name: envId-global-variables-globalVariableName
      path: /{envId}/global-variables/{globalVariableName}/
      operations:
      - name: delete
        method: DELETE
        description: Delete a Global Variable from environment scope.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: get
        method: GET
        description: Retrieve detailed information about a Global Variable declared in environment scope.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: patch
        method: PATCH
        description: Modify the attributes of a Global Variable declared in environment scope.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: globalVariableObject
          in: body
          type: string
          description: The JSON representation of a GlobalVariable object.
          required: true
    - name: envId-images
      path: /{envId}/images/
      operations:
      - name: get
        method: GET
        description: List all the Images available in the Environment.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: post
        method: POST
        description: Register a new Image in this Environment.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: imageObject
          in: body
          type: string
          description: The JSON representation of a Image object.
          required: true
    - name: envId-images-imageId
      path: /{envId}/images/{imageId}/
      operations:
      - name: delete
        method: DELETE
        description: Remove an Image from the Environment. By default this does not delete the underlying machine image from
          the Cloud it resides in.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: deleteFromCloud
          in: query
          type: boolean
          description: Attempt to also delete this Image from the Cloud.
      - name: get
        method: GET
        description: Retrieve detailed information about an Image.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: patch
        method: PATCH
        description: Modify the attributes of an Images. Currently only the name of the Image be can changed.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: image
          in: body
          type: string
          description: The updated definition.
          required: true
    - name: envId-images-imageId-actions-copy
      path: /{envId}/images/{imageId}/actions/copy/
      operations:
      - name: post
        method: POST
        description: Copy an Image from one EC2 region to another.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: copyImageRequest
          in: body
          type: string
          description: The EC2 region to copy this Image to.
          required: true
    - name: envId-images-imageId-actions-replace
      path: /{envId}/images/{imageId}/actions/replace/
      operations:
      - name: post
        method: POST
        description: Replace the current Image with a specified one for all Roles which use this Image. The Image will be
          replaced only within the Environment scope.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: replaceImageRequest
          in: body
          type: string
          description: Replace image options.
          required: true
    - name: envId-orchestration-logs
      path: /{envId}/orchestration-logs/
      operations:
      - name: get
        method: GET
        description: List of all Orchestration logs.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: envId-orchestration-logs-logEntryId
      path: /{envId}/orchestration-logs/{logEntryId}/
      operations:
      - name: get
        method: GET
        description: Describes detailed information about a result of the orchestration.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: envId-orchestration-rules
      path: /{envId}/orchestration-rules/
      operations:
      - name: get
        method: GET
        description: List the Orchestration Rules in this Environment.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: post
        method: POST
        description: Create a new Orchestration Rule for this Environment.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: orchestrationRuleObject
          in: body
          type: string
          description: The JSON representation of a OrchestrationRule object.
          required: true
    - name: envId-orchestration-rules-orchestrationRuleId
      path: /{envId}/orchestration-rules/{orchestrationRuleId}/
      operations:
      - name: delete
        method: DELETE
        description: Delete an Orchestration Rule from this Environment.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: get
        method: GET
        description: Retrieve detailed information about a given Orchestration Rule.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: patch
        method: PATCH
        description: Modify an Orchestration Rule.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: orchestrationRuleObject
          in: body
          type: string
          description: The JSON representation of a OrchestrationRule object.
          required: true
    - 

# --- truncated at 32 KB (152 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/scalr/refs/heads/main/capabilities/user.yaml