Azure Load Testing data plane
These APIs allow end users to create, view and run load tests using Azure Load Test Service.
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
These APIs allow end users to create, view and run load tests using Azure Load Test Service.
Endpoints 40
Operations
- GETGet the status of a long running operation.
/operations/:operationId?api-version=stringGet the status of a long running operation.
Test
- GETGet all load tests by the fully qualified resource Id e.g
subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName}.
/tests?api-version=string&orderby=string&search=string&lastModifiedStartTime=2024-01-01T00:00:00Z&lastModifiedEndTime=2024-01-01T00:00:00Z&maxpagesize=50Get all load tests by the fully qualified resource Id e.g subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName}. - GETGet load test details by test Id
/tests/:testId?api-version=stringGet load test details by test Id - DELETEDelete a test by its test Id.
/tests/:testId?api-version=stringDelete a test by its test Id. - PATCHCreate a new test or update an existing test by providing the test Id.
/tests/:testId?api-version=stringCreate a new test or update an existing test by providing the test Id. - POSTClone a load test.
/tests/:testId:clone?api-version=stringClone the given test with optional overrides applied to the clone test. - POSTGenerate load test plan recommendations.
/tests/:testId:generateTestPlanRecommendations?api-version=stringGenerate AI Recommendations to author a load test plan using the uploaded browser recording file. - GETGet associated app component (collection of azure resources) for the given test.
/tests/:testId/app-components?api-version=stringGet associated app component (collection of azure resources) for the given test. - PATCHAdd an app component to a test.
/tests/:testId/app-components?api-version=stringAdd an app component to a test by providing the resource Id, name and type. - GETGet all test files.
/tests/:testId/files?api-version=stringGet all test files. - GETGet all the files that are associated with a test.
/tests/:testId/files/:fileName?api-version=stringGet all the files that are associated with a test. - PUTUpload input file for a given test Id. File size can't be more than 50 MB.
Existing file with same name for the given test will be overwritten. File
should be provided in the request body as application/octet-stream.
/tests/:testId/files/:fileName?api-version=string&fileType=JMX_FILEUpload input file for a given test Id. File size can't be more than 50 MB. Existing file with same name for the given test will be overwritten. File should be… - DELETEDelete file by the file name for a test
/tests/:testId/files/:fileName?api-version=stringDelete file by the file name for a test - GETList server metrics configuration for the given test.
/tests/:testId/server-metrics-config?api-version=stringList server metrics configuration for the given test. - PATCHConfigure server metrics for a test
/tests/:testId/server-metrics-config?api-version=stringConfigure server metrics for a test
TestRun
- GETGet all test runs for the given filters.
/test-runs?api-version=string&orderby=string&search=string&testId=string&executionFrom=2024-01-01T00:00:00Z&executionTo=2024-01-01T00:00:00Z&status=string&maxpagesize=50&createdByTypes=string&testIds=stringGet all test runs for the given filters. - GETGet test run details by test run Id.
/test-runs/:testRunId?api-version=stringGet test run details by test run Id. - DELETEDelete an existing load test run.
/test-runs/:testRunId?api-version=stringDelete an existing load test run by providing the testRunId. - PATCHCreate and start a new test run with the given test run Id.
/test-runs/:testRunId?api-version=string&oldTestRunId=stringCreate and start a new test run with the given test run Id. - POSTStop test run by test run Id.
/test-runs/:testRunId:stop?api-version=stringStop test run by test run Id. - GETGet associated app component (collection of azure resources) for the given test
run.
/test-runs/:testRunId/app-components?api-version=stringGet associated app component (collection of azure resources) for the given test run. - PATCHAdd an app component to a test run.
/test-runs/:testRunId/app-components?api-version=stringAdd an app component to a test run by providing the resource Id, name and type. - GETGet test run file by file name.
/test-runs/:testRunId/files/:fileName?api-version=stringGet test run file by file name. - GETGet the latest insights for the test run.
/test-runs/:testRunId/insights/latest?api-version=stringGet the latest insights for the test run. - PATCHUpdate the latest insights for the test run.
/test-runs/:testRunId/insights/latest?api-version=stringUpdate the latest insights for the test run. - POSTGenerate insights for the test run.
/test-runs/:testRunId/insights:generate?api-version=stringGenerate insights for the test run. - GETList the metric definitions for a load test run.
/test-runs/:testRunId/metric-definitions?api-version=string&metricNamespace=stringList the metric definitions for a load test run. - GETList the dimension values for the given metric dimension name.
/test-runs/:testRunId/metric-dimensions/:name/values?api-version=string&metricname=string&interval=PT1M&metricNamespace=string×pan=stringList the dimension values for the given metric dimension name. - GETList the metric namespaces for a load test run.
/test-runs/:testRunId/metric-namespaces?api-version=stringList the metric namespaces for a load test run. - POSTList the metric values for a load test run.
/test-runs/:testRunId/metrics?api-version=string&aggregation=string&metricname=string&interval=PT1M&metricNamespace=string×pan=stringList the metric values for a load test run. - GETGet associated server metrics configuration for the given test run.
/test-runs/:testRunId/server-metrics-config?api-version=stringGet associated server metrics configuration for the given test run. - PATCHConfigure server metrics for a test run
/test-runs/:testRunId/server-metrics-config?api-version=stringConfigure server metrics for a test run
Trigger
- GETGet all triggers for the given filters.
/triggers?api-version=string&testIds=string&states=Active&lastModifiedStartTime=2024-01-01T00:00:00Z&lastModifiedEndTime=2024-01-01T00:00:00Z&maxpagesize=50Get all triggers for the given filters. - GETGet trigger details by trigger Id.
/triggers/:triggerId?api-version=stringGet trigger details by trigger Id. - DELETEDelete a trigger by its trigger Id.
/triggers/:triggerId?api-version=stringDelete a trigger by its trigger Id. - PATCHCreate a new trigger or update an existing trigger.
/triggers/:triggerId?api-version=stringCreate a new trigger or update an existing trigger by providing the trigger Id.
NotificationRule
- GETGet all notification rules for the given filters.
/notification-rules?api-version=string&testIds=string&scopes=string&lastModifiedStartTime=2024-01-01T00:00:00Z&lastModifiedEndTime=2024-01-01T00:00:00Z&maxpagesize=50Get all notification rules for the given filters. - GETGet notification rule details by notification rule Id.
/notification-rules/:notificationRuleId?api-version=stringGet notification rule details by notification rule Id. - DELETEDelete a notification rule by its notification rule Id.
/notification-rules/:notificationRuleId?api-version=stringDelete a notification rule by its notification rule Id. - PATCHCreate a new notification rule or update an existing notification rule.
/notification-rules/:notificationRuleId?api-version=stringCreate a new notification rule or update an existing notification rule by providing the notification rule Id.
API details
- Authentication
- OAuth 2.0 (implicit flow) with 1 scope
- Operations
- 40 operations on 25 pathsGET 20PATCH 9POST 5DELETE 5PUT 1
- Main resources
- TestRun 17Test 14NotificationRule 4Trigger 4Operations 1
- Response formats
application/json- Description format
- Swagger 2.0, API version
2026-04-01 - Links
- OpenAPI document
How to test the Azure Load Testing data plane in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Azure Load Testing data plane collection, without the publisher's secrets.
- Add your credentialsThis API uses OAuth 2.0 (implicit flow) with 1 scope. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Get the status of a long running operation.” (GET /operations/:operationId?api-version=string), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Azure Load Testing data plane?
These APIs allow end users to create, view and run load tests using Azure Load Test Service. It is listed under Data & analytics and has 40 endpoints.
Who publishes the Azure Load Testing data plane?
It is listed from Microsoft Azure's public API description (an OpenAPI document), not published by Microsoft Azure on Swastik Codes. Anyone who controls azure.com can claim the profile by adding a DNS TXT record.
How do I authenticate with the Azure Load Testing data plane?
With OAuth 2.0 (implicit flow) with 1 scope.
How many endpoints does the Azure Load Testing data plane have?
40 operations on 25 paths (20 GET, 9 PATCH, 5 POST, 5 DELETE, 1 PUT). The largest groups are TestRun, Test, NotificationRule, Trigger.
Is forking the Azure Load Testing data plane free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.