Cloud API - Machines and Machine Groups

Updated

Cloud API - Machines and Machine Groups

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

This article documents machine and machine group endpoints (machines, groups, configs, and related operations).

Create

Method: POST

Path: /api/services/app/MachineGroup/Create

Operation ID: ApiServicesAppMachinegroupCreatePost

Tag: MachineGroup

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

Request body fields

| Field | Type | Required | Description | Notes |

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

| cacheDatabase | object(CacheDatabaseConfig) | No | | |

| cpuLoadMonitoring | object(GuidNameValueDtoCpuLoadMonitoringConfig) | No | | |

| directorySize | object(GuidNameValueDtoDirectorySizeConfig) | No | | |

| general | object(GeneralConfig) | No | | |

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

| influxDatabase | object(InfluxDatabaseConfig) | No | | |

| masterControlAgent | object(GuidNameValueDtoMasterControlAgentConfig) | No | | |

| monitoringGeneral | object(MonitoringGeneralConfig) | No | | |

| monitoringNetwork | object(MonitoringNetworkConfig) | No | | |

| monitoringProcess | object(GuidNameValueDtoMonitoringProcessConfig) | No | | |

| monitoringProcessInformation | object(MonitoringProcessInformationConfig) | No | | |

| monitoringSystem | object(GuidNameValueDtoMonitoringSystemConfig) | No | | |

| registry | object(GuidNameValueDtoRegistryConfig) | No | | |

| remoteView | object(RemoteViewConfig) | No | | |

| specsSystem | object(SpecsSystemConfig) | No | | |

| updateAgent | object(UpdateAgentConfig) | No | | |

| updateConfiguration | object(UpdateConfigurationConfig) | No | | |

| windowsUpdate | object(GuidNameValueDtoWindowsUpdateConfig) | No | | |

| wmiQueries | array | No | | |

Example request body

`json

{

"general": {

"checkinInterval": 0,

"licenseCheckDays": 1,

"name": "string",

"uploadInterval": 1

},

"updateAgent": {

"interval": 1,

"enable": false,

"enableBetaAgents": false

},

"updateConfiguration": {

"interval": 60

}

}

`

Response

None

Curl

`bash

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

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json" \\

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

--data-raw '{"general":{"checkinInterval":0,"licenseCheckDays":1,"name":"string","uploadInterval":1},"updateAgent":{"interval":1,"enable":false,"enableBetaAgents":false},"updateConfiguration":{"interval":60}}'

`

PowerShell

`powershell

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

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

$tenantId = 12345

$accessToken = ""

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

$body = @'

{

"general": {

"checkinInterval": 0,

"licenseCheckDays": 1,

"name": "string",

"uploadInterval": 1

},

"updateAgent": {

"interval": 1,

"enable": false,

"enableBetaAgents": false

},

"updateConfiguration": {

"interval": 60

}

}

'@

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

`

Delete (MachineGroup)

Method: DELETE

Path: /api/services/app/MachineGroup/Delete

Operation ID: ApiServicesAppMachinegroupDeleteDelete

Tag: MachineGroup

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

`

Duplicate

Method: POST

Path: /api/services/app/MachineGroup/Duplicate

Operation ID: ApiServicesAppMachinegroupDuplicatePost

Tag: MachineGroup

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 |

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

| newName | query | string | No | | |

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

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/MachineGroup/Duplicate?newName=string" \\

-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/MachineGroup/Duplicate?newName=string"

$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

`

GetAllForTreeView

Method: GET

Path: /api/services/app/MachineGroup/GetAllForTreeView

Operation ID: ApiServicesAppMachinegroupGetallfortreeviewGet

Tag: MachineGroup

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

Response fields

| Field | Type | Required | Description | Notes |

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

| items | array | No | | |

Example response

`json

{

"result": {

"items": [

{

"missingFields": [

{}

],

"isEnabled": false,

"machineCount": 0

}

]

},

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

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

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

`

PowerShell

`powershell

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

$uri = "$baseUrl/api/services/app/MachineGroup/GetAllForTreeView"

$tenantId = 12345

$accessToken = ""

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

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

`

