Cloud API - E2E Monitoring Setup

Base URL: https://public-api.loadgen.cloud

This article documents End-to-End monitoring setup endpoints (canvas, wizard, schedules, sessions, flows, tests, SUT profiles, target environments, and related resources).

GetAgentDuafResults

Method: GET

Path: /api/services/app/DuafResult/GetAgentDuafResults

Operation ID: ApiServicesAppDuafresultGetagentduafresultsGet

Tag: DuafResult

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

• Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
• This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

| Name | In | Type | Required | Default | Notes |

|---|---|---|---:|---|---|

| AgentId | query | string (uuid) | No | | format: uuid |

| Sorting | query | string | No | | |

| SkipCount | query | integer (int32) | No | | format: int32

min: 0

max: 2147483647 |

| MaxResultCount | query | integer (int32) | No | | format: int32

min: 1

max: 2147483647 |

Request body

None

Response

Response envelope: ABP

• The actual payload is usually under the result property.
• Success is indicated by success: true. Errors are provided via error and unAuthorizedRequest.

200 OK response schema: GetDuafResultDto2PagedResultDto

Response fields

| Field | Type | Required | Description | Notes |

|---|---|---:|---|---|

| items | array | No | | |

| totalCount | integer (int32) | No | | format: int32 |

Example response

`json

{

"result": {

"totalCount": 0,

"items": [

{

"sessionId": "00000000-0000-0000-0000-000000000000",

"agentId": "00000000-0000-0000-0000-000000000000",

"actualTime": "2025-01-01T00:00:00Z"

}

]

},

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

curl -X GET "https://public-api.loadgen.cloud/api/services/app/DuafResult/GetAgentDuafResults?AgentId=00000000-0000-0000-0000-000000000000&Sorting=string&SkipCount=0" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/DuafResult/GetAgentDuafResults?AgentId=00000000-0000-0000-0000-000000000000&Sorting=string&SkipCount=0"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

Invoke-RestMethod -Method GET -Uri $uri -Headers $headers

`

GetAgentDuafResultsByDateRange

Method: GET

Path: /api/services/app/DuafResult/GetAgentDuafResultsByDateRange

Operation ID: ApiServicesAppDuafresultGetagentduafresultsbydaterangeGet

Tag: DuafResult

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

• Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
• This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

| Name | In | Type | Required | Default | Notes |

|---|---|---|---:|---|---|

| AgentId | query | string (uuid) | No | | format: uuid |

| StartDate | query | string (date-time) | No | | format: date-time |

| EndDate | query | string (date-time) | No | | format: date-time |

| LastMinutes | query | integer (int32) | No | | format: int32 |

| Excludes | query | array | No | | |

| Sorting | query | string | No | | |

Request body

None

Response

Response envelope: ABP

• The actual payload is usually under the result property.
• Success is indicated by success: true. Errors are provided via error and unAuthorizedRequest.

200 OK response schema: array

Response fields

None

Example response

`json

{

"result": [

{

"sessionId": "00000000-0000-0000-0000-000000000000",

"agentId": "00000000-0000-0000-0000-000000000000",

"actualTime": "2025-01-01T00:00:00Z"

}

],

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

curl -X GET "https://public-api.loadgen.cloud/api/services/app/DuafResult/GetAgentDuafResultsByDateRange?AgentId=00000000-0000-0000-0000-000000000000&StartDate=2025-01-01T00%3A00%3A00Z&EndDate=2025-01-01T00%3A00%3A00Z" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/DuafResult/GetAgentDuafResultsByDateRange?AgentId=00000000-0000-0000-0000-000000000000&StartDate=2025-01-01T00%3A00%3A00Z&EndDate=2025-01-01T00%3A00%3A00Z"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

Invoke-RestMethod -Method GET -Uri $uri -Headers $headers

`

GetScreenshotForDuafRow

Method: GET

Path: /api/services/app/DuafResult/GetScreenshotForDuafRow

Operation ID: ApiServicesAppDuafresultGetscreenshotforduafrowGet

Tag: DuafResult

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

• Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
• This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

| Name | In | Type | Required | Default | Notes |

|---|---|---|---:|---|---|

| id | query | string (uuid) | No | | format: uuid |

Request body

None

Response

Response envelope: ABP

• The actual payload is usually under the result property.
• Success is indicated by success: true. Errors are provided via error and unAuthorizedRequest.

200 OK response schema: string (byte)

Response fields

None

Example response

`json

{

"result": "AA==",

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

curl -X GET "https://public-api.loadgen.cloud/api/services/app/DuafResult/GetScreenshotForDuafRow?id=00000000-0000-0000-0000-000000000000" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/DuafResult/GetScreenshotForDuafRow?id=00000000-0000-0000-0000-000000000000"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

Invoke-RestMethod -Method GET -Uri $uri -Headers $headers

`

GetSessionDuafResults

Method: GET

Path: /api/services/app/DuafResult/GetSessionDuafResults

Operation ID: ApiServicesAppDuafresultGetsessionduafresultsGet

Tag: DuafResult

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

• Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
• This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

| Name | In | Type | Required | Default | Notes |

|---|---|---|---:|---|---|

| SessionId | query | string (uuid) | No | | format: uuid |

| Sorting | query | string | No | | |

| SkipCount | query | integer (int32) | No | | format: int32

min: 0

max: 2147483647 |

| MaxResultCount | query | integer (int32) | No | | format: int32

min: 1

max: 2147483647 |

Request body

None

Response

Response envelope: ABP

• The actual payload is usually under the result property.
• Success is indicated by success: true. Errors are provided via error and unAuthorizedRequest.

200 OK response schema: GetDuafResultDtoPagedResultDto

Response fields

| Field | Type | Required | Description | Notes |

|---|---|---:|---|---|

| items | array | No | | |

| totalCount | integer (int32) | No | | format: int32 |

Example response

`json

{

"result": {

"totalCount": 0,

"items": [

{

"actualTime": "2025-01-01T00:00:00Z",

"loadBotActualTime": "2025-01-01T00:00:00Z",

"loadTestRelativeTime": "2025-01-01T00:00:00Z"

}

]

},

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

curl -X GET "https://public-api.loadgen.cloud/api/services/app/DuafResult/GetSessionDuafResults?SessionId=00000000-0000-0000-0000-000000000000&Sorting=string&SkipCount=0" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/DuafResult/GetSessionDuafResults?SessionId=00000000-0000-0000-0000-000000000000&Sorting=string&SkipCount=0"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

Invoke-RestMethod -Method GET -Uri $uri -Headers $headers

`

GetTestDuafResults

Method: GET

Path: /api/services/app/DuafResult/GetTestDuafResults

Operation ID: ApiServicesAppDuafresultGettestduafresultsGet

Tag: DuafResult

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

• Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
• This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

| Name | In | Type | Required | Default | Notes |

|---|---|---|---:|---|---|

| TestId | query | string (uuid) | No | | format: uuid |

| Sorting | query | string | No | | |

| SkipCount | query | integer (int32) | No | | format: int32

min: 0

max: 2147483647 |

| MaxResultCount | query | integer (int32) | No | | format: int32

min: 1

max: 2147483647 |

Request body

None

Response

Response envelope: ABP

• The actual payload is usually under the result property.
• Success is indicated by success: true. Errors are provided via error and unAuthorizedRequest.

200 OK response schema: DuafResultDtoPagedResultDto

Response fields

| Field | Type | Required | Description | Notes |

|---|---|---:|---|---|

| items | array | No | | |

| totalCount | integer (int32) | No | | format: int32 |

Example response

`json

{

"result": {

"totalCount": 0,

"items": [

{

"id": "00000000-0000-0000-0000-000000000000",

"sessionId": "00000000-0000-0000-0000-000000000000",

"actualTime": "2025-01-01T00:00:00Z"

}

]

},

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

curl -X GET "https://public-api.loadgen.cloud/api/services/app/DuafResult/GetTestDuafResults?TestId=00000000-0000-0000-0000-000000000000&Sorting=string&SkipCount=0" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/DuafResult/GetTestDuafResults?TestId=00000000-0000-0000-0000-000000000000&Sorting=string&SkipCount=0"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

Invoke-RestMethod -Method GET -Uri $uri -Headers $headers

`

Delete (E2ECanvas)

Method: DELETE

Path: /api/services/app/E2ECanvas/Delete

Operation ID: ApiServicesAppE2ecanvasDeleteDelete

Tag: E2ECanvas

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

• Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
• This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

| Name | In | Type | Required | Default | Notes |

|---|---|---|---:|---|---|

| Id | query | string (uuid) | No | | format: uuid |

Request body

None

Response

None

Curl

`bash

curl -X DELETE "https://public-api.loadgen.cloud/api/services/app/E2ECanvas/Delete?Id=00000000-0000-0000-0000-000000000000" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/E2ECanvas/Delete?Id=00000000-0000-0000-0000-000000000000"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

Invoke-RestMethod -Method DELETE -Uri $uri -Headers $headers

`

EnableDisable

Method: POST

Path: /api/services/app/E2ECanvas/EnableDisable

Operation ID: ApiServicesAppE2ecanvasEnabledisablePost

Tag: E2ECanvas

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

• Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
• This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

| Name | In | Type | Required | Default | Notes |

|---|---|---|---:|---|---|

| input | query | string | No | | |

Request body

None

Response

None

Curl

`bash

curl -X POST "https://public-api.loadgen.cloud/api/services/app/E2ECanvas/EnableDisable?input=string" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/E2ECanvas/EnableDisable?input=string"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

Invoke-RestMethod -Method POST -Uri $uri -Headers $headers

`

ForceTestRun

Method: POST

Path: /api/services/app/E2ECanvas/ForceTestRun

Operation ID: ApiServicesAppE2ecanvasForcetestrunPost

Tag: E2ECanvas

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

• Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
• This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

None

Request body

Request body schema: GuidEntityDto

Request body fields

| Field | Type | Required | Description | Notes |

|---|---|---:|---|---|

| id | string (uuid) | No | | format: uuid |

Example request body

`json

{

"id": "00000000-0000-0000-0000-000000000000"

}

`

Response

None

Curl

`bash

curl -X POST "https://public-api.loadgen.cloud/api/services/app/E2ECanvas/ForceTestRun" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json" \\

-H "Content-Type: application/json" \\

--data-raw '{"id":"00000000-0000-0000-0000-000000000000"}'

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/E2ECanvas/ForceTestRun"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

$body = @'

{

"id": "00000000-0000-0000-0000-000000000000"

}

'@

Invoke-RestMethod -Method POST -Uri $uri -Headers $headers -ContentType "application/json" -Body $body

`

