/
OC
octoperf
/
OctoPerf API
Search skmtc…
⌘K
Docs
Sign in
Sign in
APIs
Generators
Stacks
Projects
Docs
History
Schema
Sources
Checked 15h ago · Updated 4w ago
latest
OpenAPI 3.1.0
OctoPerf Terms Of Service
2026-07-27
312
221
345.2 KB
4b624af2cb6e
Analysis - Bench Information
2
post
Get action ids by Bench Result ids
get
Load generator IDs grouped by regions
Analysis - Bench Report Templates
4
put
Update an existing template by ID
delete
Delete an item by ID
post
Create template from an existing report
get
Find reports by workspace ID
Analysis - Bench Reports
11
get
Find an item by ID
put
Update an existing item by ID
delete
Delete an item by ID
post
Create a new item
post
Get trend bench result ids
post
Create pre-defined report
post
Apply template to an existing report
post
Retrieve items by multiple ids
get
Get URLs of all the reports associated to the given benchResultId
get
Find Reports without items or configs by project ID
get
Find Reports by project ID
Analysis - Bench Reports - Usages
2
post
/analysis/bench-reports/usage/{projectId}/virtual-users
post
/analysis/bench-reports/usage/{projectId}/scenarios
Analysis - Errors
4
post
List errors
get
Query Errors by virtualUserId
get
Find http response by benchResultId, actionId and Timestamp
get
Find http request by benchResultId, actionId and Timestamp
Analysis - Graphs
2
post
Get percentiles chart graph points
post
Get line chart graph points
Analysis - JMeter Logs
8
get
Download file from folder with ID
post
Upload file inside folder with ID
delete
Delete file from folder with ID
post
Read XX lines from file inside folder with ID
get
Download ZIP containing all files inside folder with ID
get
Storage Quota from a given folder
get
List filenames from a given folder
get
List files from a given folder
Analysis - JUnit Reports
1
get
Generate JUnit report by benchResult ID
Analysis - Metrics
10
post
StatisticTreeReportItem Metrics
post
TopReportItem Metrics
post
StatisticTableReportItem Metrics
post
SummaryReportItem Metrics
post
StackedChartReportItem Metrics
post
PieChartReportItem Metrics
post
Get area range chart result
post
Insights list
get
Test-wide pre-defined Metrics
get
Get all metrics by charts
Analysis - Prometheus
1
get
Prometheus Metrics Exporter (Global Test Metrics)
Analysis - Textual Monitors
1
post
Find textual monitors by benchResult ID
Analysis - Threshold Alarms
2
post
Query threshold alarms by report item
post
Query threshold alarms by benchResult IDs
b-0
2
get
/.well-known/oauth-protected-resource/mcp
get
/.well-known/oauth-protected-resource
Design - Action Names
1
get
Maps action ids to action names
Design - Assertions
2
post
Execute against a Recorded Request / Response
post
Execute Against a Validation Request / Response
Design - Correlation Frameworks
7
get
Find an item by ID
put
Update an existing item by ID
delete
Delete an item by ID
get
/design/correlation-frameworks
post
Create a new item
post
Retrieve items by multiple ids
get
/design/correlation-frameworks/defaultIds
Design - Correlation Rules
6
get
Find an item by ID
put
Update an existing item by ID
delete
Delete an item by ID
post
Create a new item
post
Retrieve items by multiple ids
get
Find rules by project ID
Design - Fake Data Generator
5
put
/design/fake-data/csv/{locale}
post
/design/fake-data/samples/{locale}
post
/design/fake-data/csv/preview/{locale}
get
/design/fake-data
get
/design/fake-data/locales
Design - Http Servers
10
get
Find an item by ID
put
Update an existing item by ID
delete
Delete an item by ID
put
Replace source server ids by a target server id in all virtual users of the project
post
Create a new item
post
List by project ids
get
Find servers by project ID
post
Bulk Delete servers by project ID
post
Retrieve items by multiple ids
delete
Delete Unused Servers by Project ID
Design - Projects
7
get
Find an item by ID
put
Update an existing item by ID
delete
Delete an item by ID
post
Create a new item
post
Move project to another workspace
post
Retrieve items by multiple ids
get
List projects by workspace ID and type
Design - Projects - CSV Files
1
get
Detect delimiter from a given CSV file
Design - Projects - Files
8
get
Download file from folder with ID
post
Upload file inside folder with ID
delete
Delete file from folder with ID
post
Read XX lines from file inside folder with ID
get
Download ZIP containing all files inside folder with ID
get
Storage Quota from a given folder
get
List filenames from a given folder
get
List files from a given folder
Design - Sanity Check
3
post
Execute sanity check on multiple virtual users ids
get
Execute sanity check on virtual user with ID
get
Run sanity checks for CSV variables only
Design - Script Templates
1
get
/design/script-templates
Design - Servers - Usages
1
post
/design/http-servers/usage
Design - SLA Profiles
8
get
Find an item by ID
put
Update an existing item by ID
delete
Delete an item by ID
post
Create a new item
post
List by project ids
get
Find SLA Profiles by project ID
post
Bulk Delete SLA Profiles by project ID
post
Retrieve items by multiple ids
Design - SLA Profiles - Usages
1
post
/design/sla-profiles/usage
Design - Variables
9
get
Find an item by ID
put
Update an existing item by ID
delete
Delete an item by ID
post
Create a new item
post
Execute variable extractor on recorded response
post
Execute variable extractor on check response
post
Retrieve items by multiple ids
get
List variables by project ID
get
List variable names by project ID
Design - Virtual Users
12
get
Find an item by ID
put
Update an existing item by ID
delete
Delete an item by ID
post
Create a new item
post
List virtual users without children by project id
post
List virtual user descriptions by multiple ids
post
Lists virtual users for the specified report project ids
post
Retrieve items by multiple ids
get
Find virtual user description by id
get
List virtual users without children by project id
get
List virtual users by project ID
get
List virtual users by project ID
Design - Virtual Users - Exports
2
get
Export virtual user
get
Export virtual users (bundled as a zip)
Design - Virtual Users - Import and Export
2
post
Import a Zip Archive containing a Virtual User
get
Export a Virtual User as a Zip Archive
Design - Virtual Users - Imports
7
post
Create Virtual User with Scenario (optional) from JMeter JMX
post
Create WebDriver Virtual user from URL list
post
Create And Save Virtual user from URL list
post
Create Virtual user from Postman Archive
post
Create Virtual user from Playwright sources
post
Create Virtual User from JMeter JMX
post
Create Virtual user from HAR record
Design - Virtual Users - Tools
7
post
Execute search queries on entire Project
post
Execute search queries on specific VirtualUser
get
Get Check Response index
get
Get Virtual User ids having recorded
get
Execute correlation rules on virtual user with ID
get
Cleanups the Virtual User
get
List usable variable names
Design - Virtual Users - Usages
3
get
/design/virtual-users/usage/sla/{projectId}/{slaProfileId}
get
/design/virtual-users/usage/server/{projectId}/{serverId}
get
/design/virtual-users/usage/fragment/{projectId}/{fragmentId}
Monitoring - Connections
7
get
Find an item by ID
put
Update an existing item by ID
delete
Delete an item by ID
post
Create a new item
post
List by project ids
post
Retrieve items by multiple ids
get
List by project ID
OAuth Clients - Administration
4
post
/admin/oauth/clients/paginated
get
/admin/oauth/clients/{id}/grants
delete
/admin/oauth/clients/{id}
delete
/admin/oauth/clients/{clientId}/grants/{grantId}
OAuth Grants - Connected applications
2
get
/oauth/grants
delete
/oauth/grants/{id}
Payment - Subscriptions
2
get
Returns all the subscriptions attached to this user
get
/payment/subscriptions/{userId}
q-20
3
post
/admin/workspaces/paginated
get
/admin/workspaces
get
/admin/workspaces/by-username/{username}
q-4m
1
post
/auth/oauth2/resume
qgr
1
post
/auth/connect/register
qhm
1
get
/admin/audit-activity/{type}/{from}
qn-4
3
post
/admin/tokens/paginated
post
/admin/tokens/login-as
delete
/admin/tokens/{id}
qw-3
1
get
/admin/scheduler/{from}
Runtime - APMs
6
get
Find an item by ID
put
Update an existing item by ID
delete
Delete an item by ID
post
Create a new item
post
Retrieve items by multiple ids
get
/runtime/apms/by-project/{projectId}
Runtime - Integrations - Third-Party Tools
1
get
Generate Files for third party tools like Maven, GitLab or Github Actions
Runtime - Logs
1
get
Retrieve Test Logs by batchId
Runtime - Properties
1
get
Get runtime properties
Runtime - Remote Control
3
get
Get Runtime Properties
put
Set Runtime Property
post
Update Runtime Properties
Runtime - Scenarios
12
get
Find an item by ID
put
Update an existing item by ID
delete
Delete an item by ID
post
Create a new item
post
Executes the scenario with the given ID
post
JIRA Webhook - Executes the scenario with the given ID
post
Export the scenario as Json to be used by OctoPerf Maven Plugin
post
Lists scenarios for the specified project ids
post
Retrieve items by multiple ids
get
Lists scenarios with project ID
get
Lists scenarios without profiles or backendListeners by project ID
get
Lists scenarios with project ID
Runtime - Scenarios - Plans
1
post
Get subscriptions which can be used to run the given scenario
Runtime - Scenarios - Usages
1
post
/runtime/scenarios/usage/{projectId}
Runtime - Tests
9
get
Find an item by ID
put
Update an existing item by ID
delete
Delete an item by ID
post
Create a new item
post
Stops the test with benchResult ID
post
Retrieve items by multiple ids
get
Get design scenario id
get
Get test progress
get
Lists tests by project ID
System - Logged In Users
5
put
Update user billing information
post
Change Username
post
Set a new password
get
Logout current user
get
Get currently signed in User
System - MFA Management
4
get
List Mfas
put
Verify code and Save Mfa
post
Create New Mfa
delete
Delete Mfa
System - MFA Totp
1
post
Generate Mfa QR Code
System - Oauth2 / OpenID Connect
1
get
Get Oauth2 Settings for clientId
System - Product
1
get
Get Product information
System - Public MFA Totp
1
post
Login with MFA Token
System - Public Users
4
post
Reset Password
post
Registers a user with the given email
post
Login with username and password
post
Send an email to reset password
System - User Api Keys
2
post
Get Api Key
post
Reset Api Key
Tags
2
post
Bulk add or remove tags on a set of entities under a project
get
Aggregate all tags used in a project (project + VUs + scenarios + monitor connections + bench reports)
Task
2
post
Create and execute a new task
get
Find a task result by ID
Tokens - Short-lived Single-use Presigned Credentials
1
post
/tokens/ephemeral
Tokens - User Authentication Sessions
3
get
/tokens
get
/tokens/current
delete
/tokens/{id}
Workspaces
6
get
Find an item by ID
put
Update an existing item by ID
delete
Delete an item by ID
post
Create a new item
post
Retrieve items by multiple ids
get
List workspaces whose logged user is a member
Workspaces - Audit Logs
1
get
/workspaces/audit-logs/by-workspace/{workspaceId}
Workspaces - Members
10
get
Find an item by ID
put
Update an existing item by ID
delete
Delete an item by ID
post
Create a new item
get
List members indexed by username by workspace ID
post
Add a new workspace member for given workspace ID
post
Retrieve items by multiple ids
get
List workspace members by workspace ID
get
List a workspace's members with their username and role
get
List members of the authenticated user for a given workspace ID
Workspaces - Notifications
7
get
Find an item by ID
put
Update an existing item by ID
delete
Delete an item by ID
post
Create a new item
post
/workspaces/notifications/test
post
Retrieve items by multiple ids
get
List notifications by workspace
Workspaces - Notifications Jira helper
4
post
List available statuses for notification project (via projectId)
post
Check Jira Connection
post
List available boards
post
List available board transitions
Workspaces - Provider To Workspace
6
get
Find an item by ID
put
Update an existing item by ID
delete
Delete an item by ID
post
Create a new item
post
Retrieve items by multiple ids
get
Find Workspaces linked to the given Provider
Workspaces - Providers
12
get
Find an item by ID
put
Update an existing item by ID
delete
Delete an item by ID
post
Create a new item
post
Create a new item
post
Retrieve provider usages from given provider ids
post
Retrieve provider capacities by multiple ids
post
Retrieve items by multiple ids
get
Get Vagrantfile to run provider host from Vagrant
get
List Public providers
get
Get Provider host registration command
get
List providers by workspace ID
Workspaces - Providers - Agents
2
get
Lists agents by workspace ID
get
Lists agents by provider ID
Workspaces - Providers - Cloud Instances
5
put
/workspaces/docker-cloud-instances/terminate
put
/workspaces/docker-cloud-instances/reboot
post
/workspaces/docker-cloud-instances/provision/{providerId}/{regionId}/{zoneId}
get
/workspaces/docker-cloud-instances
get
/workspaces/docker-cloud-instances/by-provider/{providerId}
Workspaces - Providers - Configs
6
get
Find an item by ID
put
Update an existing item by ID
delete
Delete an item by ID
post
Create a new item
post
Get Provider Regions by id
post
Retrieve items by multiple ids
Workspaces - Providers - Static IPs
3
post
Allocate a new Static IP
get
List Static IPs by provider ID
delete
Release an existing Static IP
Workspaces - Scenario Notifications
1
get
List matching notifications from a given scenario id
Workspaces - Scheduler - Scheduled Jobs
7
get
Find by id
put
Update an existing scheduled job
delete
Delete an existing job
put
Enable an existing job
put
Disable an existing job
post
Create a new scheduled job
get
List scheduled jobs by project
Workspaces - Scheduler - Scheduled Jobs - Usage
1
post
/scheduler/scheduled-jobs/usage/{projectId}
Workspaces - Scheduler - Scheduled Runs
1
get
List scheduled runs by jobId
Workspaces
Find an item by ID
get
/workspaces/{id}
Path parameters
id
string
required
Response
OK