/
OC
octoperf
/
OctoPerf API
Search skmtc…
⌘K
Changes
Docs
Sign in
Sign in
APIs
Generators
Stacks
Projects
Docs
History
Schema
Updated on 2026-09-26
Details
Filter operations
Analysis - Bench Data Migration
2
Analysis - Bench Information
7
Analysis - Bench Report Templates
4
Analysis - Bench Reports
12
Analysis - Bench Reports - Usages
2
Analysis - Errors
3
Analysis - Graphs
2
Analysis - JMeter Logs
8
Analysis - JTL
1
Analysis - JUnit Reports
1
Analysis - Metrics
10
Analysis - Prometheus
1
Analysis - Textual Monitors
1
Analysis - Threshold Alarms
2
Design - Action Names
1
Design - Action Paths
2
Design - Assertions
2
Design - Correlation Frameworks
7
Design - Correlation Rules
6
Design - Fake Data Generator
5
Design - Http Servers
10
Design - Projects
7
Design - Projects - CSV Files
1
Design - Projects - Files
8
Design - Sanity Check
3
Design - Script Templates
1
Design - Servers - Usages
1
Design - SLA Profiles
9
Design - SLA Profiles - Usages
1
Design - Variables
9
Design - Virtual Users
12
Design - Virtual Users - Exports
2
Design - Virtual Users - Import and Export
2
Design - Virtual Users - Imports
11
Design - Virtual Users - Tools
7
Design - Virtual Users - Usages
3
hx
3
Monitoring - Connections
7
nau
1
nmv
1
nn-7
1
nr-9
1
nzg
2
OAuth Clients - Administration
4
OAuth Grants - Connected applications
2
Payment - Subscriptions
2
Runtime - APMs
6
Runtime - Integrations - Third-Party Tools
1
Runtime - Logs
1
Runtime - Properties
1
Runtime - Remote Control
3
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
Runtime - Scenarios - Usages
1
Runtime - Tests
9
System - Logged In Users
5
System - MFA Management
4
System - MFA Totp
1
System - Oauth2 / OpenID Connect
1
System - Product
1
System - Public MFA Totp
1
System - Public Users
4
System - User Api Keys
2
System - User Identity Proofs
1
Tags
2
Task
2
Tokens - Short-lived Single-use Presigned Credentials
1
Tokens - User Authentication Sessions
3
vi
3
Workspaces
6
Workspaces - Audit Logs
1
Workspaces - Members
11
Workspaces - Notifications
7
Workspaces - Notifications Jira helper
4
Workspaces - Provider To Workspace
6
Workspaces - Providers
12
Workspaces - Providers - Agents
2
Workspaces - Providers - Cloud Instances
5
Workspaces - Providers - Configs
6
Workspaces - Providers - Static IPs
3
Workspaces - Scenario Notifications
1
Workspaces - Scheduler - Scheduled Jobs
7
Workspaces - Scheduler - Scheduled Jobs - Usage
1
Workspaces - Scheduler - Scheduled Runs
1
Runtime - Scenarios
Export the scenario as Json to be used by OctoPerf Maven Plugin
post
/runtime/scenarios/export/maven
Request body
Scenario
required
id
string
nullable
userId
string
nullable
projectId
string
nullable
name
string
description
string
nullable
userProfiles
UserProfile[]
nullable
mode
'STANDARD'
|
'FUNCTIONAL'
nullable
created
string
date-time
nullable
lastModified
string
date-time
nullable
tags
string[]
nullable
Response
OK
Changes