Mabl

Mabl Forge Installation API

The ForgeInstallation API from Mabl — 3 operation(s) for forgeinstallation.

GitHub OpenAPI

Operations 5

GET /atlassian/forge/installations Find a private installation by exactly one legacy client key or cloud ID #
GET /atlassian/forge/installations/{installation_id} Get a private Forge installation #
PUT /atlassian/forge/installations/{installation_id} Persist installation credentials and migrate workspace bindings #
DELETE /atlassian/forge/installations/{installation_id} Delete an installation and its bindings #
DELETE /atlassian/forge/installations/{installation_id}/issues/{jira_issue_id} Mark only issues bound to this installation as deleted in Jira #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/mabl/openapi/mabl-forgeinstallation-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/mabl:mabl-forgeinstallation-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

mabl-forgeinstallation-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: mabl Forge Installation API
  description: APIs for interacting with mabl services
  version: 0.599.3.1792436330
  x-readme-id: 62c896636916ce01d2ff4f5a
servers:
- url: /
security:
- basicAuth: []
- bearerAuth: []
tags:
- name: ForgeInstallation
paths:
  /atlassian/forge/installations:
    get:
      tags:
      - ForgeInstallation
      summary: Find a private installation by exactly one legacy client key or cloud ID
      description: Find a private installation by exactly one legacy client key or cloud ID. Restricted to infrastructure API keys with global integration permissions.
      operationId: findForgeInstallation
      parameters:
      - name: app_id
        in: query
        description: app id
        required: true
        style: form
        explode: true
        schema:
          maxLength: 1024
          minLength: 1
          type: string
      - name: environment_id
        in: query
        description: environment id
        required: true
        style: form
        explode: true
        schema:
          maxLength: 1024
          minLength: 1
          type: string
      - name: legacy_client_key
        in: query
        description: legacy client key
        required: false
        style: form
        explode: true
        schema:
          maxLength: 1024
          minLength: 1
          type: string
      - name: cloud_id
        in: query
        description: cloud id
        required: false
        style: form
        explode: true
        schema:
          maxLength: 1024
          minLength: 1
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForgeInstallation'
        '400':
          $ref: '#/components/responses/ErrorResponse400'
        '401':
          $ref: '#/components/responses/ErrorResponse401'
        '403':
          $ref: '#/components/responses/ErrorResponse403'
        '404':
          $ref: '#/components/responses/ErrorResponse404'
        default:
          $ref: '#/components/responses/ErrorResponse'
      x-mabl-action: Read::Integration
  /atlassian/forge/installations/{installation_id}:
    get:
      tags:
      - ForgeInstallation
      summary: Get a private Forge installation
      description: Get a private Forge installation. Restricted to infrastructure API keys with global integration permissions.
      operationId: getForgeInstallation
      parameters:
      - name: installation_id
        in: path
        description: installation id
        required: true
        style: simple
        explode: false
        schema:
          maxLength: 1024
          minLength: 1
          type: string
      - name: app_id
        in: query
        description: app id
        required: true
        style: form
        explode: true
        schema:
          maxLength: 1024
          minLength: 1
          type: string
      - name: environment_id
        in: query
        description: environment id
        required: true
        style: form
        explode: true
        schema:
          maxLength: 1024
          minLength: 1
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForgeInstallation'
        '400':
          $ref: '#/components/responses/ErrorResponse400'
        '401':
          $ref: '#/components/responses/ErrorResponse401'
        '403':
          $ref: '#/components/responses/ErrorResponse403'
        '404':
          $ref: '#/components/responses/ErrorResponse404'
        default:
          $ref: '#/components/responses/ErrorResponse'
      x-mabl-action: Read::Integration
    put:
      tags:
      - ForgeInstallation
      summary: Persist installation credentials and migrate workspace bindings
      description: Persist installation credentials and migrate workspace bindings. Restricted to infrastructure API keys with global integration permissions.
      operationId: upsertForgeInstallation
      parameters:
      - name: installation_id
        in: path
        description: installation id
        required: true
        style: simple
        explode: false
        schema:
          maxLength: 1024
          minLength: 1
          type: string
      - name: app_id
        in: query
        description: app id
        required: true
        style: form
        explode: true
        schema:
          maxLength: 1024
          minLength: 1
          type: string
      - name: environment_id
        in: query
        description: environment id
        required: true
        style: form
        explode: true
        schema:
          maxLength: 1024
          minLength: 1
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ForgeInstallation'
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForgeInstallation'
        '400':
          $ref: '#/components/responses/ErrorResponse400'
        '401':
          $ref: '#/components/responses/ErrorResponse401'
        '403':
          $ref: '#/components/responses/ErrorResponse403'
        '410':
          description: The installation was uninstalled
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseGeneric'
        default:
          $ref: '#/components/responses/ErrorResponse'
      x-mabl-action: Edit::Integration
    delete:
      tags:
      - ForgeInstallation
      summary: Delete an installation and its bindings
      description: Tombstones the installation and every workspace integration bound to it (not recoverable; purged by retention cleanup) and removes its site aliases. Repeats are no-ops; later GET and find return 404, and a later upsert of the same id returns 410. Restricted to infrastructure API keys with global integration permissions.
      operationId: deactivateForgeInstallation
      parameters:
      - name: installation_id
        in: path
        description: installation id
        required: true
        style: simple
        explode: false
        schema:
          maxLength: 1024
          minLength: 1
          type: string
      - name: app_id
        in: query
        description: app id
        required: true
        style: form
        explode: true
        schema:
          maxLength: 1024
          minLength: 1
          type: string
      - name: environment_id
        in: query
        description: environment id
        required: true
        style: form
        explode: true
        schema:
          maxLength: 1024
          minLength: 1
          type: string
      responses:
        '204':
          description: Success
        '400':
          $ref: '#/components/responses/ErrorResponse400'
        '401':
          $ref: '#/components/responses/ErrorResponse401'
        '403':
          $ref: '#/components/responses/ErrorResponse403'
        default:
          $ref: '#/components/responses/ErrorResponse'
      x-mabl-action: Delete::Integration
  /atlassian/forge/installations/{installation_id}/issues/{jira_issue_id}:
    delete:
      tags:
      - ForgeInstallation
      summary: Mark only issues bound to this installation as deleted in Jira
      description: Mark only issues bound to this installation as deleted in Jira. Restricted to infrastructure API keys with global integration permissions.
      operationId: deleteForgeIssue
      parameters:
      - name: installation_id
        in: path
        description: installation id
        required: true
        style: simple
        explode: false
        schema:
          maxLength: 1024
          minLength: 1
          type: string
      - name: app_id
        in: query
        description: app id
        required: true
        style: form
        explode: true
        schema:
          maxLength: 1024
          minLength: 1
          type: string
      - name: environment_id
        in: query
        description: environment id
        required: true
        style: form
        explode: true
        schema:
          maxLength: 1024
          minLength: 1
          type: string
      - name: jira_issue_id
        in: path
        description: jira issue id
        required: true
        style: simple
        explode: false
        schema:
          maxLength: 1024
          minLength: 1
          type: string
      responses:
        '204':
          description: Success
        '400':
          $ref: '#/components/responses/ErrorResponse400'
        '401':
          $ref: '#/components/responses/ErrorResponse401'
        '403':
          $ref: '#/components/responses/ErrorResponse403'
        default:
          $ref: '#/components/responses/ErrorResponse'
      x-mabl-action: Delete::Integration
