BugBug

BugBug Tests API

Retrieving tests

GitHub OpenAPI

Operations 11

GET /v2/tests/ Retrieving tests list #
POST /v2/tests/ Create a new test #
GET /v2/tests/{id}/ Retrieving test by ID #
PUT /v2/tests/{id}/ V2 tests update #
PATCH /v2/tests/{id}/ Retrieve a test by its ID and update details #
DELETE /v2/tests/{id}/ Retrieve a test by its ID and remove it #
POST /v2/tests/{id}/insert-component/ Insert a component into a test by test ID #
PUT /v2/tests/{id}/tags/ Replace test tags #
POST /v2/tests/{id}/update-group-position/ Move a group to a different position #
POST /v2/tests/{id}/update-step-position/ Move a step to a different position or group #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/bugbug-io/openapi/bugbug-io-tests-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/bugbug-io/json-schema/bugbug-io-v2-project-settings-schema.json
📊
JSONSchema
https://artifacts.apis.io/bugbug-io/json-schema/bugbug-io-v2-test-run-schema.json
📊
JSONSchema
https://artifacts.apis.io/bugbug-io/json-schema/bugbug-io-v2-step-run-detail-schema.json
📊
JSONSchema
https://artifacts.apis.io/bugbug-io/json-schema/bugbug-io-patched-step-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/bugbug-io/json-schema/bugbug-io-step-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/bugbug-io/json-schema/bugbug-io-v2-suite-run-schema.json

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/bugbug-io:bugbug-io-tests-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

bugbug-io-tests-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: BugBug.io Public Tests API
  version: v2
  x-logo:
    url: /static/images/logo.svg
    altText: BugBug.io
  description: 'BugBug.io is a modern browser-based app for software testers, developers, or product managers in need of quick & reliable test automation. You can run tests from your CI/CD pipeline or build system. You can run tests and suites in the cloud via BugBug Command Line Interface.


    Please use Authorize button to Try it out.'
  contact:
    email: support@bugbug.io
tags:
- name: Tests
  description: Retrieving tests
