Armory

Armory Cluster Controller API

The cluster-controller API from Armory — 8 operation(s) for cluster-controller.

GitHub OpenAPI

Operations 8

GET /applications/{application}/clusters listByAccount #
GET /applications/{application}/clusters/{account} getForAccount #
GET /applications/{application}/clusters/{account}/{clusterName}/{cloudProvider}/{scope}/serverGroups/target/{target} getTargetServerGroup #
GET /applications/{application}/clusters/{account}/{clusterName}/{cloudProvider}/{scope}/serverGroups/target/{target}/{summaryType} getServerGroupSummary #
GET /applications/{application}/clusters/{account}/{clusterName}/{type}/serverGroups getServerGroups #
GET /applications/{application}/clusters/{account}/{clusterName}/{type}/serverGroups/{serverGroupName} getServerGroup #
GET /applications/{application}/clusters/{account}/{name} getForAccountAndName #
GET /applications/{application}/clusters/{account}/{name}/{type} getForAccountAndNameAndType #

Documentation

📖
Documentation
https://docs.armory.io/plugins/scale-agent/
📖
APIReference
https://docs.armory.io/plugins/scale-agent/reference/
📖
GettingStarted
https://docs.armory.io/plugins/scale-agent/install/quickstart/
📖
Authentication
https://artifacts.apis.io/armory/authentication/armory-authentication.yml

Specifications

⚙
OpenAPI
https://artifacts.apis.io/armory/openapi/armory-cluster-controller-api-openapi.yml

SDKs

📦
GitHubRepository
https://github.com/armory/docs

Other Resources

🔗
Swagger
https://docs.armory.io/reference/scale-agent/swagger.json
🔗
Conventions
https://artifacts.apis.io/armory/conventions/armory-conventions.yml
🔗
ErrorCatalog
https://artifacts.apis.io/armory/errors/armory-problem-types.yml
🔗
DataModel
https://artifacts.apis.io/armory/data-model/armory-data-model.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/armory:armory-cluster-controller-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

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

armory-cluster-controller-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  description: Cloud read and write operations
  title: clouddriver Cluster Controller API
  contact:
    name: admin@host.net
