Scalr

Scalr Roles API

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

GitHub OpenAPI

Operations 66

GET /{accountId}/roles/
POST /{accountId}/roles/
DELETE /{accountId}/roles/{roleId}/
GET /{accountId}/roles/{roleId}/
PATCH /{accountId}/roles/{roleId}/
POST /{accountId}/roles/{roleId}/actions/clone/
POST /{accountId}/roles/{roleId}/actions/deprecate/
GET /{accountId}/roles/{roleId}/global-variables/
POST /{accountId}/roles/{roleId}/global-variables/
DELETE /{accountId}/roles/{roleId}/global-variables/{globalVariableName}/
GET /{accountId}/roles/{roleId}/global-variables/{globalVariableName}/
PATCH /{accountId}/roles/{roleId}/global-variables/{globalVariableName}/
GET /{accountId}/roles/{roleId}/images/
POST /{accountId}/roles/{roleId}/images/
DELETE /{accountId}/roles/{roleId}/images/{imageId}/
GET /{accountId}/roles/{roleId}/images/{imageId}/
POST /{accountId}/roles/{roleId}/images/{imageId}/actions/replace/
GET /{accountId}/roles/{roleId}/orchestration-rules/
POST /{accountId}/roles/{roleId}/orchestration-rules/
DELETE /{accountId}/roles/{roleId}/orchestration-rules/{orchestrationRuleId}/
GET /{accountId}/roles/{roleId}/orchestration-rules/{orchestrationRuleId}/
PATCH /{accountId}/roles/{roleId}/orchestration-rules/{orchestrationRuleId}/
GET /roles/
POST /roles/
DELETE /roles/{roleId}/
GET /roles/{roleId}/
PATCH /roles/{roleId}/
POST /roles/{roleId}/actions/deprecate/
GET /roles/{roleId}/global-variables/
POST /roles/{roleId}/global-variables/
DELETE /roles/{roleId}/global-variables/{globalVariableName}/
GET /roles/{roleId}/global-variables/{globalVariableName}/
PATCH /roles/{roleId}/global-variables/{globalVariableName}/
GET /roles/{roleId}/images/
POST /roles/{roleId}/images/
DELETE /roles/{roleId}/images/{imageId}/
GET /roles/{roleId}/images/{imageId}/
POST /roles/{roleId}/images/{imageId}/actions/replace/
GET /roles/{roleId}/orchestration-rules/
POST /roles/{roleId}/orchestration-rules/
DELETE /roles/{roleId}/orchestration-rules/{orchestrationRuleId}/
GET /roles/{roleId}/orchestration-rules/{orchestrationRuleId}/
PATCH /roles/{roleId}/orchestration-rules/{orchestrationRuleId}/
GET /{envId}/roles/
POST /{envId}/roles/
DELETE /{envId}/roles/{roleId}/
GET /{envId}/roles/{roleId}/
PATCH /{envId}/roles/{roleId}/
POST /{envId}/roles/{roleId}/actions/clone/
POST /{envId}/roles/{roleId}/actions/deprecate/
POST /{envId}/roles/{roleId}/actions/promote/
GET /{envId}/roles/{roleId}/global-variables/
POST /{envId}/roles/{roleId}/global-variables/
DELETE /{envId}/roles/{roleId}/global-variables/{globalVariableName}/
GET /{envId}/roles/{roleId}/global-variables/{globalVariableName}/
PATCH /{envId}/roles/{roleId}/global-variables/{globalVariableName}/
GET /{envId}/roles/{roleId}/images/
POST /{envId}/roles/{roleId}/images/
DELETE /{envId}/roles/{roleId}/images/{imageId}/
GET /{envId}/roles/{roleId}/images/{imageId}/
POST /{envId}/roles/{roleId}/images/{imageId}/actions/replace/
GET /{envId}/roles/{roleId}/orchestration-rules/
POST /{envId}/roles/{roleId}/orchestration-rules/
DELETE /{envId}/roles/{roleId}/orchestration-rules/{orchestrationRuleId}/
GET /{envId}/roles/{roleId}/orchestration-rules/{orchestrationRuleId}/
PATCH /{envId}/roles/{roleId}/orchestration-rules/{orchestrationRuleId}/

Documentation

📖
Documentation
https://api-explorer.scalr.com/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/scalr/refs/heads/main/openapi/scalr-roles-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/scalr-roles-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

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

OpenAPI Specification

scalr-roles-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  description: Manage Roles, Images, Environments and etc.
  title: Scalr Account Acl Roles API
  version: 1.0.0
