Tricentis

Tricentis Rule API

Rule API

GitHub OpenAPI

Operations 6

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /rules List a project's Pulse rules · Get all rules of a project #
Ask an LLM
“Which automation rules are set up in my Pulse project?”
“Can I page through Pulse rules with an offset?”
Tell an agent
List the rules in project {project}.
Show the first {first} rules of project {project}.
POST /rules Create a Pulse rule · Create a rule #
Ask an LLM
“How do I create a rule that runs actions when a trigger fires?”
“Can a new Pulse rule be created inactive?”
Tell an agent
Create rule {name} in project {project} with active {active}.
Create an active rule {name} in {project} linking trigger {trigger} to actions {actions}.
GET /rules/{id} Get a Pulse rule · Get a rule #
Ask an LLM
“Which trigger and actions does a given rule use?”
“Can I look up one Pulse rule by id?”
Tell an agent
Get rule {id}.
Show the trigger and actions of rule {id}.
PUT /rules/{id} Replace a Pulse rule · Update a rule #
Ask an LLM
“Can I fully replace a rule's trigger and actions with PUT?”
“What must I resend to overwrite a Pulse rule?”
Tell an agent
Replace rule {id} with name {name}, active {active}, in project {project}.
Overwrite rule {id} so it uses trigger {trigger}.
PATCH /rules/{id} Patch a Pulse rule · Update a rule #
Ask an LLM
“Can I just switch a rule off with PATCH?”
“Is there a partial update to change a rule's actions?”
Tell an agent
Patch rule {id} to set active to {active}.
Partially update rule {id} to run actions {actions}.
DELETE /rules/{id} Delete a Pulse rule · Delete a rule #
Ask an LLM
“How do I remove an automation rule from Pulse?”
“Can I delete one rule by id?”
Tell an agent destructive · confirm first
Delete rule {id}.
Remove Pulse rule {id} permanently.

Documentation

📖
Documentation
https://docs.tricentis.com/qtest-saas/content/apis/overview/qtest_api_specification.htm
📖
APIReference
https://api.qasymphony.com/
📖
Documentation
https://docs.tricentis.com/qtest-saas/content/apis/data_export/use_data_export_api.htm
📖
APIReference
https://neoload-api.saas.neotys.com/explore/
📖
APIReference
https://api.ttm4j.tricentis.com/
📖
Documentation
https://docs.tricentis.com/ttm-for-jira/content/developer/api_overview.htm

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/tricentis/refs/heads/main/openapi/tricentis-rule-api-openapi.yml

Other Resources

🔗
Webhooks
https://raw.githubusercontent.com/api-evangelist/tricentis/refs/heads/main/asyncapi/tricentis-qtest-webhooks.yml
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/tricentis/refs/heads/main/data-model/tricentis-data-model.yml
🔗
ToolCrosswalk
https://raw.githubusercontent.com/api-evangelist/tricentis/refs/heads/main/mcp/tricentis-tool-crosswalk.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/tricentis:tricentis-rule-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

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

tricentis-rule-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  version: 2025.2.0
  title: qTest Pulse Rule API
  description: Rule API
servers:
- url: https://pulse-us-east-1.qtestnet.com/api
security:
- qtestToken: []
  qtestUrl: []
tags:
- name: Rule
  description: Rule API