paths:
  /v2/tests/:
    get:
      operationId: v2_tests_list
      description: Returns many tests.
      summary: Retrieving tests list
      parameters:
      - in: query
        name: folder
        schema:
          type: string
          format: uuid
      - in: query
        name: folderId
        schema:
          type: string
          format: uuid
      - in: query
        name: latestRun
        schema:
          type: boolean
        description: Include the latest run summary for each test.
      - in: query
        name: noFolder
        schema:
          type: boolean
      - in: query
        name: ordering
        schema:
          type: string
          enum:
          - -created
          - -name
          - created
          - name
      - name: page
        required: false
        in: query
        description: A page number within the paginated result set.
        schema:
          type: integer
      - name: page_size
        required: false
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      - in: query
        name: query
        schema:
          type: string
        description: Search in names with the following query
      - in: query
        name: tags
        schema:
          type: string
        description: Comma-separated tag names. Names cannot contain commas. Matching is case-insensitive and uses AND semantics.
      tags:
      - Tests
      security:
      - tokenAuth: []
      - Bearer: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedV2TestList'
          description: ''
        '401':
          description: Authentication credentials were missing or invalid.
    post:
      operationId: v2_tests_create
      description: Create test.
      summary: Create a new test
      parameters: []
      tags:
      - Tests
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/V2TestCreate'
          application/json:
            schema:
              $ref: '#/components/schemas/V2TestCreate'
      security:
      - tokenAuth: []
      - Bearer: []
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2TestDetails'
          description: ''
        '401':
          description: Authentication credentials were missing or invalid.
        '400':
          description: Request body failed validation.
  /v2/tests/{id}/:
    get:
      operationId: v2_tests_retrieve
      description: Returns a single test.
      summary: Retrieving test by ID
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this test.
        required: true
      tags:
      - Tests
      security:
      - tokenAuth: []
      - Bearer: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2TestDetails'
          description: ''
        '401':
          description: Authentication credentials were missing or invalid.
        '404':
          description: Resource not found.
    put:
      operationId: v2_tests_update
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this test.
        required: true
      tags:
      - Tests
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/V2Test'
          application/json:
            schema:
              $ref: '#/components/schemas/V2Test'
      security:
      - tokenAuth: []
      - Bearer: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2Test'
          description: ''
        '401':
          description: Authentication credentials were missing or invalid.
        '400':
          description: Request body failed validation.
        '404':
          description: Resource not found.
      summary: V2 tests update
      x-summary-source: derived
    patch:
      operationId: v2_tests_partial_update
      description: Updates test details.
      summary: Retrieve a test by its ID and update details
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this test.
        required: true
      tags:
      - Tests
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/PatchedV2TestCreate'
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedV2TestCreate'
      security:
      - tokenAuth: []
      - Bearer: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2TestDetails'
          description: ''
        '401':
          description: Authentication credentials were missing or invalid.
        '400':
          description: Request body failed validation.
        '404':
          description: Resource not found.
    delete:
      operationId: v2_tests_destroy
      description: Remove a test.
      summary: Retrieve a test by its ID and remove it
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this test.
        required: true
      tags:
      - Tests
      security:
      - tokenAuth: []
      - Bearer: []
      responses:
        '204':
          description: No response body
        '401':
          description: Authentication credentials were missing or invalid.
        '404':
          description: Resource not found.
  /v2/tests/{id}/insert-component/:
    post:
      operationId: v2_tests_insert_component_create
      description: Insert a component into a test. Prefer componentId. The legacy groupId field is still accepted and must contain the component relation ID returned by the components endpoint.
      summary: Insert a component into a test by test ID
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this test.
        required: true
      tags:
      - Tests
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/V2InsertComponent'
          application/json:
            schema:
              $ref: '#/components/schemas/V2InsertComponent'
      security:
      - tokenAuth: []
      - Bearer: []
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2TestDetails'
          description: ''
        '401':
          description: Authentication credentials were missing or invalid.
        '400':
          description: Request body failed validation.
        '404':
          description: Resource not found.
  /v2/tests/{id}/tags/:
    put:
      operationId: v2_tests_tags_update
      description: Replaces tags assigned to the test. Tag names that do not exist yet are created in the project with a default color.
      summary: Replace test tags
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this test.
        required: true
      tags:
      - Tests
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/V2TagAssignmentsUpdate'
          application/json:
            schema:
              $ref: '#/components/schemas/V2TagAssignmentsUpdate'
      security:
      - tokenAuth: []
      - Bearer: []
      responses:
        '200':
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/V2Tag'
          description: ''
        '401':
          description: Authentication credentials were missing or invalid.
        '400':
          description: Request body failed validation.
        '404':
          description: Resource not found.
  /v2/tests/{id}/unlink-component/:
    post:
      operationId: v2_tests_unlink_component_create
      description: Unlink a component from a test.
      summary: Unlink a component from a test by test ID
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this test.
        required: true
      tags:
      - Tests
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/UnlinkComponent'
          application/json:
            schema:
              $ref: '#/components/schemas/UnlinkComponent'
        required: true
      security:
      - tokenAuth: []
      - Bearer: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2TestDetails'
          description: ''
        '401':
          description: Authentication credentials were missing or invalid.
        '400':
          description: Request body failed validation.
        '404':
          description: Resource not found.
  /v2/tests/{id}/update-group-position/:
    post:
      operationId: v2_tests_update_group_position_create
      description: Move a group or component to a new zero-based position within a test. `groupId` is the test-group relation ID returned in the test's `groups[].id`. An `atIndex` past the end moves the group to the last position.
      summary: Move a group to a different position
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this test.
        required: true
      tags:
      - Tests
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/V2UpdateGroupPosition'
          application/json:
            schema:
              $ref: '#/components/schemas/V2UpdateGroupPosition'
        required: true
      security:
      - tokenAuth: []
      - Bearer: []
      responses:
        '200':
          description: No response body
        '401':
          description: Authentication credentials were missing or invalid.
        '400':
          description: Request body failed validation.
        '404':
          description: Resource not found.
  /v2/tests/{id}/update-step-position/:
    post:
      operationId: v2_tests_update_step_position_create
      description: Update the position of a step within a test.
      summary: Move a step to a different position or group
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this test.
        required: true
      tags:
      - Tests
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/V2UpdateStepPosition'
          application/json:
            schema:
              $ref: '#/components/schemas/V2UpdateStepPosition'
        required: true
      security:
      - tokenAuth: []
      - Bearer: []
      responses:
        '200':
          description: No response body
        '401':
          description: Authentication credentials were missing or invalid.
        '400':
          description: Request body failed validation.
        '404':
          description: Resource not found.
