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 Roles API

The Roles API from Scalr — 33 operation(s) for roles.

Documentation Provider Profile APIs.io OpenAPI GitHub

Scalr 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 Roles. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 66 operations across 33 paths, and defines 103 schemas. It is described by OpenAPI 2.0, at version 1.0.0.

66 operations 33 paths 103 schemas 12 DELETE24 GET9 PATCH21 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 66

Across 33 paths, the API surfaces 66 operations — 12 DELETE, 24 GET, 9 PATCH, 21 POST. Each is listed below with its method, path, parameters, and response codes.

Roles 66
GET
/{accountId}/roles/
List all the Roles available in this Account.
1 param → 200400401403404409422500
POST
/{accountId}/roles/
Create a new Role in this Account.
2 params → 201400401403404409422500
DELETE
/{accountId}/roles/{roleId}/
Delete a Role from this Account.
2 params → 204400401403404409422500
GET
/{accountId}/roles/{roleId}/
Retrieve detailed information about a given Role.
2 params → 200400401403404409422500
PATCH
/{accountId}/roles/{roleId}/
Modify the attributes of a given Role.
3 params → 200400401403404409422500
POST
/{accountId}/roles/{roleId}/actions/clone/
Make a copy of an existing Role by cloning it.
3 params → 201400401403404409422500
POST
/{accountId}/roles/{roleId}/actions/deprecate/
Deprecate a Role and set another Role to replace it.
3 params → 200400401403404409422500
GET
/{accountId}/roles/{roleId}/global-variables/
List all the Global Variables associated with a given Role.
2 params → 200400401403404409422500
POST
/{accountId}/roles/{roleId}/global-variables/
Declare a new Global Variable for this Role.
3 params → 201400401403404409422500
DELETE
/{accountId}/roles/{roleId}/global-variables/{globalVariableName}/
Delete a Global Variable from a given Role's scope.
3 params → 204400401403404409422500
GET
/{accountId}/roles/{roleId}/global-variables/{globalVariableName}/
Retrieve detailed information about Global Variable in the Role's scope.
3 params → 200400401403404409422500
PATCH
/{accountId}/roles/{roleId}/global-variables/{globalVariableName}/
Modify the attributes of a Global Variable in the Role's scope.
4 params → 200400401403404409422500
GET
/{accountId}/roles/{roleId}/images/
List all the Images associated with a given Role.
2 params → 200400401403404409422500
POST
/{accountId}/roles/{roleId}/images/
Associate 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.
3 params → 201400401403404409422500
DELETE
/{accountId}/roles/{roleId}/images/{imageId}/
Dis-associate an Image from a given Role.
3 params → 204400401403404409422500
GET
/{accountId}/roles/{roleId}/images/{imageId}/
Retrieve detailed information about an Image.
3 params → 200400401403404409422500
POST
/{accountId}/roles/{roleId}/images/{imageId}/actions/replace/
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…
4 params → 200400401403404409422500
GET
/{accountId}/roles/{roleId}/orchestration-rules/
List the Orchestration Rules associated with a given Role, including Rules from higher Scopes (those are read-only).
2 params → 200400401403404409422500
POST
/{accountId}/roles/{roleId}/orchestration-rules/
Create a new Orchestration Rule associated to a Role.
3 params → 201400401403404409422500
DELETE
/{accountId}/roles/{roleId}/orchestration-rules/{orchestrationRuleId}/
Delete an Orchestration Rule from the Role.
3 params → 204400401403404409422500
GET
/{accountId}/roles/{roleId}/orchestration-rules/{orchestrationRuleId}/
Retrieve detailed information about a given Orchestration Rule associated to this Role.
3 params → 200400401403404409422500
PATCH
/{accountId}/roles/{roleId}/orchestration-rules/{orchestrationRuleId}/
Modify the attributes of a given Orchestration Rule.
4 params → 200400401403404409422500
GET
/roles/
List all the Roles available in the global scope.
→ 200400401403404409422500
POST
/roles/
Create a new Role in the global scope.
1 param → 201400401403404409422500
DELETE
/roles/{roleId}/
Delete a Role from the global scope.
1 param → 204400401403404409422500
GET
/roles/{roleId}/
Retrieve detailed information about a given Role.
1 param → 200400401403404409422500
PATCH
/roles/{roleId}/
Modify the attributes of a given Role.
2 params → 200400401403404409422500
POST
/roles/{roleId}/actions/deprecate/
Deprecate a Role and set another Role to replace it.
2 params → 200400401403404409422500
GET
/roles/{roleId}/global-variables/
List all the Global Variables associated with a given Role.
1 param → 200400401403404409422500
POST
/roles/{roleId}/global-variables/
Declares a new Global Variable for this Role.
2 params → 201400401403404409422500
DELETE
/roles/{roleId}/global-variables/{globalVariableName}/
Deletes a Global Variable from a given Role's scope.
2 params → 204400401403404409422500
GET
/roles/{roleId}/global-variables/{globalVariableName}/
Retrieve detailed information about a Global Variable in the Role's scope.
2 params → 200400401403404409422500
PATCH
/roles/{roleId}/global-variables/{globalVariableName}/
Modify the attributes of a Global Variable in the Role's scope.
3 params → 200400401403404409422500
GET
/roles/{roleId}/images/
List all the Images associated with the specified Role.
1 param → 200400401403404409422500
POST
/roles/{roleId}/images/
Associate a new Image with this Role. This will fail if an Image associated to the Role is in the same location than the Image you are trying to add.
2 params → 201400401403404409422500
DELETE
/roles/{roleId}/images/{imageId}/
Dis-associates an Image from a given Role.
2 params → 204400401403404409422500
GET
/roles/{roleId}/images/{imageId}/
Retrieve detailed information about an Image.
2 params → 200400401403404409422500
POST
/roles/{roleId}/images/{imageId}/actions/replace/
Replaces an Image in-place in a given Role. This allows you 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…
3 params → 200400401403404409422500
GET
/roles/{roleId}/orchestration-rules/
List the Orchestration Rules associated to a Role.
1 param → 200400401403404409422500
POST
/roles/{roleId}/orchestration-rules/
Create a new Orchestration Rule associated to a Role.
2 params → 201400401403404409422500
DELETE
/roles/{roleId}/orchestration-rules/{orchestrationRuleId}/
Deletes the specified Orchestration Rule from the Role.
2 params → 204400401403404409422500
GET
/roles/{roleId}/orchestration-rules/{orchestrationRuleId}/
Retrieve a given Orchestration Rule associated to a Role.
2 params → 200400401403404409422500
PATCH
/roles/{roleId}/orchestration-rules/{orchestrationRuleId}/
Modify the attributes of the specified Orchestration Rule.
3 params → 200400401403404409422500
GET
/{envId}/roles/
List all the Roles available in this Environment.
1 param → 200400401403404409422500
POST
/{envId}/roles/
Create a new Role in this Environment.
2 params → 201400401403404409422500
DELETE
/{envId}/roles/{roleId}/
Delete a Role from this Environment.
2 params → 204400401403404409422500
GET
/{envId}/roles/{roleId}/
Retrieve detailed information about a given Role.
2 params → 200400401403404409422500
PATCH
/{envId}/roles/{roleId}/
Modify the attributes of a given Role.
3 params → 200400401403404409422500
POST
/{envId}/roles/{roleId}/actions/clone/
Make a copy of an existing Role by cloning it.
3 params → 201400401403404409422500
POST
/{envId}/roles/{roleId}/actions/deprecate/
Deprecate a Role and set another Role to replace it.
3 params → 200400401403404409422500
POST
/{envId}/roles/{roleId}/actions/promote/
Promote Role to account scope.
2 params → 200400401403404409422500
GET
/{envId}/roles/{roleId}/global-variables/
List all the Global Variables associated with a given Role.
2 params → 200400401403404409422500
POST
/{envId}/roles/{roleId}/global-variables/
Declares a new Global Variable for this Role.
3 params → 201400401403404409422500
DELETE
/{envId}/roles/{roleId}/global-variables/{globalVariableName}/
Deletes a Global Variable from this Role's scope.
3 params → 204400401403404409422500
GET
/{envId}/roles/{roleId}/global-variables/{globalVariableName}/
Retrieve detailed information about Global Variable in the Role's scope.
3 params → 200400401403404409422500
PATCH
/{envId}/roles/{roleId}/global-variables/{globalVariableName}/
Modify the attributes of a Global Variable in the Role's scope.
4 params → 200400401403404409422500
GET
/{envId}/roles/{roleId}/images/
List all Images associated with a given Role.
2 params → 200400401403404409422500
POST
/{envId}/roles/{roleId}/images/
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.
3 params → 201400401403404409422500
DELETE
/{envId}/roles/{roleId}/images/{imageId}/
Dis-associates an Image from a given Role.
3 params → 204400401403404409422500
GET
/{envId}/roles/{roleId}/images/{imageId}/
Retrieve detailed information about an Image.
3 params → 200400401403404409422500
POST
/{envId}/roles/{roleId}/images/{imageId}/actions/replace/
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…
4 params → 200400401403404409422500
GET
/{envId}/roles/{roleId}/orchestration-rules/
List the Orchestration Rules associated with a given Role, including Rules from higher Scopes (those are read-only).
2 params → 200400401403404409422500
POST
/{envId}/roles/{roleId}/orchestration-rules/
Create a new Orchestration Rule associated to a Role.
3 params → 201400401403404409422500
DELETE
/{envId}/roles/{roleId}/orchestration-rules/{orchestrationRuleId}/
Delete the specified Orchestration Rule from the Role.
3 params → 204400401403404409422500
GET
/{envId}/roles/{roleId}/orchestration-rules/{orchestrationRuleId}/
Retrieve a given Orchestration Rule associated to a Role.
3 params → 200400401403404409422500
PATCH
/{envId}/roles/{roleId}/orchestration-rules/{orchestrationRuleId}/
Modify the attributes of a given Orchestration Rule.
4 params → 200400401403404409422500