components:
  responses:
    ErrorResponse401:
      description: User not authenticated
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponseGeneric'
    ErrorResponse400:
      description: Invalid or missing parameter
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponseGeneric'
    ErrorResponse404:
      description: Entity not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponseGeneric'
    ErrorResponse403:
      description: User not authorized
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponseGeneric'
    ErrorResponse:
      description: Unknown error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponseGeneric'
  schemas:
    GuardrailApprovalKind:
      type: string
      description: Who decides a guardrail approval. SELF is decided by the person the agent acts for; WORKSPACE, for an agent acting for an API key, by a workspace owner or editor.
      enum:
      - SELF
      - WORKSPACE
    GuardrailRefusal:
      type: object
      properties:
        id:
          type: string
          description: The id of the guardrail policy that decided the refusal.
        reason:
          type: string
          description: Why the policy refuses the request, written for the person the agent acts for.
        decision_id:
          type: string
          description: The id of this decision in the guardrail decision log.
        action:
          type: string
          description: The action the request was evaluated as, written Verb::Resource (for example Delete::Test), as declared by the operation's x-mabl-action extension.
        policy_source:
          type: string
          description: 'Who set the deciding policy: workspace for a rule the workspace''s owners wrote, account for a rule set for the workspace''s account, mabl_agent_type for the agent type''s ceiling, and mabl_default for mabl''s own defaults.'
        approval:
          description: The approval for this request; present when error_code is approval_required and the approval could be recorded. Without it the request cannot be approved.
          allOf:
          - $ref: '#/components/schemas/GuardrailApprovalRef'
      description: The guardrail policy that refused an agent request.
    GuardrailApprovalState:
      type: string
      description: Where a guardrail approval stands. PENDING awaits a decision and expires undecided after 24 hours; APPROVED lets the agent repeat the request, as often as it does, for 20 minutes; DENIED refuses the same request for 20 minutes after the decision, after which asking again opens a new approval; CANCELLED means a person withdrew it while pending or revoked it while approved. EXPIRED and CANCELLED are final.
      enum:
      - PENDING
      - APPROVED
      - DENIED
      - EXPIRED
      - CANCELLED
    ForgeInstallation:
      required:
      - app_id
      - environment_id
      - installation_id
      type: object
      properties:
        installation_id:
          maxLength: 1024
          minLength: 1
          type: string
        app_id:
          maxLength: 1024
          minLength: 1
          type: string
        environment_id:
          maxLength: 1024
          minLength: 1
          type: string
        cloud_id:
          maxLength: 1024
          minLength: 1
          type: string
        api_base_url:
          maxLength: 1024
          minLength: 1
          type: string
        base_url:
          maxLength: 1024
          minLength: 1
          type: string
        legacy_client_key:
          maxLength: 1024
          minLength: 1
          type: string
        replaces_installation_id:
          maxLength: 1024
          minLength: 1
          type: string
          description: Ignored on write.
          deprecated: true
        system_token:
          maxLength: 32768
          minLength: 1
          type: string
          description: Private app system token. Never store in workspace integration configuration.
          x-sensitive: true
        token_expires_at:
          minimum: 1
          type: integer
          description: Token expiry in milliseconds since the Unix epoch.
          format: int64
        encryption_workspace_id:
          maxLength: 1024
          minLength: 1
          type: string
          description: Server-managed. Workspace whose KMS key currently encrypts system_token; absent while the installation is unclaimed and the token sits under the shared unclaimed-installations key.
        active:
          type: boolean
          description: Server-managed; ignored on write.
          deprecated: true
    GuardrailApprovalRef:
      type: object
      properties:
        id:
          type: string
          description: The approval's id.
        state:
          description: Where the approval stands.
          allOf:
          - $ref: '#/components/schemas/GuardrailApprovalState'
        kind:
          description: Who decides the approval.
          allOf:
          - $ref: '#/components/schemas/GuardrailApprovalKind'
        request_expires_time:
          type: integer
          description: When the approval expires if nobody decides it, in epoch milliseconds.
          format: int64
        url:
          type: string
          description: The mabl app page where a person reviews the approval.
      description: 'An approval a guardrail policy asks for. While it is PENDING, stop: give the person the url, tell them the request is waiting for approval, and do not repeat the request or poll in a loop. Once a person tells you it is APPROVED, repeat the identical request with the header X-Mabl-Approval set to id. DENIED means a person said no, so do not work around it.'
    ErrorResponseGeneric:
      type: object
      properties:
        id:
          type: string
          x-mabl-scope: public
        code:
          maximum: 599
          minimum: 100
          type: integer
          format: int32
          x-mabl-scope: public
        message:
          type: string
          x-mabl-scope: public
        error_code:
          type: string
          description: Machine-readable reason for the error, present only when the API names one. Values are guardrail_blocked (a guardrail policy refused an agent request), approval_required (a guardrail policy requires a person to approve the request first).
        guardrail:
          description: The guardrail policy that refused the request; present only when error_code is guardrail_blocked or approval_required.
          allOf:
          - $ref: '#/components/schemas/GuardrailRefusal'
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
    bearerAuth:
      type: apiKey
      name: Authorization
      in: header