paths:
  /rules:
    get:
      tags:
      - Rule
      summary: Get all rules of a project
      description: To get all rules of a project
      parameters:
      - $ref: '#/components/parameters/ProjectIdQuery'
      - $ref: '#/components/parameters/FirstQuery'
      - $ref: '#/components/parameters/OffsetQuery'
      responses:
        400:
          $ref: '#/components/responses/BadRequest'
        401:
          $ref: '#/components/responses/Unauthorized'
        403:
          $ref: '#/components/responses/Forbidden'
        default:
          $ref: '#/components/responses/Default'
        200:
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Rule'
      operationId: getRules
      x-operation-id-source: derived
    post:
      tags:
      - Rule
      summary: Create a rule
      description: To create a rule
      responses:
        400:
          $ref: '#/components/responses/BadRequest'
        401:
          $ref: '#/components/responses/Unauthorized'
        403:
          $ref: '#/components/responses/Forbidden'
        default:
          $ref: '#/components/responses/Default'
        201:
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Rule'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RuleInput'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/RuleInput'
        required: true
      operationId: postRules
      x-operation-id-source: derived
  /rules/{id}:
    parameters:
    - $ref: '#/components/parameters/IdPath'
    get:
      tags:
      - Rule
      summary: Get a rule
      description: To get a rule by id
      responses:
        400:
          $ref: '#/components/responses/BadRequest'
        401:
          $ref: '#/components/responses/Unauthorized'
        403:
          $ref: '#/components/responses/Forbidden'
        default:
          $ref: '#/components/responses/Default'
        200:
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Rule'
      operationId: getRulesById
      x-operation-id-source: derived
    put:
      tags:
      - Rule
      summary: Update a rule
      responses:
        400:
          $ref: '#/components/responses/BadRequest'
        401:
          $ref: '#/components/responses/Unauthorized'
        403:
          $ref: '#/components/responses/Forbidden'
        default:
          $ref: '#/components/responses/Default'
        200:
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Rule'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RuleInput'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/RuleInput'
        required: true
      operationId: putRulesById
      x-operation-id-source: derived
    patch:
      tags:
      - Rule
      summary: Update a rule
      responses:
        400:
          $ref: '#/components/responses/BadRequest'
        401:
          $ref: '#/components/responses/Unauthorized'
        403:
          $ref: '#/components/responses/Forbidden'
        default:
          $ref: '#/components/responses/Default'
        200:
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Rule'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RuleInput'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/RuleInput'
        required: true
      operationId: patchRulesById
      x-operation-id-source: derived
    delete:
      tags:
      - Rule
      summary: Delete a rule
      description: To delete a rule
      responses:
        400:
          $ref: '#/components/responses/BadRequest'
        401:
          $ref: '#/components/responses/Unauthorized'
        403:
          $ref: '#/components/responses/Forbidden'
        default:
          $ref: '#/components/responses/Default'
        200:
          description: OK
          content:
            application/json:
              schema:
                type: string
      operationId: deleteRulesById
      x-operation-id-source: derived
components:
  parameters:
    IdPath:
      name: id
      in: path
      required: true
      description: ID of the project
      schema:
        type: string
    FirstQuery:
      name: first
      in: query
      description: Return only the first N results
      schema:
        type: integer
        format: int64
    ProjectIdQuery:
      name: projectId
      in: query
      required: true
      description: ID of the project
      schema:
        type: string
    OffsetQuery:
      name: offset
      in: query
      description: Skip the first N results
      schema:
        type: integer
        format: int64
  responses:
    Unauthorized:
      description: Unauthorized
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Default:
      description: Error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Forbidden:
      description: Forbidden
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    BadRequest:
      description: Bad Request
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  schemas:
    Error:
      required:
      - message
      properties:
        message:
          type: string
    RuleInput:
      allOf:
      - $ref: '#/components/schemas/ProjectDoc'
      - required:
        - name
        - active
        properties:
          name:
            type: string
          active:
            type: boolean
          triggerId:
            type: string
          actionIds:
            type: array
            items:
              type: string
    Rule:
      allOf:
      - $ref: '#/components/schemas/Doc'
      - $ref: '#/components/schemas/RuleInput'
    Doc:
      required:
      - id
      properties:
        id:
          type: string
    ProjectDoc:
      required:
      - projectId
      properties:
        projectId:
          type: string
  securitySchemes:
    qtestToken:
      type: apiKey
      in: header
      name: Authorization
    qtestUrl:
      type: apiKey
      in: header
      name: x-qtest-url
externalDocs:
  description: Introduction to qTest Pulse API
  url: https://documentation.tricentis.com/qtest/od/en/content/apis/apis/common_apis.htm