openapi: 3.2.0
info:
  contact:
    name: ''
  description: ''
  title: Spinnaker Cluster Controller API
servers:
- description: Generated server url
  url: http://localhost
tags:
- name: cluster-controller
paths:
  /applications/{application}/clusters:
    get:
      operationId: getClusters_1
      parameters:
      - in: path
        name: application
        required: true
        schema:
          type: string
      - in: header
        name: X-RateLimit-App
        required: false
        schema:
          type: string
      responses:
        '200':
          content:
            '*/*':
              schema:
                additionalProperties: {}
                type: object
          description: OK
      summary: Retrieve a list of cluster names for an application, grouped by account
      tags:
      - cluster-controller
  /applications/{application}/clusters/{account}:
    get:
      operationId: getClusters_2
      parameters:
      - in: path
        name: application
        required: true
        schema:
          type: string
      - in: path
        name: account
        required: true
        schema:
          type: string
      - in: header
        name: X-RateLimit-App
        required: false
        schema:
          type: string
      responses:
        '200':
          content:
            '*/*':
              schema:
                items:
                  additionalProperties: {}
                  type: object
                type: array
          description: OK
      summary: Retrieve a list of clusters for an account
      tags:
      - cluster-controller
  /applications/{application}/clusters/{account}/{clusterName}:
    get:
      operationId: getClusters_3
      parameters:
      - in: path
        name: application
        required: true
        schema:
          type: string
      - in: path
        name: account
        required: true
        schema:
          type: string
      - in: path
        name: clusterName
        required: true
        schema:
          type: string
      - in: header
        name: X-RateLimit-App
        required: false
        schema:
          type: string
      responses:
        '200':
          content:
            '*/*':
              schema:
                additionalProperties: {}
                type: object
          description: OK
      summary: Retrieve a cluster's details
      tags:
      - cluster-controller
  /applications/{application}/clusters/{account}/{clusterName}/serverGroups:
    get:
      operationId: getServerGroups_1
      parameters:
      - in: path
        name: application
        required: true
        schema:
          type: string
      - in: path
        name: account
        required: true
        schema:
          type: string
      - in: path
        name: clusterName
        required: true
        schema:
          type: string
      - in: header
        name: X-RateLimit-App
        required: false
        schema:
          type: string
      responses:
        '200':
          content:
            '*/*':
              schema:
                items:
                  additionalProperties: {}
                  type: object
                type: array
          description: OK
      summary: Retrieve a list of server groups for a cluster
      tags:
      - cluster-controller
  /applications/{application}/clusters/{account}/{clusterName}/serverGroups/{serverGroupName}:
    get:
      operationId: getServerGroups_2
      parameters:
      - in: path
        name: application
        required: true
        schema:
          type: string
      - in: path
        name: account
        required: true
        schema:
          type: string
      - in: path
        name: clusterName
        required: true
        schema:
          type: string
      - in: path
        name: serverGroupName
        required: true
        schema:
          type: string
      - in: header
        name: X-RateLimit-App
        required: false
        schema:
          type: string
      responses:
        '200':
          content:
            '*/*':
              schema:
                items:
                  additionalProperties: {}
                  type: object
                type: array
          description: OK
      summary: Retrieve a server group's details
      tags:
      - cluster-controller
  /applications/{application}/clusters/{account}/{clusterName}/serverGroups/{serverGroupName}/scalingActivities:
    get:
      operationId: getScalingActivities
      parameters:
      - in: path
        name: application
        required: true
        schema:
          type: string
      - in: path
        name: account
        required: true
        schema:
          type: string
      - in: path
        name: clusterName
        required: true
        schema:
          type: string
      - in: path
        name: serverGroupName
        required: true
        schema:
          type: string
      - in: query
        name: provider
        required: false
        schema:
          default: aws
          type: string
      - in: query
        name: region
        required: false
        schema:
          type: string
      - in: header
        name: X-RateLimit-App
        required: false
        schema:
          type: string
      responses:
        '200':
          content:
            '*/*':
              schema:
                items:
                  additionalProperties: {}
                  type: object
                type: array
          description: OK
      summary: Retrieve a list of scaling activities for a server group
      tags:
      - cluster-controller
  /applications/{application}/clusters/{account}/{clusterName}/{cloudProvider}/{scope}/serverGroups/target/{target}:
    get:
      description: '`scope` is either a zone or a region'
      operationId: getTargetServerGroup
      parameters:
      - in: path
        name: application
        required: true
        schema:
          type: string
      - in: path
        name: account
        required: true
        schema:
          type: string
      - in: path
        name: clusterName
        required: true
        schema:
          type: string
      - in: path
        name: cloudProvider
        required: true
        schema:
          type: string
      - in: path
        name: scope
        required: true
        schema:
          type: string
      - in: path
        name: target
        required: true
        schema:
          type: string
      - in: query
        name: onlyEnabled
        required: false
        schema:
          type: boolean
      - in: query
        name: validateOldest
        required: false
        schema:
          type: boolean
      - in: header
        name: X-RateLimit-App
        required: false
        schema:
          type: string
      responses:
        '200':
          content:
            '*/*':
              schema:
                additionalProperties: {}
                type: object
          description: OK
      summary: Retrieve a server group that matches a target coordinate (e.g., newest…
      tags:
      - cluster-controller
  /applications/{application}/clusters/{account}/{clusterName}/{type}/loadBalancers:
    get:
      operationId: getClusterLoadBalancers
      parameters:
      - in: path
        name: account
        required: true
        schema:
          type: string
      - in: path
        name: clusterName
        required: true
        schema:
          type: string
      - in: path
        name: type
        required: true
        schema:
          type: string
      - in: header
        name: X-RateLimit-App
        required: false
        schema:
          type: string
      responses:
        '200':
          content:
            '*/*':
              schema:
                items: {}
                type: array
          description: OK
      summary: Retrieve a cluster's loadbalancers
      tags:
      - cluster-controller
externalDocs:
  description: Spinnaker Documentation
  url: https://spinnaker.io