Mabl

Mabl Xray Proxy API

The XrayProxy API from Mabl — 4 operation(s) for xrayproxy.

GitHub OpenAPI
Business capability
Software Quality Engineering BC-4200.50

Operations 4

GET /integrations/{integration_id}/xray/tests Query Xray Tests #
GET /integrations/{integration_id}/xray/tests/{id} Get Xray Test #
GET /integrations/{integration_id}/xray/plans Query Xray Plans #
GET /integrations/{integration_id}/xray/plans/{id} Get Xray Plan #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/mabl/openapi/mabl-xrayproxy-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-xrayproxy-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-xrayproxy-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: mabl Xray Proxy API
  description: APIs for interacting with mabl services
  version: 0.599.3.1792436330
  x-readme-id: 62c896636916ce01d2ff4f5a
servers:
- url: /
security:
- basicAuth: []
- bearerAuth: []
tags:
- name: XrayProxy
paths:
  /integrations/{integration_id}/xray/tests:
    get:
      tags:
      - XrayProxy
      summary: Query Xray Tests
      description: Queries Xray Tests for a specific project.
      operationId: queryXrayTests
      parameters:
      - name: integration_id
        in: path
        description: The workspace integration ID for Xray
        required: true
        style: simple
        explode: false
        schema:
          type: string
      - name: search
        in: query
        description: Search string to filter tests by key or text content
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: Number of results to return
        required: false
        style: form
        explode: true
        schema:
          maximum: 1000
          minimum: 1
          type: integer
          format: int32
          default: 100
      - name: cursor
        in: query
        description: The cursor to use for pagination
        required: false
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Xray tests query results
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/XrayTestQueryResult'
        '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
  /integrations/{integration_id}/xray/tests/{id}:
    get:
      tags:
      - XrayProxy
      summary: Get Xray Test
      description: Get Xray Test for a specific project.
      operationId: getXrayTestById
      parameters:
      - name: integration_id
        in: path
        description: The workspace integration ID for Xray
        required: true
        style: simple
        explode: false
        schema:
          type: string
      - name: id
        in: path
        description: Entity ID to load
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '200':
          description: Xray test
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/XrayTest'
        '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
  /integrations/{integration_id}/xray/plans:
    get:
      tags:
      - XrayProxy
      summary: Query Xray Plans
      description: Queries Xray Plans for a specific project.
      operationId: queryXrayPlans
      parameters:
      - name: integration_id
        in: path
        description: The workspace integration ID for Xray
        required: true
        style: simple
        explode: false
        schema:
          type: string
      - name: search
        in: query
        description: Search string to filter plans by key or text content
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: Number of results to return
        required: false
        style: form
        explode: true
        schema:
          maximum: 1000
          minimum: 1
          type: integer
          format: int32
          default: 100
      - name: cursor
        in: query
        description: The cursor to use for pagination
        required: false
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Xray plans query results
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/XrayTestPlanQueryResult'
        '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
  /integrations/{integration_id}/xray/plans/{id}:
    get:
      tags:
      - XrayProxy
      summary: Get Xray Plan
      description: Get Xray Plan for a specific project.
      operationId: getXrayPlanById
      parameters:
      - name: integration_id
        in: path
        description: The workspace integration ID for Xray
        required: true
        style: simple
        explode: false
        schema:
          type: string
      - name: id
        in: path
        description: Entity ID to load
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '200':
          description: Xray plan
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/XrayTestPlan'
        '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
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:
    XrayTestQueryResult:
      type: object
      properties:
        tests:
          type: array
          description: The list of tests
          items:
            $ref: '#/components/schemas/XrayTest'
      description: An Xray Tests Query Result
      allOf:
      - $ref: '#/components/schemas/BaseXrayQueryResult'
    BaseXrayQueryResult:
      type: object
      properties:
        total:
          type: integer
          description: The total number of entities
          format: int32
        start:
          type: integer
          description: Page offset
          format: int32
        limit:
          type: integer
          description: The maximum amount of entities returned
          format: int32
    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.
    XrayJiraIssue:
      type: object
      properties:
        issue_id:
          type: string
          description: A unique identifier for the associated Jira Issue
        project_id:
          type: string
          description: The ID of the associated Jira Project
        issue_key:
          type: string
          description: The Jira Issue Key
        summary:
          type: string
          description: The Jira Issue Summary
        description:
          type: string
          description: The Jira Issue Description
      description: A base Jira Issue
    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
    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.'
    XrayTestPlan:
      type: object
      description: An Xray TestPlan
      allOf:
      - $ref: '#/components/schemas/XrayJiraIssue'
    XrayTestPlanQueryResult:
      type: object
      properties:
        test_plans:
          type: array
          description: The list of test plans
          items:
            $ref: '#/components/schemas/XrayTestPlan'
      description: An Xray TestPlans Query Result
      allOf:
      - $ref: '#/components/schemas/BaseXrayQueryResult'
    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'
    XrayTest:
      type: object
      description: An Xray Test
      allOf:
      - $ref: '#/components/schemas/XrayJiraIssue'
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
    bearerAuth:
      type: apiKey
      name: Authorization
      in: header