Mend

Mend Adoption Wizard API

The Adoption Wizard API from Mend — 7 operation(s) for adoption wizard.

GitHub OpenAPI

Operations 9

POST /api/v3.0/orgs/{orgUuid}/adoptionWizard/start Start an Adoption Wizard onboarding the user completes by scanning manually #
POST /api/v3.0/orgs/{orgUuid}/adoptionWizard/repositories/{repoId}/onboard Onboard a repository to the Adoption Wizard engine #
POST /api/v3.0/orgs/{orgUuid}/adoptionWizard/invite Delegate the Adoption Wizard onboarding to another user #
DELETE /api/v3.0/orgs/{orgUuid}/adoptionWizard/invite Cancel a pending Adoption Wizard delegation #
GET /api/v3.0/orgs/{orgUuid}/adoptionWizard/status Get Organization Adoption Wizard Status #
DELETE /api/v3.0/orgs/{orgUuid}/adoptionWizard/status Reset an organization's Adoption Wizard status #
GET /api/v3.0/orgs/{orgUuid}/adoptionWizard/repositories Get Organization Adoption Wizard Onboardable Repositories #
GET /api/v3.0/orgs/{orgUuid}/adoptionWizard/invitedUser Verify the current user may complete a pending Adoption Wizard delegation #
GET /api/v3.0/orgs/{orgUuid}/adoptionWizard/capability Get Organization Adoption Wizard Capability #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/mend/openapi/mend-adoption-wizard-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/mend:mend-adoption-wizard-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

mend-adoption-wizard-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Mend Adoption Wizard API
  description: 'Mend''s enhanced SCA 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 App.

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

    + Added scalability with support for pagination, filtering and sorting search results.

    + Broader functionality available programmatically.

    + New standard API documentation for easy navigation and search.


    **Note:** To help you get started with the Mend SCA API 2.0, we recommend reviewing our onboarding guide -> Getting Started with Mend SCA API 2.0.

    This resource covers initial setup, authentication instructions, and helpful tips to help you successfully begin working with the Mend SCA API 2.0. If you have a dedicated instance of Mend, contact your Mend representative to access this API on your instance.'
  version: 3.0.1
servers:
- url: https://api-saas.mend.io
  description: Generated server url
