Mabl

Mabl Custom Failure Reason API

The CustomFailureReason API from Mabl — 4 operation(s) for customfailurereason.

GitHub OpenAPI
Business capability
Software Quality Engineering BC-4200.50

Operations 6

GET /customFailureReason List custom failure reasons #
POST /customFailureReason Create a custom failure reason #
GET /customFailureReason/{custom_failure_reason_id} Get a custom failure reason #
PATCH /customFailureReason/{custom_failure_reason_id} Rename a custom failure reason #
POST /customFailureReason/{custom_failure_reason_id}/disable Disable a custom failure reason #
POST /customFailureReason/{custom_failure_reason_id}/enable Enable a custom failure reason #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/mabl/openapi/mabl-customfailurereason-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-customfailurereason-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-customfailurereason-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: mabl Custom Failure Reason API
  description: APIs for interacting with mabl services
  version: 0.599.3.1792436330
  x-readme-id: 62c896636916ce01d2ff4f5a
servers:
- url: /
security:
- basicAuth: []
- bearerAuth: []
tags:
- name: CustomFailureReason
paths:
  /customFailureReason:
    get:
      tags:
      - CustomFailureReason
      summary: List custom failure reasons
      description: Lists all failure reasons for a workspace, including the nine default reasons. Custom reasons are returned alongside defaults.
      operationId: listCustomFailureReasons
      parameters:
      - name: workspace_id
        in: query
        description: The ID of the workspace to list failure reasons for
        required: true
        style: form
        explode: true
        schema:
          type: string
      - name: include_disabled
        in: query
        description: When true, include disabled custom failure reasons in the result
        required: false
        style: form
        explode: true
        schema:
          type: boolean
      responses:
        '200':
          description: The list of failure reasons
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomFailureReasonListResult'
        '400':
          $ref: '#/components/responses/ErrorResponse400'
        '401':
          $ref: '#/components/responses/ErrorResponse401'
        '403':
          $ref: '#/components/responses/ErrorResponse403'
        default:
          $ref: '#/components/responses/ErrorResponse'
      x-mabl-action: Read::CustomFailureReason
    post:
      tags:
      - CustomFailureReason
      summary: Create a custom failure reason
      description: Creates a new custom failure reason for a workspace. Requires Owner role.
      operationId: createCustomFailureReason
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateCustomFailureReasonRequest'
        required: true
      responses:
        '201':
          description: The created custom failure reason
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomFailureReason'
        '400':
          $ref: '#/components/responses/ErrorResponse400'
        '401':
          $ref: '#/components/responses/ErrorResponse401'
        '403':
          $ref: '#/components/responses/ErrorResponse403'
        default:
          $ref: '#/components/responses/ErrorResponse'
      x-mabl-action: Create::CustomFailureReason
  /customFailureReason/{custom_failure_reason_id}:
    get:
      tags:
      - CustomFailureReason
      summary: Get a custom failure reason
      description: Retrieves a specific custom failure reason by ID. Also accepts default failure reason IDs.
      operationId: getCustomFailureReason
      parameters:
      - name: custom_failure_reason_id
        in: path
        description: The ID of the custom failure reason
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '200':
          description: The custom failure reason
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomFailureReason'
        '401':
          $ref: '#/components/responses/ErrorResponse401'
        '403':
          $ref: '#/components/responses/ErrorResponse403'
        '404':
          $ref: '#/components/responses/ErrorResponse404'
        default:
          $ref: '#/components/responses/ErrorResponse'
      x-mabl-action: Read::CustomFailureReason
    patch:
      tags:
      - CustomFailureReason
      summary: Rename a custom failure reason
      description: Renames an existing custom failure reason. Requires Owner role. Cannot be used on default failure reasons.
      operationId: renameCustomFailureReason
      parameters:
      - name: custom_failure_reason_id
        in: path
        description: The ID of the custom failure reason to rename
        required: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RenameCustomFailureReasonRequest'
        required: true
      responses:
        '200':
          description: The renamed custom failure reason
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomFailureReason'
        '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: Edit::CustomFailureReason
  /customFailureReason/{custom_failure_reason_id}/disable:
    post:
      tags:
      - CustomFailureReason
      summary: Disable a custom failure reason
      description: Disables a custom failure reason, hiding it from the failure reason picker. Requires Owner role. Cannot be used on default failure reasons.
      operationId: disableCustomFailureReason
      parameters:
      - name: custom_failure_reason_id
        in: path
        description: The ID of the custom failure reason to disable
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '200':
          description: The disabled custom failure reason
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomFailureReason'
        '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: Edit::CustomFailureReason
  /customFailureReason/{custom_failure_reason_id}/enable:
    post:
      tags:
      - CustomFailureReason
      summary: Enable a custom failure reason
      description: Re-enables a previously disabled custom failure reason. Requires Owner role. Cannot be used on default failure reasons.
      operationId: enableCustomFailureReason
      parameters:
      - name: custom_failure_reason_id
        in: path
        description: The ID of the custom failure reason to enable
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '200':
          description: The enabled custom failure reason
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomFailureReason'
        '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: Edit::CustomFailureReason
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:
    CustomFailureReasonListResult:
      type: object
      properties:
        custom_failure_reasons:
          type: array
          description: The list of failure reasons, with the workspace's custom reasons first followed by the mabl default reasons
          items:
            $ref: '#/components/schemas/CustomFailureReason'
      description: Result of listing failure reasons for a workspace
    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
    CustomFailureReason:
      type: object
      properties:
        custom_failure_reason_id:
          type: string
          description: Unique identifier for the custom failure reason
        workspace_id:
          type: string
          description: The workspace this failure reason belongs to. Null for default failure reasons.
        display_name:
          type: string
          description: The human-readable name displayed in the failure reason picker
        description:
          type: string
          description: Optional short description of the failure reason
        agent_guidelines:
          type: string
          description: Optional guidance prompt that helps result analysis decide when a failure should be assigned this reason.
        is_default:
          type: boolean
          description: Whether this is one of the nine built-in default failure reasons
        disabled:
          type: boolean
          description: Whether this failure reason is disabled. Disabled reasons are hidden from the picker but preserve historical assignments.
        created_by_id:
          type: string
          description: The user who created this failure reason
        created_time:
          type: integer
          description: Creation timestamp in epoch milliseconds
          format: int64
        last_updated_by_id:
          type: string
          description: The user who last updated this failure reason
        last_updated_time:
          type: integer
          description: Last update timestamp in epoch milliseconds
          format: int64
      description: A workspace-scoped failure reason used to categorize test run failures
      x-implements-interface:
      - HasWorkspaceId
    RenameCustomFailureReasonRequest:
      required:
      - display_name
      type: object
      properties:
        display_name:
          type: string
          description: The new display name for the failure reason
        description:
          type: string
          description: Optional short description of the failure reason
        agent_guidelines:
          maxLength: 1000
          type: string
          description: Optional guidance prompt that helps result analysis decide when a failure should be assigned this reason.
      description: Request body for renaming a custom failure reason
    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.'
    CreateCustomFailureReasonRequest:
      required:
      - display_name
      - workspace_id
      type: object
      properties:
        workspace_id:
          type: string
          description: The workspace to create the failure reason in
        display_name:
          type: string
          description: The human-readable name for the failure reason
        description:
          type: string
          description: Optional short description of the failure reason
        agent_guidelines:
          maxLength: 1000
          type: string
          description: Optional guidance prompt that helps result analysis decide when a failure should be assigned this reason.
      description: Request body for creating a new custom failure reason
    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