Scalr Global API

naftiko: 1.0.0-alpha2
info:
  label: Scalr Global API
  description: 'Scalr Global API. 57 operations. Lead operation: Scalr Global API. Self-contained Naftiko capability covering
    one Scalr business surface.'
  tags:
  - Scalr
  - Scalr Global API
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    SCALR_API_KEY: SCALR_API_KEY
capability:
  consumes:
  - type: http
    namespace: global
    baseUri: ''
    description: Scalr Global API business capability. Self-contained, no shared references.
    resources:
    - name: ansible-tower-configurations
      path: /ansible-tower/configurations/
      operations:
      - name: get
        method: GET
        description: List all Ansible Tower Configurations in the global scope.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: post
        method: POST
        description: Add a new Ansible Tower Configuration in the global 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: ansible-tower-configurations-ansibleTowerConfigurationId
      path: /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: ansible-tower-servers
      path: /ansible-tower/servers/
      operations:
      - name: get
        method: GET
        description: List all Ansible Tower Servers in the global scope.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: cloud-credentials
      path: /cloud-credentials/
      operations:
      - name: get
        method: GET
        description: List all Cloud Credentials available in the global scope.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: post
        method: POST
        description: Create new 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: cloud-credentials-cloudCredentialsId
      path: /cloud-credentials/{cloudCredentialsId}/
      operations:
      - name: delete
        method: DELETE
        description: Delete the specified Cloud Credentials from global scope.
        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 the global 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: global-variables
      path: /global-variables/
      operations:
      - name: get
        method: GET
        description: List Global Variables declared in global scope.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: post
        method: POST
        description: Declare a new Global Variable for this global 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: global-variables-globalVariableName
      path: /global-variables/{globalVariableName}/
      operations:
      - name: delete
        method: DELETE
        description: Delete a Global Variable from global scope.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: get
        method: GET
        description: Retrieve detailed information about a Global Variable declared in global scope.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: patch
        method: PATCH
        description: Modify the attributes of a Global Variable declared in global 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: images
      path: /images/
      operations:
      - name: get
        method: GET
        description: List all the Images available in the global scope.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: post
        method: POST
        description: Register a new Image in the global scope.
        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: images-imageId
      path: /images/{imageId}/
      operations:
      - name: delete
        method: DELETE
        description: Deregisters an Image from the global scope.
        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: images-imageId-actions-copy
      path: /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: images-imageId-actions-replace
      path: /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: os
      path: /os/
      operations:
      - name: get
        method: GET
        description: List all the Operating Systems definitions available in the global scope.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: os-osId
      path: /os/{osId}/
      operations:
      - name: get
        method: GET
        description: Retrieve detailed information about a given OS.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: projects
      path: /projects/
      operations:
      - name: get
        method: GET
        description: List the Projects available in the global scope.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: post
        method: POST
        description: Create a new Project in the global scope.
        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: projects-projectId
      path: /projects/{projectId}/
      operations:
      - name: delete
        method: DELETE
        description: Delete a Project from global scope.
        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: role-categories
      path: /role-categories/
      operations:
      - name: get
        method: GET
        description: List the Role Categories available in the global scope.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: post
        method: POST
        description: Create a new Role Category in the global scope.
        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: role-categories-roleCategoryId
      path: /role-categories/{roleCategoryId}/
      operations:
      - name: delete
        method: DELETE
        description: Delete a Role Category from the global scope.
        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: Edit 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: roles
      path: /roles/
      operations:
      - name: get
        method: GET
        description: List all the Roles available in the global scope.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: post
        method: POST
        description: Create a new Role in the global scope.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: roleObject
          in: body
          type: string
          description: The JSON representation of a Role object.
          required: true
    - name: roles-roleId
      path: /roles/{roleId}/
      operations:
      - name: delete
        method: DELETE
        description: Delete a Role from the global scope.
        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: roleObject
          in: body
          type: string
          description: The JSON representation of a Role object.
          required: true
    - name: roles-roleId-actions-deprecate
      path: /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: roles-roleId-global-variables
      path: /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: Declares 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: roles-roleId-global-variables-globalVariableName
      path: /roles/{roleId}/global-variables/{globalVariableName}/
      operations:
      - name: delete
        method: DELETE
        description: Deletes 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 a 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: roles-roleId-images
      path: /roles/{roleId}/images/
      operations:
      - name: get
        method: GET
        description: List all the Images associated with the specified Role.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: post
        method: POST
        description: 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.
        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: roles-roleId-images-imageId
      path: /roles/{roleId}/images/{imageId}/
      operations:
      - name: delete
        method: DELETE
        description: Dis-associates 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: roles-roleId-images-imageId-actions-replace
      path: /roles/{roleId}/images/{imageId}/actions/replace/
      operations:
      - name: post
        method: POST
        description: 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 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: roles-roleId-orchestration-rules
      path: /roles/{roleId}/orchestration-rules/
      operations:
      - name: get
        method: GET
        description: List the Orchestration Rules associated to a Role.
        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: roles-roleId-orchestration-rules-orchestrationRuleId
      path: /roles/{roleId}/orchestration-rules/{orchestrationRuleId}/
      operations:
      - name: delete
        method: DELETE
        description: Deletes the specified Orchestration Rule from the Role.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: get
        method: GET
        description: Retrieve a given Orchestration Rule associated to a Role.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: patch
        method: PATCH
        description: Modify the attributes of the specified 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: users
      path: /users/
      operations:
      - name: get
        method: GET
        description: List all available Users.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
  exposes:
  - type: rest
    namespace: global-rest
    port: 8080
    description: REST adapter for Scalr Global API. One Spectral-compliant resource per consumed operation, prefixed with
      /v1.
    resources:
    - path: /v1/ansible-tower/configurations
      name: ansible-tower-configurations
      description: REST surface for ansible-tower-configurations.
      operations:
      - method: GET
        name: get
        description: List all Ansible Tower Configurations in the global scope.
        call: global.get
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: post
        description: Add a new Ansible Tower Configuration in the global scope.
        call: global.post
        with:
          ansibleTowerConfigurationObject: rest.ansibleTowerConfigurationObject
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/ansible-tower/configurations/{ansibletowerconfigurationid}
      name: ansible-tower-configurations-ansibletowerconfigurationid
      description: REST surface for ansible-tower-configurations-ansibleTowerConfigurationId.
      operations:
      - method: DELETE
        name: delete
        description: Delete the Ansible Tower Configuration.
        call: global.delete
        outputParameters:
        - type: object
          mapping: $.
      - method: GET
        name: get
        description: Retrieve detailed information about a given Ansible Tower Configuration.
        call: global.get
        outputParameters:
        - type: object
          mapping: $.
      - method: PATCH
        name: patch
        description: Modify the Ansible Tower Configuration.
        call: global.patch
        with:
          ansibleTowerConfigurationObject: rest.ansibleTowerConfigurationObject
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/ansible-tower/servers
      name: ansible-tower-servers
      description: REST surface for ansible-tower-servers.
      operations:
      - method: GET
        name: get
        description: List all Ansible Tower Servers in the global scope.
        call: global.get
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/cloud-credentials
      name: cloud-credentials
      description: REST surface for cloud-credentials.
      operations:
      - method: GET
        name: get
        description: List all Cloud Credentials available in the global scope.
        call: global.get
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: post
        description: Create new Cloud Credentials.
        call: global.post
        with:
          cloudCredentialsObject: rest.cloudCredentialsObject
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/cloud-credentials/{cloudcredentialsid}
      name: cloud-credentials-cloudcredentialsid
      description: REST surface for cloud-credentials-cloudCredentialsId.
      operations:
      - method: DELETE
        name: delete
        description: Delete the specified Cloud Credentials from global scope.
        call: global.delete
        outputParameters:
        - type: object
          mapping: $.
      - method: GET
        name: get
        description: Retrieve detailed information about given Cloud Credentials. You can only obtain information about Cloud
          Credentials defined in the global scope.
        call: global.get
        outputParameters:
        - type: object
          mapping: $.
      - method: PATCH
        name: patch
        description: Modify the attributes of given Cloud Credentials.
        call: global.patch
        with:
          cloudCredentialsObject: rest.cloudCredentialsObject
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/global-variables
      name: global-variables
      description: REST surface for global-variables.
      operations:
      - method: GET
        name: get
        description: List Global Variables declared in global scope.
        call: global.get
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: post
        description: Declare a new Global Variable for this global scope.
        call: global.post
        with:
          globalVariableObject: rest.globalVariableObject
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/global-variables/{globalvariablename}
      name: global-variables-globalvariablename
      description: REST surface for global-variables-globalVariableName.
      operations:
      - method: DELETE
        name: delete
        description: Delete a Global Variable from global scope.
        call: global.delete
        outputParameters:
        - type: object
          mapping: $.
      - method: GET
        name: get
        description: Retrieve detailed information about a Global Variable declared in global scope.
        call: global.get
        outputParameters:
        - type: object
          mapping: $.
      - method: PATCH
        name: patch
        description: Modify the attributes of a Global Variable declared in global scope.
        call: global.patch
        with:
          globalVariableObject: rest.globalVariableObject
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/images
      name: images
      description: REST surface for images.
      operations:
      - method: GET
        name: get
        description: List all the Images available in the global scope.
        call: global.get
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: post
        description: Register a new Image in the global scope.
        call: global.post
        with:
          imageObject: rest.imageObject
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/images/{imageid}
      name: images-imageid
      description: REST surface for images-imageId.
      operations:
      - method: DELETE
        name: delete
        description: Deregisters an Image from the global scope.
        call: global.delete
        outputParameters:
        - type: object
          mapping: $.
      - method: GET
        name: get
        description: Retrieve detailed information about an Image.
        call: global.get
        outputParameters:
        - type: object
          mapping: $.
      - method: PATCH
        name: patch
        description: Modify the attributes of an Image. Currently only the name of the Image can be changed.
        call: global.patch
        with:
          image: rest.image
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/images/{imageid}/actions/copy
      name: images-imageid-actions-copy
      description: REST surface for images-imageId-actions-copy.
      operations:
      - method: POST
        name: post
        description: Copy an Image from one EC2 region to another.
        call: global.post
        with:
          copyImageRequest: rest.copyImageRequest
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/images/{imageid}/actions/replace
      name: images-imageid-actions-replace
      description: REST surface for images-imageId-actions-replace.
      operations:
      - method: POST
        name: post
        description: Replace the current Image with a specified one for all Roles which use this Image.
        call: global.post
        with:
          replaceImageRequest: rest.replaceImageRequest
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/os
      name: os
      description: REST surface for os.
      operations:
      - method: GET
        name: get
        description: List all the Operating Systems definitions available in the global scope.
        call: global.get
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/os/{osid}
      name: os-osid
      description: REST surface for os-osId.
      operations:
      - method: GET
        name: get
        description: Retrieve detailed information about a given OS.
        call: global.get
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/projects
      name: projects
      description: REST surface for projects.
      operations:
      - method: GET
        name: get
        description: List the Projects available in the global scope.
        call: global.get
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: post
        description: Create a new Project in the global scope.
        call: global.post
        with:
          projectObject: rest.projectObject
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/projects/{projectid}
      name: projects-projectid
      description: REST surface for projects-projectId.
      operations:
      - method: DELETE
        name: delete
        description: Delete a Project from global scope.
        call: global.delete
        outputParameters:
        - type: object
          mapping: $.
      - method: GET
        name: get
        description: Retrieve detailed information about a Project.
        call: global.get
        outputParameters:
        - type: object
          mapping: $.
      - method: PATCH
        name: patch
        description: Modify the attributes of the Project.
        call: global.patch
        with:
          projectObject: rest.projectObject
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/role-categories
      name: role-categories
      description: REST surface for role-categories.
      operations:
      - method: GET
        name: get
        description: List the Role Categories available in the global scope.
        call: global.get
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: post
        description: Create a new Role Category in the global scope.
        call: global.post
        with:
          roleCategoryObject: rest.roleCategoryObject
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/role-categories/{rolecategoryid}
      name: role-categories-rolecategoryid
      description: REST surface for role-categories-roleCategoryId.
      operations:
      - method: DELETE
        name: delete
        description: Delete a Role Category from the global scope.
        call: global.delete
        outputParameters:
        - type: object
          mapping: $.
      - method: GET
        name: get
        description: Retrieve detailed information about a given Role Category.
        call: global.get
        outputParameters:
        - type: object
          mapping: $.
      - method: PATCH
        name: patch
        description: Edit the attributes of a given Role Category.
        call: global.patch
        with:
          roleCategoryObject: rest.roleCategoryObject
        outputParameters:
        - type: object
          mapping: $.
    - path:

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