/

/OctoPerf API

APIs
Generators
Stacks
Projects

Docs
History
Schema
Sources

v2

latestOpenAPI 3.1.0OctoPerf Terms Of Service2026-07-27312221345.2 KB

Workspaces

Find an item by ID

get/workspaces/{id}

Path parameters

idstring required

Response

OK

All 312 operations

get Find an item by ID
put Update an existing item by ID
delete Delete an item by ID
get Find an item by ID
put Update an existing item by ID
delete Delete an item by ID
get Find an item by ID
put Update an existing item by ID
delete Delete an item by ID
get Find an item by ID
put Update an existing item by ID
delete Delete an item by ID
get Find an item by ID
put Update an existing item by ID
delete Delete an item by ID
get Find an item by ID
put Update an existing item by ID
delete Delete an item by ID
put /workspaces/docker-cloud-instances/terminate
put /workspaces/docker-cloud-instances/reboot
put Update user billing information
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
get Find an item by ID
put Update an existing item by ID
delete Delete an item by ID
get Get Runtime Properties
put Set Runtime Property
post Update Runtime Properties
get Find an item by ID
put Update an existing item by ID
delete Delete an item by ID
get Find an item by ID
put Update an existing item by ID
delete Delete an item by ID
get Find an item by ID
put Update an existing item by ID
delete Delete an item by ID
get List Mfas
put Verify code and Save Mfa
post Create New Mfa
get Find an item by ID
put Update an existing item by ID
delete Delete an item by ID
get Find an item by ID
put Update an existing item by ID
delete Delete an item by ID
get Find an item by ID
put Update an existing item by ID
delete Delete an item by ID
get Find an item by ID
put Update an existing item by ID
delete Delete an item by ID
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
put /design/fake-data/csv/{locale}
get Find an item by ID
put Update an existing item by ID
delete Delete an item by ID
get Find an item by ID
put Update an existing item by ID
delete Delete an item by ID
get Find an item by ID
put Update an existing item by ID
delete Delete an item by ID
put Update an existing template by ID
delete Delete an item by ID
post Create a new item
post Create a new item
post /workspaces/notifications/test
post List available statuses for notification project (via projectId)
post Check Jira Connection
post List available boards
post List available board transitions
post Retrieve items by multiple ids
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
post Create a new item
post Create a new item
post Retrieve provider usages from given provider ids
post Allocate a new Static IP
post Retrieve provider capacities by multiple ids
post Retrieve items by multiple ids
post Create a new item
post Retrieve items by multiple ids
post Create a new item
post Get Provider Regions by id
post Retrieve items by multiple ids
post /workspaces/docker-cloud-instances/provision/{providerId}/{regionId}/{zoneId}
post Retrieve items by multiple ids
post Change Username
post Set a new password
post Get Api Key
post Reset Api Key
post /tokens/ephemeral
post Create and execute a new task
post Create a new scheduled job
post /scheduler/scheduled-jobs/usage/{projectId}
post Create a new item
post /runtime/scenarios/usage/{projectId}
post Executes the scenario with the given ID
post Get subscriptions which can be used to run the given scenario
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
post Create a new item
post Stops the test with benchResult ID
post Retrieve items by multiple ids
post Create a new item
post Retrieve items by multiple ids
post Reset Password
post Registers a user with the given email
post Login with username and password
post Send an email to reset password
post Login with MFA Token
post Create a new item
post List by project ids
post Retrieve items by multiple ids
post Generate Mfa QR Code
post Create Virtual User with Scenario (optional) from JMeter JMX
post Create a new item
post Execute search queries on entire Project
post Execute search queries on specific VirtualUser
post Execute sanity check on multiple virtual users ids
post Import a Zip Archive containing a Virtual User
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
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
post Create a new item
post /design/sla-profiles/usage
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
post Create a new item
post Bulk add or remove tags on a set of entities under a project
post Move project to another workspace
post Retrieve items by multiple ids
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
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
post Create a new item
post /design/http-servers/usage
post List by project ids
get Find servers by project ID
post Bulk Delete servers by project ID
post Retrieve items by multiple ids
post /design/fake-data/samples/{locale}
post /design/fake-data/csv/preview/{locale}
post Create a new item
post Retrieve items by multiple ids
get /design/correlation-frameworks
post Create a new item
post Retrieve items by multiple ids
post Execute against a Recorded Request / Response
post Execute Against a Validation Request / Response
post /auth/oauth2/resume
post /auth/connect/register
post Query threshold alarms by report item
post Query threshold alarms by benchResult IDs
post Find textual monitors by benchResult ID
post StatisticTreeReportItem Metrics
post TopReportItem Metrics
post StatisticTableReportItem Metrics
post SummaryReportItem Metrics
post StackedChartReportItem Metrics
post PieChartReportItem Metrics
post Get area range chart result
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
post Insights list
post Get percentiles chart graph points
post Get line chart graph points
post List errors
post Create a new item
post /analysis/bench-reports/usage/{projectId}/virtual-users
post /analysis/bench-reports/usage/{projectId}/scenarios
post Get trend bench result ids
post Create pre-defined report
post Apply template to an existing report
post Retrieve items by multiple ids
post Create template from an existing report
post Get action ids by Bench Result ids
post /admin/workspaces/paginated
post /admin/tokens/paginated
post /admin/tokens/login-as
post /admin/oauth/clients/paginated
get List matching notifications from a given scenario id
get List notifications by workspace
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
get List workspaces whose logged user is a member
get Get Vagrantfile to run provider host from Vagrant
get List Static IPs by provider ID
get List Public providers
get Get Provider host registration command
get List providers by workspace ID
get Find Workspaces linked to the given Provider
get /workspaces/docker-cloud-instances
get /workspaces/docker-cloud-instances/by-provider/{providerId}
get /workspaces/audit-logs/by-workspace/{workspaceId}
get Lists agents by workspace ID
get Lists agents by provider ID
get Logout current user
get Get currently signed in User
get /tokens
get /tokens/current
get Find a task result by ID
get List scheduled runs by jobId
get List scheduled jobs by project
get Lists scenarios with project ID
get Lists scenarios without profiles or backendListeners by project ID
get Lists scenarios with project ID
get Get runtime properties
get Generate Files for third party tools like Maven, GitLab or Github Actions
get Retrieve Test Logs by batchId
get Get design scenario id
get Get test progress
get Lists tests by project ID
get /runtime/apms/by-project/{projectId}
get Get Oauth2 Settings for clientId
get Get Product information
get Returns all the subscriptions attached to this user
get /payment/subscriptions/{userId}
get /oauth/grants
get List by project ID
get /design/virtual-users/usage/sla/{projectId}/{slaProfileId}
get /design/virtual-users/usage/server/{projectId}/{serverId}
get /design/virtual-users/usage/fragment/{projectId}/{fragmentId}
get Execute sanity check on virtual user with ID
get Run sanity checks for CSV variables only
get Get Check Response index
get Get Virtual User ids having recorded
get Export a Virtual User as a Zip Archive
get Find virtual user description by id
get List virtual users without children by project id
get Execute correlation rules on virtual user with ID
get Cleanups the Virtual User
get List virtual users by project ID
get List virtual users by project ID
get List usable variable names
get List variables by project ID
get List variable names by project ID
get /design/script-templates
get Aggregate all tags used in a project (project + VUs + scenarios + monitor connections + bench reports)
get List projects by workspace ID and type
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
get Detect delimiter from a given CSV file
get Maps action ids to action names
get /design/fake-data
get /design/fake-data/locales
get Export virtual user
get Export virtual users (bundled as a zip)
get Find rules by project ID
get /design/correlation-frameworks/defaultIds
get Prometheus Metrics Exporter (Global Test Metrics)
get Test-wide pre-defined Metrics
get Get all metrics by charts
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
get Generate JUnit report by benchResult ID
get Query Errors by virtualUserId
get Find http response by benchResultId, actionId and Timestamp
get Find http request by benchResultId, actionId and Timestamp
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
get Find reports by workspace ID
get Load generator IDs grouped by regions
get /admin/workspaces
get /admin/workspaces/by-username/{username}
get /admin/scheduler/{from}
get /admin/oauth/clients/{id}/grants
get /admin/audit-activity/{type}/{from}
get /.well-known/oauth-protected-resource/mcp
get /.well-known/oauth-protected-resource
delete Release an existing Static IP
delete /tokens/{id}
delete /oauth/grants/{id}
delete Delete Mfa
delete Delete Unused Servers by Project ID
delete /admin/tokens/{id}
delete /admin/oauth/clients/{id}
delete /admin/oauth/clients/{clientId}/grants/{grantId}