Scalr Account API

naftiko: 1.0.0-alpha2
info:
  label: Scalr Account API
  description: 'Scalr Account API. 105 operations. Lead operation: Scalr Account API. Self-contained Naftiko capability covering
    one Scalr business surface.'
  tags:
  - Scalr
  - Scalr Account API
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    SCALR_API_KEY: SCALR_API_KEY
capability:
  consumes:
  - type: http
    namespace: account
    baseUri: ''
    description: Scalr Account API business capability. Self-contained, no shared references.
    resources:
    - name: accountId-acl-roles
      path: /{accountId}/acl-roles/
      operations:
      - name: get
        method: GET
        description: List the ACL Roles in this account.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: accountId-ansible-tower-configurations
      path: /{accountId}/ansible-tower/configurations/
      operations:
      - name: get
        method: GET
        description: List all Ansible Tower Configurations in the Account scope.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: post
        method: POST
        description: Add a new Ansible Tower Configuration in the Account scope.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: ansibleTowerConfigurationObject
          in: body
          type: string
          description: The JSON representation of a AnsibleTowerConfiguration object.
          required: true
    - name: accountId-ansible-tower-configurations-ansibleTowerConfigurationId
      path: /{accountId}/ansible-tower/configurations/{ansibleTowerConfigurationId}/
      operations:
      - name: delete
        method: DELETE
        description: Delete the Ansible Tower Configuration.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: get
        method: GET
        description: Retrieve detailed information about a given Ansible Tower Configuration.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: patch
        method: PATCH
        description: Modify the Ansible Tower Configuration.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: ansibleTowerConfigurationObject
          in: body
          type: string
          description: The JSON representation of a AnsibleTowerConfiguration object.
          required: true
    - name: accountId-ansible-tower-servers
      path: /{accountId}/ansible-tower/servers/
      operations:
      - name: get
        method: GET
        description: List all Ansible Tower Servers in the Account scope.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: accountId-cloud-credentials
      path: /{accountId}/cloud-credentials/
      operations:
      - name: get
        method: GET
        description: List all Cloud Credentials available in this Account.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: post
        method: POST
        description: Create new Cloud Credentials at this Account's scope.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: cloudCredentialsObject
          in: body
          type: string
          description: The JSON representation of a CloudCredentials object.
          required: true
    - name: accountId-cloud-credentials-cloudCredentialsId
      path: /{accountId}/cloud-credentials/{cloudCredentialsId}/
      operations:
      - name: delete
        method: DELETE
        description: Delete the specified Cloud Credentials from this Account.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: get
        method: GET
        description: Retrieve detailed information about given Cloud Credentials. You can only obtain information about Cloud
          Credentials defined in this Account's scope.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: patch
        method: PATCH
        description: Modify the attributes of given Cloud Credentials.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: cloudCredentialsObject
          in: body
          type: string
          description: The JSON representation of a CloudCredentials object.
          required: true
    - name: accountId-cost-centers
      path: /{accountId}/cost-centers/
      operations:
      - name: get
        method: GET
        description: List the Cost Centers available in the Account.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: accountId-cost-centers-costCenterId
      path: /{accountId}/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: accountId-environments
      path: /{accountId}/environments/
      operations:
      - name: get
        method: GET
        description: List Environments available in this Account.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: post
        method: POST
        description: Create a new Environment in the Account.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: environmentObject
          in: body
          type: string
          description: The JSON representation of a Environment object.
          required: true
    - name: accountId-environments-envId
      path: /{accountId}/environments/{envId}/
      operations:
      - name: delete
        method: DELETE
        description: Delete an Environment from the Account.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: get
        method: GET
        description: Retrieve detailed information about a given Environment.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: patch
        method: PATCH
        description: Update the attributes of an Environment.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: environmentObject
          in: body
          type: string
          description: The JSON representation of a Environment object.
          required: true
    - name: accountId-environments-envId-clouds
      path: /{accountId}/environments/{envId}/clouds/
      operations:
      - name: get
        method: GET
        description: List the Clouds this environment has access to.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: accountId-environments-envId-clouds-cloud
      path: /{accountId}/environments/{envId}/clouds/{cloud}/
      operations:
      - name: delete
        method: DELETE
        description: Detaches Cloud Credentials from this Environment.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: get
        method: GET
        description: Retrieve detailed information about given Cloud Credentials that this Environment is using.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: post
        method: POST
        description: Associate or replace Cloud Credentials with this Environment for the given Cloud.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: cloudCredentialsForeignKeyObject
          in: body
          type: string
          description: The JSON representation of a CloudCredentialsForeignKey object.
          required: true
    - name: accountId-environments-envId-teams
      path: /{accountId}/environments/{envId}/teams/
      operations:
      - name: get
        method: GET
        description: List the Teams that have access to this Environment.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: post
        method: POST
        description: Grants a Team access to this Environment.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: environmentTeamObject
          in: body
          type: string
          description: The JSON representation of a EnvironmentTeam object.
          required: true
    - name: accountId-environments-envId-teams-teamId
      path: /{accountId}/environments/{envId}/teams/{teamId}/
      operations:
      - name: delete
        method: DELETE
        description: Withhold a Team's access to this Environment.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: patch
        method: PATCH
        description: Update the attributes of an Team access on this Environment.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: environmentTeamObject
          in: body
          type: string
          description: The JSON representation of a EnvironmentTeam object.
          required: true
    - name: accountId-events
      path: /{accountId}/events/
      operations:
      - name: get
        method: GET
        description: List all the Events available in this Account.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: post
        method: POST
        description: Create a new Custom Event in this Account.
        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: replace
          in: query
          type: boolean
          description: Replace all Events declared at a lower scope with the same name with this one.
    - name: accountId-events-eventId
      path: /{accountId}/events/{eventId}/
      operations:
      - name: delete
        method: DELETE
        description: Delete a given Event from this Account.
        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 a given 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: accountId-global-variables
      path: /{accountId}/global-variables/
      operations:
      - name: get
        method: GET
        description: List Global Variables declared in account scope.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: post
        method: POST
        description: Declare a new Global Variable for this account 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: accountId-global-variables-globalVariableName
      path: /{accountId}/global-variables/{globalVariableName}/
      operations:
      - name: delete
        method: DELETE
        description: Delete a Global Variable from account scope.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: get
        method: GET
        description: Retrieve detailed information about a Global Variable declared in account scope.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: patch
        method: PATCH
        description: Modify the attributes of a Global Variable declared in account 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: accountId-images
      path: /{accountId}/images/
      operations:
      - name: get
        method: GET
        description: List all the Images available in this Account.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: post
        method: POST
        description: Register a new Image in this Account.
        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: accountId-images-imageId
      path: /{accountId}/images/{imageId}/
      operations:
      - name: delete
        method: DELETE
        description: Remove an Image from this Account. This does not remove the underlying machine image from the Cloud it
          resides in.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - 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 Image. Currently only the name of the Image can be changed.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: image
          in: body
          type: string
          description: The updated definition.
          required: true
    - name: accountId-images-imageId-actions-copy
      path: /{accountId}/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: Copy Image options.
          required: true
    - name: accountId-images-imageId-actions-replace
      path: /{accountId}/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.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: replaceImageRequest
          in: body
          type: string
          description: Replace image options.
          required: true
    - name: accountId-orchestration-rules
      path: /{accountId}/orchestration-rules/
      operations:
      - name: get
        method: GET
        description: List the Orchestration Rules in this Account.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: post
        method: POST
        description: Create a new Orchestration Rule for this Account.
        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: accountId-orchestration-rules-orchestrationRuleId
      path: /{accountId}/orchestration-rules/{orchestrationRuleId}/
      operations:
      - name: delete
        method: DELETE
        description: Delete an Orchestration Rule from this Account.
        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
    - name: accountId-os
      path: /{accountId}/os/
      operations:
      - name: get
        method: GET
        description: List all the Operating Systems definitions available in this Account.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: accountId-os-osId
      path: /{accountId}/os/{osId}/
      operations:
      - name: get
        method: GET
        description: Retrieve detailed information about a given OS.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: accountId-projects
      path: /{accountId}/projects/
      operations:
      - name: get
        method: GET
        description: List the Projects available in this Account.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: post
        method: POST
        description: Create a new Project in this Account.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: projectObject
          in: body
          type: string
          description: The JSON representation of a Project object.
          required: true
    - name: accountId-projects-projectId
      path: /{accountId}/projects/{projectId}/
      operations:
      - name: delete
        method: DELETE
        description: Delete a Project from this Account.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: get
        method: GET
        description: Retrieve detailed information about a Project.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: patch
        method: PATCH
        description: Modify the attributes of the Project.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: projectObject
          in: body
          type: string
          description: The JSON representation of a Project object.
          required: true
    - name: accountId-role-categories
      path: /{accountId}/role-categories/
      operations:
      - name: get
        method: GET
        description: List the Role Categories available in this Account.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: post
        method: POST
        description: Create a new Role Category in this Account.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: roleCategoryObject
          in: body
          type: string
          description: The JSON representation of a RoleCategory object.
          required: true
    - name: accountId-role-categories-roleCategoryId
      path: /{accountId}/role-categories/{roleCategoryId}/
      operations:
      - name: delete
        method: DELETE
        description: Delete a Role Category from this Account.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: get
        method: GET
        description: Retrieve detailed information about a given Role Category.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: patch
        method: PATCH
        description: Modify the attributes of a given Role Category.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: roleCategoryObject
          in: body
          type: string
          description: The JSON representation of a RoleCategory object.
          required: true
    - name: accountId-roles
      path: /{accountId}/roles/
      operations:
      - name: get
        method: GET
        description: List all the Roles available in this Account.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: post
        method: POST
        description: Create a new Role in this Account.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: accountRoleObject
          in: body
          type: string
          description: The JSON representation of a AccountRole object.
          required: true
    - name: accountId-roles-roleId
      path: /{accountId}/roles/{roleId}/
      operations:
      - name: delete
        method: DELETE
        description: Delete a Role from this Account.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: get
        method: GET
        description: Retrieve detailed information about a given Role.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: patch
        method: PATCH
        description: Modify the attributes of a given Role.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: accountRoleObject
          in: body
          type: string
          description: The JSON representation of a AccountRole object.
          required: true
    - name: accountId-roles-roleId-actions-clone
      path: /{accountId}/roles/{roleId}/actions/clone/
      operations:
      - name: post
        method: POST
        description: Make a copy of an existing Role by cloning it.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: cloneRoleRequest
          in: body
          type: string
          description: Role cloning options.
          required: true
    - name: accountId-roles-roleId-actions-deprecate
      path: /{accountId}/roles/{roleId}/actions/deprecate/
      operations:
      - name: post
        method: POST
        description: Deprecate a Role and set another Role to replace it.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: deprecateRoleRequest
          in: body
          type: string
          description: Deprecate Role options.
    - name: accountId-roles-roleId-global-variables
      path: /{accountId}/roles/{roleId}/global-variables/
      operations:
      - name: get
        method: GET
        description: List all the Global Variables associated with a given Role.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: post
        method: POST
        description: Declare a new Global Variable for this 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: accountId-roles-roleId-global-variables-globalVariableName
      path: /{accountId}/roles/{roleId}/global-variables/{globalVariableName}/
      operations:
      - name: delete
        method: DELETE
        description: Delete a Global Variable from a given Role's scope.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: get
        method: GET
        description: Retrieve detailed information about Global Variable in the Role's scope.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: patch
        method: PATCH
        description: Modify the attributes of a Global Variable in the 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: accountId-roles-roleId-images
      path: /{accountId}/roles/{roleId}/images/
      operations:
      - name: get
        method: GET
        description: List all the Images associated with a given Role.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: post
        method: POST
        description: 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.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: roleImageObject
          in: body
          type: string
          description: The JSON representation of a RoleImage object.
          required: true
    - name: accountId-roles-roleId-images-imageId
      path: /{accountId}/roles/{roleId}/images/{imageId}/
      operations:
      - name: delete
        method: DELETE
        description: Dis-associate an Image from a given Role.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: get
        method: GET
        description: Retrieve detailed information about an Image.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: accountId-roles-roleId-images-imageId-actions-replace
      path: /{accountId}/roles/{roleId}/images/{imageId}/actions/replace/
      operations:
      - name: post
        method: POST
        description: 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.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: roleImageObject
          in: body
          type: string
          description: The JSON representation of a RoleImage object.
          required: true
    - name: accountId-roles-roleId-orchestration-rules
      path: /{accountId}/roles/{roleId}/orchestration-rules/
      operations:
      - name: get
        method: GET
        description: List the Orchestration Rules associated with a given 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 a 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: accountId-roles-roleId-orchestration-rules-orchestrationRuleId
      path: /{accountId}/roles/{roleId}/orchestration-rules/{orchestrationRuleId}/
      operations:
      - name: delete
        method: DELETE
        description: Delete an Orchestration Rule from the Role.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: get
        method: GET
        description: Retrieve detailed information about a given Orchestration Rule associated to this Role.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: patch
        method: PATCH
        description: Modify the attributes of a given 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
    - name: accountId-scaling-metrics
      path: /{accountId}/scaling-metrics/
      operations:
      - name: get
        method: GET
        description: List all Scaling metrics in the Account scope.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: post
        method: POST
        description: Add a new custom Scaling metric in the Account scope.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: scalingMetricObject
          in: body
          type: string
          description: The JSON representation of a ScalingMetric object.
  

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