GetAll (E2ECanvas)

Method: GET

Path: /api/services/app/E2ECanvas/GetAll

Operation ID: ApiServicesAppE2ecanvasGetallGet

Tag: E2ECanvas

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

• Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
• This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

| Name | In | Type | Required | Default | Notes |

|---|---|---|---:|---|---|

| Filter | query | string | No | | |

| Sorting | query | string | No | | |

| SkipCount | query | integer (int32) | No | | format: int32

min: 0

max: 2147483647 |

| MaxResultCount | query | integer (int32) | No | | format: int32

min: 1

max: 2147483647 |

Request body

None

Response

Response envelope: ABP

• The actual payload is usually under the result property.
• Success is indicated by success: true. Errors are provided via error and unAuthorizedRequest.

200 OK response schema: GetAllE2ECanvasDtoPagedResultDto

Response fields

| Field | Type | Required | Description | Notes |

|---|---|---:|---|---|

| items | array | No | | |

| totalCount | integer (int32) | No | | format: int32 |

Example response

`json

{

"result": {

"totalCount": 0,

"items": [

{

"name": "string",

"scheduleName": "string",

"targetEnvironmentName": "string"

}

]

},

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

curl -X GET "https://public-api.loadgen.cloud/api/services/app/E2ECanvas/GetAll?Filter=string&Sorting=string&SkipCount=0" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/E2ECanvas/GetAll?Filter=string&Sorting=string&SkipCount=0"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

Invoke-RestMethod -Method GET -Uri $uri -Headers $headers

`

GetAllE2EAgentsInCanvas

Method: GET

Path: /api/services/app/E2ECanvas/GetAllE2EAgentsInCanvas

Operation ID: ApiServicesAppE2ecanvasGetalle2eagentsincanvasGet

Tag: E2ECanvas

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

• Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
• This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

None

Request body

None

Response

Response envelope: ABP

• The actual payload is usually under the result property.
• Success is indicated by success: true. Errors are provided via error and unAuthorizedRequest.

200 OK response schema: GetAllE2EAgentsInCanvasDtoListResultDto

Response fields

| Field | Type | Required | Description | Notes |

|---|---|---:|---|---|

| items | array | No | | |

Example response

`json

{

"result": {

"items": [

{

"name": "string",

"agents": [

"00000000-0000-0000-0000-000000000000"

],

"id": "00000000-0000-0000-0000-000000000000"

}

]

},

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

curl -X GET "https://public-api.loadgen.cloud/api/services/app/E2ECanvas/GetAllE2EAgentsInCanvas" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/E2ECanvas/GetAllE2EAgentsInCanvas"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

Invoke-RestMethod -Method GET -Uri $uri -Headers $headers

`

CreateOrEdit (E2EWizard)

Method: POST

Path: /api/services/app/E2EWizard/CreateOrEdit

Operation ID: ApiServicesAppE2ewizardCreateoreditPost

Tag: E2EWizard

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

• Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
• This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

None

Request body

Request body schema: CreateOrEditE2EWizardDto

Request body fields

| Field | Type | Required | Description | Notes |

|---|---|---:|---|---|

| agentTestUserFlow | array | No | | |

| anonymizeLoadGenAgentIp | boolean | No | | |

| anonymizeRemoteServer | boolean | No | | |

| anonymizeUsername | boolean | No | | |

| id | string (uuid) | No | | format: uuid |

| influxDatabaseId | string (uuid) | No | | format: uuid |

| isCanvasDisabled | boolean | No | | |

| name | string | No | | |

| scheduleId | string (uuid) | No | | format: uuid |

| sutProfileId | string (uuid) | No | | format: uuid |

| targetEnvironmentId | string (uuid) | No | | format: uuid |

Example request body

`json

{

"name": "string",

"anonymizeLoadGenAgentIp": false,

"anonymizeRemoteServer": false

}

`

Response

None

Curl

`bash

curl -X POST "https://public-api.loadgen.cloud/api/services/app/E2EWizard/CreateOrEdit" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json" \\

-H "Content-Type: application/json" \\

--data-raw '{"name":"string","anonymizeLoadGenAgentIp":false,"anonymizeRemoteServer":false}'

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/E2EWizard/CreateOrEdit"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

$body = @'

{

"name": "string",

"anonymizeLoadGenAgentIp": false,

"anonymizeRemoteServer": false

}

'@

Invoke-RestMethod -Method POST -Uri $uri -Headers $headers -ContentType "application/json" -Body $body

`

Get (E2EWizard)

Method: GET

Path: /api/services/app/E2EWizard/Get

Operation ID: ApiServicesAppE2ewizardGetGet

Tag: E2EWizard

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

• Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
• This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

| Name | In | Type | Required | Default | Notes |

|---|---|---|---:|---|---|

| id | query | string (uuid) | No | | format: uuid |

Request body

None

Response

Response envelope: ABP

• The actual payload is usually under the result property.
• Success is indicated by success: true. Errors are provided via error and unAuthorizedRequest.

200 OK response schema: GetE2ECanvasForWizardDto

Response fields

| Field | Type | Required | Description | Notes |

|---|---|---:|---|---|

| agents | array | No | | |

| anonymizeLoadGenAgentIp | boolean | No | | |

| anonymizeRemoteServer | boolean | No | | |

| anonymizeUsername | boolean | No | | |

| id | string (uuid) | No | | format: uuid |

| influxDatabaseId | string (uuid) | No | | format: uuid |

| influxDatabaseName | string | No | | |

| isCanvasDisabled | boolean | No | | |

| name | string | No | | |

| scheduleId | string (uuid) | No | | format: uuid |

| scheduleName | string | No | | |

| sutProfileId | string (uuid) | No | | format: uuid |

| sutProfileName | string | No | | |

| targetEnvironmentId | string (uuid) | No | | format: uuid |

| targetEnvironmentName | string | No | | |

Example response

`json

{

"result": {

"name": "string",

"anonymizeLoadGenAgentIp": false,

"anonymizeRemoteServer": false

},

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

curl -X GET "https://public-api.loadgen.cloud/api/services/app/E2EWizard/Get?id=00000000-0000-0000-0000-000000000000" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/E2EWizard/Get?id=00000000-0000-0000-0000-000000000000"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

Invoke-RestMethod -Method GET -Uri $uri -Headers $headers

`

CreateFlowItemFromLgs

Method: POST

Path: /api/services/app/FlowItem/CreateFlowItemFromLgs

Operation ID: ApiServicesAppFlowitemCreateflowitemfromlgsPost

Tag: FlowItem

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

• Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
• This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

None

Request body

Request body schema: CreateOrEditFlowItemDto

Request body fields

| Field | Type | Required | Description | Notes |

|---|---|---:|---|---|

| description | string | No | | |

| fileToken | string | No | | |

| id | string (uuid) | No | | format: uuid |

| name | string | No | | |

Example request body

`json

{

"name": "string",

"description": "string",

"fileToken": "string"

}

`

Response

Response envelope: ABP

• The actual payload is usually under the result property.
• Success is indicated by success: true. Errors are provided via error and unAuthorizedRequest.

200 OK response schema: boolean

Response fields

None

Example response

`json

{

"result": false,

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

curl -X POST "https://public-api.loadgen.cloud/api/services/app/FlowItem/CreateFlowItemFromLgs" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json" \\

-H "Content-Type: application/json" \\

--data-raw '{"name":"string","description":"string","fileToken":"string"}'

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/FlowItem/CreateFlowItemFromLgs"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

$body = @'

{

"name": "string",

"description": "string",

"fileToken": "string"

}

'@

Invoke-RestMethod -Method POST -Uri $uri -Headers $headers -ContentType "application/json" -Body $body

`

CreateForWizard

Method: POST

Path: /api/services/app/FlowItem/CreateForWizard

Operation ID: ApiServicesAppFlowitemCreateforwizardPost

Tag: FlowItem

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

• Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
• This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

None

Request body

Request body schema: CreateOrEditFlowItemDto

Request body fields

| Field | Type | Required | Description | Notes |

|---|---|---:|---|---|

| description | string | No | | |

| fileToken | string | No | | |

| id | string (uuid) | No | | format: uuid |

| name | string | No | | |

Example request body

`json

{

"name": "string",

"description": "string",

"fileToken": "string"

}

`

Response

Response envelope: ABP

• The actual payload is usually under the result property.
• Success is indicated by success: true. Errors are provided via error and unAuthorizedRequest.

200 OK response schema: string (uuid)

Response fields

None

Example response

`json

{

"result": "00000000-0000-0000-0000-000000000000",

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

curl -X POST "https://public-api.loadgen.cloud/api/services/app/FlowItem/CreateForWizard" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json" \\

-H "Content-Type: application/json" \\

--data-raw '{"name":"string","description":"string","fileToken":"string"}'

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/FlowItem/CreateForWizard"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

$body = @'

{

"name": "string",

"description": "string",

"fileToken": "string"

}

'@

Invoke-RestMethod -Method POST -Uri $uri -Headers $headers -ContentType "application/json" -Body $body

`

CreateOrEdit (FlowItem)

Method: POST

Path: /api/services/app/FlowItem/CreateOrEdit

Operation ID: ApiServicesAppFlowitemCreateoreditPost

Tag: FlowItem

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

• Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
• This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

None

Request body

Request body schema: CreateOrEditFlowItemDto

Request body fields

| Field | Type | Required | Description | Notes |

|---|---|---:|---|---|

| description | string | No | | |

| fileToken | string | No | | |

| id | string (uuid) | No | | format: uuid |

| name | string | No | | |

Example request body

`json

{

"name": "string",

"description": "string",

"fileToken": "string"

}

`

Response

None

Curl

`bash

curl -X POST "https://public-api.loadgen.cloud/api/services/app/FlowItem/CreateOrEdit" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json" \\

-H "Content-Type: application/json" \\

--data-raw '{"name":"string","description":"string","fileToken":"string"}'

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/FlowItem/CreateOrEdit"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

$body = @'

{

"name": "string",

"description": "string",

"fileToken": "string"

}

'@

Invoke-RestMethod -Method POST -Uri $uri -Headers $headers -ContentType "application/json" -Body $body

`