GetAllInstallVersionsForLookupTable

Method: GET

Path: /api/services/app/MachineGroup/GetAllInstallVersionsForLookupTable

Operation ID: ApiServicesAppMachinegroupGetallinstallversionsforlookuptableGet

Tag: MachineGroup

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 |

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

| ShowBetaVersions | query | boolean | 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: Int32MachineGroupLookupTableDtoPagedResultDto

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/MachineGroup/GetAllInstallVersionsForLookupTable?ShowBetaVersions=false&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/MachineGroup/GetAllInstallVersionsForLookupTable?ShowBetaVersions=false&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

`

GetAllMasterControlAgentsForLookupTable

Method: GET

Path: /api/services/app/MachineGroup/GetAllMasterControlAgentsForLookupTable

Operation ID: ApiServicesAppMachinegroupGetallmastercontrolagentsforlookuptableGet

Tag: MachineGroup

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 |

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

| NotAlreadyAdded | query | boolean | No | | |

| DontInclude | query | array | 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: GuidMachineGroupLookupTableDtoPagedResultDto

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

"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/MachineGroup/GetAllMasterControlAgentsForLookupTable?NotAlreadyAdded=false&DontInclude=00000000-0000-0000-0000-000000000000&Filter=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/MachineGroup/GetAllMasterControlAgentsForLookupTable?NotAlreadyAdded=false&DontInclude=00000000-0000-0000-0000-000000000000&Filter=string"

$tenantId = 12345

$accessToken = ""

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

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

`

GetAllOrganizationUnitForLookupTable

Method: GET

Path: /api/services/app/MachineGroup/GetAllOrganizationUnitForLookupTable

Operation ID: ApiServicesAppMachinegroupGetallorganizationunitforlookuptableGet

Tag: MachineGroup

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

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/MachineGroup/GetAllOrganizationUnitForLookupTable?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/MachineGroup/GetAllOrganizationUnitForLookupTable?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

`

GetControlAgentWithId

Method: GET

Path: /api/services/app/MachineGroup/GetControlAgentWithId

Operation ID: ApiServicesAppMachinegroupGetcontrolagentwithidGet

Tag: MachineGroup

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

Response fields

| Field | Type | Required | Description | Notes |

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

| displayName | string | No | | |

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

Example response

`json