components:
  schemas:
    V2UpdateGroupPosition:
      type: object
      properties:
        groupId:
          type: string
          format: uuid
        atIndex:
          type: integer
          minimum: 0
      required:
      - atIndex
      - groupId
    V2TestCreate:
      type: object
      properties:
        name:
          type:
          - string
          - 'null'
          maxLength: 255
        screenSizeType:
          enum:
          - desktop
          - mobile
          - custom
          type: string
          description: '* `desktop` - Desktop

            * `mobile` - Mobile

            * `custom` - Custom'
          x-spec-enum-id: c0cdf94a62475084
        notes:
          type:
          - string
          - 'null'
          title: Test notes
        folderId:
          type:
          - string
          - 'null'
          format: uuid
        tags:
          type: array
          items:
            type: string
            maxLength: 64
          writeOnly: true
          maxItems: 64
        tagIds:
          type: array
          items:
            type: string
            format: uuid
          writeOnly: true
          maxItems: 64
    V2UpdateStepPosition:
      type: object
      properties:
        stepId:
          type: string
          format: uuid
        groupId:
          type: string
          format: uuid
        atIndex:
          type: integer
        blockId:
          type:
          - string
          - 'null'
          format: uuid
      required:
      - stepId
    PaginatedV2TestList:
      type: object
      required:
      - count
      - results
      properties:
        count:
          type: integer
          example: 123
        next:
          type: string
          nullable: true
          format: uri
          example: http://api.example.org/accounts/?page=4
        previous:
          type: string
          nullable: true
          format: uri
          example: http://api.example.org/accounts/?page=2
        results:
          type: array
          items:
            $ref: '#/components/schemas/V2Test'
    V2InsertComponent:
      type: object
      properties:
        groupId:
          type: string
          format: uuid
        componentId:
          type: string
          format: uuid
          writeOnly: true
        atIndex:
          type:
          - integer
          - 'null'
    PatchedV2TestCreate:
      type: object
      properties:
        name:
          type:
          - string
          - 'null'
          maxLength: 255
        screenSizeType:
          enum:
          - desktop
          - mobile
          - custom
          type: string
          description: '* `desktop` - Desktop

            * `mobile` - Mobile

            * `custom` - Custom'
          x-spec-enum-id: c0cdf94a62475084
        notes:
          type:
          - string
          - 'null'
          title: Test notes
        folderId:
          type:
          - string
          - 'null'
          format: uuid
        tags:
          type: array
          items:
            type: string
            maxLength: 64
          writeOnly: true
          maxItems: 64
        tagIds:
          type: array
          items:
            type: string
            format: uuid
          writeOnly: true
          maxItems: 64
    V2Test:
      type: object
      properties:
        folderId:
          type:
          - string
          - 'null'
          format: uuid
        id:
          type: string
          format: uuid
          readOnly: true
        name:
          type: string
          maxLength: 255
        tags:
          type: array
          items:
            $ref: '#/components/schemas/V2Tag'
          readOnly: true
      required:
      - id
      - tags
    UnlinkComponent:
      type: object
      properties:
        groupId:
          type: string
          format: uuid
      required:
      - groupId
    V2TestDetails:
      type: object
      properties:
        folderId:
          type:
          - string
          - 'null'
          format: uuid
        id:
          type: string
          format: uuid
          readOnly: true
        name:
          type: string
          maxLength: 255
        tags:
          type: array
          items:
            $ref: '#/components/schemas/V2Tag'
          readOnly: true
        groups:
          type: string
          readOnly: true
        notes:
          type:
          - string
          - 'null'
          readOnly: true
          title: Test notes
        screenSizeType:
          enum:
          - desktop
          - mobile
          - custom
          type: string
          description: '* `desktop` - Desktop

            * `mobile` - Mobile

            * `custom` - Custom'
          x-spec-enum-id: c0cdf94a62475084
          readOnly: true
        webappUrl:
          type: string
          readOnly: true
      required:
      - groups
      - id
      - notes
      - screenSizeType
      - tags
      - webappUrl
    V2Tag:
      type: object
      properties:
        color:
          type: string
          readOnly: true
        id:
          type: string
          format: uuid
          readOnly: true
        name:
          type: string
          readOnly: true
      required:
      - color
      - id
      - name
    V2TagAssignmentsUpdate:
      type: object
      properties:
        tags:
          type: array
          items:
            type: string
            maxLength: 64
          maxItems: 64
        tagIds:
          type: array
          items:
            type: string
            format: uuid
          maxItems: 64
  securitySchemes:
    tokenAuth:
      type: apiKey
      in: header
      name: Authorization
      description: Token-based authentication with required prefix "Token"