Delete (FlowItem)

Method: DELETE

Path: /api/services/app/FlowItem/Delete

Operation ID: ApiServicesAppFlowitemDeleteDelete

Tag: FlowItem

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

• Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
• This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

| Name | In | Type | Required | Default | Notes |

|---|---|---|---:|---|---|

| Id | query | string (uuid) | No | | format: uuid |

Request body

None

Response

None

Curl

`bash

curl -X DELETE "https://public-api.loadgen.cloud/api/services/app/FlowItem/Delete?Id=00000000-0000-0000-0000-000000000000" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/FlowItem/Delete?Id=00000000-0000-0000-0000-000000000000"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

Invoke-RestMethod -Method DELETE -Uri $uri -Headers $headers

`

GetAll (FlowItem)

Method: GET

Path: /api/services/app/FlowItem/GetAll

Operation ID: ApiServicesAppFlowitemGetallGet

Tag: FlowItem

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

• Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
• This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

| Name | In | Type | Required | Default | Notes |

|---|---|---|---:|---|---|

| Name | query | string | No | | |

| Filter | query | string | No | | |

| Sorting | query | string | No | | |

| SkipCount | query | integer (int32) | No | | format: int32

min: 0

max: 2147483647 |

| MaxResultCount | query | integer (int32) | No | | format: int32

min: 1

max: 2147483647 |

Request body

None

Response

Response envelope: ABP

• The actual payload is usually under the result property.
• Success is indicated by success: true. Errors are provided via error and unAuthorizedRequest.

200 OK response schema: GetFlowItemForViewDtoPagedResultDto

Response fields

| Field | Type | Required | Description | Notes |

|---|---|---:|---|---|

| items | array | No | | |

| totalCount | integer (int32) | No | | format: int32 |

Example response

`json

{

"result": {

"totalCount": 0,

"items": [

{

"name": "string",

"description": "string",

"versions": 0

}

]

},

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

curl -X GET "https://public-api.loadgen.cloud/api/services/app/FlowItem/GetAll?Name=string&Filter=string&Sorting=string" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/FlowItem/GetAll?Name=string&Filter=string&Sorting=string"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

Invoke-RestMethod -Method GET -Uri $uri -Headers $headers

`

GetFlowForWizard

Method: GET

Path: /api/services/app/FlowItem/GetFlowForWizard

Operation ID: ApiServicesAppFlowitemGetflowforwizardGet

Tag: FlowItem

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

• Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
• This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

| Name | In | Type | Required | Default | Notes |

|---|---|---|---:|---|---|

| id | query | string (uuid) | No | | format: uuid |

Request body

None

Response

Response envelope: ABP

• The actual payload is usually under the result property.
• Success is indicated by success: true. Errors are provided via error and unAuthorizedRequest.

200 OK response schema: GetFlowItemForViewDto

Response fields

| Field | Type | Required | Description | Notes |

|---|---|---:|---|---|

| description | string | No | | |

| id | string (uuid) | No | | format: uuid |

| name | string | No | | |

| versions | integer (int32) | No | | format: int32 |

Example response

`json

{

"result": {

"name": "string",

"description": "string",

"versions": 0

},

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

curl -X GET "https://public-api.loadgen.cloud/api/services/app/FlowItem/GetFlowForWizard?id=00000000-0000-0000-0000-000000000000" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/FlowItem/GetFlowForWizard?id=00000000-0000-0000-0000-000000000000"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

Invoke-RestMethod -Method GET -Uri $uri -Headers $headers

`

GetFlowItemForEdit

Method: GET

Path: /api/services/app/FlowItem/GetFlowItemForEdit

Operation ID: ApiServicesAppFlowitemGetflowitemforeditGet

Tag: FlowItem

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

• Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
• This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

| Name | In | Type | Required | Default | Notes |

|---|---|---|---:|---|---|

| id | query | string (uuid) | No | | format: uuid |

Request body

None

Response

Response envelope: ABP

• The actual payload is usually under the result property.
• Success is indicated by success: true. Errors are provided via error and unAuthorizedRequest.

200 OK response schema: GetFlowItemForEditDto

Response fields

| Field | Type | Required | Description | Notes |

|---|---|---:|---|---|

| description | string | No | | |

| id | string (uuid) | No | | format: uuid |

| name | string | No | | |

Example response

`json

{

"result": {

"name": "string",

"description": "string",

"id": "00000000-0000-0000-0000-000000000000"

},

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

curl -X GET "https://public-api.loadgen.cloud/api/services/app/FlowItem/GetFlowItemForEdit?id=00000000-0000-0000-0000-000000000000" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/FlowItem/GetFlowItemForEdit?id=00000000-0000-0000-0000-000000000000"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

Invoke-RestMethod -Method GET -Uri $uri -Headers $headers

`

GetVersionsForView

Method: GET

Path: /api/services/app/FlowItem/GetVersionsForView

Operation ID: ApiServicesAppFlowitemGetversionsforviewGet

Tag: FlowItem

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

• Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
• This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

| Name | In | Type | Required | Default | Notes |

|---|---|---|---:|---|---|

| flowItemId | query | string (uuid) | No | | format: uuid |

Request body

None

Response

Response envelope: ABP

• The actual payload is usually under the result property.
• Success is indicated by success: true. Errors are provided via error and unAuthorizedRequest.

200 OK response schema: GetFlowVersionForViewDtoListResultDto

Response fields

| Field | Type | Required | Description | Notes |

|---|---|---:|---|---|

| items | array | No | | |

Example response

`json

{

"result": {

"items": [

{

"name": "string",

"version": 0,

"creationTime": "2025-01-01T00:00:00Z"

}

]

},

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

curl -X GET "https://public-api.loadgen.cloud/api/services/app/FlowItem/GetVersionsForView?flowItemId=00000000-0000-0000-0000-000000000000" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/FlowItem/GetVersionsForView?flowItemId=00000000-0000-0000-0000-000000000000"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

Invoke-RestMethod -Method GET -Uri $uri -Headers $headers

`

CreateOrEdit (FlowVersion)

Method: POST

Path: /api/services/app/FlowVersion/CreateOrEdit

Operation ID: ApiServicesAppFlowversionCreateoreditPost

Tag: FlowVersion

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

• Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
• This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

None

Request body

Request body schema: CreateOrEditFlowItemVersionDto

Request body fields

| Field | Type | Required | Description | Notes |

|---|---|---:|---|---|

| description | string | No | | |

| id | string (uuid) | No | | format: uuid |

| name | string | No | | |

| version | integer (int32) | No | | format: int32 |

Example request body

`json

{

"name": "string",

"description": "string",

"version": 0

}

`

Response

None

Curl

`bash

curl -X POST "https://public-api.loadgen.cloud/api/services/app/FlowVersion/CreateOrEdit" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json" \\

-H "Content-Type: application/json" \\

--data-raw '{"name":"string","description":"string","version":0}'

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/FlowVersion/CreateOrEdit"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

$body = @'

{

"name": "string",

"description": "string",

"version": 0

}

'@

Invoke-RestMethod -Method POST -Uri $uri -Headers $headers -ContentType "application/json" -Body $body

`

Delete (FlowVersion)

Method: DELETE

Path: /api/services/app/FlowVersion/Delete

Operation ID: ApiServicesAppFlowversionDeleteDelete

Tag: FlowVersion

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

• Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
• This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

| Name | In | Type | Required | Default | Notes |

|---|---|---|---:|---|---|

| Id | query | string (uuid) | No | | format: uuid |

Request body

None

Response

None

Curl

`bash

curl -X DELETE "https://public-api.loadgen.cloud/api/services/app/FlowVersion/Delete?Id=00000000-0000-0000-0000-000000000000" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/FlowVersion/Delete?Id=00000000-0000-0000-0000-000000000000"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

Invoke-RestMethod -Method DELETE -Uri $uri -Headers $headers

`

DeleteWithGuid

Method: DELETE

Path: /api/services/app/FlowVersion/DeleteWithGuid

Operation ID: ApiServicesAppFlowversionDeletewithguidDelete

Tag: FlowVersion

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

• Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
• This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

| Name | In | Type | Required | Default | Notes |

|---|---|---|---:|---|---|

| id | query | string (uuid) | No | | format: uuid |

Request body

None

Response

None

Curl

`bash

curl -X DELETE "https://public-api.loadgen.cloud/api/services/app/FlowVersion/DeleteWithGuid?id=00000000-0000-0000-0000-000000000000" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/FlowVersion/DeleteWithGuid?id=00000000-0000-0000-0000-000000000000"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

Invoke-RestMethod -Method DELETE -Uri $uri -Headers $headers

`

CreateOrEdit (InfluxDatabase)

Method: POST

Path: /api/services/app/InfluxDatabase/CreateOrEdit

Operation ID: ApiServicesAppInfluxdatabaseCreateoreditPost

Tag: InfluxDatabase

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

• Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
• This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

None

Request body

Request body schema: CreateOrEditInfluxDatabaseDto

Request body fields

| Field | Type | Required | Description | Notes |

|---|---|---:|---|---|

| id | string (uuid) | No | | format: uuid |

| influxDatabase | object(InfluxDatabaseDto) | No | | |

Example request body

`json

{

"influxDatabase": {

"apiKey": "string",

"bucketId": "string",

"name": "string",

"organizationId": "string",

"port": 1,

"url": "https://example.com"

},

"id": "00000000-0000-0000-0000-000000000000"

}

`

Response

None

Curl

`bash

curl -X POST "https://public-api.loadgen.cloud/api/services/app/InfluxDatabase/CreateOrEdit" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json" \\

-H "Content-Type: application/json" \\

--data-raw '{"influxDatabase":{"apiKey":"string","bucketId":"string","name":"string","organizationId":"string","port":1,"url":"https://example.com"},"id":"00000000-0000-0000-0000-000000000000"}'

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/InfluxDatabase/CreateOrEdit"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

$body = @'

{

"influxDatabase": {

"apiKey": "string",

"bucketId": "string",

"name": "string",

"organizationId": "string",

"port": 1,

"url": "https://example.com"

},

"id": "00000000-0000-0000-0000-000000000000"

}

'@

Invoke-RestMethod -Method POST -Uri $uri -Headers $headers -ContentType "application/json" -Body $body

`

Delete (InfluxDatabase)

Method: DELETE

Path: /api/services/app/InfluxDatabase/Delete

