Armory Agent Accounts Controller API

The agent-accounts-controller API from Armory — 2 operation(s) for agent-accounts-controller.

OpenAPI Specification

armory-agent-accounts-controller-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Armory Scale Agent Dynamic Accounts Agent Accounts Controller API
  description: Armory-specific endpoints for retrieving Kubernetes accounts and namespaces handled by an Armory Scale Agent.
  version: 0.13.x
  contact:
    name: Armory Docs
    url: https://docs.armory.io/plugins/scale-agent/
  x-origin:
  - format: swagger
    version: '2.0'
    url: https://docs.armory.io/reference/scale-agent/swagger.json
servers:
- url: /
tags:
- name: agent-accounts-controller
paths:
  /agents/kubernetes/accounts/{accountName}:
    get:
      tags:
      - agent-accounts-controller
      summary: Retrieve account by name if handled by armory agent
      operationId: getAccountUsingGET
      parameters:
      - name: accountName
        in: path
        description: accountName
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/KubesvcAccount'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
      deprecated: false
  /agents/kubernetes/accounts/{accountName}/namespaces:
    get:
      tags:
      - agent-accounts-controller
      summary: Retrieve namespaces by account name if handled by armory agent
      operationId: getNamespacesUsingGET
      parameters:
      - name: accountName
        in: path
        description: accountName
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: array
                items:
                  type: string
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
      deprecated: false
components:
  schemas:
    KubesvcAccount:
      type: object
      required:
      - definition
      - definitionAsString
      - name
      - permissions
      - properties
      - propertiesAsString
      properties:
        certFingerprint:
          type: string
        def:
          type: string
        definition:
          type: object
        definitionAsString:
          type: string
        dynamic:
          type: boolean
        errorMessage:
          type: string
        kubeHost:
          type: string
        kubeVersion:
          type: string
        lastUpdated:
          type: integer
          format: int64
        maxWatchAgeSeconds:
          type: integer
          format: int64
        name:
          type: string
        permissions:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
        properties:
          type: object
        propertiesAsString:
          type: string
        props:
          type: string
        status:
          type: string
          enum:
          - ACTIVATING
          - ACTIVE
          - DEACTIVATING
          - FAILED
          - INACTIVE
          - TO_DEACTIVATE
          - TO_MIGRATE
          - ORPHANED
        zoneId:
          type: string
      title: KubesvcAccount