Cloud API - Control Agents and Jobs

Updated

Cloud API - Control Agents and Jobs

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

This article documents control plane endpoints (control agents, control jobs, and control APIs).

CreateOrEdit (ControlAgent)

Method: POST

Path: /api/services/app/ControlAgent/CreateOrEdit

Operation ID: ApiServicesAppControlagentCreateoreditPost

Tag: ControlAgent

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: CreateOrEditControlAgentDto

Request body fields

| Field | Type | Required | Description | Notes |

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

| name | string | Yes | | minLength: 0

maxLength: 64 |

| dnsAddress | string | No | | |

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

| ipAddress | string | No | | |

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

Example request body

`json

{

"name": "string",

"parentControlAgentId": "00000000-0000-0000-0000-000000000000",

"dnsAddress": "string"

}

`

Response

None

Curl

`bash

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

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json" \\

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

--data-raw '{"name":"string","parentControlAgentId":"00000000-0000-0000-0000-000000000000","dnsAddress":"string"}'

`

PowerShell

`powershell

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

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

$tenantId = 12345

$accessToken = ""

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

$body = @'

{

"name": "string",

"parentControlAgentId": "00000000-0000-0000-0000-000000000000",

"dnsAddress": "string"

}

'@

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

`

Delete (ControlAgent)

Method: DELETE

Path: /api/services/app/ControlAgent/Delete

Operation ID: ApiServicesAppControlagentDeleteDelete

Tag: ControlAgent

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/ControlAgent/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/ControlAgent/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

`

GetAllByParentId

Method: GET

Path: /api/services/app/ControlAgent/GetAllByParentId

Operation ID: ApiServicesAppControlagentGetallbyparentidGet

Tag: ControlAgent

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 |

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

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

| 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: GetControlAgentForViewDtoPagedResultDto

Response fields

| Field | Type | Required | Description | Notes |

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

| items | array | No | | |

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

Example response

`json

