ARMO Workload API

openapi: 3.2.0
info:
  description: 'Documentation of Armo Platform API

    How to get the API key Get the API key from the Armo platform


    Navigate to the https://cloud.armosec.io


    Click on Settings (bottom left corner)


    Under the Agent Access Keys section, generate a new access key or use an existing one.


    Copy and save the access key, as it will not appear again.


    Using the API Key in Requests Pass the access key in the request headers under the key x-api-key as shown below:

    curl -X ''POST'' \

    ''https://api.armosec.io/api/v1/some-endpoint'' \

    -H ''accept: application/json'' \

    -H ''x-api-key: YOUR_ACCESS_KEY'' \

    -d ''{}'''
  title: ARMO PLATFORM Workload API
  version: 1.0.0
servers:
- url: https://api.armosec.io/api/v1
- url: http://api.armosec.io/api/v1
security:
- customerGUID:
  - '[]'
- accessKey:
  - '[]'
- openID:
  - '[]'
tags:
- name: Workload
paths:
  /workloadView:
    post:
      description: This endpoint returns workloads statuses.
      tags:
      - Workload
      summary: Retrieve workloads view list
      operationId: getWorkloadView
      parameters:
      - name: customerGUID
        in: query
        required: true
        schema:
          type: string
      responses:
        '200':
          $ref: '#/components/responses/workloadViewResponse'
        '400':
          description: ''
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                innerFilters:
                  description: Optional filters.
                  type: array
                  items:
                    type: object
                    additionalProperties:
                      type: string
                  x-go-name: InnerFilters
                  example:
                  - accountID: string
                    cluster: string
                    namespace: string
                    region: string
                    riskFactors: string
                    status: string
                    workloadName: string
                pageNum:
                  description: Page number to retrieve.
                  type: integer
                  format: int64
                  x-go-name: PageNum
                  example: 1
                pageSize:
                  description: Page size of the page.
                  type: integer
                  format: int64
                  x-go-name: PageSize
                  example: 50
        description: Optional filters and pagination config.
components:
  schemas:
    WorkloadViewResponse:
      type: object
      properties:
        cursor:
          type: string
          x-go-name: Cursor
        response:
          type: array
          items:
            $ref: '#/components/schemas/WorkloadViewItem'
          x-go-name: Response
        total:
          type: object
          properties:
            relation:
              type: string
              x-go-name: Relation
            value:
              type: integer
              format: int64
              x-go-name: Value
          x-go-name: Total
      x-go-package: github.com/armosec/cadashboardbe/docs
    WorkloadViewItem:
      type: object
      properties:
        accountId:
          type: string
          x-go-name: AccountID
        cluster:
          type: string
          x-go-name: Cluster
        completionStatus:
          type: string
          x-go-name: CompletionStatus
        creationTimestamp:
          type: string
          x-go-name: CreationTimestamp
        kind:
          type: string
          x-go-name: Kind
        learningPercentage:
          type: integer
          format: int64
          x-go-name: LearningPercentage
        learningPeriod:
          type: string
          x-go-name: LearningPeriod
        namespace:
          type: string
          x-go-name: Namespace
        provider:
          type: string
          x-go-name: Provider
        region:
          type: string
          x-go-name: Region
        riskFactors:
          type: array
          items:
            type: string
          x-go-name: RiskFactors
        status:
          type: string
          x-go-name: Status
        workloadName:
          type: string
          x-go-name: WorkloadName
      x-go-package: github.com/armosec/cadashboardbe/docs
  responses:
    workloadViewResponse:
      description: ''
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/WorkloadViewResponse'
  securitySchemes:
    accessKey:
      type: apiKey
      name: x-api-key
      in: header
    customerGUID:
      type: apiKey
      name: customerGUID
      in: query
x-provenance:
  method: harvested
  publisher: ARMO
  source: https://api.armosec.io/openapi/v2/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)