ARMO Kubernetes Accounts 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 Kubernetes Accounts 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: KubernetesAccounts
paths:
  /accounts/kubernetes:
    delete:
      description: 'Deletes the cluster from config-service, then deletes its data in the background.

        Replaces the legacy DELETE /cluster?name=.'
      tags:
      - KubernetesAccounts
      summary: Delete a Kubernetes cluster
      operationId: deleteKubernetesAccount
      parameters:
      - x-go-name: CustomerGUID
        name: customerGUID
        in: query
        required: true
        schema:
          type: string
      responses:
        '204':
          description: ''
        '400':
          $ref: '#/components/responses/BadRequestResponse'
        '404':
          $ref: '#/components/responses/ErrorResponse'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
              - cluster
              properties:
                cluster:
                  description: Cluster name, as returned in `cluster` by POST /accounts/kubernetes/list.
                  type: string
                  x-go-name: Cluster
                  example: arn:aws:eks:us-east-1:123456789012:cluster/prod
        required: true
components:
  responses:
    ErrorResponse:
      description: ''
      content:
        application/json:
          schema:
            type: object
            properties:
              code:
                type: integer
                format: int64
                x-go-name: Code
              message:
                type: string
                x-go-name: Message
    BadRequestResponse:
      description: ''
      content:
        application/json:
          schema:
            type: array
            items:
              type: object
              properties:
                detail:
                  description: Error detail (Optional)
                  type: string
                  x-go-name: Detail
                  example: '"invalid set crone job request"'
                message:
                  description: User-Friendly Error Messages (Optional)
                  type: string
                  x-go-name: Message
                  example: '"You are running an old version of Kubescape Helm chart"'
                url:
                  description: URL to documentation / future investigation (Optional)
                  type: string
                  x-go-name: URL
                  example: '"https://docs.armo.cloud"'
  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)