Apache JMeter · JSON Structure

Rest Api Test Run Request Structure

Request to start a JMeter test

Type: object Properties: 2
API TestingJavaLoad TestingOpen SourcePerformance TestingStress Testing

TestRunRequest is a JSON Structure definition published by Apache JMeter, describing 2 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

testPlan properties

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑ 
{
  "type": "object",
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/apache-jmeter/refs/heads/main/json-structure/rest-api-test-run-request-structure.json",
  "name": "TestRunRequest",
  "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"
    }
  }
}