servers:
- url: /api/v1beta0/account
tags:
- name: Roles
paths:
  /{accountId}/roles/:
    parameters:
    - description: The ID of the Account scoping this request.
      in: path
      name: accountId
      required: true
      schema:
        type: integer
    get:
      description: List all the Roles available in this Account.
      responses:
        200:
          description: A list of AccountRole objects.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountRoleListResponse'
        400:
          description: A client-side error was made.
          x-errorCodes:
          - description: The request was structurally incorrect, and was not understood by the API.
            name: InvalidStructure
          - description: The request was understood by the API, but included invalid data.
            name: InvalidValue
          - description: The request wasn't understood by the API.
            name: BadRequest
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        401:
          description: The request was not authenticated.
          x-errorCodes:
          - description: The request was not properly authenticated.
            name: BadAuthentication
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        403:
          description: Insufficient permissions.
          x-errorCodes:
          - description: This request should be made in a different Scope.
            name: ScopeViolation
          - description: You do not have the necessary permissions to perform this request.
            name: PermissionViolation
          - description: The maximum memory limit in GB has been reached.
            name: MemoryQuotaExceeded
          - description: The vCPUs limit has been reached.
            name: VcpusQuotaExceeded
          - description: The maximum number of the Servers that you can launch or resume has been reached.
            name: ServersQuotaExceeded
          - description: The maximum number of the Servers that you can launch or resume on current Farm has been reached.
            name: ServersPerFarmQuotaExceeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        404:
          description: Resource not found.
          x-errorCodes:
          - description: This endpoint does not exist.
            name: EndpointNotFound
            noDoc: true
          - description: The object you are trying to access does not exist.
            name: ObjectNotFound
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        409:
          description: Conflict with current state.
          x-errorCodes:
          - description: These changes aren't possible while this object is in use.
            name: ObjectInUse
          - description: These changes would violate a policy.
            name: PolicyViolation
          - description: These changes would violate a unicity constraint.
            name: UnicityViolation
          - description: Some of the objects being changed are locked and cannot be changed.
            name: Locked
          - description: This Cloud platform is not enabled.
            name: NotEnabledPlatform
          - description: The Operating System does not match.
            name: OperatingSystemMismatch
          - description: Some of these settings cannot be applied, they either conflict with the current state or are invalid.
            name: UnacceptableObjectConfiguration
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        422:
          description: This request was well-formed but was rejected due to semantic errors.
          x-errorCodes:
          - description: Some of the configuration settings cannot be applied because they conflict with the current state.
            name: ConfigurationMismatch
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        500:
          description: A server-side error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        501:
          description: This feature is not implemented in Scalr.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        503:
          description: The service is currently unavailable.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
      tags:
      - Roles
    post:
      description: Create a new Role in this Account.
      responses:
        201:
          description: The JSON representation of a AccountRole object.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountRoleDetailsResponse'
        400:
          description: A client-side error was made.
          x-errorCodes:
          - description: The request was structurally incorrect, and was not understood by the API.
            name: InvalidStructure
          - description: The request was understood by the API, but included invalid data.
            name: InvalidValue
          - description: The request wasn't understood by the API.
            name: BadRequest
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        401:
          description: The request was not authenticated.
          x-errorCodes:
          - description: The request was not properly authenticated.
            name: BadAuthentication
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        403:
          description: Insufficient permissions.
          x-errorCodes:
          - description: This request should be made in a different Scope.
            name: ScopeViolation
          - description: You do not have the necessary permissions to perform this request.
            name: PermissionViolation
          - description: The maximum memory limit in GB has been reached.
            name: MemoryQuotaExceeded
          - description: The vCPUs limit has been reached.
            name: VcpusQuotaExceeded
          - description: The maximum number of the Servers that you can launch or resume has been reached.
            name: ServersQuotaExceeded
          - description: The maximum number of the Servers that you can launch or resume on current Farm has been reached.
            name: ServersPerFarmQuotaExceeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        404:
          description: Resource not found.
          x-errorCodes:
          - description: This endpoint does not exist.
            name: EndpointNotFound
            noDoc: true
          - description: The object you are trying to access does not exist.
            name: ObjectNotFound
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        409:
          description: Conflict with current state.
          x-errorCodes:
          - description: These changes aren't possible while this object is in use.
            name: ObjectInUse
          - description: These changes would violate a policy.
            name: PolicyViolation
          - description: These changes would violate a unicity constraint.
            name: UnicityViolation
          - description: Some of the objects being changed are locked and cannot be changed.
            name: Locked
          - description: This Cloud platform is not enabled.
            name: NotEnabledPlatform
          - description: The Operating System does not match.
            name: OperatingSystemMismatch
          - description: Some of these settings cannot be applied, they either conflict with the current state or are invalid.
            name: UnacceptableObjectConfiguration
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        422:
          description: This request was well-formed but was rejected due to semantic errors.
          x-errorCodes:
          - description: Some of the configuration settings cannot be applied because they conflict with the current state.
            name: ConfigurationMismatch
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        500:
          description: A server-side error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        501:
          description: This feature is not implemented in Scalr.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        503:
          description: The service is currently unavailable.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
      tags:
      - Roles
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AccountRole'
        description: The JSON representation of a AccountRole object.
        required: true
  /{accountId}/roles/{roleId}/:
    parameters:
    - description: The ID of the Account scoping this request.
      in: path
      name: accountId
      required: true
      schema:
        type: integer
    - description: The ID of a Role object.
      in: path
      name: roleId
      required: true
      x-references:
        $ref: '#/components/schemas/Role'
      schema:
        type: integer
    delete:
      description: Delete a Role from this Account.
      responses:
        204:
          description: Successful deletion.
        400:
          description: A client-side error was made.
          x-errorCodes:
          - description: The request was structurally incorrect, and was not understood by the API.
            name: InvalidStructure
          - description: The request was understood by the API, but included invalid data.
            name: InvalidValue
          - description: The request wasn't understood by the API.
            name: BadRequest
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        401:
          description: The request was not authenticated.
          x-errorCodes:
          - description: The request was not properly authenticated.
            name: BadAuthentication
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        403:
          description: Insufficient permissions.
          x-errorCodes:
          - description: This request should be made in a different Scope.
            name: ScopeViolation
          - description: You do not have the necessary permissions to perform this request.
            name: PermissionViolation
          - description: The maximum memory limit in GB has been reached.
            name: MemoryQuotaExceeded
          - description: The vCPUs limit has been reached.
            name: VcpusQuotaExceeded
          - description: The maximum number of the Servers that you can launch or resume has been reached.
            name: ServersQuotaExceeded
          - description: The maximum number of the Servers that you can launch or resume on current Farm has been reached.
            name: ServersPerFarmQuotaExceeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        404:
          description: Resource not found.
          x-errorCodes:
          - description: This endpoint does not exist.
            name: EndpointNotFound
            noDoc: true
          - description: The object you are trying to access does not exist.
            name: ObjectNotFound
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        409:
          description: Conflict with current state.
          x-errorCodes:
          - description: These changes aren't possible while this object is in use.
            name: ObjectInUse
          - description: These changes would violate a policy.
            name: PolicyViolation
          - description: These changes would violate a unicity constraint.
            name: UnicityViolation
          - description: Some of the objects being changed are locked and cannot be changed.
            name: Locked
          - description: This Cloud platform is not enabled.
            name: NotEnabledPlatform
          - description: The Operating System does not match.
            name: OperatingSystemMismatch
          - description: Some of these settings cannot be applied, they either conflict with the current state or are invalid.
            name: UnacceptableObjectConfiguration
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        422:
          description: This request was well-formed but was rejected due to semantic errors.
          x-errorCodes:
          - description: Some of the configuration settings cannot be applied because they conflict with the current state.
            name: ConfigurationMismatch
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        500:
          description: A server-side error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        501:
          description: This feature is not implemented in Scalr.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        503:
          description: The service is currently unavailable.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
      tags:
      - Roles
    get:
      description: Retrieve detailed information about a given Role.
      responses:
        200:
          description: The JSON representation of a AccountRole object.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountRoleDetailsResponse'
        400:
          description: A client-side error was made.
          x-errorCodes:
          - description: The request was structurally incorrect, and was not understood by the API.
            name: InvalidStructure
          - description: The request was understood by the API, but included invalid data.
            name: InvalidValue
          - description: The request wasn't understood by the API.
            name: BadRequest
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        401:
          description: The request was not authenticated.
          x-errorCodes:
          - description: The request was not properly authenticated.
            name: BadAuthentication
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        403:
          description: Insufficient permissions.
          x-errorCodes:
          - description: This request should be made in a different Scope.
            name: ScopeViolation
          - description: You do not have the necessary permissions to perform this request.
            name: PermissionViolation
          - description: The maximum memory limit in GB has been reached.
            name: MemoryQuotaExceeded
          - description: The vCPUs limit has been reached.
            name: VcpusQuotaExceeded
          - description: The maximum number of the Servers that you can launch or resume has been reached.
            name: ServersQuotaExceeded
          - description: The maximum number of the Servers that you can launch or resume on current Farm has been reached.
            name: ServersPerFarmQuotaExceeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        404:
          description: Resource not found.
          x-errorCodes:
          - description: This endpoint does not exist.
            name: EndpointNotFound
            noDoc: true
          - description: The object you are trying to access does not exist.
            name: ObjectNotFound
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        409:
          description: Conflict with current state.
          x-errorCodes:
          - description: These changes aren't possible while this object is in use.
            name: ObjectInUse
          - description: These changes would violate a policy.
            name: PolicyViolation
          - description: These changes would violate a unicity constraint.
            name: UnicityViolation
          - description: Some of the objects being changed are locked and cannot be changed.
            name: Locked
          - description: This Cloud platform is not enabled.
            name: NotEnabledPlatform
          - description: The Operating System does not match.
            name: OperatingSystemMismatch
          - description: Some of these settings cannot be applied, they either conflict with the current state or are invalid.
            name: UnacceptableObjectConfiguration
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        422:
          description: This request was well-formed but was rejected due to semantic errors.
          x-errorCodes:
          - description: Some of the configuration settings cannot be applied because they conflict with the current state.
            name: ConfigurationMismatch
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        500:
          description: A server-side error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        501:
          description: This feature is not implemented in Scalr.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        503:
          description: The service is currently unavailable.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
      tags:
      - Roles
    patch:
      description: Modify the attributes of a given Role.
      responses:
        200:
          description: The JSON representation of a AccountRole object.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountRoleDetailsResponse'
        400:
          description: A client-side error was made.
          x-errorCodes:
          - description: The request was structurally incorrect, and was not understood by the API.
            name: InvalidStructure
          - description: The request was understood by the API, but included invalid data.
            name: InvalidValue
          - description: The request wasn't understood by the API.
            name: BadRequest
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        401:
          description: The request was not authenticated.
          x-errorCodes:
          - description: The request was not properly authenticated.
            name: BadAuthentication
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        403:
          description: Insufficient permissions.
          x-errorCodes:
          - description: This request should be made in a different Scope.
            name: ScopeViolation
          - description: You do not have the necessary permissions to perform this request.
            name: PermissionViolation
          - description: The maximum memory limit in GB has been reached.
            name: MemoryQuotaExceeded
          - description: The vCPUs limit has been reached.
            name: VcpusQuotaExceeded
          - description: The maximum number of the Servers that you can launch or resume has been reached.
            name: ServersQuotaExceeded
          - description: The maximum number of the Servers that you can launch or resume on current Farm has been reached.
            name: ServersPerFarmQuotaExceeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        404:
          description: Resource not found.
          x-errorCodes:
          - description: This endpoint does not exist.
            name: EndpointNotFound
            noDoc: true
          - description: The object you are trying to access does not exist.
            name: ObjectNotFound
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        409:
          description: Conflict with current state.
          x-errorCodes:
          - description: These changes aren't possible while this object is in use.
            name: ObjectInUse
          - description: These changes would violate a policy.
            name: PolicyViolation
          - description: These changes would violate a unicity constraint.
            name: UnicityViolation
          - description: Some of the objects being changed are locked and cannot be changed.
            name: Locked
          - description: This Cloud platform is not enabled.
            name: NotEnabledPlatform
          - description: The Operating System does not match.
            name: OperatingSystemMismatch
          - description: Some of these settings cannot be applied, they either conflict with the current state or are invalid.
            name: UnacceptableObjectConfiguration
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        422:
          description: This request was well-formed but was rejected due to semantic errors.
          x-errorCodes:
          - description: Some of the configuration settings cannot be applied because they conflict with the current state.
            name: ConfigurationMismatch
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        500:
          description: A server-side error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        501:
          description: This feature is not implemented in Scalr.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        503:
          description: The service is currently unavailable.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
      tags:
      - Roles
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AccountRole'
        description: The JSON representation of a AccountRole object.
        required: true
  /{accountId}/roles/{roleId}/actions/clone/:
    parameters:
    - description: The ID of the Account scoping this request.
      in: path
      name: accountId
      required: true
      schema:
        type: integer
    - description: The ID of a Role object.
      in: path
      name: roleId
      required: true
      x-references:
        $ref: '#/components/schemas/Role'
      schema:
        type: integer
    post:
      description: Make a copy of an existing Role by cloning it.
      responses:
        201:
          description: The JSON representation of a AccountRole object.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountRoleDetailsResponse'
        400:
          description: A client-side error was made.
          x-errorCodes:
          - description: The request was structurally incorrect, and was not understood by the API.
            name: InvalidStructure
          - description: The request was understood by the API, but included invalid data.
            name: InvalidValue
          - description: The request wasn't understood by the API.
            name: BadRequest
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        401:
          description: The request was not authenticated.
          x-errorCodes:
          - description: The request was not properly authenticated.
            name: BadAuthentication
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        403:
          description: Insufficient permissions.
          x-errorCodes:
          - description: This request should be made in a different Scope.
            name: ScopeViolation
          - description: You do not have the necessary permissions to perform this request.
            name: PermissionViolation
          - description: The maximum memory limit in GB has been reached.
            name: MemoryQuotaExceeded
          - description: The vCPUs limit has been reached.
            name: VcpusQuotaExceeded
          - description: The maximum number of the Servers that you can launch or resume has been reached.
            name: ServersQuotaExceeded
          - description: The maximum number of the Servers that you can launch or resume on current Farm has been reached.
            name: ServersPerFarmQuotaExceeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        404:
          description: Resource not found.
          x-errorCodes:
          - description: This endpoint does not exist.
            name: EndpointNotFound
            noDoc: true
          - description: The object you are trying to access does not exist.
            name: ObjectNotFound
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        409:
          description: Conflict with current state.
          x-errorCodes:
          - description: These changes aren't possible while this object is in use.
            name: ObjectInUse
          - description: These changes would violate a policy.
            name: PolicyViolation
          - description: These changes would violate a unicity constraint.
            name: UnicityViolation
          - description: Some of the objects being changed are locked and cannot be changed.
            name: Locked
          - description: This Cloud platform is not enabled.
            name: NotEnabledPlatform
          - description: The Operating System does not match.
            name: OperatingSystemMismatch
          - description: Some of these settings cannot be applied, they either conflict with the current state or are invalid.
            name: UnacceptableObjectConfiguration
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        422:
          description: This request was well-formed but was rejected due to semantic errors.
          x-errorCodes:
          - description: Some of the configuration settings cannot be applied because they conflict with the current state.
            name: ConfigurationMismatch
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        500:
          description: A server-side error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        501:
          description: This feature is not implemented in Scalr.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        503:
          description: The service is currently unavailable.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
      tags:
      - Roles
      requestBody:
        content:
          application/json:
            schema:
              properties:
                name:
                  description: The name of the new Role.
                  type: string
              required:
              - name
        description: Role cloning options.
        required: true
  /{accountId}/roles/{roleId}/actions/deprecate/:
    parameters:
    - description: The ID of the Account scoping this request.
      in: path
      name: accountId
      required: true
      schema:
        type: integer
    - description: The ID of a Role object.
      in: path
      name: roleId
      required: true
      x-references:
        $ref: '#/components/schemas/Role'
      schema:
        type: integer
    post:
      description: Deprecate a Role and set another Role to replace it.
      responses:
        200:
          description: The JSON representation of a AccountRole object.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountRoleDetailsResponse'
        400:
          description: A client-side error was made.
          x-errorCodes:
          - description: The request was structurally incorrect, and was not understood by the API.
            name: InvalidStructure
          - description: The request was understood by the API, but included invalid data.
            name: InvalidValue
          - description: The request wasn't understood by the API.
            name: BadRequest
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        401:
          description: The request was not authenticated.
          x-errorCodes:
          - description: The request was not properly authenticated.
            name: BadAuthentication
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        403:
          description: Insufficient permissions.
          x-errorCodes:
          - description: This request should be made in a different Scope.
            name: ScopeViolation
          - description: You do not have the necessary permissions to perform this request.
            name: PermissionViolation
          - description: The maximum memory limit in GB has been reached.
            name: MemoryQuotaExceeded
          - description: The vCPUs limit has been reached.
            name: VcpusQuotaExceeded
          - description: The maximum number of the Servers that you can launch or resume has been reached.
            name: ServersQuotaExceeded
          - description: The maximum number of the Servers that you can launch or resume on current Farm has

# --- truncated at 32 KB (446 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/scalr/refs/heads/main/openapi/scalr-roles-api-openapi.yml