Mend Integrations API

The Integrations API from Mend — 1 operation(s) for integrations.

OpenAPI Specification

mend-integrations-api-openapi.yml Raw ↑
openapi: 3.0.1
info:
  title: Mend Access Management Integrations API
  description: 'Mend''s enhanced API enables automation of workflows in a REST compliant format. The API features:

    + Access for any user with Mend credentials, via a user key available in the user''s profile page in the Mend Platform.

    + Improved security with a JWT token per organization, which expires every 10 minutes.

    + Added scalability with support for cursor pagination and limiting results size.

    + Broader functionality available programmatically.

    + New standard API documentation for easy navigation and search.


    **Note:** To help you get started with the Mend API 3.0, we recommend reviewing our onboarding guide -> [Getting Started with API 3.0](https://docs.mend.io/platform/latest/getting-started-with-mend-api-3-0).

    This resource covers initial setup, authentication instructions, and helpful tips to help you successfully begin working with the Mend API 3.0. If you have a dedicated instance of Mend, contact your Mend representative to access this API on your instance.'
  version: '3.0'
servers:
- url: https://baseUrl
  description: Generated server url
security:
- bearer-key: []
tags:
- name: Integrations
paths:
  /api/v3.0/orgs/{orgUuid}/integrations:
    get:
      tags:
      - Integrations
      summary: Get All Integrations
      description: Returns all integrations for the given organization with optional filtering.
      operationId: getOrgIntegrations
      parameters:
      - name: orgUuid
        in: path
        required: true
        schema:
          type: string
        description: 'org UUID (from the Mend App: **Administration** General > **Organization UUID**).'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DWRResponseV3ListIntegrationDTOV3'
        '400':
          description: Bad Request
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/DWRResponseBase'
        '403':
          description: Forbidden
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/DWRResponseBase'
components:
  schemas:
    DWRResponseV3ListIntegrationDTOV3:
      type: object
      properties:
        supportToken:
          title: Support Token
          type: string
          example: 1171c60d
        response:
          type: array
          items:
            $ref: '#/components/schemas/IntegrationDTOV3'
    IntegrationDTOV3:
      type: object
      properties:
        uuid:
          type: string
        orgUuid:
          type: string
        status:
          type: string
          enum:
          - ACTIVE
          - SUSPENDED
          - DELETED
        type:
          type: string
          enum:
          - JIRA
          - GITHUB
          - INVICTI
          - WIZ
        variant:
          type: string
          enum:
          - JIRA_CLOUD
          - JIRA_CLOUD_SECURITY
          - JIRA_DC
          - WIZ_COMMERCIAL
          - WIZ_GOV
          - WIZ_COMM_ON_GOV
          - WIZ_DEMO
        extraData:
          type: object
        createdBy:
          type: string
        creationDate:
          type: string
          format: date-time
        lastUpdate:
          type: string
          format: date-time
    DWRResponseBase:
      type: object
      properties:
        supportToken:
          title: Support Token
          type: string
          example: 1171c60d
  securitySchemes:
    bearer-key:
      type: http
      description: JWT token Bearer
      scheme: bearer
      bearerFormat: JWT