servers:
- url: https://localhost:7002/
tags:
- name: cluster-controller
paths:
  /applications/{application}/clusters:
    get:
      tags:
      - cluster-controller
      summary: listByAccount
      operationId: listByAccountUsingGET
      parameters:
      - name: application
        in: path
        description: application
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
                additionalProperties:
                  type: array
                  items:
                    type: string
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
      deprecated: false
  /applications/{application}/clusters/{account}:
    get:
      tags:
      - cluster-controller
      summary: getForAccount
      operationId: getForAccountUsingGET
      parameters:
      - name: account
        in: path
        description: account
        required: true
        schema:
          type: string
      - name: application
        in: path
        description: application
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ClusterViewModel'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
      deprecated: false
  /applications/{application}/clusters/{account}/{clusterName}/{cloudProvider}/{scope}/serverGroups/target/{target}:
    get:
      tags:
      - cluster-controller
      summary: getTargetServerGroup
      operationId: getTargetServerGroupUsingGET
      parameters:
      - name: account
        in: path
        description: account
        required: true
        schema:
          type: string
      - name: application
        in: path
        description: application
        required: true
        schema:
          type: string
      - name: cloudProvider
        in: path
        description: cloudProvider
        required: true
        schema:
          type: string
      - name: clusterName
        in: path
        description: clusterName
        required: true
        schema:
          type: string
      - name: onlyEnabled
        in: query
        description: onlyEnabled
        required: false
        schema:
          type: string
          default: 'false'
      - name: scope
        in: path
        description: scope
        required: true
        schema:
          type: string
      - name: target
        in: path
        description: target
        required: true
        schema:
          type: string
      - name: validateOldest
        in: query
        description: validateOldest
        required: false
        schema:
          type: string
          default: 'true'
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ServerGroup'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
      deprecated: false
  ? /applications/{application}/clusters/{account}/{clusterName}/{cloudProvider}/{scope}/serverGroups/target/{target}/{summaryType}
  : get:
      tags:
      - cluster-controller
      summary: getServerGroupSummary
      operationId: getServerGroupSummaryUsingGET
      parameters:
      - name: account
        in: path
        description: account
        required: true
        schema:
          type: string
      - name: application
        in: path
        description: application
        required: true
        schema:
          type: string
      - name: cloudProvider
        in: path
        description: cloudProvider
        required: true
        schema:
          type: string
      - name: clusterName
        in: path
        description: clusterName
        required: true
        schema:
          type: string
      - name: onlyEnabled
        in: query
        description: onlyEnabled
        required: false
        schema:
          type: string
          default: 'false'
      - name: scope
        in: path
        description: scope
        required: true
        schema:
          type: string
      - name: summaryType
        in: path
        description: summaryType
        required: true
        schema:
          type: string
      - name: target
        in: path
        description: target
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/Summary'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
      deprecated: false
  /applications/{application}/clusters/{account}/{clusterName}/{type}/serverGroups:
    get:
      tags:
      - cluster-controller
      summary: getServerGroups
      operationId: getServerGroupsUsingGET
      parameters:
      - name: account
        in: path
        description: account
        required: true
        schema:
          type: string
      - name: application
        in: path
        description: application
        required: true
        schema:
          type: string
      - name: clusterName
        in: path
        description: clusterName
        required: true
        schema:
          type: string
      - name: expand
        in: query
        description: expand
        required: false
        schema:
          type: boolean
          default: true
      - name: region
        in: query
        description: region
        required: false
        schema:
          type: string
      - name: type
        in: path
        description: type
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ServerGroup'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
      deprecated: false
  /applications/{application}/clusters/{account}/{clusterName}/{type}/serverGroups/{serverGroupName}:
    get:
      tags:
      - cluster-controller
      summary: getServerGroup
      operationId: getServerGroupUsingGET
      parameters:
      - name: account
        in: path
        description: account
        required: true
        schema:
          type: string
      - name: application
        in: path
        description: application
        required: true
        schema:
          type: string
      - name: clusterName
        in: path
        description: clusterName
        required: true
        schema:
          type: string
      - name: region
        in: query
        description: region
        required: false
        schema:
          type: string
      - name: serverGroupName
        in: path
        description: serverGroupName
        required: true
        schema:
          type: string
      - name: type
        in: path
        description: type
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
      deprecated: false
  /applications/{application}/clusters/{account}/{name}:
    get:
      tags:
      - cluster-controller
      summary: getForAccountAndName
      operationId: getForAccountAndNameUsingGET
      parameters:
      - name: account
        in: path
        description: account
        required: true
        schema:
          type: string
      - name: application
        in: path
        description: application
        required: true
        schema:
          type: string
      - name: expand
        in: query
        description: expand
        required: false
        schema:
          type: boolean
          default: true
      - name: name
        in: path
        description: name
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Cluster'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
      deprecated: false
  /applications/{application}/clusters/{account}/{name}/{type}:
    get:
      tags:
      - cluster-controller
      summary: getForAccountAndNameAndType
      operationId: getForAccountAndNameAndTypeUsingGET
      parameters:
      - name: account
        in: path
        description: account
        required: true
        schema:
          type: string
      - name: application
        in: path
        description: application
        required: true
        schema:
          type: string
      - name: expand
        in: query
        description: expand
        required: false
        schema:
          type: boolean
          default: true
      - name: name
        in: path
        description: name
        required: true
        schema:
          type: string
      - name: type
        in: path
        description: type
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/Cluster'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
      deprecated: false
