Mend AI API

The AI API from Mend — 1 operation(s) for ai.

OpenAPI Specification

mend-ai-api-openapi.yml Raw ↑
openapi: 3.0.1
info:
  title: Mend Access Management AI 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: AI
paths:
  /api/v3.0/ai/implementationweakness:
    get:
      security:
      - bearer-key: []
      description: Returns a list of implementation weakness types and their details
      tags:
      - AI
      summary: Get implementation weaknesses
      operationId: getImplementationWeaknesses
      parameters:
      - description: Filter by specific weakness ID
        name: weaknessID
        in: query
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/v3.V3ImplementationWeaknessResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: string
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                type: string
components:
  schemas:
    v3.V3ImplementationWeaknessResponse:
      type: object
      properties:
        weaknessID:
          type: string
        weaknessCategory:
          type: string
        weaknessSeverity:
          type: string
        weaknessScore:
          type: string
        weaknessTitle:
          type: string
        owaspCategory:
          type: string
        weaknessDescription:
          type: string
        weaknessPotentialImpact:
          type: string
        weaknessBestPractices:
          type: string
        weaknessReferences:
          type: string
  securitySchemes:
    bearer-key:
      type: http
      description: JWT token Bearer
      scheme: bearer
      bearerFormat: JWT