{

"result": {

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

"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/MachineGroup/GetControlAgentWithId?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/MachineGroup/GetControlAgentWithId?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

`

GetForView

Method: GET

Path: /api/services/app/MachineGroup/GetForView

Operation ID: ApiServicesAppMachinegroupGetforviewGet

Tag: MachineGroup

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 |

| type | query | enum(0 | 1 | 2) | No | | format: int32

enum: 0, 1, 2 |

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

Response fields

| Field | Type | Required | Description | Notes |

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

| general | object(GeneralConfigForView) | No | | |

Example response

`json

{

"result": {

"general": {

"checkinInterval": 0,

"licenseCheckDays": 1,

"name": "string",

"uploadInterval": 1

}

},

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

curl -X GET "https://public-api.loadgen.cloud/api/services/app/MachineGroup/GetForView?id=00000000-0000-0000-0000-000000000000&type=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/MachineGroup/GetForView?id=00000000-0000-0000-0000-000000000000&type=0"

$tenantId = 12345

$accessToken = ""

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

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

`

GetInstallerVersionWithId

Method: GET

Path: /api/services/app/MachineGroup/GetInstallerVersionWithId

Operation ID: ApiServicesAppMachinegroupGetinstallerversionwithidGet

Tag: MachineGroup

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 | integer (int32) | No | | format: int32 |

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

Response fields

| Field | Type | Required | Description | Notes |

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

| displayName | string | No | | |

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

Example response

`json

{

"result": {

"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/MachineGroup/GetInstallerVersionWithId?id=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/MachineGroup/GetInstallerVersionWithId?id=0"

$tenantId = 12345

$accessToken = ""

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

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

`

GetMachineGroupConfig

Method: GET

Path: /api/services/app/MachineGroup/GetMachineGroupConfig

Operation ID: ApiServicesAppMachinegroupGetmachinegroupconfigGet

Tag: MachineGroup

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 |

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

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

| config | query | enum(0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17) | No | | format: int32

enum: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17 |

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

Response fields

None

Example response

`json

{

"result": {

"key": "value"

},

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

curl -X GET "https://public-api.loadgen.cloud/api/services/app/MachineGroup/GetMachineGroupConfig?machineGroupId=00000000-0000-0000-0000-000000000000&config=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/MachineGroup/GetMachineGroupConfig?machineGroupId=00000000-0000-0000-0000-000000000000&config=0"

$tenantId = 12345

$accessToken = ""

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

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

`

GetOrganizationUnitWithId

Method: GET

Path: /api/services/app/MachineGroup/GetOrganizationUnitWithId

Operation ID: ApiServicesAppMachinegroupGetorganizationunitwithidGet

Tag: MachineGroup

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 | integer (int64) | No | | format: int64 |

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

Response fields

| Field | Type | Required | Description | Notes |

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

| displayName | string | No | | |

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

Example response

`json

{

"result": {

"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/MachineGroup/GetOrganizationUnitWithId?id=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/MachineGroup/GetOrganizationUnitWithId?id=0"

$tenantId = 12345

$accessToken = ""

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

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

`

SetActive

Method: POST

Path: /api/services/app/MachineGroup/SetActive

Operation ID: ApiServicesAppMachinegroupSetactivePost

Tag: MachineGroup

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 |

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

| active | query | boolean | No | | |

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/MachineGroup/SetActive?active=false" \\

-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/MachineGroup/SetActive?active=false"

$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

`

UpdateMachineGroupConfig

Method: PUT

Path: /api/services/app/MachineGroup/UpdateMachineGroupConfig

Operation ID: ApiServicesAppMachinegroupUpdatemachinegroupconfigPut

Tag: MachineGroup

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

Request body fields

| Field | Type | Required | Description | Notes |

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

| config | object | No | | |

| machineGroupConfigs | enum(0 \| 1 \| 2 \| 3 \| 4 \| 5 \| 6 \| 7 \| 8 \| 9 \| 10 \| 11 \| 12 \| 13 \| 14 \| 15 \| 16 \| 17) | No | | format: int32

enum: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17 |

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

Example request body

`json

{

"machineGroupId": "00000000-0000-0000-0000-000000000000",

"machineGroupConfigs": 0,

"config": {

"key": "value"

}

}

`

Response

None

Curl

`bash

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

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json" \\

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

--data-raw '{"machineGroupId":"00000000-0000-0000-0000-000000000000","machineGroupConfigs":0,"config":{"key":"value"}}'

`

PowerShell

`powershell

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

$uri = "$baseUrl/api/services/app/MachineGroup/UpdateMachineGroupConfig"

$tenantId = 12345

$accessToken = ""

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

$body = @'

{

"machineGroupId": "00000000-0000-0000-0000-000000000000",

"machineGroupConfigs": 0,

"config": {

"key": "value"

}

}

'@

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

`

AddUserCounter

Method: POST

Path: /api/services/app/Machines/AddUserCounter

Operation ID: ApiServicesAppMachinesAddusercounterPost

Tag: Machines

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

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

Request body

None

Response

None

Curl

`bash

curl -X POST "https://public-api.loadgen.cloud/api/services/app/Machines/AddUserCounter?name=string&machineId=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/Machines/AddUserCounter?name=string&machineId=00000000-0000-0000-0000-000000000000"

$tenantId = 12345

$accessToken = ""

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

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

`

Checkin

Method: POST

Path: /api/services/app/Machines/Checkin

Operation ID: ApiServicesAppMachinesCheckinPost

Tag: Machines

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

Request body fields

| Field | Type | Required | Description | Notes |

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

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

| machineId | string | No | | |

| machineName | string | No | | |

| status | enum(0 \| 1 \| 2) | No | | format: int32

enum: 0, 1, 2 |

| version | string | No | | |

Example request body

`json

{

"machineId": "string",

"status": 0,

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

}

`

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": [

{

"jobType": 0,

"urgency": 0,

"machineId": "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/Machines/Checkin" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json" \\

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

--data-raw '{"machineId":"string","status":0,"checkInDate":"2025-01-01T00:00:00Z"}'

`

PowerShell

`powershell

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

$uri = "$baseUrl/api/services/app/Machines/Checkin"

$tenantId = 12345

$accessToken = ""

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

$body = @'

{

"machineId": "string",

"status": 0,

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

}

'@

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

`

CreateBatch

Method: POST

Path: /api/services/app/Machines/CreateBatch

Operation ID: ApiServicesAppMachinesCreatebatchPost

Tag: Machines

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

Request body fields

None

Example request body

`json

[

{

"name": "string",

"description": "string",

"machineGroupId": "00000000-0000-0000-0000-000000000000"

}

]

`

Response

None

Curl

`bash

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

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json" \\

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

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

`

PowerShell

`powershell

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

$uri = "$baseUrl/api/services/app/Machines/CreateBatch"

$tenantId = 12345

$accessToken = ""

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

$body = @'

[

{

"name": "string",

"description": "string",

"machineGroupId": "00000000-0000-0000-0000-000000000000"

}

]

'@

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

`

CreateOrEdit

Method: POST

Path: /api/services/app/Machines/CreateOrEdit

Operation ID: ApiServicesAppMachinesCreateoreditPost

Tag: Machines

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

Request body fields

| Field | Type | Required | Description | Notes |

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

| name | string | Yes | | minLength: 0

maxLength: 64 |

| description | string | No | | |

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

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

| uniqueID | string | No | | |

Example request body

`json

{

"name": "string",

"description": "string",

"machineGroupId": "00000000-0000-0000-0000-000000000000"

}

`

Response

None

Curl

`bash

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

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json" \\

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

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

`

PowerShell

`powershell

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

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

$tenantId = 12345

$accessToken = ""

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

$body = @'

{

"name": "string",

"description": "string",

"machineGroupId": "00000000-0000-0000-0000-000000000000"

}

'@

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

`

Delete (Machines)

Method: DELETE

Path: /api/services/app/Machines/Delete

Operation ID: ApiServicesAppMachinesDeleteDelete

Tag: Machines

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

Method: GET

Path: /api/services/app/Machines/GetAll

Operation ID: ApiServicesAppMachinesGetallGet

Tag: Machines

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

| NameFilter | query | string | No | | |

| GroupFilter | query | string | No | | |

| StatusFilter | query | boolean | 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: GetMachineForViewDtoPagedResultDto

Response fields

| Field | Type | Required | Description | Notes |

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

| items | array | No | | |

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

Example response

`json

{

"result": {

"totalCount": 0,

"items": [

{

"machine": {

"name": "string",

"description": "string",

"machineGroupId": "00000000-0000-0000-0000-000000000000"

},

"machineGroupName": "string"

}

]

},

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

curl -X GET "https://public-api.loadgen.cloud/api/services/app/Machines/GetAll?Filter=string&NameFilter=string&GroupFilter=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/Machines/GetAll?Filter=string&NameFilter=string&GroupFilter=string"

$tenantId = 12345

$accessToken = ""

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

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

`

GetAllMachineGroupsForLookupTable

Method: GET

Path: /api/services/app/Machines/GetAllMachineGroupsForLookupTable

Operation ID: ApiServicesAppMachinesGetallmachinegroupsforlookuptableGet

Tag: Machines

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

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

"value": "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/Machines/GetAllMachineGroupsForLookupTable?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/Machines/GetAllMachineGroupsForLookupTable?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

`

GetMachineForEdit

Method: GET

Path: /api/services/app/Machines/GetMachineForEdit

Operation ID: ApiServicesAppMachinesGetmachineforeditGet

Tag: Machines

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

Response fields

| Field | Type | Required | Description | Notes |

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

| machine | object(CreateOrEditMachineDto) | No | | |

| machineGroupName | string | No | | |

Example response

`json

{

"result": {

"machine": {

"name": "string",

"description": "string",

"machineGroupId": "00000000-0000-0000-0000-000000000000"

},

"machineGroupName": "string"

},

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

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

`

GetMachineForView

Method: GET

Path: /api/services/app/Machines/GetMachineForView

Operation ID: ApiServicesAppMachinesGetmachineforviewGet

Tag: Machines

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

Response fields

| Field | Type | Required | Description | Notes |

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

| machine | object(MachineDto) | No | | |

| machineGroupName | string | No | | |

Example response

`json

{

"result": {

"machine": {

"name": "string",

"description": "string",

"machineGroupId": "00000000-0000-0000-0000-000000000000"

},

"machineGroupName": "string"

},

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

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

`

GetMachinesInMachineGroup

Method: GET

Path: /api/services/app/Machines/GetMachinesInMachineGroup

Operation ID: ApiServicesAppMachinesGetmachinesinmachinegroupGet

Tag: Machines

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 |

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

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

| sort | query | string | No | | |

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

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

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

Response fields

| Field | Type | Required | Description | Notes |

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

| items | array | No | | |

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

Example response

`json

{

"result": {

"totalCount": 0,

"items": [

{

"machine": {

"name": "string",

"description": "string",

"machineGroupId": "00000000-0000-0000-0000-000000000000"

},

"machineGroupName": "string"

}

]

},

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

curl -X GET "https://public-api.loadgen.cloud/api/services/app/Machines/GetMachinesInMachineGroup?groupId=00000000-0000-0000-0000-000000000000&sort=string&skip=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/Machines/GetMachinesInMachineGroup?groupId=00000000-0000-0000-0000-000000000000&sort=string&skip=0"

$tenantId = 12345

$accessToken = ""

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

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

`

GetMachinesNotInMachineGroup

Method: GET

Path: /api/services/app/Machines/GetMachinesNotInMachineGroup

Operation ID: ApiServicesAppMachinesGetmachinesnotinmachinegroupGet

Tag: Machines

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 |

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

| sort | query | string | No | | |

| filter | query | string | No | | |

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

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

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

Response fields

| Field | Type | Required | Description | Notes |

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

| items | array | No | | |

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

Example response

`json

{

"result": {

"totalCount": 0,

"items": [

{

"machine": {

"name": "string",

"description": "string",

"machineGroupId": "00000000-0000-0000-0000-000000000000"

},

"machineGroupName": "string"

}

]

},

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

curl -X GET "https://public-api.loadgen.cloud/api/services/app/Machines/GetMachinesNotInMachineGroup?sort=string&filter=string&skip=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/Machines/GetMachinesNotInMachineGroup?sort=string&filter=string&skip=0"

$tenantId = 12345

$accessToken = ""

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

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

`

RemoveMachineFromMachineGroup

Method: DELETE

Path: /api/services/app/Machines/RemoveMachineFromMachineGroup

Operation ID: ApiServicesAppMachinesRemovemachinefrommachinegroupDelete

Tag: Machines

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 |

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

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

| 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/Machines/RemoveMachineFromMachineGroup?GroupId=00000000-0000-0000-0000-000000000000&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/Machines/RemoveMachineFromMachineGroup?GroupId=00000000-0000-0000-0000-000000000000&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

`

SetMachineMachineGroup

Method: POST

Path: /api/services/app/Machines/SetMachineMachineGroup

Operation ID: ApiServicesAppMachinesSetmachinemachinegroupPost

Tag: Machines

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 |

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

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

Request body

Request body schema: array

Request body fields

None

Example request body

`json

[

"00000000-0000-0000-0000-000000000000"

]

`

Response

None

Curl

`bash

curl -X POST "https://public-api.loadgen.cloud/api/services/app/Machines/SetMachineMachineGroup?groupId=00000000-0000-0000-0000-000000000000" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json" \\

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

--data-raw '["00000000-0000-0000-0000-000000000000"]'

`

PowerShell

`powershell

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

$uri = "$baseUrl/api/services/app/Machines/SetMachineMachineGroup?groupId=00000000-0000-0000-0000-000000000000"

$tenantId = 12345

$accessToken = ""

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

$body = @'

[

"00000000-0000-0000-0000-000000000000"

]

'@

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

`

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