OpenAPI Specification
openapi: 3.0.3
info:
title: Apache JMeter REST Results Tests API
description: REST API for Apache JMeter test control and monitoring. Provides endpoints for starting, stopping, and monitoring load tests remotely, and for accessing test results.
version: 5.6.3
license:
name: Apache 2.0
url: https://www.apache.org/licenses/LICENSE-2.0
contact:
email: dev@jmeter.apache.org
servers:
- url: http://localhost:4445
description: JMeter REST API server
tags:
- name: Tests
description: Test execution management
paths:
/run:
post:
operationId: startTest
summary: Apache JMeter Start Test
description: Start a JMeter load test with a given test plan.
tags:
- Tests
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/TestRunRequest'
examples:
startTestRequestExample:
summary: Default startTest request
x-microcks-default: true
value:
testPlan: /tests/my-load-test.jmx
properties: {}
responses:
'200':
description: Test started
content:
application/json:
schema:
$ref: '#/components/schemas/TestRunResponse'
examples:
startTest200Example:
summary: Default startTest 200 response
x-microcks-default: true
value:
testId: test-1234
status: running
startTime: 1718153645993
/stop:
post:
operationId: stopTest
summary: Apache JMeter Stop Test
description: Stop the currently running JMeter test.
tags:
- Tests
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
responses:
'200':
description: Test stopped
components:
schemas:
TestRunResponse:
type: object
description: Response from starting a test
properties:
testId:
type: string
description: Unique test run identifier
example: test-1234
status:
type: string
example: running
startTime:
type: integer
description: Test start timestamp
example: 1718153645993
TestRunRequest:
type: object
description: Request to start a JMeter test
properties:
testPlan:
type: string
description: Path to the JMeter test plan file
example: /tests/my-load-test.jmx
properties:
type: object
description: JMeter properties to override