Cloud API - Monitoring Data and Diagnostics

Updated

Cloud API - Monitoring Data and Diagnostics

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

This article documents monitoring data and diagnostic endpoints (performance counters, system/process performance, logs, connectivity checks, caching).

CanClearAllCaches

Method: POST

Path: /api/services/app/Caching/CanClearAllCaches

Operation ID: ApiServicesAppCachingCanclearallcachesPost

Tag: Caching

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

Response fields

None

Example response

`json

{

"result": false,

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

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

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json" \\

-H "Content-Type: application/json"

`

PowerShell

`powershell

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

$uri = "$baseUrl/api/services/app/Caching/CanClearAllCaches"

$tenantId = 12345

$accessToken = ""

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

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

`

ClearAllCaches

Method: POST

Path: /api/services/app/Caching/ClearAllCaches

Operation ID: ApiServicesAppCachingClearallcachesPost

Tag: Caching

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

None

Curl

`bash

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

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

`

PowerShell

`powershell

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

$uri = "$baseUrl/api/services/app/Caching/ClearAllCaches"

$tenantId = 12345

$accessToken = ""

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

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

`

ClearCache

Method: POST

Path: /api/services/app/Caching/ClearCache

Operation ID: ApiServicesAppCachingClearcachePost

Tag: Caching

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

Request body fields

| Field | Type | Required | Description | Notes |

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

| id | string | No | | |

Example request body

`json

{

"id": "string"

}

`

Response

None

Curl

`bash

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

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json" \\

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

--data-raw '{"id":"string"}'

`

PowerShell

`powershell

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

$uri = "$baseUrl/api/services/app/Caching/ClearCache"

$tenantId = 12345

$accessToken = ""

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

$body = @'

{

"id": "string"

}

'@

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

`

GetAllCaches

Method: GET

Path: /api/services/app/Caching/GetAllCaches

Operation ID: ApiServicesAppCachingGetallcachesGet

Tag: Caching

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

Response fields

| Field | Type | Required | Description | Notes |

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

| items | array | No | | |

Example response

`json

{

"result": {

"items": [

{

"name": "string"

}

]

},

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

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

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

`

PowerShell

`powershell

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

$uri = "$baseUrl/api/services/app/Caching/GetAllCaches"

$tenantId = 12345

$accessToken = ""

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

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

`

GetNetworkConnectionCheck

Method: GET

Path: /api/services/app/NCC/GetNetworkConnectionCheck

Operation ID: ApiServicesAppNCCGetnetworkconnectioncheckGet

Tag: NCC

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

Response fields

None

Example response

`json

{

"result": "string",

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

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

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

`

PowerShell

`powershell

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

$uri = "$baseUrl/api/services/app/NCC/GetNetworkConnectionCheck"

$tenantId = 12345

$accessToken = ""

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

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

`

SendAllCounters

Method: POST

Path: /api/services/app/PerformanceCounters/SendAllCounters

Operation ID: ApiServicesAppPerformancecountersSendallcountersPost

Tag: PerformanceCounters

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

Request body fields

| Field | Type | Required | Description | Notes |

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

| counters | object(PerformanceCounterModelDto) | No | | |

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

Example request body

`json

{

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

"counters": {

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

"machineName": "string",

"categories": [

{

"name": "string",

"instances": []

}

]

}

}

`

Response

None

Curl

`bash

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

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json" \\

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

--data-raw '{"id":"00000000-0000-0000-0000-000000000000","counters":{"machineId":"00000000-0000-0000-0000-000000000000","machineName":"string","categories":[{"name":"string","instances":[]}]}}'

`

PowerShell

`powershell

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

$uri = "$baseUrl/api/services/app/PerformanceCounters/SendAllCounters"

$tenantId = 12345

$accessToken = ""

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

$body = @'

{

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

"counters": {

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

"machineName": "string",

"categories": [

{

"name": "string",

"instances": []

}

]

}

}

'@

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

`

GetAll (ProcessPerformance)

Method: GET

Path: /api/services/app/ProcessPerformance/GetAll

Operation ID: ApiServicesAppProcessperformanceGetallGet

