ARMO Integrations 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 Integrations 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: Integrations
paths:
  /integrations/jira/configV2:
    get:
      description: Get Jira integration configuration
      operationId: JiraIntegration
      responses:
        '200':
          $ref: '#/components/responses/JiraConfigResp'
      tags:
      - Integrations
      summary: Jira integration
      x-summary-source: derived
  /integrations/link/{guid}:
    delete:
      tags:
      - Integrations
      summary: Get integrations connection status
      operationId: unlinkIssue
      parameters:
      - x-go-name: Guid
        name: guid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: ''
components:
  schemas:
    IntOrString:
      description: '+protobuf=true

        +protobuf.options.(gogoproto.goproto_stringer)=false

        +k8s:openapi-gen=true

        +k8s:openapi-model-package=io.k8s.apimachinery.pkg.util.intstr'
      type: object
      title: 'IntOrString is a type that can hold an int32 or a string.  When used in

        JSON or YAML marshalling and unmarshalling, it produces or consumes the

        inner type.  This allows you to have, for example, a JSON field that can

        accept a name or number.

        TODO: Rename to Int32OrString'
      properties:
        IntVal:
          type: integer
          format: int32
        StrVal:
          type: string
        Type:
          $ref: '#/components/schemas/Type'
      x-go-package: k8s.io/apimachinery/pkg/util/intstr
    Type:
      type: integer
      format: int64
      title: Type represents the stored type of IntOrString.
      x-go-package: k8s.io/apimachinery/pkg/util/intstr
    AuthenticationType:
      type: string
      x-go-package: github.com/armosec/cadashboardbe/integrations/tickets/jira
    JiraProjectConfig:
      type: object
      properties:
        autoClosureSettings:
          $ref: '#/components/schemas/JiraAutoClosureSettings'
        defaultIssueType:
          type: string
          x-go-name: DefaultIssueType
        id:
          $ref: '#/components/schemas/IntOrString'
        isDefault:
          type: boolean
          x-go-name: IsDefault
        name:
          type: string
          x-go-name: Name
      x-go-package: github.com/armosec/armosec-infra/jira
    AuthConfig:
      type: object
      properties:
        authType:
          $ref: '#/components/schemas/AuthenticationType'
        token:
          type: string
          x-go-name: Token
      x-go-package: github.com/armosec/cadashboardbe/integrations/tickets/jira
    JiraAutoClosureSettings:
      type: object
      properties:
        isEnabled:
          type: boolean
          x-go-name: IsEnabled
        issueTypeIdToResolvedStatusId:
          type: object
          additionalProperties:
            type: string
          x-go-name: IssueTypeIdToResolvedStatusId
      x-go-package: github.com/armosec/armosec-infra/jira
    JiraEntity:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/IntOrString'
        name:
          type: string
          x-go-name: Name
      x-go-package: github.com/armosec/armosec-infra/jira
    JiraConfig:
      type: object
      properties:
        authConfig:
          $ref: '#/components/schemas/AuthConfig'
        connectionError:
          description: Connection error fields
          type: string
          x-go-name: ConnectionError
        connectionErrorStatus:
          type: integer
          format: int64
          x-go-name: ConnectionErrorStatus
        isSelfHosted:
          type: boolean
          x-go-name: IsSelfHosted
        jiraCollabGUID:
          type: string
          x-go-name: JiraCollabGUID
        projects:
          type: array
          items:
            $ref: '#/components/schemas/JiraProjectConfig'
          x-go-name: Projects
        selectedSite:
          $ref: '#/components/schemas/JiraEntity'
      x-go-package: github.com/armosec/cadashboardbe/integrations/tickets/jira
  responses:
    JiraConfigResp:
      description: ''
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/JiraConfig'
  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)