Operation ID: ApiServicesAppInfluxdatabaseDeleteDelete

Tag: InfluxDatabase

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

• Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
• This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

| Name | In | Type | Required | Default | Notes |

|---|---|---|---:|---|---|

| Id | query | string (uuid) | No | | format: uuid |

Request body

None

Response

None

Curl

`bash

curl -X DELETE "https://public-api.loadgen.cloud/api/services/app/InfluxDatabase/Delete?Id=00000000-0000-0000-0000-000000000000" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/InfluxDatabase/Delete?Id=00000000-0000-0000-0000-000000000000"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

Invoke-RestMethod -Method DELETE -Uri $uri -Headers $headers

`

Get (InfluxDatabase)

Method: GET

Path: /api/services/app/InfluxDatabase/Get

Operation ID: ApiServicesAppInfluxdatabaseGetGet

Tag: InfluxDatabase

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

• Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
• This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

| Name | In | Type | Required | Default | Notes |

|---|---|---|---:|---|---|

| Id | query | string (uuid) | No | | format: uuid |

Request body

None

Response

Response envelope: ABP

• The actual payload is usually under the result property.
• Success is indicated by success: true. Errors are provided via error and unAuthorizedRequest.

200 OK response schema: InfluxDatabaseDto

Response fields

| Field | Type | Required | Description | Notes |

|---|---|---:|---|---|

| apiKey | string | Yes | | minLength: 1 |

| bucketId | string | Yes | | minLength: 1 |

| name | string | Yes | | minLength: 0

maxLength: 64 |

| organizationId | string | Yes | | minLength: 1 |

| port | integer (int32) | Yes | | format: int32

min: 1

max: 65535 |

| url | string (uri) | Yes | | format: uri

minLength: 1 |

| id | string (uuid) | No | | format: uuid |

| organizationUnitId | integer (int64) | No | | format: int64 |

Example response

`json

{

"result": {

"apiKey": "string",

"bucketId": "string",

"name": "string",

"organizationId": "string",

"port": 1,

"url": "https://example.com"

},

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

curl -X GET "https://public-api.loadgen.cloud/api/services/app/InfluxDatabase/Get?Id=00000000-0000-0000-0000-000000000000" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/InfluxDatabase/Get?Id=00000000-0000-0000-0000-000000000000"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

Invoke-RestMethod -Method GET -Uri $uri -Headers $headers

`

GetAll (InfluxDatabase)

Method: GET

Path: /api/services/app/InfluxDatabase/GetAll

Operation ID: ApiServicesAppInfluxdatabaseGetallGet

Tag: InfluxDatabase

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

• Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
• This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

| Name | In | Type | Required | Default | Notes |

|---|---|---|---:|---|---|

| Sorting | query | string | No | | |

| SkipCount | query | integer (int32) | No | | format: int32

min: 0

max: 2147483647 |

| MaxResultCount | query | integer (int32) | No | | format: int32

min: 1

max: 2147483647 |

Request body

None

Response

Response envelope: ABP

• The actual payload is usually under the result property.
• Success is indicated by success: true. Errors are provided via error and unAuthorizedRequest.

200 OK response schema: InfluxDatabaseDtoPagedResultDto

Response fields

| Field | Type | Required | Description | Notes |

|---|---|---:|---|---|

| items | array | No | | |

| totalCount | integer (int32) | No | | format: int32 |

Example response

`json

{

"result": {

"totalCount": 0,

"items": [

{

"apiKey": "string",

"bucketId": "string",

"name": "string",

"organizationId": "string",

"port": 1,

"url": "https://example.com"

}

]

},

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

curl -X GET "https://public-api.loadgen.cloud/api/services/app/InfluxDatabase/GetAll?Sorting=string&SkipCount=0&MaxResultCount=1" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/InfluxDatabase/GetAll?Sorting=string&SkipCount=0&MaxResultCount=1"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

Invoke-RestMethod -Method GET -Uri $uri -Headers $headers

`

CreateOrEdit (ScheduleE2E)

Method: POST

Path: /api/services/app/ScheduleE2E/CreateOrEdit

Operation ID: ApiServicesAppSchedulee2eCreateoreditPost

Tag: ScheduleE2E

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

• Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
• This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

None

Request body

Request body schema: CreateOrEditScheduleDto

Request body fields

| Field | Type | Required | Description | Notes |

|---|---|---:|---|---|

| daysOfWeek | enum(1 \| 2 \| 4 \| 8 \| 16 \| 32 \| 64) | No | | format: int32

enum: 1, 2, 4, 8, 16, 32, 64 |

| description | string | No | | |

| endDate | string (date-time) | No | | format: date-time |

| endTime | string (date-span) | No | | format: date-span |

| id | string (uuid) | No | | format: uuid |

| killSessionIfNeeded | boolean | No | | |

| name | string | No | | |

| startDate | string (date-time) | No | | format: date-time |

| startTime | string (date-span) | No | | format: date-span |

| testDuration | integer (int32) | No | | format: int32 |

Example request body

`json

{

"name": "string",

"description": "string",

"startDate": "2025-01-01T00:00:00Z"

}

`

Response

None

Curl

`bash

curl -X POST "https://public-api.loadgen.cloud/api/services/app/ScheduleE2E/CreateOrEdit" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json" \\

-H "Content-Type: application/json" \\

--data-raw '{"name":"string","description":"string","startDate":"2025-01-01T00:00:00Z"}'

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/ScheduleE2E/CreateOrEdit"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

$body = @'

{

"name": "string",

"description": "string",

"startDate": "2025-01-01T00:00:00Z"

}

'@

Invoke-RestMethod -Method POST -Uri $uri -Headers $headers -ContentType "application/json" -Body $body

`

Delete (ScheduleE2E)

Method: DELETE

Path: /api/services/app/ScheduleE2E/Delete

Operation ID: ApiServicesAppSchedulee2eDeleteDelete

Tag: ScheduleE2E

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

• Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
• This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

| Name | In | Type | Required | Default | Notes |

|---|---|---|---:|---|---|

| Id | query | string (uuid) | No | | format: uuid |

Request body

None

Response

None

Curl

`bash

curl -X DELETE "https://public-api.loadgen.cloud/api/services/app/ScheduleE2E/Delete?Id=00000000-0000-0000-0000-000000000000" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/ScheduleE2E/Delete?Id=00000000-0000-0000-0000-000000000000"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

Invoke-RestMethod -Method DELETE -Uri $uri -Headers $headers

`

GetAll (ScheduleE2E)

Method: GET

Path: /api/services/app/ScheduleE2E/GetAll

Operation ID: ApiServicesAppSchedulee2eGetallGet

Tag: ScheduleE2E

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

• Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
• This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

| Name | In | Type | Required | Default | Notes |

|---|---|---|---:|---|---|

| Filter | query | string | No | | |

| Sorting | query | string | No | | |

| SkipCount | query | integer (int32) | No | | format: int32

min: 0

max: 2147483647 |

| MaxResultCount | query | integer (int32) | No | | format: int32

min: 1

max: 2147483647 |

Request body

None

Response

Response envelope: ABP

• The actual payload is usually under the result property.
• Success is indicated by success: true. Errors are provided via error and unAuthorizedRequest.

200 OK response schema: GetAllScheduleE2EDtoPagedResultDto

Response fields

| Field | Type | Required | Description | Notes |

|---|---|---:|---|---|

| items | array | No | | |

| totalCount | integer (int32) | No | | format: int32 |

Example response

`json

{

"result": {

"totalCount": 0,

"items": [

{

"name": "string",

"description": "string",

"startDate": "2025-01-01T00:00:00Z"

}

]

},

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

curl -X GET "https://public-api.loadgen.cloud/api/services/app/ScheduleE2E/GetAll?Filter=string&Sorting=string&SkipCount=0" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/ScheduleE2E/GetAll?Filter=string&Sorting=string&SkipCount=0"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

Invoke-RestMethod -Method GET -Uri $uri -Headers $headers

`

GetScheduleE2EForEdit

Method: GET

Path: /api/services/app/ScheduleE2E/GetScheduleE2EForEdit

Operation ID: ApiServicesAppSchedulee2eGetschedulee2eforeditGet

Tag: ScheduleE2E

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

• Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
• This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

| Name | In | Type | Required | Default | Notes |

|---|---|---|---:|---|---|

| id | query | string (uuid) | No | | format: uuid |

Request body

None

Response

Response envelope: ABP

• The actual payload is usually under the result property.
• Success is indicated by success: true. Errors are provided via error and unAuthorizedRequest.

200 OK response schema: GetScheduleE2EForEditDto

Response fields

| Field | Type | Required | Description | Notes |

|---|---|---:|---|---|

| daysOfWeek | enum(1 \| 2 \| 4 \| 8 \| 16 \| 32 \| 64) | No | | format: int32

enum: 1, 2, 4, 8, 16, 32, 64 |

| description | string | No | | |

| endDate | string (date-time) | No | | format: date-time |

| endTime | string (date-span) | No | | format: date-span |

| id | string (uuid) | No | | format: uuid |

| killSessionIfNeeded | boolean | No | | |

| name | string | No | | |

| startDate | string (date-time) | No | | format: date-time |

| startTime | string (date-span) | No | | format: date-span |

| testDuration | integer (int32) | No | | format: int32 |

Example response

`json

{

"result": {

"name": "string",

"description": "string",

"startDate": "2025-01-01T00:00:00Z"

},

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

curl -X GET "https://public-api.loadgen.cloud/api/services/app/ScheduleE2E/GetScheduleE2EForEdit?id=00000000-0000-0000-0000-000000000000" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/ScheduleE2E/GetScheduleE2EForEdit?id=00000000-0000-0000-0000-000000000000"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

Invoke-RestMethod -Method GET -Uri $uri -Headers $headers

`

GetScheduleForWizard

Method: GET

Path: /api/services/app/ScheduleE2E/GetScheduleForWizard

Operation ID: ApiServicesAppSchedulee2eGetscheduleforwizardGet

Tag: ScheduleE2E

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

• Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
• This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

| Name | In | Type | Required | Default | Notes |

|---|---|---|---:|---|---|

| id | query | string (uuid) | No | | format: uuid |

Request body

None

Response

Response envelope: ABP

• The actual payload is usually under the result property.
• Success is indicated by success: true. Errors are provided via error and unAuthorizedRequest.

200 OK response schema: GetScheduleE2EForWizardDto