{

"result": {

"totalCount": 0,

"items": [

{

"parentControlAgent": {

"name": "string",

"value": "00000000-0000-0000-0000-000000000000"

},

"name": "string",

"hasChildren": false

}

]

},

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

curl -X GET "https://public-api.loadgen.cloud/api/services/app/ControlAgent/GetAllByParentId?ParentId=00000000-0000-0000-0000-000000000000&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/ControlAgent/GetAllByParentId?ParentId=00000000-0000-0000-0000-000000000000&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

`

Create (ControlJob)

Method: POST

Path: /api/services/app/ControlJob/Create

Operation ID: ApiServicesAppControljobCreatePost

Tag: ControlJob

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: CreateControlJobDto

Request body fields

| Field | Type | Required | Description | Notes |

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

| startTime | string (date-time) | Yes | | format: date-time |

| command | string | No | | |

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

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

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

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

| packageIsZip | boolean | No | | |

| packageName | string | No | | |

| runAsPassword | string | No | | |

| runAsUser | boolean | No | | |

| runAsUserName | string | No | | |

| saveLocation | string | No | | |

| targetMachines | array | No | | |

Example request body

`json

{

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

"packageId": "00000000-0000-0000-0000-000000000000",

"packageIsZip": false

}

`

Response

None

Curl

`bash

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

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json" \\

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

--data-raw '{"startTime":"2025-01-01T00:00:00Z","packageId":"00000000-0000-0000-0000-000000000000","packageIsZip":false}'

`

PowerShell

`powershell

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

$uri = "$baseUrl/api/services/app/ControlJob/Create"

$tenantId = 12345

$accessToken = ""

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

$body = @'

{

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

"packageId": "00000000-0000-0000-0000-000000000000",

"packageIsZip": false

}

'@

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

`

CreateOrEdit (ControlJob)

Method: POST

Path: /api/services/app/ControlJob/CreateOrEdit

Operation ID: ApiServicesAppControljobCreateoreditPost

Tag: ControlJob

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: CreateOrEditControlJobMetaDto

Request body fields

| Field | Type | Required | Description | Notes |

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

| command | string | No | | |

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

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

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

| packageBytes | string (byte) | No | | format: byte |

| packageIsZip | boolean | No | | |

| packageName | string | No | | |

| runAsPassword | string | No | | |

| runAsUser | boolean | No | | |

| runAsUserName | string | No | | |

| saveLocation | string | No | | |

| targets | array | No | | |

Example request body

`json

{

"packageBytes": "AA==",

"packageIsZip": false,

"packageName": "string"

}

`

Response

None

Curl

`bash

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

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json" \\

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

--data-raw '{"packageBytes":"AA==","packageIsZip":false,"packageName":"string"}'

`

PowerShell

`powershell

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

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

$tenantId = 12345

$accessToken = ""

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

$body = @'

{

"packageBytes": "AA==",

"packageIsZip": false,

"packageName": "string"

}

'@

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

`

Delete (ControlJob)

Method: DELETE

Path: /api/services/app/ControlJob/Delete

Operation ID: ApiServicesAppControljobDeleteDelete

Tag: ControlJob

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/ControlJob/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/ControlJob/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 (ControlJob)

Method: GET

Path: /api/services/app/ControlJob/GetAll

Operation ID: ApiServicesAppControljobGetallGet

Tag: ControlJob

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 | | |

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

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

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

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

| CommandFilter | query | string | No | | |

| UserNameFilter | 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: GetControlJobMetaForViewDtoPagedResultDto

Response fields

| Field | Type | Required | Description | Notes |

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

| items | array | No | | |

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

Example response

`json

{

"result": {

"totalCount": 0,

"items": [

{

"controlJobMeta": {

"packageName": "string",

"command": "string"

},

"userName": "string"

}

]

},

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

curl -X GET "https://public-api.loadgen.cloud/api/services/app/ControlJob/GetAll?Filter=string&MaxCreationTimeFilter=2025-01-01T00%3A00%3A00Z&MinCreationTimeFilter=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/ControlJob/GetAll?Filter=string&MaxCreationTimeFilter=2025-01-01T00%3A00%3A00Z&MinCreationTimeFilter=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

`

GetAllUserForLookupTable (ControlJob)

Method: GET

Path: /api/services/app/ControlJob/GetAllUserForLookupTable

Operation ID: ApiServicesAppControljobGetalluserforlookuptableGet

Tag: ControlJob

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: ControlJobMetaUserLookupTableDtoPagedResultDto

Response fields

| Field | Type | Required | Description | Notes |

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

| items | array | No | | |

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

Example response

`json

{

"result": {

"totalCount": 0,

"items": [

{

"id": 0,

"displayName": "string"

}

]

},

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

curl -X GET "https://public-api.loadgen.cloud/api/services/app/ControlJob/GetAllUserForLookupTable?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/ControlJob/GetAllUserForLookupTable?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

`

GetControlJobMetaForEdit (ControlJob)

Method: GET

Path: /api/services/app/ControlJob/GetControlJobMetaForEdit

Operation ID: ApiServicesAppControljobGetcontroljobmetaforeditGet

Tag: ControlJob

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: GetControlJobMetaForEditOutput

Response fields

| Field | Type | Required | Description | Notes |

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

| controlJobMeta | object(CreateOrEditControlJobMetaDto) | No | | |

| userName | string | No | | |

Example response

`json

{

"result": {

"controlJobMeta": {

"packageBytes": "AA==",

"packageIsZip": false,

"packageName": "string"

},

"userName": "string"

},

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

curl -X GET "https://public-api.loadgen.cloud/api/services/app/ControlJob/GetControlJobMetaForEdit?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/ControlJob/GetControlJobMetaForEdit?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

`

GetControlJobMetaForView (ControlJob)

Method: GET

Path: /api/services/app/ControlJob/GetControlJobMetaForView

Operation ID: ApiServicesAppControljobGetcontroljobmetaforviewGet

Tag: ControlJob

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: GetControlJobMetaForViewDto

Response fields

| Field | Type | Required | Description | Notes |

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

| controlJobMeta | object(ControlJobMetaDto) | No | | |

| userName | string | No | | |

Example response

`json

{

"result": {

"controlJobMeta": {

"packageName": "string",

"command": "string",

"jobType": 0

},

"userName": "string"

},

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

curl -X GET "https://public-api.loadgen.cloud/api/services/app/ControlJob/GetControlJobMetaForView?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/ControlJob/GetControlJobMetaForView?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

`

Create (ControlJobs)

Method: POST

Path: /api/services/app/ControlJobs/Create

Operation ID: ApiServicesAppControljobsCreatePost

Tag: ControlJobs

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: CreateControlJobDto

Request body fields

| Field | Type | Required | Description | Notes |

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

| startTime | string (date-time) | Yes | | format: date-time |

| command | string | No | | |

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

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

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

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

| packageIsZip | boolean | No | | |

| packageName | string | No | | |

| runAsPassword | string | No | | |

| runAsUser | boolean | No | | |

| runAsUserName | string | No | | |

| saveLocation | string | No | | |

| targetMachines | array | No | | |

Example request body

`json

{

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

"packageId": "00000000-0000-0000-0000-000000000000",

"packageIsZip": false

}

`

Response

None

Curl

`bash

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

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json" \\

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

--data-raw '{"startTime":"2025-01-01T00:00:00Z","packageId":"00000000-0000-0000-0000-000000000000","packageIsZip":false}'

`

PowerShell

`powershell

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

$uri = "$baseUrl/api/services/app/ControlJobs/Create"

$tenantId = 12345

$accessToken = ""

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

$body = @'

{

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

"packageId": "00000000-0000-0000-0000-000000000000",

"packageIsZip": false

}

'@

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

`

CreateOrEdit (ControlJobs)

Method: POST

Path: /api/services/app/ControlJobs/CreateOrEdit

Operation ID: ApiServicesAppControljobsCreateoreditPost

Tag: ControlJobs

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: CreateOrEditControlJobMetaDto

Request body fields

| Field | Type | Required | Description | Notes |

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

| command | string | No | | |

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

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

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

| packageBytes | string (byte) | No | | format: byte |

| packageIsZip | boolean | No | | |

| packageName | string | No | | |

| runAsPassword | string | No | | |

| runAsUser | boolean | No | | |

| runAsUserName | string | No | | |

| saveLocation | string | No | | |

| targets | array | No | | |

Example request body

`json

{

"packageBytes": "AA==",

"packageIsZip": false,

"packageName": "string"

}

`

Response

None

Curl

`bash

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

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json" \\

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

--data-raw '{"packageBytes":"AA==","packageIsZip":false,"packageName":"string"}'

`

PowerShell

`powershell

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

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

$tenantId = 12345

$accessToken = ""

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

$body = @'

{

"packageBytes": "AA==",

"packageIsZip": false,

"packageName": "string"

}

'@

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

`

Delete (ControlJobs)

Method: DELETE

Path: /api/services/app/ControlJobs/Delete

Operation ID: ApiServicesAppControljobsDeleteDelete

Tag: ControlJobs

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/ControlJobs/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/ControlJobs/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 (ControlJobs)

Method: GET

Path: /api/services/app/ControlJobs/GetAll

Operation ID: ApiServicesAppControljobsGetallGet

Tag: ControlJobs

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 | | |

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

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

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

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

| CommandFilter | query | string | No | | |

| UserNameFilter | 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: GetControlJobMetaForViewDtoPagedResultDto

Response fields

| Field | Type | Required | Description | Notes |

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

| items | array | No | | |

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

Example response

`json

{

"result": {

"totalCount": 0,

"items": [

{

"controlJobMeta": {

"packageName": "string",

"command": "string"

},

"userName": "string"

}

]

},

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

curl -X GET "https://public-api.loadgen.cloud/api/services/app/ControlJobs/GetAll?Filter=string&MaxCreationTimeFilter=2025-01-01T00%3A00%3A00Z&MinCreationTimeFilter=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/ControlJobs/GetAll?Filter=string&MaxCreationTimeFilter=2025-01-01T00%3A00%3A00Z&MinCreationTimeFilter=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

`

GetAllUserForLookupTable (ControlJobs)

Method: GET

Path: /api/services/app/ControlJobs/GetAllUserForLookupTable

Operation ID: ApiServicesAppControljobsGetalluserforlookuptableGet

Tag: ControlJobs

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: ControlJobMetaUserLookupTableDtoPagedResultDto

Response fields

| Field | Type | Required | Description | Notes |

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

| items | array | No | | |

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

Example response

`json

{

"result": {

"totalCount": 0,

"items": [

{

"id": 0,

"displayName": "string"

}

]

},

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

curl -X GET "https://public-api.loadgen.cloud/api/services/app/ControlJobs/GetAllUserForLookupTable?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/ControlJobs/GetAllUserForLookupTable?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

`

GetControlJobMetaForEdit (ControlJobs)

Method: GET

Path: /api/services/app/ControlJobs/GetControlJobMetaForEdit

Operation ID: ApiServicesAppControljobsGetcontroljobmetaforeditGet

Tag: ControlJobs

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: GetControlJobMetaForEditOutput

Response fields

| Field | Type | Required | Description | Notes |

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

| controlJobMeta | object(CreateOrEditControlJobMetaDto) | No | | |

| userName | string | No | | |

Example response

`json

{

"result": {

"controlJobMeta": {

"packageBytes": "AA==",

"packageIsZip": false,

"packageName": "string"

},

"userName": "string"

},

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

curl -X GET "https://public-api.loadgen.cloud/api/services/app/ControlJobs/GetControlJobMetaForEdit?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/ControlJobs/GetControlJobMetaForEdit?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

`

GetControlJobMetaForView (ControlJobs)

Method: GET

Path: /api/services/app/ControlJobs/GetControlJobMetaForView

Operation ID: ApiServicesAppControljobsGetcontroljobmetaforviewGet

Tag: ControlJobs

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: GetControlJobMetaForViewDto

Response fields

| Field | Type | Required | Description | Notes |

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

| controlJobMeta | object(ControlJobMetaDto) | No | | |

| userName | string | No | | |

Example response

`json

{

"result": {

"controlJobMeta": {

"packageName": "string",

"command": "string",

"jobType": 0

},

"userName": "string"

},

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

curl -X GET "https://public-api.loadgen.cloud/api/services/app/ControlJobs/GetControlJobMetaForView?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/ControlJobs/GetControlJobMetaForView?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

`

GetTriggerStatusControlJob

Method: GET

Path: /api/services/app/ControlJobsControlApi/GetTriggerStatusControlJob

Operation ID: ApiServicesAppControljobscontrolapiGettriggerstatuscontroljobGet

Tag: ControlJobsControlApi

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 |

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

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

Request body

None

Response

None

Curl

`bash

curl -X GET "https://public-api.loadgen.cloud/api/services/app/ControlJobsControlApi/GetTriggerStatusControlJob?controlJobGuid=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/ControlJobsControlApi/GetTriggerStatusControlJob?controlJobGuid=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

`

Was this article helpful?
0 out of 0 found this helpful