LoadTests endpoints

This page is generated from the OpenAPI document of the API (src/Vellum.Web/openapi.json) when the documentation is built.

GET /api/projects/{projectId}/load-tests/targets

Parameter	In	Type	Required
projectId	path	string (uuid)	yes

Status	Meaning	Body
200	OK	array of TargetDto

POST /api/projects/{projectId}/load-tests/targets

Parameter	In	Type	Required
projectId	path	string (uuid)	yes

Request body (application/json): TargetRequest

Field	Type	Required	Notes
name	string or null	yes
baseUrl	string or null	yes
environment	string or null	yes

Status	Meaning	Body
201	Created	TargetDto

PUT /api/projects/{projectId}/load-tests/targets/{targetId}

Parameter	In	Type	Required
projectId	path	string (uuid)	yes
targetId	path	string (uuid)	yes

Request body (application/json): TargetRequest

Field	Type	Required	Notes
name	string or null	yes
baseUrl	string or null	yes
environment	string or null	yes

Status	Meaning	Body
200	OK	TargetDto

DELETE /api/projects/{projectId}/load-tests/targets/{targetId}

Parameter	In	Type	Required
projectId	path	string (uuid)	yes
targetId	path	string (uuid)	yes

Status	Meaning	Body
204	No Content	none

POST /api/projects/{projectId}/load-tests/targets/{targetId}/authorise

Parameter	In	Type	Required
projectId	path	string (uuid)	yes
targetId	path	string (uuid)	yes

Request body (application/json): AuthoriseTargetRequest

Field	Type	Required	Notes
baseUrl	string or null	yes
environment	string or null	yes
version	integer (int64) or string (int64) or null	yes	pattern "^-?(?:0|[1-9]\\d*)$"

Status	Meaning	Body
200	OK	TargetDto
409	Conflict	ErrorResponse

DELETE /api/projects/{projectId}/load-tests/targets/{targetId}/authorisation

Parameter	In	Type	Required
projectId	path	string (uuid)	yes
targetId	path	string (uuid)	yes

Status	Meaning	Body
200	OK	TargetDto

PUT /api/projects/{projectId}/load-tests/targets/{targetId}/override

Parameter	In	Type	Required
projectId	path	string (uuid)	yes
targetId	path	string (uuid)	yes

Request body (application/json): TargetOverrideRequest

Field	Type	Required	Notes
allowNonIdempotent	boolean	yes
allowFailureInjection	boolean	yes
reason	string or null	yes
confirmName	string or null	yes

Status	Meaning	Body
200	OK	TargetDto

GET /api/projects/{projectId}/load-tests/scripts

Parameter	In	Type	Required
projectId	path	string (uuid)	yes

Status	Meaning	Body
200	OK	array of ScriptDto

POST /api/projects/{projectId}/load-tests/scripts

Parameter	In	Type	Required
projectId	path	string (uuid)	yes
branchId	query	string (uuid)	no

Request body (application/json): GenerateScriptRequest

Field	Type	Required	Notes
targetId	string (uuid)	yes
profileId	string (uuid)	yes

Status	Meaning	Body
200	OK	ScriptDto
201	Created	ScriptDto
422	Unprocessable Entity	ScriptRefusedResponse

GET /api/projects/{projectId}/load-tests/scripts/{scriptId}

Parameter	In	Type	Required
projectId	path	string (uuid)	yes
scriptId	path	string (uuid)	yes

Status	Meaning	Body
200	OK	ScriptDto

GET /api/projects/{projectId}/load-tests/results

Parameter	In	Type	Required
projectId	path	string (uuid)	yes

Status	Meaning	Body
200	OK	array of MeasuredResultSummaryDto

POST /api/projects/{projectId}/load-tests/results

Parameter	In	Type	Required
projectId	path	string (uuid)	yes

Request body (application/json): any

Status	Meaning	Body
201	Created	MeasuredResultDto
400	Bad Request	ErrorResponse
409	Conflict	ErrorResponse
413	Payload Too Large	ErrorResponse
422	Unprocessable Entity	ResultRefusedResponse

GET /api/projects/{projectId}/load-tests/results/{resultId}

Parameter	In	Type	Required
projectId	path	string (uuid)	yes
resultId	path	string (uuid)	yes

Status	Meaning	Body
200	OK	MeasuredResultDto

DELETE /api/projects/{projectId}/load-tests/results/{resultId}

Parameter	In	Type	Required
projectId	path	string (uuid)	yes
resultId	path	string (uuid)	yes

Status	Meaning	Body
204	No Content	none
409	Conflict	ErrorResponse

GET /api/projects/{projectId}/load-tests/compare/estimate

Parameter	In	Type	Required
projectId	path	string (uuid)	yes
resultId	query	string (uuid)	yes
runId	query	string (uuid)	yes

Status	Meaning	Body
200	OK	EstimateComparisonDto

GET /api/projects/{projectId}/load-tests/compare/results

Parameter	In	Type	Required
projectId	path	string (uuid)	yes
baseline	query	string (uuid)	yes
candidate	query	string (uuid)	yes

Status	Meaning	Body
200	OK	RegressionDto