components:
  schemas:
    ServerGroup:
      type: object
      properties:
        capacity:
          $ref: '#/components/schemas/Capacity'
        cloudProvider:
          type: string
        createdTime:
          type: integer
          format: int64
        disabled:
          type: boolean
        instanceCounts:
          $ref: '#/components/schemas/InstanceCounts'
        instanceType:
          type: string
        instances:
          type: array
          items:
            $ref: '#/components/schemas/Instance'
        labels:
          type: object
          additionalProperties:
            type: string
        launchConfig:
          type: object
        loadBalancers:
          type: array
          items:
            type: string
        moniker:
          $ref: '#/components/schemas/Moniker'
        name:
          type: string
        region:
          type: string
        securityGroups:
          type: array
          items:
            type: string
        serverGroupManagers:
          type: array
          items:
            $ref: '#/components/schemas/ServerGroupManagerSummary'
        tags:
          type: object
        type:
          type: string
        zones:
          type: array
          items:
            type: string
      title: ServerGroup
    ClusterViewModel:
      type: object
      properties:
        account:
          type: string
        loadBalancers:
          type: array
          items:
            type: string
        moniker:
          $ref: '#/components/schemas/Moniker'
        name:
          type: string
        serverGroups:
          type: array
          items:
            type: string
      title: ClusterViewModel
    InstanceCounts:
      type: object
      properties:
        down:
          type: integer
          format: int32
        outOfService:
          type: integer
          format: int32
        starting:
          type: integer
          format: int32
        total:
          type: integer
          format: int32
        unknown:
          type: integer
          format: int32
        up:
          type: integer
          format: int32
      title: InstanceCounts
    Instance:
      type: object
      properties:
        cloudProvider:
          type: string
        health:
          type: array
          items:
            $ref: '#/components/schemas/Map_string_object'
        healthState:
          type: string
          enum:
          - Failed
          - Down
          - OutOfService
          - Unknown
          - Starting
          - Succeeded
          - Up
          - Draining
        humanReadableName:
          type: string
        labels:
          type: object
          additionalProperties:
            type: string
        launchTime:
          type: integer
          format: int64
        name:
          type: string
        providerType:
          type: string
        zone:
          type: string
      title: Instance
    Capacity:
      type: object
      properties:
        desired:
          type: integer
          format: int32
        max:
          type: integer
          format: int32
        min:
          type: integer
          format: int32
        pinned:
          type: boolean
      title: Capacity
    LoadBalancer:
      type: object
      properties:
        account:
          type: string
        cloudProvider:
          type: string
        labels:
          type: object
          additionalProperties:
            type: string
        moniker:
          $ref: '#/components/schemas/Moniker'
        name:
          type: string
        serverGroups:
          type: array
          items:
            $ref: '#/components/schemas/LoadBalancerServerGroup'
        type:
          type: string
      title: LoadBalancer
    LoadBalancerInstance:
      type: object
      properties:
        health:
          type: object
        id:
          type: string
        name:
          type: string
        zone:
          type: string
      title: LoadBalancerInstance
    Moniker:
      type: object
      properties:
        app:
          type: string
        cluster:
          type: string
        detail:
          type: string
        sequence:
          type: integer
          format: int32
        stack:
          type: string
      title: Moniker
    Map_string_object:
      type: object
      title: Map«string,object»
      additionalProperties:
        type: object
    ServerGroupManagerSummary:
      type: object
      properties:
        account:
          type: string
        location:
          type: string
        name:
          type: string
      title: ServerGroupManagerSummary
    Cluster:
      type: object
      properties:
        accountName:
          type: string
        loadBalancers:
          type: array
          items:
            $ref: '#/components/schemas/LoadBalancer'
        moniker:
          $ref: '#/components/schemas/Moniker'
        name:
          type: string
        serverGroups:
          type: array
          items:
            $ref: '#/components/schemas/ServerGroup'
        type:
          type: string
      title: Cluster
    Summary:
      type: object
      title: Summary
    LoadBalancerServerGroup:
      type: object
      properties:
        account:
          type: string
        cloudProvider:
          type: string
        detachedInstances:
          type: array
          items:
            type: string
        instances:
          type: array
          items:
            $ref: '#/components/schemas/LoadBalancerInstance'
        isDisabled:
          type: boolean
        name:
          type: string
        region:
          type: string
      title: LoadBalancerServerGroup
x-provenance:
  method: harvested
  publisher: Armory
  source: https://docs.armory.io/reference/scale-agent/swagger.json
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)