ARMO Security Risks 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 Security Risks 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: SecurityRisks
paths:
  /securityrisks/list:
    post:
      tags:
      - SecurityRisks
      summary: Retrieve a list of security risks that match the provided filters
      operationId: listSecurityRisks
      parameters:
      - x-go-name: CustomerGUID
        description: Unique identifier for the customer.
        name: customerGUID
        in: query
        required: true
        schema:
          type: string
      responses:
        '200':
          description: ''
        '400':
          description: ''
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                innerFilters:
                  description: Array of inner filters to narrow down the security risks.
                  type: array
                  items:
                    type: object
                    properties:
                      category:
                        description: Filter by risk category.
                        type: string
                        x-go-name: Category
                      clusterShortName:
                        description: Specify the cluster's short name.
                        type: string
                        x-go-name: ClusterShortName
                      namespace:
                        description: Filter by namespace.
                        type: string
                        x-go-name: Namespace
                      securityRiskName:
                        description: Filter by the name of the security risk.
                        type: string
                        x-go-name: SecurityRiskName
                      severity:
                        description: Filter by severity level.
                        type: string
                        x-go-name: Severity
                      smartRemediation:
                        description: Filter by whether smart remediation is enabled.
                        type: string
                        x-go-name: SmartRemediation
                      tickets:
                        description: Filter by the presence of associated tickets.
                        type: string
                        x-go-name: Tickets
                  x-go-name: InnerFilters
        description: Request body containing optional filters for narrowing down the security risks.
  /securityrisks/resources:
    post:
      description: This endpoint retrieves resources linked to specific security risks for the given customer GUID.
      tags:
      - SecurityRisks
      summary: Retrieve resources associated with specific security risks
      operationId: listSecurityRiskResources
      parameters:
      - x-go-name: CustomerGUID
        description: The customer GUID for identifying the customer.
        name: customerGUID
        in: query
        required: true
        schema:
          type: string
      responses:
        '200':
          description: ''
        '400':
          description: ''
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                innerFilters:
                  type: array
                  items:
                    type: object
                    properties:
                      clusterShortName:
                        description: Specify the cluster's short name.
                        type: string
                        x-go-name: ClusterShortName
                      exceptionApplied:
                        description: Filter by whether an exception is applied.
                        type: string
                        x-go-name: ExceptionApplied
                      namespace:
                        description: Filter by namespace using exact match or regular expressions.
                        type: string
                        x-go-name: Namespace
                      resourceName:
                        description: Filter by the resource name.
                        type: string
                        x-go-name: ResourceName
                      securityRiskID:
                        description: Filter by the unique identifier of the security risk.
                        type: string
                        x-go-name: SecurityRiskID
                      tickets:
                        description: Filter by the presence of associated tickets.
                        type: string
                        x-go-name: Tickets
                  x-go-name: InnerFilters
        description: Optional filters for narrowing down the security risk resources.
  /securityrisks/severities:
    post:
      description: This endpoint retrieves a summary of the severities for security risks associated with the specified customer GUID.
      tags:
      - SecurityRisks
      summary: Retrieve a summary of security risk severities for the specified customer GUID
      operationId: listSecurityRiskSeverities
      parameters:
      - x-go-name: CustomerGUID
        description: Unique identifier for the customer.
        name: customerGUID
        in: query
        required: true
        schema:
          type: string
      responses:
        '200':
          description: ''
        '400':
          description: ''
      requestBody:
        content:
          application/json:
            schema:
              type: object
        description: Optional body for the request.
components:
  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)