security:
- bearer-key: []
tags:
- name: Adoption Wizard
paths:
  /api/v3.0/orgs/{orgUuid}/adoptionWizard/start:
    post:
      tags:
      - Adoption Wizard
      summary: Start an Adoption Wizard onboarding the user completes by scanning manually
      description: Records that the user accepted the suggested manual setup (classic-repo only); their next SAST scan from the integration is then tracked as the onboarding scan.
      operationId: startManualOnboarding
      parameters:
      - name: orgUuid
        in: path
        description: Org UUID (Administration > General)
        required: true
        schema:
          type: string
      - name: engine
        in: query
        required: true
        schema:
          type: string
          enum:
          - sast
      - name: scanSource
        in: query
        required: true
        schema:
          type: string
          enum:
          - developer-platform
          - classic-repo
      responses:
        '403':
          description: Forbidden
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/DWRResponseBase'
        '400':
          description: Bad Request
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/DWRResponseBase'
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DWRResponseV3MessageDTO'
  /api/v3.0/orgs/{orgUuid}/adoptionWizard/repositories/{repoId}/onboard:
    post:
      tags:
      - Adoption Wizard
      summary: Onboard a repository to the Adoption Wizard engine
      operationId: onboardRepository
      parameters:
      - name: orgUuid
        in: path
        description: Org UUID (Administration > General)
        required: true
        schema:
          type: string
      - name: repoId
        in: path
        required: true
        schema:
          type: string
      - name: engine
        in: query
        required: true
        schema:
          type: string
          enum:
          - sast
      - name: scanSource
        in: query
        required: true
        schema:
          type: string
          enum:
          - developer-platform
          - classic-repo
      responses:
        '403':
          description: Forbidden
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/DWRResponseBase'
        '400':
          description: Bad Request
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/DWRResponseBase'
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DWRResponseV3MessageDTO'
  /api/v3.0/orgs/{orgUuid}/adoptionWizard/invite:
    post:
      tags:
      - Adoption Wizard
      summary: Delegate the Adoption Wizard onboarding to another user
      operationId: invite
      parameters:
      - name: orgUuid
        in: path
        description: Org UUID (Administration > General)
        required: true
        schema:
          type: string
      - name: engine
        in: query
        required: true
        schema:
          type: string
          enum:
          - sast
      - name: scanSource
        in: query
        required: true
        schema:
          type: string
          enum:
          - developer-platform
          - classic-repo
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AdoptionWizardInviteRequestDTO'
        required: true
      responses:
        '403':
          description: Forbidden
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/DWRResponseBase'
        '400':
          description: Bad Request
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/DWRResponseBase'
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DWRResponseV3MessageDTO'
    delete:
      tags:
      - Adoption Wizard
      summary: Cancel a pending Adoption Wizard delegation
      operationId: cancelInvite
      parameters:
      - name: orgUuid
        in: path
        description: Org UUID (Administration > General)
        required: true
        schema:
          type: string
      - name: engine
        in: query
        required: true
        schema:
          type: string
          enum:
          - sast
      - name: scanSource
        in: query
        required: true
        schema:
          type: string
          enum:
          - developer-platform
          - classic-repo
      responses:
        '403':
          description: Forbidden
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/DWRResponseBase'
        '400':
          description: Bad Request
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/DWRResponseBase'
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DWRResponseV3MessageDTO'
  /api/v3.0/orgs/{orgUuid}/adoptionWizard/status:
    get:
      tags:
      - Adoption Wizard
      summary: Get Organization Adoption Wizard Status
      operationId: getAdoptionWizardStatus
      parameters:
      - name: orgUuid
        in: path
        description: Org UUID (Administration > General)
        required: true
        schema:
          type: string
      - name: engine
        in: query
        required: true
        schema:
          type: string
          enum:
          - sast
      - name: scanSource
        in: query
        required: true
        schema:
          type: string
          enum:
          - developer-platform
          - classic-repo
      responses:
        '403':
          description: Forbidden
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/DWRResponseBase'
        '400':
          description: Bad Request
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/DWRResponseBase'
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DWRResponseV3AdoptionWizardStatusDTO'
    delete:
      tags:
      - Adoption Wizard
      summary: Reset an organization's Adoption Wizard status
      description: Deletes the status of the given engine/scanSource in any state, so eligibility is evaluated afresh. For support use on stuck onboardings.
      operationId: resetAdoptionWizardStatus
      parameters:
      - name: orgUuid
        in: path
        description: Org UUID (Administration > General)
        required: true
        schema:
          type: string
      - name: engine
        in: query
        required: true
        schema:
          type: string
          enum:
          - sast
      - name: scanSource
        in: query
        required: true
        schema:
          type: string
          enum:
          - developer-platform
          - classic-repo
      responses:
        '403':
          description: Forbidden
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/DWRResponseBase'
        '400':
          description: Bad Request
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/DWRResponseBase'
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DWRResponseV3MessageDTO'
  /api/v3.0/orgs/{orgUuid}/adoptionWizard/repositories:
    get:
      tags:
      - Adoption Wizard
      summary: Get Organization Adoption Wizard Onboardable Repositories
      operationId: getOnboardableRepositories
      parameters:
      - name: cursor
        in: query
        description: Parameter indicates the starting point for retrieving results, the first call doesn't include a cursor parameter in the request, the API response includes the first set of results along with a cursor pointing to the last item retrieved
        required: false
        allowEmptyValue: true
        schema:
          type: string
          default: '0'
      - name: limit
        in: query
        description: Specifies the maximum number of items to be return in the response.
        required: false
        allowEmptyValue: true
        schema:
          maximum: 10000
          type: string
          default: '50'
      - name: orgUuid
        in: path
        description: Org UUID (Administration > General)
        required: true
        schema:
          type: string
      - name: engine
        in: query
        required: true
        schema:
          type: string
          enum:
          - sast
      - name: scanSource
        in: query
        required: true
        schema:
          type: string
          enum:
          - developer-platform
          - classic-repo
      - name: name
        in: query
        required: false
        schema:
          type: string
      responses:
        '403':
          description: Forbidden
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/DWRResponseBase'
        '400':
          description: Bad Request
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/DWRResponseBase'
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DWRResponseV3AdoptionWizardRepositoriesDTO'
  /api/v3.0/orgs/{orgUuid}/adoptionWizard/invitedUser:
    get:
      tags:
      - Adoption Wizard
      summary: Verify the current user may complete a pending Adoption Wizard delegation
      description: Returns 200 if the session user is an org admin or the specific user invited for this engine/scanSource, 403 otherwise. Used by Developer Platform to gate its own onboarding endpoint against users who were never delegated.
      operationId: checkInvitedUser
      parameters:
      - name: orgUuid
        in: path
        description: Org UUID (Administration > General)
        required: true
        schema:
          type: string
      - name: engine
        in: query
        required: true
        schema:
          type: string
          enum:
          - sast
      - name: scanSource
        in: query
        required: true
        schema:
          type: string
          enum:
          - developer-platform
          - classic-repo
      responses:
        '403':
          description: Forbidden
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/DWRResponseBase'
        '400':
          description: Bad Request
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/DWRResponseBase'
        '200':
          description: OK
  /api/v3.0/orgs/{orgUuid}/adoptionWizard/capability:
    get:
      tags:
      - Adoption Wizard
      summary: Get Organization Adoption Wizard Capability
      operationId: getAdoptionWizardCapability
      parameters:
      - name: orgUuid
        in: path
        description: Org UUID (Administration > General)
        required: true
        schema:
          type: string
      responses:
        '403':
          description: Forbidden
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/DWRResponseBase'
        '400':
          description: Bad Request
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/DWRResponseBase'
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DWRResponseV3AdoptionWizardCapabilityDTO'
components:
  schemas:
    AdoptionWizardCapabilityDTO:
      type: object
      properties:
        adoptionOptions:
          type: array
          items:
            $ref: '#/components/schemas/AdoptionOptionDTO'
    DWRResponseBase:
      type: object
      properties:
        supportToken:
          title: Support Token
          type: string
          example: 1171c60d
    DWRResponseV3AdoptionWizardStatusDTO:
      type: object
      properties:
        supportToken:
          title: Support Token
          type: string
          example: 1171c60d
        response:
          $ref: '#/components/schemas/AdoptionWizardStatusDTO'
    AdoptionWizardRepositoryDTO:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
    DWRResponseV3AdoptionWizardCapabilityDTO:
      type: object
      properties:
        supportToken:
          title: Support Token
          type: string
          example: 1171c60d
        response:
          $ref: '#/components/schemas/AdoptionWizardCapabilityDTO'
    DWRResponseV3AdoptionWizardRepositoriesDTO:
      type: object
      properties:
        supportToken:
          title: Support Token
          type: string
          example: 1171c60d
        response:
          $ref: '#/components/schemas/AdoptionWizardRepositoriesDTO'
    MessageDTO:
      type: object
      properties:
        message:
          title: message
          type: string
          example: Success!
    DWRResponseV3MessageDTO:
      type: object
      properties:
        supportToken:
          title: Support Token
          type: string
          example: 1171c60d
        response:
          $ref: '#/components/schemas/MessageDTO'
    AdoptionWizardInviteRequestDTO:
      type: object
      properties:
        email:
          type: string
        message:
          type: string
    ProgressDTO:
      required:
      - currentStage
      - overallPercentage
      type: object
      properties:
        overallPercentage:
          maximum: 100
          minimum: 0
          type: integer
          format: int32
        currentStage:
          maxLength: 255
          minLength: 0
          type: string
    AdoptionWizardRepositoriesDTO:
      type: object
      properties:
        repositories:
          type: array
          items:
            $ref: '#/components/schemas/AdoptionWizardRepositoryDTO'
    AdoptionWizardStatusDTO:
      type: object
      properties:
        status:
          type: string
        scanUuid:
          type: string
        updatedAt:
          type: string
          format: date-time
        progress:
          $ref: '#/components/schemas/ProgressDTO'
        invitedUserEmail:
          type: string
        projectUuid:
          type: string
        supportToken:
          type: string
    AdoptionOptionDTO:
      type: object
      properties:
        engine:
          type: string
        scanSource:
          type: string
        state:
          type: string
          enum:
          - ELIGIBLE
          - IN_PROGRESS
          - FINISHED
  securitySchemes:
    bearer-key:
      type: http
      description: JWT token Bearer
      scheme: bearer
      bearerFormat: JWT