/
OC
octoperf
/
OctoPerf API
Search skmtc…
⌘K
Docs
Sign in
Sign in
APIs
Generators
Stacks
Projects
Docs
History
Schema
Sources
Checked 17h ago · Updated 4w ago
View markdown
octoperf
OctoPerf API
get
Get Provider host registration command
latest
OpenAPI 3.1.0
OctoPerf Terms Of Service
2026-07-27
312
221
345.2 KB
4b624af2cb6e
Analysis - Bench Information
2
Analysis - Bench Report Templates
4
Analysis - Bench Reports
11
Analysis - Bench Reports - Usages
2
Analysis - Errors
4
Analysis - Graphs
2
Analysis - JMeter Logs
8
Analysis - JUnit Reports
1
Analysis - Metrics
10
Analysis - Prometheus
1
Analysis - Textual Monitors
1
Analysis - Threshold Alarms
2
b-0
2
Design - Action Names
1
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
8
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
7
Design - Virtual Users - Tools
7
Design - Virtual Users - Usages
3
Monitoring - Connections
7
OAuth Clients - Administration
4
OAuth Grants - Connected applications
2
Payment - Subscriptions
2
q-20
3
q-4m
1
qgr
1
qhm
1
qn-4
3
qw-3
1
Runtime - APMs
6
Runtime - Integrations - Third-Party Tools
1
Runtime - Logs
1
Runtime - Properties
1
Runtime - Remote Control
3
Runtime - Scenarios
12
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
Tags
2
Task
2
Tokens - Short-lived Single-use Presigned Credentials
1
Tokens - User Authentication Sessions
3
Workspaces
6
Workspaces - Audit Logs
1
Workspaces - Members
10
Workspaces - Notifications
7
Workspaces - Notifications Jira helper
4
Workspaces - Provider To Workspace
6
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
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
Workspaces - Providers
Get Provider host registration command
get
/workspaces/docker-providers/command/{providerId}/{regionName}
Path parameters
providerId
string
required
regionName
string
required
Response
OK