Response fields

| Field | Type | Required | Description | Notes |

|---|---|---:|---|---|

| description | string | No | | |

| id | string (uuid) | No | | format: uuid |

| name | string | No | | |

| summary | string | No | | |

Example response

`json

{

"result": {

"name": "string",

"description": "string",

"summary": "string"

},

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

curl -X GET "https://public-api.loadgen.cloud/api/services/app/ScheduleE2E/GetScheduleForWizard?id=00000000-0000-0000-0000-000000000000" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/ScheduleE2E/GetScheduleForWizard?id=00000000-0000-0000-0000-000000000000"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

Invoke-RestMethod -Method GET -Uri $uri -Headers $headers

`

CreateOrEdit (Session)

Method: POST

Path: /api/services/app/Session/CreateOrEdit

Operation ID: ApiServicesAppSessionCreateoreditPost

Tag: Session

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

• Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
• This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

None

Request body

Request body schema: CreateOrEditSessionDto

Request body fields

| Field | Type | Required | Description | Notes |

|---|---|---:|---|---|

| agentId | string (uuid) | No | | format: uuid |

| id | string (uuid) | No | | format: uuid |

| profileId | string (uuid) | No | | format: uuid |

| simulationFlowId | string (uuid) | No | | format: uuid |

| testId | string (uuid) | No | | format: uuid |

| testPassword | string (password) | No | | format: password |

| testuserDomain | string | No | | |

| testuserName | string | No | | |

| univsersalStartDate | string (date-time) | No | | format: date-time |

Example request body

`json

{

"agentId": "00000000-0000-0000-0000-000000000000",

"testId": "00000000-0000-0000-0000-000000000000",

"profileId": "00000000-0000-0000-0000-000000000000"

}

`

Response

None

Curl

`bash

curl -X POST "https://public-api.loadgen.cloud/api/services/app/Session/CreateOrEdit" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json" \\

-H "Content-Type: application/json" \\

--data-raw '{"agentId":"00000000-0000-0000-0000-000000000000","testId":"00000000-0000-0000-0000-000000000000","profileId":"00000000-0000-0000-0000-000000000000"}'

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/Session/CreateOrEdit"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

$body = @'

{

"agentId": "00000000-0000-0000-0000-000000000000",

"testId": "00000000-0000-0000-0000-000000000000",

"profileId": "00000000-0000-0000-0000-000000000000"

}

'@

Invoke-RestMethod -Method POST -Uri $uri -Headers $headers -ContentType "application/json" -Body $body

`

Delete (Session)

Method: DELETE

Path: /api/services/app/Session/Delete

Operation ID: ApiServicesAppSessionDeleteDelete

Tag: Session

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

• Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
• This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

| Name | In | Type | Required | Default | Notes |

|---|---|---|---:|---|---|

| Id | query | string (uuid) | No | | format: uuid |

Request body

None

Response

None

Curl

`bash

curl -X DELETE "https://public-api.loadgen.cloud/api/services/app/Session/Delete?Id=00000000-0000-0000-0000-000000000000" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/Session/Delete?Id=00000000-0000-0000-0000-000000000000"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

Invoke-RestMethod -Method DELETE -Uri $uri -Headers $headers

`

GetCurrentLoginInformations

Method: GET

Path: /api/services/app/Session/GetCurrentLoginInformations

Operation ID: ApiServicesAppSessionGetcurrentlogininformationsGet

Tag: Session

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

• Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
• This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

None

Request body

None

Response

Response envelope: ABP

• The actual payload is usually under the result property.
• Success is indicated by success: true. Errors are provided via error and unAuthorizedRequest.

200 OK response schema: GetCurrentLoginInformationsOutput

Response fields

| Field | Type | Required | Description | Notes |

|---|---|---:|---|---|

| application | object(ApplicationInfoDto) | No | | |

| impersonatorTenant | object(TenantLoginInfoDto) | No | | |

| impersonatorUser | object(UserLoginInfoDto) | No | | |

| tenant | object(TenantLoginInfoDto) | No | | |

| theme | object(UiCustomizationSettingsDto) | No | | |

| user | object(UserLoginInfoDto) | No | | |

Example response

`json

{

"result": {

"user": {

"name": "string",

"surname": "string",

"userName": "string"

},

"tenant": {

"tenancyName": "string",

"name": "string",

"darkLogoId": "00000000-0000-0000-0000-000000000000"

}

},

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

curl -X GET "https://public-api.loadgen.cloud/api/services/app/Session/GetCurrentLoginInformations" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/Session/GetCurrentLoginInformations"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

Invoke-RestMethod -Method GET -Uri $uri -Headers $headers

`

GetTestId

Method: GET

Path: /api/services/app/Session/GetTestId

Operation ID: ApiServicesAppSessionGettestidGet

Tag: Session

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

• Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
• This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

| Name | In | Type | Required | Default | Notes |

|---|---|---|---:|---|---|

| sessionId | query | string (uuid) | No | | format: uuid |

Request body

None

Response

Response envelope: ABP

• The actual payload is usually under the result property.
• Success is indicated by success: true. Errors are provided via error and unAuthorizedRequest.

200 OK response schema: string (uuid)

Response fields

None

Example response

`json

{

"result": "00000000-0000-0000-0000-000000000000",

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

curl -X GET "https://public-api.loadgen.cloud/api/services/app/Session/GetTestId?sessionId=00000000-0000-0000-0000-000000000000" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/Session/GetTestId?sessionId=00000000-0000-0000-0000-000000000000"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

Invoke-RestMethod -Method GET -Uri $uri -Headers $headers

`

UpdateUserSignInToken

Method: PUT

Path: /api/services/app/Session/UpdateUserSignInToken

Operation ID: ApiServicesAppSessionUpdateusersignintokenPut

Tag: Session

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

• Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
• This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

None

Request body

None

Response

Response envelope: ABP

• The actual payload is usually under the result property.
• Success is indicated by success: true. Errors are provided via error and unAuthorizedRequest.

200 OK response schema: UpdateUserSignInTokenOutput

Response fields

| Field | Type | Required | Description | Notes |

|---|---|---:|---|---|

| encodedTenantId | string | No | | |

| encodedUserId | string | No | | |

| signInToken | string | No | | |

Example response

`json

{

"result": {

"signInToken": "string",

"encodedUserId": "string",

"encodedTenantId": "string"

},

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

curl -X PUT "https://public-api.loadgen.cloud/api/services/app/Session/UpdateUserSignInToken" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json" \\

-H "Content-Type: application/json"

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/Session/UpdateUserSignInToken"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

Invoke-RestMethod -Method PUT -Uri $uri -Headers $headers

`

CreateOrUpdate (SUTMachine)

Method: POST

Path: /api/services/app/SUTMachine/CreateOrUpdate

Operation ID: ApiServicesAppSutmachineCreateorupdatePost

Tag: SUTMachine

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

• Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
• This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

None

Request body

Request body schema: CreateOrUpdateSutMachineDto

Request body fields

| Field | Type | Required | Description | Notes |

|---|---|---:|---|---|

| description | string | No | | |

| id | string (uuid) | No | | format: uuid |

| name | string | No | | |

| runAsProfileId | string (uuid) | No | | format: uuid |

Example request body

`json

{

"name": "string",

"description": "string",

"runAsProfileId": "00000000-0000-0000-0000-000000000000"

}

`

Response

None

Curl

`bash

curl -X POST "https://public-api.loadgen.cloud/api/services/app/SUTMachine/CreateOrUpdate" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json" \\

-H "Content-Type: application/json" \\

--data-raw '{"name":"string","description":"string","runAsProfileId":"00000000-0000-0000-0000-000000000000"}'

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/SUTMachine/CreateOrUpdate"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

$body = @'

{

"name": "string",

"description": "string",

"runAsProfileId": "00000000-0000-0000-0000-000000000000"

}

'@

Invoke-RestMethod -Method POST -Uri $uri -Headers $headers -ContentType "application/json" -Body $body

`

Delete (SUTMachine)

Method: DELETE

Path: /api/services/app/SUTMachine/Delete

Operation ID: ApiServicesAppSutmachineDeleteDelete

Tag: SUTMachine

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

• Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
• This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

| Name | In | Type | Required | Default | Notes |

|---|---|---|---:|---|---|

| id | query | string (uuid) | No | | format: uuid |

Request body

None

Response

None

Curl

`bash

curl -X DELETE "https://public-api.loadgen.cloud/api/services/app/SUTMachine/Delete?id=00000000-0000-0000-0000-000000000000" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/SUTMachine/Delete?id=00000000-0000-0000-0000-000000000000"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

Invoke-RestMethod -Method DELETE -Uri $uri -Headers $headers

`

GetAll (SUTMachine)

Method: GET

Path: /api/services/app/SUTMachine/GetAll

Operation ID: ApiServicesAppSutmachineGetallGet

Tag: SUTMachine

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

• Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
• This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

| Name | In | Type | Required | Default | Notes |

|---|---|---|---:|---|---|

| Filter | query | string | No | | |

| Sorting | query | string | No | | |

| SkipCount | query | integer (int32) | No | | format: int32

min: 0

max: 2147483647 |

| MaxResultCount | query | integer (int32) | No | | format: int32

min: 1

max: 2147483647 |

Request body

None

Response

Response envelope: ABP

• The actual payload is usually under the result property.
• Success is indicated by success: true. Errors are provided via error and unAuthorizedRequest.

200 OK response schema: GetAllSutMachineDtoPagedResultDto

Response fields

| Field | Type | Required | Description | Notes |

|---|---|---:|---|---|

| items | array | No | | |

| totalCount | integer (int32) | No | | format: int32 |

Example response

`json

{

"result": {

"totalCount": 0,

"items": [

{

"name": "string",

"ipAddress": "string",

"runAsProfileId": "00000000-0000-0000-0000-000000000000"

}

]

},

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

curl -X GET "https://public-api.loadgen.cloud/api/services/app/SUTMachine/GetAll?Filter=string&Sorting=string&SkipCount=0" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/SUTMachine/GetAll?Filter=string&Sorting=string&SkipCount=0"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

Invoke-RestMethod -Method GET -Uri $uri -Headers $headers

`

GetSutMachineForEdit

Method: GET

Path: /api/services/app/SUTMachine/GetSutMachineForEdit

Operation ID: ApiServicesAppSutmachineGetsutmachineforeditGet

Tag: SUTMachine

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

• Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
• This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

| Name | In | Type | Required | Default | Notes |

|---|---|---|---:|---|---|

| Id | query | string (uuid) | No | | format: uuid |

Request body

None

Response

Response envelope: ABP

• The actual payload is usually under the result property.
• Success is indicated by success: true. Errors are provided via error and unAuthorizedRequest.

200 OK response schema: GetSutMachineForEditDto

Response fields

| Field | Type | Required | Description | Notes |

|---|---|---:|---|---|

| description | string | No | | |

| id | string (uuid) | No | | format: uuid |

| ipAddress | string | No | | |

| name | string | No | | |

| runAsProfileId | string (uuid) | No | | format: uuid |

| runAsProfileName | string | No | | |

Example response

`json

{

"result": {

"name": "string",

"description": "string",

"ipAddress": "string"

},

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

curl -X GET "https://public-api.loadgen.cloud/api/services/app/SUTMachine/GetSutMachineForEdit?Id=00000000-0000-0000-0000-000000000000" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/SUTMachine/GetSutMachineForEdit?Id=00000000-0000-0000-0000-000000000000"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

Invoke-RestMethod -Method GET -Uri $uri -Headers $headers

`

CreateOrUpdate (SUTTemplate)

Method: POST

Path: /api/services/app/SUTTemplate/CreateOrUpdate

Operation ID: ApiServicesAppSuttemplateCreateorupdatePost

Tag: SUTTemplate

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

• Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
• This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

None

Request body

Request body schema: CreateOrUpdateSUTTemplateDto

Request body fields

| Field | Type | Required | Description | Notes |

|---|---|---:|---|---|

| description | string | No | | |

| id | string (uuid) | No | | format: uuid |

| name | string | No | | |

| performanceCounters | array | No | | |

Example request body

`json

{

"name": "string",

"description": "string",

"performanceCounters": [

{

"category": "string",

"instance": "string",

"counter": "string"

}

]

}

`

Response

None

Curl

`bash

curl -X POST "https://public-api.loadgen.cloud/api/services/app/SUTTemplate/CreateOrUpdate" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json" \\

-H "Content-Type: application/json" \\

--data-raw '{"name":"string","description":"string","performanceCounters":[{"category":"string","instance":"string","counter":"string"}]}'

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/SUTTemplate/CreateOrUpdate"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

$body = @'

{

"name": "string",

"description": "string",

"performanceCounters": [

{

"category": "string",

"instance": "string",

"counter": "string"

}

]

}

'@

Invoke-RestMethod -Method POST -Uri $uri -Headers $headers -ContentType "application/json" -Body $body

`

Delete (SUTTemplate)

Method: DELETE

Path: /api/services/app/SUTTemplate/Delete

Operation ID: ApiServicesAppSuttemplateDeleteDelete

Tag: SUTTemplate

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

• Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
• This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

| Name | In | Type | Required | Default | Notes |

|---|---|---|---:|---|---|

| id | query | string (uuid) | No | | format: uuid |

Request body

None

Response

None

Curl

`bash

curl -X DELETE "https://public-api.loadgen.cloud/api/services/app/SUTTemplate/Delete?id=00000000-0000-0000-0000-000000000000" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/SUTTemplate/Delete?id=00000000-0000-0000-0000-000000000000"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

Invoke-RestMethod -Method DELETE -Uri $uri -Headers $headers

`

GetAll (SUTTemplate)

Method: GET

Path: /api/services/app/SUTTemplate/GetAll

Operation ID: ApiServicesAppSuttemplateGetallGet

Tag: SUTTemplate

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

• Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
• This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

| Name | In | Type | Required | Default | Notes |

|---|---|---|---:|---|---|

| Filter | query | string | No | | |

| Sorting | query | string | No | | |

| SkipCount | query | integer (int32) | No | | format: int32

min: 0

max: 2147483647 |

| MaxResultCount | query | integer (int32) | No | | format: int32

min: 1

max: 2147483647 |

Request body

None

Response

Response envelope: ABP

• The actual payload is usually under the result property.
• Success is indicated by success: true. Errors are provided via error and unAuthorizedRequest.

200 OK response schema: GetAllSutTemplatesDtoPagedResultDto

Response fields

| Field | Type | Required | Description | Notes |

|---|---|---:|---|---|

| items | array | No | | |

| totalCount | integer (int32) | No | | format: int32 |

Example response

`json

{

"result": {

"totalCount": 0,

"items": [

{

"name": "string",

"description": "string",

"counters": 0

}

]

},

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

curl -X GET "https://public-api.loadgen.cloud/api/services/app/SUTTemplate/GetAll?Filter=string&Sorting=string&SkipCount=0" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/SUTTemplate/GetAll?Filter=string&Sorting=string&SkipCount=0"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

Invoke-RestMethod -Method GET -Uri $uri -Headers $headers

`

GetCachedCounters

Method: GET

Path: /api/services/app/SUTTemplate/GetCachedCounters

Operation ID: ApiServicesAppSuttemplateGetcachedcountersGet

Tag: SUTTemplate

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

• Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
• This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

| Name | In | Type | Required | Default | Notes |

|---|---|---|---:|---|---|

| id | query | string (uuid) | No | | format: uuid |

Request body

None

Response

Response envelope: ABP

• The actual payload is usually under the result property.
• Success is indicated by success: true. Errors are provided via error and unAuthorizedRequest.

200 OK response schema: PerformanceCounterModelCachedDto

Response fields

| Field | Type | Required | Description | Notes |

|---|---|---:|---|---|

| data | array | No | | |

| machineId | string (uuid) | No | | format: uuid |

| machineName | string | No | | |

Example response

`json

{

"result": {

"machineId": "00000000-0000-0000-0000-000000000000",

"machineName": "string",

"data": [

{

"parentId": 0,

"label": "string"

}

]

},

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

curl -X GET "https://public-api.loadgen.cloud/api/services/app/SUTTemplate/GetCachedCounters?id=00000000-0000-0000-0000-000000000000" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/SUTTemplate/GetCachedCounters?id=00000000-0000-0000-0000-000000000000"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

Invoke-RestMethod -Method GET -Uri $uri -Headers $headers

`

GetSutTemplateForEdit

Method: GET

Path: /api/services/app/SUTTemplate/GetSutTemplateForEdit

Operation ID: ApiServicesAppSuttemplateGetsuttemplateforeditGet

Tag: SUTTemplate

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

• Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
• This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

| Name | In | Type | Required | Default | Notes |

|---|---|---|---:|---|---|

| Id | query | string (uuid) | No | | format: uuid |

| SkipCount | query | integer (int32) | No | | format: int32

min: 0

max: 2147483647 |

| MaxResultCount | query | integer (int32) | No | | format: int32

min: 1

max: 2147483647 |

Request body

None

Response

Response envelope: ABP

• The actual payload is usually under the result property.
• Success is indicated by success: true. Errors are provided via error and unAuthorizedRequest.

200 OK response schema: GetSutTemplateForEditDto

Response fields

| Field | Type | Required | Description | Notes |

|---|---|---:|---|---|

| description | string | No | | |

| id | string (uuid) | No | | format: uuid |

| name | string | No | | |

| performanceCounters | array | No | | |

| totalCounterCount | integer (int32) | No | | format: int32 |

Example response

`json

{

"result": {

"name": "string",

"description": "string",

"performanceCounters": [

{

"category": "string",

"instance": "string",

"counter": "string"

}

]

},

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

curl -X GET "https://public-api.loadgen.cloud/api/services/app/SUTTemplate/GetSutTemplateForEdit?Id=00000000-0000-0000-0000-000000000000&SkipCount=0&MaxResultCount=1" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/SUTTemplate/GetSutTemplateForEdit?Id=00000000-0000-0000-0000-000000000000&SkipCount=0&MaxResultCount=1"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

Invoke-RestMethod -Method GET -Uri $uri -Headers $headers

`

CreateOrUpdate (SystemsUnderTest)

Method: POST

Path: /api/services/app/SystemsUnderTest/CreateOrUpdate

Operation ID: ApiServicesAppSystemsundertestCreateorupdatePost

Tag: SystemsUnderTest

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

• Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
• This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

None

Request body

Request body schema: CreateOrUpdateSUTProfileWizardDto

Request body fields

| Field | Type | Required | Description | Notes |

|---|---|---:|---|---|

| agentLinks | array | No | | |

| description | string | No | | |

| id | string (uuid) | No | | format: uuid |

| name | string | No | | |

Example request body

`json

{

"name": "string",

"description": "string",

"agentLinks": [

{

"agentGuid": "00000000-0000-0000-0000-000000000000",

"machineTemplates": [

{}

]

}

]

}

`

Response

None

Curl

`bash

curl -X POST "https://public-api.loadgen.cloud/api/services/app/SystemsUnderTest/CreateOrUpdate" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json" \\

-H "Content-Type: application/json" \\

--data-raw '{"name":"string","description":"string","agentLinks":[{"agentGuid":"00000000-0000-0000-0000-000000000000","machineTemplates":[{}]}]}'

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/SystemsUnderTest/CreateOrUpdate"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

$body = @'

{

"name": "string",

"description": "string",

"agentLinks": [

{

"agentGuid": "00000000-0000-0000-0000-000000000000",

"machineTemplates": [

{}

]

}

]

}

'@

Invoke-RestMethod -Method POST -Uri $uri -Headers $headers -ContentType "application/json" -Body $body

`

Delete (SystemsUnderTest)

Method: DELETE

Path: /api/services/app/SystemsUnderTest/Delete

Operation ID: ApiServicesAppSystemsundertestDeleteDelete

Tag: SystemsUnderTest

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

• Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
• This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

| Name | In | Type | Required | Default | Notes |

|---|---|---|---:|---|---|

| id | query | string (uuid) | No | | format: uuid |

Request body

None

Response

None

Curl

`bash

curl -X DELETE "https://public-api.loadgen.cloud/api/services/app/SystemsUnderTest/Delete?id=00000000-0000-0000-0000-000000000000" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/SystemsUnderTest/Delete?id=00000000-0000-0000-0000-000000000000"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

Invoke-RestMethod -Method DELETE -Uri $uri -Headers $headers

`

Get (SystemsUnderTest)

Method: GET

Path: /api/services/app/SystemsUnderTest/Get

Operation ID: ApiServicesAppSystemsundertestGetGet

Tag: SystemsUnderTest

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

• Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
• This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

| Name | In | Type | Required | Default | Notes |

|---|---|---|---:|---|---|

| id | query | string (uuid) | No | | format: uuid |

Request body

None

Response

Response envelope: ABP

• The actual payload is usually under the result property.
• Success is indicated by success: true. Errors are provided via error and unAuthorizedRequest.

200 OK response schema: GetSUTProfileForWizardDto

Response fields

| Field | Type | Required | Description | Notes |

|---|---|---:|---|---|

| agents | array | No | | |

| description | string | No | | |

| id | string (uuid) | No | | format: uuid |

| name | string | No | | |

Example response

`json

{

"result": {

"name": "string",

"description": "string",

"agents": [

{

"agentName": "string",

"isOnline": false,

"sutMachines": [

{}

]

}

]

},

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

curl -X GET "https://public-api.loadgen.cloud/api/services/app/SystemsUnderTest/Get?id=00000000-0000-0000-0000-000000000000" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/SystemsUnderTest/Get?id=00000000-0000-0000-0000-000000000000"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

Invoke-RestMethod -Method GET -Uri $uri -Headers $headers

`

GetAll (SystemsUnderTest)

Method: GET

Path: /api/services/app/SystemsUnderTest/GetAll

Operation ID: ApiServicesAppSystemsundertestGetallGet

Tag: SystemsUnderTest

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

• Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
• This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

| Name | In | Type | Required | Default | Notes |

|---|---|---|---:|---|---|

| Filter | query | string | No | | |

| Sorting | query | string | No | | |

| SkipCount | query | integer (int32) | No | | format: int32

min: 0

max: 2147483647 |

| MaxResultCount | query | integer (int32) | No | | format: int32

min: 1

max: 2147483647 |

Request body

None

Response

Response envelope: ABP

• The actual payload is usually under the result property.
• Success is indicated by success: true. Errors are provided via error and unAuthorizedRequest.

200 OK response schema: GetAllSUTProfileDtoPagedResultDto

Response fields

| Field | Type | Required | Description | Notes |

|---|---|---:|---|---|

| items | array | No | | |

| totalCount | integer (int32) | No | | format: int32 |

Example response

`json

{

"result": {

"totalCount": 0,

"items": [

{

"name": "string",

"description": "string",

"id": "00000000-0000-0000-0000-000000000000"

}

]

},

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

curl -X GET "https://public-api.loadgen.cloud/api/services/app/SystemsUnderTest/GetAll?Filter=string&Sorting=string&SkipCount=0" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/SystemsUnderTest/GetAll?Filter=string&Sorting=string&SkipCount=0"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

Invoke-RestMethod -Method GET -Uri $uri -Headers $headers

`

CreateOrEdit (TargetEnvironment)

Method: POST

Path: /api/services/app/TargetEnvironment/CreateOrEdit

Operation ID: ApiServicesAppTargetenvironmentCreateoreditPost

Tag: TargetEnvironment

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

• Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
• This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

None

Request body

Request body schema: CreateOrEditTargetEnvironmentDto

Request body fields

| Field | Type | Required | Description | Notes |

|---|---|---:|---|---|

| avdSettings | object(AVDConfigDto) | No | | |

| citrixSettings | object(CitrixConfigDto) | No | | |

| description | string | No | | |

| durationSettings | object(DurationDto) | No | | |

| id | string (uuid) | No | | format: uuid |

| name | string | No | | |

| rdsSettings | object(RdsConfigDto) | No | | |

| technology | enum(0 \| 1 \| 2 \| 3 \| 4 \| 5 \| 6 \| 7) | No | | format: int32

enum: 0, 1, 2, 3, 4, 5, 6, 7 |

| vMwareSettings | object(VMwareConfigDto) | No | | |

| webTestingSettings | object(WebTestingConfigDto) | No | | |

Example request body

`json

{

"name": "string",

"description": "string",

"citrixSettings": {

"connectTechnology": 0,

"server": "string",

"publishedApplication": "string"

}

}

`

Response

None

Curl

`bash

curl -X POST "https://public-api.loadgen.cloud/api/services/app/TargetEnvironment/CreateOrEdit" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json" \\

-H "Content-Type: application/json" \\

--data-raw '{"name":"string","description":"string","citrixSettings":{"connectTechnology":0,"server":"string","publishedApplication":"string"}}'

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/TargetEnvironment/CreateOrEdit"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

$body = @'

{

"name": "string",

"description": "string",

"citrixSettings": {

"connectTechnology": 0,

"server": "string",

"publishedApplication": "string"

}

}

'@

Invoke-RestMethod -Method POST -Uri $uri -Headers $headers -ContentType "application/json" -Body $body

`

Delete (TargetEnvironment)

Method: DELETE

Path: /api/services/app/TargetEnvironment/Delete

Operation ID: ApiServicesAppTargetenvironmentDeleteDelete

Tag: TargetEnvironment

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

• Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
• This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

| Name | In | Type | Required | Default | Notes |

|---|---|---|---:|---|---|

| Id | query | string (uuid) | No | | format: uuid |

Request body

None

Response

None

Curl

`bash

curl -X DELETE "https://public-api.loadgen.cloud/api/services/app/TargetEnvironment/Delete?Id=00000000-0000-0000-0000-000000000000" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/TargetEnvironment/Delete?Id=00000000-0000-0000-0000-000000000000"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

Invoke-RestMethod -Method DELETE -Uri $uri -Headers $headers

`

GetAll (TargetEnvironment)

Method: GET

Path: /api/services/app/TargetEnvironment/GetAll

Operation ID: ApiServicesAppTargetenvironmentGetallGet

Tag: TargetEnvironment

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

• Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
• This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

| Name | In | Type | Required | Default | Notes |

|---|---|---|---:|---|---|

| Filter | query | string | No | | |

| Sorting | query | string | No | | |

| SkipCount | query | integer (int32) | No | | format: int32

min: 0

max: 2147483647 |

| MaxResultCount | query | integer (int32) | No | | format: int32

min: 1

max: 2147483647 |

Request body

None

Response

Response envelope: ABP

• The actual payload is usually under the result property.
• Success is indicated by success: true. Errors are provided via error and unAuthorizedRequest.

200 OK response schema: GetAllTargetEnviornmentForOverviewDtoPagedResultDto

Response fields

| Field | Type | Required | Description | Notes |

|---|---|---:|---|---|

| items | array | No | | |

| totalCount | integer (int32) | No | | format: int32 |

Example response

`json

{

"result": {

"totalCount": 0,

"items": [

{

"name": "string",

"description": "string",

"technologyType": 0

}

]

},

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

curl -X GET "https://public-api.loadgen.cloud/api/services/app/TargetEnvironment/GetAll?Filter=string&Sorting=string&SkipCount=0" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/TargetEnvironment/GetAll?Filter=string&Sorting=string&SkipCount=0"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

Invoke-RestMethod -Method GET -Uri $uri -Headers $headers

`

GetTargetEnvironmentForEdit

Method: GET

Path: /api/services/app/TargetEnvironment/GetTargetEnvironmentForEdit

Operation ID: ApiServicesAppTargetenvironmentGettargetenvironmentforeditGet

Tag: TargetEnvironment

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

• Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
• This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

| Name | In | Type | Required | Default | Notes |

|---|---|---|---:|---|---|

| id | query | string (uuid) | No | | format: uuid |

Request body

None

Response

Response envelope: ABP

• The actual payload is usually under the result property.
• Success is indicated by success: true. Errors are provided via error and unAuthorizedRequest.

200 OK response schema: CreateOrEditTargetEnvironmentDto

Response fields

| Field | Type | Required | Description | Notes |

|---|---|---:|---|---|

| avdSettings | object(AVDConfigDto) | No | | |

| citrixSettings | object(CitrixConfigDto) | No | | |

| description | string | No | | |

| durationSettings | object(DurationDto) | No | | |

| id | string (uuid) | No | | format: uuid |

| name | string | No | | |

| rdsSettings | object(RdsConfigDto) | No | | |

| technology | enum(0 \| 1 \| 2 \| 3 \| 4 \| 5 \| 6 \| 7) | No | | format: int32

enum: 0, 1, 2, 3, 4, 5, 6, 7 |

| vMwareSettings | object(VMwareConfigDto) | No | | |

| webTestingSettings | object(WebTestingConfigDto) | No | | |

Example response

`json

{

"result": {

"name": "string",

"description": "string",

"citrixSettings": {

"connectTechnology": 0,

"server": "string",

"publishedApplication": "string"

}

},

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

curl -X GET "https://public-api.loadgen.cloud/api/services/app/TargetEnvironment/GetTargetEnvironmentForEdit?id=00000000-0000-0000-0000-000000000000" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/TargetEnvironment/GetTargetEnvironmentForEdit?id=00000000-0000-0000-0000-000000000000"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

Invoke-RestMethod -Method GET -Uri $uri -Headers $headers

`

GetTargetEnvironmentForView

Method: GET

Path: /api/services/app/TargetEnvironment/GetTargetEnvironmentForView

Operation ID: ApiServicesAppTargetenvironmentGettargetenvironmentforviewGet

Tag: TargetEnvironment

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

• Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
• This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

| Name | In | Type | Required | Default | Notes |

|---|---|---|---:|---|---|

| id | query | string (uuid) | No | | format: uuid |

Request body

None

Response

Response envelope: ABP

• The actual payload is usually under the result property.
• Success is indicated by success: true. Errors are provided via error and unAuthorizedRequest.

200 OK response schema: GetTargetEnvironmentForViewDto

Response fields

| Field | Type | Required | Description | Notes |

|---|---|---:|---|---|

| avdSettings | object(AVDConfigDto) | No | | |

| citrixSettings | object(CitrixConfigDto) | No | | |

| description | string | No | | |

| durationSettings | object(DurationDto) | No | | |

| id | string (uuid) | No | | format: uuid |

| name | string | No | | |

| rdsSettings | object(RdsConfigDto) | No | | |

| technology | enum(0 \| 1 \| 2 \| 3 \| 4 \| 5 \| 6 \| 7) | No | | format: int32

enum: 0, 1, 2, 3, 4, 5, 6, 7 |

| vMwareSettings | object(VMwareConfigDto) | No | | |

| webTestingSettings | object(WebTestingConfigDto) | No | | |

Example response