Tag: ProcessPerformance

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 |

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

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

| ProcessName | query | string | No | | |

| DateTimeOffset | query | string (date-span) | No | | format: date-span |

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

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

Response fields

| Field | Type | Required | Description | Notes |

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

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

| items | array | No | | |

| machineName | string | No | | |

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

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

Example response

`json

{

"result": {

"machineName": "string",

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

"duration": "00:05:00"

},

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

curl -X GET "https://public-api.loadgen.cloud/api/services/app/ProcessPerformance/GetAll?MachineId=00000000-0000-0000-0000-000000000000&ProcessName=string&DateTimeOffset=00%3A05%3A00" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

`

PowerShell

`powershell

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

$uri = "$baseUrl/api/services/app/ProcessPerformance/GetAll?MachineId=00000000-0000-0000-0000-000000000000&ProcessName=string&DateTimeOffset=00%3A05%3A00"

$tenantId = 12345

$accessToken = ""

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

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

`

BuildGraph

Method: POST

Path: /api/services/app/SystemPerformance/BuildGraph

Operation ID: ApiServicesAppSystemperformanceBuildgraphPost

Tag: SystemPerformance

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 |

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

| machineId | 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: SystemPerformanceCounterDtoAllItemsPerformanceCounterWrapperDto

Response fields

| Field | Type | Required | Description | Notes |

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

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

| items | array | No | | |

| machineName | string | No | | |

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

Example response

`json

{

"result": {

"machineName": "string",

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

"duration": "00:05:00"

},

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

curl -X POST "https://public-api.loadgen.cloud/api/services/app/SystemPerformance/BuildGraph?machineId=00000000-0000-0000-0000-000000000000" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json" \\

-H "Content-Type: application/json"

`

PowerShell

`powershell

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

$uri = "$baseUrl/api/services/app/SystemPerformance/BuildGraph?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

`

GetAll (SystemPerformance)

Method: GET

Path: /api/services/app/SystemPerformance/GetAll

Operation ID: ApiServicesAppSystemperformanceGetallGet

Tag: SystemPerformance

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 |

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

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

| DateTimeOffset | query | string (date-span) | No | | format: date-span |

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

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

Response fields

| Field | Type | Required | Description | Notes |

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

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

| items | array | No | | |

| machineName | string | No | | |

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

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

Example response

`json

{

"result": {

"machineName": "string",

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

"duration": "00:05:00"

},

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

curl -X GET "https://public-api.loadgen.cloud/api/services/app/SystemPerformance/GetAll?MachineId=00000000-0000-0000-0000-000000000000&DateTimeOffset=00%3A05%3A00&StartDate=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/SystemPerformance/GetAll?MachineId=00000000-0000-0000-0000-000000000000&DateTimeOffset=00%3A05%3A00&StartDate=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

`

DownloadWebLogs

Method: POST

Path: /api/services/app/WebLog/DownloadWebLogs

Operation ID: ApiServicesAppWeblogDownloadweblogsPost

Tag: WebLog

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

Response fields

| Field | Type | Required | Description | Notes |

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

| fileName | string | Yes | | minLength: 1 |

| fileToken | string | Yes | | minLength: 1 |

| fileType | string | No | | |

Example response

`json

{

"result": {

"fileName": "string",

"fileToken": "string",

"fileType": "string"

},

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

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

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json" \\

-H "Content-Type: application/json"

`

PowerShell

`powershell

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

$uri = "$baseUrl/api/services/app/WebLog/DownloadWebLogs"

$tenantId = 12345

$accessToken = ""

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

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

`

GetLatestWebLogs

Method: GET

Path: /api/services/app/WebLog/GetLatestWebLogs

Operation ID: ApiServicesAppWeblogGetlatestweblogsGet

Tag: WebLog

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

Response fields

| Field | Type | Required | Description | Notes |

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

| latestWebLogLines | array | No | | |

Example response

`json

{

"result": {

"latestWebLogLines": [

"string"

]

},

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

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

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

`

PowerShell

`powershell

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

$uri = "$baseUrl/api/services/app/WebLog/GetLatestWebLogs"

$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