Cloud API - Licensing

Updated

Cloud API - Licensing

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

This article documents licensing endpoints (cloud licenses, usage, and machine licensing).

ClearUserAndMachine

Method: POST

Path: /api/services/app/CloudLicenses/ClearUserAndMachine

Operation ID: ApiServicesAppCloudlicensesClearuserandmachinePost

Tag: CloudLicenses

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 POST "https://public-api.loadgen.cloud/api/services/app/CloudLicenses/ClearUserAndMachine?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/CloudLicenses/ClearUserAndMachine?id=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

`

CreateOrEdit (CloudLicenses)

Method: POST

Path: /api/services/app/CloudLicenses/CreateOrEdit

Operation ID: ApiServicesAppCloudlicensesCreateoreditPost

Tag: CloudLicenses

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

Request body fields

| Field | Type | Required | Description | Notes |

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

| moduleName | string | Yes | | minLength: 1 |

| boundByUserName | boolean | No | | |

| description | string | No | | |

| friendlyName | string | No | | |

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

| isDemo | boolean | No | | |

| isLocked | boolean | No | | |

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

| machineName | string | No | | |

| noMachineLock | boolean | No | | |

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

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

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

| userName | string | No | | |

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

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

Example request body

`json

{

"moduleName": "string",

"description": "string",

"friendlyName": "string"

}

`

Response

None

Curl

`bash

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

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json" \\

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

--data-raw '{"moduleName":"string","description":"string","friendlyName":"string"}'

`

PowerShell

`powershell

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

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

$tenantId = 12345

$accessToken = ""

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

$body = @'

{

"moduleName": "string",

"description": "string",

"friendlyName": "string"

}

'@

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

`

Delete

Method: DELETE

Path: /api/services/app/CloudLicenses/Delete

Operation ID: ApiServicesAppCloudlicensesDeleteDelete

Tag: CloudLicenses

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

`

DeleteMultiple

Method: DELETE

Path: /api/services/app/CloudLicenses/DeleteMultiple

Operation ID: ApiServicesAppCloudlicensesDeletemultipleDelete

Tag: CloudLicenses

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 |

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

| inputs | query | array | No | | |

Request body

None

Response

None

Curl

`bash

curl -X DELETE "https://public-api.loadgen.cloud/api/services/app/CloudLicenses/DeleteMultiple?inputs=%5Bobject%20Object%5D" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

`

PowerShell

`powershell

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

$uri = "$baseUrl/api/services/app/CloudLicenses/DeleteMultiple?inputs=%5Bobject%20Object%5D"

$tenantId = 12345

$accessToken = ""

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

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

`

GetAll (CloudLicenses)

Method: GET

Path: /api/services/app/CloudLicenses/GetAll

Operation ID: ApiServicesAppCloudlicensesGetallGet

Tag: CloudLicenses

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

| ModuleNameFilter | query | string | No | | |

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

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

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

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

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

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

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

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

| UserNameFilter | query | string | No | | |

| TenantNameFilter | 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: GetCloudLicenseForViewDtoPagedResultDto

Response fields

| Field | Type | Required | Description | Notes |

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

| items | array | No | | |

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

Example response

`json

{

"result": {

"totalCount": 0,

"items": [

{

"cloudLicense": {

"moduleName": "string",

"description": "string",

"friendlyName": "string"

},

"userName": "string",

"tenantName": "string"

}

]

},

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

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

$tenantId = 12345

$accessToken = ""

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

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

`

GetAllTenantForLookupTable

Method: GET

Path: /api/services/app/CloudLicenses/GetAllTenantForLookupTable

Operation ID: ApiServicesAppCloudlicensesGetalltenantforlookuptableGet

Tag: CloudLicenses

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

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

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

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/CloudLicenses/GetAllTenantForLookupTable?Filter=string&TenantId=0&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/CloudLicenses/GetAllTenantForLookupTable?Filter=string&TenantId=0&Sorting=string"

$tenantId = 12345

$accessToken = ""

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

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