`json

{

"result": {

"name": "string",

"description": "string",

"citrixSettings": {

"connectTechnology": 0,

"server": "string",

"publishedApplication": "string"

}

},

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

curl -X GET "https://public-api.loadgen.cloud/api/services/app/TargetEnvironment/GetTargetEnvironmentForView?id=00000000-0000-0000-0000-000000000000" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/TargetEnvironment/GetTargetEnvironmentForView?id=00000000-0000-0000-0000-000000000000"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

Invoke-RestMethod -Method GET -Uri $uri -Headers $headers

`

CreateOrEdit (Test)

Method: POST

Path: /api/services/app/Test/CreateOrEdit

Operation ID: ApiServicesAppTestCreateoreditPost

Tag: Test

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

• Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
• This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

None

Request body

Request body schema: CreateOrEditTestDto

Request body fields

| Field | Type | Required | Description | Notes |

|---|---|---:|---|---|

| description | string | No | | |

| id | string (uuid) | No | | format: uuid |

| name | string | No | | |

Example request body

`json

{

"name": "string",

"description": "string",

"id": "00000000-0000-0000-0000-000000000000"

}

`

Response

None

Curl

`bash

curl -X POST "https://public-api.loadgen.cloud/api/services/app/Test/CreateOrEdit" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json" \\

-H "Content-Type: application/json" \\

--data-raw '{"name":"string","description":"string","id":"00000000-0000-0000-0000-000000000000"}'

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/Test/CreateOrEdit"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

$body = @'

{

"name": "string",

"description": "string",

"id": "00000000-0000-0000-0000-000000000000"

}

'@

Invoke-RestMethod -Method POST -Uri $uri -Headers $headers -ContentType "application/json" -Body $body

`

Delete (Test)

Method: DELETE

Path: /api/services/app/Test/Delete

Operation ID: ApiServicesAppTestDeleteDelete

Tag: Test

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

• Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
• This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

| Name | In | Type | Required | Default | Notes |

|---|---|---|---:|---|---|

| Id | query | string (uuid) | No | | format: uuid |

Request body

None

Response

None

Curl

`bash

curl -X DELETE "https://public-api.loadgen.cloud/api/services/app/Test/Delete?Id=00000000-0000-0000-0000-000000000000" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/Test/Delete?Id=00000000-0000-0000-0000-000000000000"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

Invoke-RestMethod -Method DELETE -Uri $uri -Headers $headers

`

GetAll (Test)

Method: GET

Path: /api/services/app/Test/GetAll

Operation ID: ApiServicesAppTestGetallGet

Tag: Test

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

• Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
• This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

| Name | In | Type | Required | Default | Notes |

|---|---|---|---:|---|---|

| Filter | query | string | No | | |

| Sorting | query | string | No | | |

| SkipCount | query | integer (int32) | No | | format: int32

min: 0

max: 2147483647 |

| MaxResultCount | query | integer (int32) | No | | format: int32

min: 1

max: 2147483647 |

Request body

None

Response

Response envelope: ABP

• The actual payload is usually under the result property.
• Success is indicated by success: true. Errors are provided via error and unAuthorizedRequest.

200 OK response schema: GetAllTestForViewDtoPagedResultDto

Response fields

| Field | Type | Required | Description | Notes |

|---|---|---:|---|---|

| items | array | No | | |

| totalCount | integer (int32) | No | | format: int32 |

Example response

`json

{

"result": {

"totalCount": 0,

"items": [

{

"name": "string",

"description": "string",

"id": "00000000-0000-0000-0000-000000000000"

}

]

},

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

curl -X GET "https://public-api.loadgen.cloud/api/services/app/Test/GetAll?Filter=string&Sorting=string&SkipCount=0" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/Test/GetAll?Filter=string&Sorting=string&SkipCount=0"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

Invoke-RestMethod -Method GET -Uri $uri -Headers $headers

`

CreateOrEdit (TestUser)

Method: POST

Path: /api/services/app/TestUser/CreateOrEdit

Operation ID: ApiServicesAppTestuserCreateoreditPost

Tag: TestUser

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

• Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
• This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

None

Request body

Request body schema: CreateOrEditTestUserDto

Request body fields

| Field | Type | Required | Description | Notes |

|---|---|---:|---|---|

| domain | string | No | | |

| id | string (uuid) | No | | format: uuid |

| name | string | No | | |

| password | string | No | | |

Example request body

`json

{

"name": "string",

"password": "string",

"domain": "string"

}

`

Response

None

Curl

`bash

curl -X POST "https://public-api.loadgen.cloud/api/services/app/TestUser/CreateOrEdit" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json" \\

-H "Content-Type: application/json" \\

--data-raw '{"name":"string","password":"string","domain":"string"}'

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/TestUser/CreateOrEdit"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

$body = @'

{

"name": "string",

"password": "string",

"domain": "string"

}

'@

Invoke-RestMethod -Method POST -Uri $uri -Headers $headers -ContentType "application/json" -Body $body

`

CreateWithCSV

Method: POST

Path: /api/services/app/TestUser/CreateWithCSV

Operation ID: ApiServicesAppTestuserCreatewithcsvPost

Tag: TestUser

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

• Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
• This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

None

Request body

Request body schema: CreateMultipleTestUsersDto

Request body fields

| Field | Type | Required | Description | Notes |

|---|---|---:|---|---|

| csvFileToken | string | No | | |

Example request body

`json

{

"csvFileToken": "string"

}

`

Response

None

Curl

`bash

curl -X POST "https://public-api.loadgen.cloud/api/services/app/TestUser/CreateWithCSV" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json" \\

-H "Content-Type: application/json" \\

--data-raw '{"csvFileToken":"string"}'

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/TestUser/CreateWithCSV"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

$body = @'

{

"csvFileToken": "string"

}

'@

Invoke-RestMethod -Method POST -Uri $uri -Headers $headers -ContentType "application/json" -Body $body

`

Delete (TestUser)

Method: DELETE

Path: /api/services/app/TestUser/Delete

Operation ID: ApiServicesAppTestuserDeleteDelete

Tag: TestUser

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

• Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
• This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

| Name | In | Type | Required | Default | Notes |

|---|---|---|---:|---|---|

| Id | query | string (uuid) | No | | format: uuid |

Request body

None

Response

None

Curl

`bash

curl -X DELETE "https://public-api.loadgen.cloud/api/services/app/TestUser/Delete?Id=00000000-0000-0000-0000-000000000000" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/TestUser/Delete?Id=00000000-0000-0000-0000-000000000000"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

Invoke-RestMethod -Method DELETE -Uri $uri -Headers $headers

`

GetAll (TestUser)

Method: GET

Path: /api/services/app/TestUser/GetAll

Operation ID: ApiServicesAppTestuserGetallGet

Tag: TestUser

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

• Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
• This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

| Name | In | Type | Required | Default | Notes |

|---|---|---|---:|---|---|

| UserName | query | string | No | | |

| Sorting | query | string | No | | |

| SkipCount | query | integer (int32) | No | | format: int32

min: 0

max: 2147483647 |

| MaxResultCount | query | integer (int32) | No | | format: int32

min: 1

max: 2147483647 |

Request body

None

Response

Response envelope: ABP

• The actual payload is usually under the result property.
• Success is indicated by success: true. Errors are provided via error and unAuthorizedRequest.

200 OK response schema: GetAllTestUserForOverviewDtoPagedResultDto

Response fields

| Field | Type | Required | Description | Notes |

|---|---|---:|---|---|

| items | array | No | | |

| totalCount | integer (int32) | No | | format: int32 |

Example response

`json

{

"result": {

"totalCount": 0,

"items": [

{

"name": "string",

"domain": "string",

"id": "00000000-0000-0000-0000-000000000000"

}

]

},

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

curl -X GET "https://public-api.loadgen.cloud/api/services/app/TestUser/GetAll?UserName=string&Sorting=string&SkipCount=0" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/TestUser/GetAll?UserName=string&Sorting=string&SkipCount=0"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

Invoke-RestMethod -Method GET -Uri $uri -Headers $headers

`

GetTestUserForEdit

Method: GET

Path: /api/services/app/TestUser/GetTestUserForEdit

Operation ID: ApiServicesAppTestuserGettestuserforeditGet

Tag: TestUser

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

• Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
• This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

| Name | In | Type | Required | Default | Notes |

|---|---|---|---:|---|---|

| id | query | string (uuid) | No | | format: uuid |

Request body

None

Response

Response envelope: ABP

• The actual payload is usually under the result property.
• Success is indicated by success: true. Errors are provided via error and unAuthorizedRequest.

200 OK response schema: GetTestUserForEditDto

Response fields

| Field | Type | Required | Description | Notes |

|---|---|---:|---|---|

| domain | string | No | | |

| id | string (uuid) | No | | format: uuid |

| name | string | No | | |

Example response

`json

{

"result": {

"name": "string",

"domain": "string",

"id": "00000000-0000-0000-0000-000000000000"

},

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

curl -X GET "https://public-api.loadgen.cloud/api/services/app/TestUser/GetTestUserForEdit?id=00000000-0000-0000-0000-000000000000" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/TestUser/GetTestUserForEdit?id=00000000-0000-0000-0000-000000000000"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

Invoke-RestMethod -Method GET -Uri $uri -Headers $headers

`

UpdateMultiplePasswords

Method: PUT

Path: /api/services/app/TestUser/UpdateMultiplePasswords

Operation ID: ApiServicesAppTestuserUpdatemultiplepasswordsPut

Tag: TestUser

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

• Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
• This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

None

Request body

Request body schema: UpdateTestUsersPassWordDto

Request body fields

| Field | Type | Required | Description | Notes |

|---|---|---:|---|---|

| password | string | No | | |

| testUserIds | array | No | | |

Example request body

`json

{

"password": "string",

"testUserIds": [

"00000000-0000-0000-0000-000000000000"

]

}

`

Response

None

Curl

`bash

curl -X PUT "https://public-api.loadgen.cloud/api/services/app/TestUser/UpdateMultiplePasswords" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json" \\

-H "Content-Type: application/json" \\

--data-raw '{"password":"string","testUserIds":["00000000-0000-0000-0000-000000000000"]}'

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/TestUser/UpdateMultiplePasswords"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

$body = @'

{

"password": "string",

"testUserIds": [

"00000000-0000-0000-0000-000000000000"

]

}

'@

Invoke-RestMethod -Method PUT -Uri $uri -Headers $headers -ContentType "application/json" -Body $body

`