Schemas 103

The contract defines 103 schemas that model the data the API accepts and returns. The most detailed are Image (19 properties), Image_3 (19 properties), Image_2 (19 properties), AccountRole (14 properties). Each schema is shown below with its type and property counts.

OrchestrationRuleCondition
object
1 property 1 required
OsCondition
object
2 properties 2 required
ScriptVariableRemoteList
object
9 properties 3 required
TriggeringServerTarget
object
Select only the Server that triggered the Event.
2 properties 1 required
GlobalVariableList
object
12 properties 3 required
RoleImageDetailsResponse_2
object
4 properties
RoleImageDetailsResponse
object
4 properties
FarmRoleIdentity
object
2 properties
ApiErrorResponse_3
object
Common response for erroneous requests.
3 properties
ImageDetailsResponse_2
object
4 properties
ImageDetailsResponse
object
4 properties
ScriptVariable
object
8 properties 2 required
EnvironmentForeignKey
object
1 property 1 required
ImageForeignKey
object
1 property 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
RemoteScriptAction_2
object
2 properties 2 required
GlobalVariableRemoteList
object
12 properties 3 required
GlobalVariableString
object
13 properties 2 required
Target
object
1 property 1 required
RemoteScriptAction
object
2 properties 2 required
OrchestrationRuleDetailsResponse_2
object
4 properties
Image_3
object
19 properties 5 required
RoleImageListResponse_3
object
5 properties
RoleImageDetailsResponse_3
object
4 properties
RoleCategory
object
3 properties 1 required
Action
object
1 property 1 required
OrchestrationRule_2
object
10 properties 3 required
AccountRoleListResponse
object
5 properties
ApiPagination
object
4 properties
OpenstackImageCloudFeatures
object
Cloud specifics Image configuration.
2 properties 1 required
RoleDeprecatedOptions
object
2 properties
RoleListResponse_2
object
5 properties
OrchestrationRuleListResponse
object
5 properties
WebhookEndpoint
object
Webhook endpoint summary.
3 properties
RoleImageListResponse
object
5 properties
FarmRolesCondition
object
2 properties 1 required
Action_3
object
1 property 1 required
Action_2
object
1 property 1 required
ChefAction
object
1 property 1 required
GlobalVariable_2
object
11 properties 2 required
ImageCloudFeatures
object
Cloud specifics Image configuration.
1 property 1 required
ApiErrorResponse_2
object
Common response for erroneous requests.
3 properties
RoleForeignKey
object
1 property 1 required
AccountRoleDetailsResponse
object
4 properties
OrchestrationRule_3
object
10 properties 3 required
ScriptVersionIdentity
object
3 properties
EventForeignKey
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
RoleDetailsResponse
object
4 properties
Trigger
object
1 property 1 required
LocalScriptAction
object
2 properties 2 required
Role
object
12 properties 3 required
VmwareImageCloudFeatures
object
Cloud specifics Image configuration.
2 properties 1 required
AccountRole
object
14 properties 3 required
OsForeignKey
object
1 property 1 required
ScalrScriptAction
object
2 properties 2 required
OrchestrationRule
object
10 properties 3 required
GlobalVariableJson
object
11 properties 2 required
Role_3
object
12 properties 3 required
GlobalVariableListResponse
object
5 properties
OrchestrationRuleListResponse_3
object
5 properties
ApiMessage
object
2 properties
GlobalVariableDetailsResponse_2
object
4 properties
RoleDetailsResponse_2
object
4 properties
RoleListResponse
object
5 properties
GlobalVariable
object
11 properties 2 required
ImageDetailsResponse_3
object
4 properties
TagsCondition
object
2 properties 2 required
ScriptVariableList
object
9 properties 3 required
Role_2
object
12 properties 3 required
GlobalVariableListResponse_3
object
5 properties
Environment
object
6 properties 1 required
Os
object
5 properties 5 required
GlobalVariable_3
object
11 properties 2 required
AnsibleTowerConfigurationIdentity
object
2 properties
RoleImage
object
A Representation of a Role Image. Note that the role property is optional when POST-ing to a URL that already includes {roleId}.
2 properties 2 required
ApiErrorResponse
object
Common response for erroneous requests.
3 properties
GlobalVariableDetailsResponse_3
object
4 properties
Image
object
19 properties 5 required
ApiMetaContainer
object
1 property
AwsImageCloudFeatures
object
Cloud specifics Image configuration.
3 properties 1 required
ScriptIdentity
object
2 properties 1 required
RoleImageListResponse_2
object
5 properties
ScriptVariableString
object
10 properties 2 required
VariableAllowedValue
object
2 properties 1 required
RoleImage_2
object
A Representation of a Role Image. Note that the role property is optional when POST-ing to a URL that already includes {roleId}.
2 properties 2 required
GlobalVariableDetailsResponse
object
4 properties
Script
object
13 properties 2 required
RoleCategoryForeignKey
object
1 property 1 required
GlobalVariableListResponse_2
object
5 properties
RoleImage_3
object
A Representation of a Role Image. Note that the role property is optional when POST-ing to a URL that already includes {roleId}.
2 properties 2 required
Event
object
3 properties 1 required
OrchestrationRuleListResponse_2
object
5 properties
Image_2
object
19 properties 5 required
SpecificEventTrigger
object
Triggers when a specific Event fires.
2 properties 2 required
ScriptVariableJson
object
8 properties 2 required
JobTemplateIdentity
object
3 properties
ScriptVariableValue
object
2 properties 1 required
OrchestrationRuleDetailsResponse_3
object
4 properties
WebhookEndpointForeignKey
object
1 property 1 required
OrchestrationRuleDetailsResponse
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

scalr-roles-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 Farms API
AE Profile APIs.io
Scalr Global Variables API
AE Profile APIs.io
#Roles
← Back to S APIs
API Details
ID
scalr:scalr-roles-api
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-roles-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/scalr-roles-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 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.