`

GetAllTenantTypes

Method: GET

Path: /api/services/app/CloudLicenses/GetAllTenantTypes

Operation ID: ApiServicesAppCloudlicensesGetalltenanttypesGet

Tag: CloudLicenses

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

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

Response fields

| Field | Type | Required | Description | Notes |

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

| items | array | No | | |

Example response

`json

{

"result": {

"items": [

{

"tenantName": "string",

"tenantType": 0,

"id": 0

}

]

},

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

curl -X GET "https://public-api.loadgen.cloud/api/services/app/CloudLicenses/GetAllTenantTypes?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/CloudLicenses/GetAllTenantTypes?filter=string"

$tenantId = 12345

$accessToken = ""

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

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

`

GetAllTimeTamperDetection

Method: GET

Path: /api/services/app/CloudLicenses/GetAllTimeTamperDetection

Operation ID: ApiServicesAppCloudlicensesGetalltimetamperdetectionGet

Tag: CloudLicenses

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

Response fields

| Field | Type | Required | Description | Notes |

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

| items | array | No | | |

Example response

`json

{

"result": {

"items": [

{

"tenantName": "string",

"timeTamperDetectionDisabled": false,

"id": 0

}

]

},

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

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

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

`

PowerShell

`powershell

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

$uri = "$baseUrl/api/services/app/CloudLicenses/GetAllTimeTamperDetection"

$tenantId = 12345

$accessToken = ""

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

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

`

GetAllUserForLookupTable

Method: GET

Path: /api/services/app/CloudLicenses/GetAllUserForLookupTable

Operation ID: ApiServicesAppCloudlicensesGetalluserforlookuptableGet

Tag: CloudLicenses

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

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

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

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

"surName": "string"

}

]

},

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

curl -X GET "https://public-api.loadgen.cloud/api/services/app/CloudLicenses/GetAllUserForLookupTable?Filter=string&TenantId=0&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/CloudLicenses/GetAllUserForLookupTable?Filter=string&TenantId=0&Sorting=string"

$tenantId = 12345

$accessToken = ""

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

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

`

GetCloudLicenseForEdit

Method: GET

Path: /api/services/app/CloudLicenses/GetCloudLicenseForEdit

Operation ID: ApiServicesAppCloudlicensesGetcloudlicenseforeditGet

Tag: CloudLicenses

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

Response fields

| Field | Type | Required | Description | Notes |

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

| cloudLicense | object(CreateOrEditCloudLicenseDto) | No | | |

| tenantName | string | No | | |

| userName | string | No | | |

Example response

`json

{

"result": {

"cloudLicense": {

"moduleName": "string",

"description": "string",

"friendlyName": "string"

},

"userName": "string",

"tenantName": "string"

},

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

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

`

GetCloudLicenseForView

Method: GET

Path: /api/services/app/CloudLicenses/GetCloudLicenseForView

Operation ID: ApiServicesAppCloudlicensesGetcloudlicenseforviewGet

Tag: CloudLicenses

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

Response fields

| Field | Type | Required | Description | Notes |

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

| cloudLicense | object(CloudLicenseDto) | No | | |

| tenantName | string | No | | |

| userName | string | No | | |

Example response

`json

{

"result": {

"cloudLicense": {

"moduleName": "string",

"description": "string",

"friendlyName": "string"

},

"userName": "string",

"tenantName": "string"

},

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

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

`

GetLicenseFile

Method: GET

Path: /api/services/app/CloudLicenses/GetLicenseFile

Operation ID: ApiServicesAppCloudlicensesGetlicensefileGet

Tag: CloudLicenses

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: 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 GET "https://public-api.loadgen.cloud/api/services/app/CloudLicenses/GetLicenseFile?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/CloudLicenses/GetLicenseFile?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

`

GetLicenseForUser

Method: POST

Path: /api/services/app/CloudLicenses/GetLicenseForUser

Operation ID: ApiServicesAppCloudlicensesGetlicenseforuserPost

Tag: CloudLicenses

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

Request body fields

None

Example request body

`json

"string"

`

Response

Response envelope: ABP

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

200 OK response schema: LoadGenCloudLicenseDto

Response fields

| Field | Type | Required | Description | Notes |

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

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

| cloudLicenses | array | No | | |

| companyName | string | No | | |

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

| hash | string | No | | |

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

| timeTamperDetectionDisabled | boolean | No | | |

Example response

`json

{

"result": {

"companyName": "string",

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

"allowedOfflineDays": 0

},

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

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

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json" \\

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

--data-raw '"string"'

`

PowerShell

`powershell

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

$uri = "$baseUrl/api/services/app/CloudLicenses/GetLicenseForUser"

$tenantId = 12345

$accessToken = ""

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

$body = @'

"string"

'@

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

`

SetTenantType

Method: POST

Path: /api/services/app/CloudLicenses/SetTenantType

Operation ID: ApiServicesAppCloudlicensesSettenanttypePost

Tag: CloudLicenses

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

Request body fields

| Field | Type | Required | Description | Notes |

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

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

| tenantType | enum(0 \| 1 \| 2 \| 3 \| 4) | No | | format: int32

enum: 0, 1, 2, 3, 4 |

Example request body

`json

{

"tenantId": 0,

"tenantType": 0

}

`

Response

None

Curl

`bash

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

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json" \\

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

--data-raw '{"tenantId":0,"tenantType":0}'

`

PowerShell

`powershell

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

$uri = "$baseUrl/api/services/app/CloudLicenses/SetTenantType"

$tenantId = 12345

$accessToken = ""

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

$body = @'

{

"tenantId": 0,

"tenantType": 0

}

'@

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

`

SetTimeTamperDetection

Method: POST

Path: /api/services/app/CloudLicenses/SetTimeTamperDetection

Operation ID: ApiServicesAppCloudlicensesSettimetamperdetectionPost

Tag: CloudLicenses

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

Request body fields

| Field | Type | Required | Description | Notes |

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

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

| timeTamperDetectionDisabled | boolean | No | | |

Example request body

`json

{

"tenantId": 0,

"timeTamperDetectionDisabled": false

}

`

Response

None

Curl

`bash

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

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json" \\

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

--data-raw '{"tenantId":0,"timeTamperDetectionDisabled":false}'

`

PowerShell

`powershell

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

$uri = "$baseUrl/api/services/app/CloudLicenses/SetTimeTamperDetection"

$tenantId = 12345

$accessToken = ""

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

$body = @'

{

"tenantId": 0,

"timeTamperDetectionDisabled": false

}

'@

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

`

UpdateLic

Method: POST

Path: /api/services/app/CloudLicenses/UpdateLic

Operation ID: ApiServicesAppCloudlicensesUpdatelicPost

Tag: CloudLicenses

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 |

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

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

Request body

Request body schema: UpdateMachineAndUserNameDto

Request body fields

| Field | Type | Required | Description | Notes |

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

| machineName | string | No | | |

| userName | string | No | | |

| version | string | No | | |

Example request body

`json

{

"machineName": "string",

"userName": "string",

"version": "string"

}

`

Response

None

Curl

`bash

curl -X POST "https://public-api.loadgen.cloud/api/services/app/CloudLicenses/UpdateLic?licId=00000000-0000-0000-0000-000000000000" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json" \\

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

--data-raw '{"machineName":"string","userName":"string","version":"string"}'

`

PowerShell

`powershell

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

$uri = "$baseUrl/api/services/app/CloudLicenses/UpdateLic?licId=00000000-0000-0000-0000-000000000000"

$tenantId = 12345

$accessToken = ""

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

$body = @'

{

"machineName": "string",

"userName": "string",

"version": "string"

}

'@

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

`

GetLatest

Method: GET

Path: /api/services/app/CloudLicenseUsage/GetLatest

Operation ID: ApiServicesAppCloudlicenseusageGetlatestGet

Tag: CloudLicenseUsage

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

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

| UserNameFilter | query | string | No | | |

| TenantNameFilter | 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: GetAllCloudLicenseUsageForViewDtoPagedResultDto

Response fields

| Field | Type | Required | Description | Notes |

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

| items | array | No | | |

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

Example response

`json

{

"result": {

"totalCount": 0,

"items": [

{

"cloudLicense": {

"moduleName": "string",

"description": "string",

"friendlyName": "string"

},

"cloudLicenseUsage": {

"windowsUsername": "string",

"machineName": "string",

"version": "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/CloudLicenseUsage/GetLatest?Filter=string&TenantId=0&UserNameFilter=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/CloudLicenseUsage/GetLatest?Filter=string&TenantId=0&UserNameFilter=string"

$tenantId = 12345

$accessToken = ""

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

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

`

CreateOrEdit (MachineLicense)

Method: POST

Path: /api/services/app/MachineLicense/CreateOrEdit

Operation ID: ApiServicesAppMachinelicenseCreateoreditPost

Tag: MachineLicense

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

Request body fields

| Field | Type | Required | Description | Notes |

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

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

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

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

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

| type | enum(0 \| 1) | No | | format: int32

enum: 0, 1 |

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

Example request body

`json

{

"type": 0,

"tenantId": 0,

"licenseCount": 0

}

`

Response

None

Curl

`bash

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

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json" \\

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

--data-raw '{"type":0,"tenantId":0,"licenseCount":0}'

`

PowerShell

`powershell

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

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

$tenantId = 12345

$accessToken = ""

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

$body = @'

{

"type": 0,

"tenantId": 0,

"licenseCount": 0

}

'@

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

`

Get

Method: GET

Path: /api/services/app/MachineLicense/Get

Operation ID: ApiServicesAppMachinelicenseGetGet

Tag: MachineLicense

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

Response fields

| Field | Type | Required | Description | Notes |

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

| canceled | boolean | No | | |

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

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

| isEnabled | boolean | No | | |

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

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

| tenantName | string | No | | |

| type | enum(0 \| 1) | No | | format: int32

enum: 0, 1 |

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

Example response

`json

{

"result": {

"type": 0,

"tenantId": 0,

"licenseCount": 0

},

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

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

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

`

PowerShell

`powershell

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

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

$tenantId = 12345

$accessToken = ""

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

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

`

GetAll (MachineLicense)

Method: GET

Path: /api/services/app/MachineLicense/GetAll

Operation ID: ApiServicesAppMachinelicenseGetallGet

Tag: MachineLicense

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 |

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

| LicenseType | query | enum(0 | 1) | No | | format: int32

enum: 0, 1 |

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

Response fields

| Field | Type | Required | Description | Notes |

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

| items | array | No | | |

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

Example response

`json

{

"result": {

"totalCount": 0,

"items": [

{

"type": 0,

"tenantId": 0,

"licenseCount": 0

}

]

},

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

curl -X GET "https://public-api.loadgen.cloud/api/services/app/MachineLicense/GetAll?LicenseType=0&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/MachineLicense/GetAll?LicenseType=0&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

`

GetAllForTenant

Method: GET

Path: /api/services/app/MachineLicense/GetAllForTenant

Operation ID: ApiServicesAppMachinelicenseGetallfortenantGet

Tag: MachineLicense

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

Response fields

None

Example response

`json

{

"result": {

"key": {

"type": 0,

"tenantId": 0,

"licenseCount": 0

}

},

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

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

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

`

PowerShell

`powershell

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

$uri = "$baseUrl/api/services/app/MachineLicense/GetAllForTenant"

$tenantId = 12345

$accessToken = ""

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

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

`

GetByTenantId

Method: GET

Path: /api/services/app/MachineLicense/GetByTenantId

Operation ID: ApiServicesAppMachinelicenseGetbytenantidGet

Tag: MachineLicense

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 |

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

enum: 0, 1 |

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

Response fields

| Field | Type | Required | Description | Notes |

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

| canceled | boolean | No | | |

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

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

| isEnabled | boolean | No | | |

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

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

| tenantName | string | No | | |

| type | enum(0 \| 1) | No | | format: int32

enum: 0, 1 |

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

Example response

`json

{

"result": {

"type": 0,

"tenantId": 0,

"licenseCount": 0

},

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

curl -X GET "https://public-api.loadgen.cloud/api/services/app/MachineLicense/GetByTenantId?Id=0&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/MachineLicense/GetByTenantId?Id=0&type=0"

$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