Cloud API - Installer and Deployment

Updated

Cloud API - Installer and Deployment

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

This article documents installer and deployment endpoints (install/setup, installer catalogs, versions, and temp file upload).

CheckDatabase

Method: POST

Path: /api/services/app/Install/CheckDatabase

Operation ID: ApiServicesAppInstallCheckdatabasePost

Tag: Install

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

Response fields

| Field | Type | Required | Description | Notes |

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

| isDatabaseExist | boolean | No | | |

Example response

`json

{

"result": {

"isDatabaseExist": false

},

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

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

-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/Install/CheckDatabase"

$tenantId = 12345

$accessToken = ""

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

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

`

GetAppSettingsJson

Method: GET

Path: /api/services/app/Install/GetAppSettingsJson

Operation ID: ApiServicesAppInstallGetappsettingsjsonGet

Tag: Install

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

Response fields

| Field | Type | Required | Description | Notes |

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

| languages | array | No | | |

| serverSiteUrl | string | No | | |

| webSiteUrl | string | No | | |

Example response

`json

{

"result": {

"webSiteUrl": "https://example.com",

"serverSiteUrl": "https://example.com",

"languages": [

{

"name": "string",

"value": "string"

}

]

},

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

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

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

`

PowerShell

`powershell

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

$uri = "$baseUrl/api/services/app/Install/GetAppSettingsJson"

$tenantId = 12345

$accessToken = ""

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

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

`

Setup

Method: POST

Path: /api/services/app/Install/Setup

Operation ID: ApiServicesAppInstallSetupPost

Tag: Install

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

Request body fields

| Field | Type | Required | Description | Notes |

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

| adminPassword | string | Yes | | minLength: 1 |

| connectionString | string | Yes | | minLength: 1 |

| defaultLanguage | string | Yes | | minLength: 1 |

| webSiteUrl | string | Yes | | minLength: 1 |

| billInfo | object(HostBillingSettingsEditDto) | No | | |

| serverUrl | string | No | | |

| smtpSettings | object(EmailSettingsEditDto) | No | | |

Example request body

`json

{

"adminPassword": "string",

"connectionString": "string",

"defaultLanguage": "string",

"webSiteUrl": "https://example.com"

}

`

Response

None

Curl

`bash

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

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json" \\

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

--data-raw '{"adminPassword":"string","connectionString":"string","defaultLanguage":"string","webSiteUrl":"https://example.com"}'

`

PowerShell

`powershell

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

$uri = "$baseUrl/api/services/app/Install/Setup"

$tenantId = 12345

$accessToken = ""

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

$body = @'

{

"adminPassword": "string",

"connectionString": "string",

"defaultLanguage": "string",

"webSiteUrl": "https://example.com"

}

'@

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

`

CreateOrEdit (Installer)

Method: POST

Path: /api/services/app/Installer/CreateOrEdit

Operation ID: ApiServicesAppInstallerCreateoreditPost

Tag: Installer

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

Request body fields

| Field | Type | Required | Description | Notes |

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

| additionalConfigurationRequired | boolean | No | | |

| allFeaturesEnabled | boolean | No | | |

| description | string | No | | |

| features | array | No | | |

| fileName | string | No | | |

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

| imageFileToken | string | No | | |

| isEnabled | boolean | No | | |

| isServiceUserProduct | boolean | No | | |

| name | string | No | | |

| productShortName | string | No | | |

Example request body

`json

{

"name": "string",

"fileName": "string",

"description": "string"

}

`

Response

None

Curl

`bash

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

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json" \\

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

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

`

PowerShell

`powershell

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

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

$tenantId = 12345

$accessToken = ""

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

$body = @'

{

"name": "string",

"fileName": "string",

"description": "string"

}

'@

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

`

Delete (Installer)

Method: DELETE

Path: /api/services/app/Installer/Delete

Operation ID: ApiServicesAppInstallerDeleteDelete

Tag: Installer

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

None

Curl

`bash

curl -X DELETE "https://public-api.loadgen.cloud/api/services/app/Installer/Delete?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/Installer/Delete?Id=0"

$tenantId = 12345

$accessToken = ""

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

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

`

GetAll (Installer)

Method: GET

Path: /api/services/app/Installer/GetAll

Operation ID: ApiServicesAppInstallerGetallGet

Tag: Installer

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

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

"fileName": "string",

"description": "string"

}

]

},

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

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

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

`

PowerShell

`powershell

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

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

$tenantId = 12345

$accessToken = ""

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

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

`

GetAllFeatures

Method: GET

Path: /api/services/app/Installer/GetAllFeatures

Operation ID: ApiServicesAppInstallerGetallfeaturesGet

Tag: Installer

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 |

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

| FilterName | 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: StringListResultDto

Response fields

| Field | Type | Required | Description | Notes |

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

| items | array | No | | |

Example response

`json

{

"result": {

"items": [

"string"

]

},

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

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

$tenantId = 12345

$accessToken = ""

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

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

`

GetBootstrap

Method: GET

Path: /api/services/app/Installer/GetBootstrap

Operation ID: ApiServicesAppInstallerGetbootstrapGet

Tag: Installer

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 |

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

| FileName | 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: CloudFileDto

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/Installer/GetBootstrap?FileName=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/Installer/GetBootstrap?FileName=string"

$tenantId = 12345

$accessToken = ""

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

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

`

GetInstallerFiles

Method: GET

Path: /api/services/app/Installer/GetInstallerFiles

Operation ID: ApiServicesAppInstallerGetinstallerfilesGet

Tag: Installer

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

Response fields

| Field | Type | Required | Description | Notes |

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

| items | array | No | | |

Example response

`json

{

"result": {

"items": [

{

"name": "string",

"description": "string",

"buildVersion": 0

}

]

},

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

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

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

`

PowerShell

`powershell

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

$uri = "$baseUrl/api/services/app/Installer/GetInstallerFiles"

$tenantId = 12345

$accessToken = ""

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

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

`

GetInstallProductForView

Method: GET

Path: /api/services/app/Installer/GetInstallProductForView

Operation ID: ApiServicesAppInstallerGetinstallproductforviewGet

Tag: Installer

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

Response fields

| Field | Type | Required | Description | Notes |

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

| additionalConfigurationRequired | boolean | No | | |

| allFeaturesEnabled | boolean | No | | |

| description | string | No | | |

| enabledOnFeatures | array | No | | |

| fileName | string | No | | |

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

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

| isEnabled | boolean | No | | |

| name | string | No | | |

| productShortName | string | No | | |

Example response

`json

{

"result": {

"name": "string",

"fileName": "string",

"productShortName": "string"

},

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

curl -X GET "https://public-api.loadgen.cloud/api/services/app/Installer/GetInstallProductForView?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/Installer/GetInstallProductForView?id=0"

$tenantId = 12345

$accessToken = ""

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

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

`

CreateOrEdit (InstallerVersion)

Method: POST

Path: /api/services/app/InstallerVersion/CreateOrEdit

Operation ID: ApiServicesAppInstallerversionCreateoreditPost

Tag: InstallerVersion

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

Request body fields

| Field | Type | Required | Description | Notes |

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

| betaVersion | boolean | No | | |

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

| changeLog | string | No | | |

| description | string | No | | |

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

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

| isEnabled | boolean | No | | |

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

| url | string | No | | |

Example request body

`json

{

"installProductId": 0,

"buildVersion": 0,

"description": "string"

}

`

Response

None

Curl

`bash

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

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json" \\

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

--data-raw '{"installProductId":0,"buildVersion":0,"description":"string"}'

`

PowerShell

`powershell

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

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

$tenantId = 12345

$accessToken = ""

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

$body = @'

{

"installProductId": 0,

"buildVersion": 0,

"description": "string"

}

'@

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

`

Delete (InstallerVersion)

Method: DELETE

Path: /api/services/app/InstallerVersion/Delete

Operation ID: ApiServicesAppInstallerversionDeleteDelete

Tag: InstallerVersion

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

None

Curl

`bash

curl -X DELETE "https://public-api.loadgen.cloud/api/services/app/InstallerVersion/Delete?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/InstallerVersion/Delete?Id=0"

$tenantId = 12345

$accessToken = ""

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

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

`

GetAll (InstallerVersion)

Method: GET

Path: /api/services/app/InstallerVersion/GetAll

Operation ID: ApiServicesAppInstallerversionGetallGet

Tag: InstallerVersion

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 |

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

| InstallProductId | 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: GetAllInstallProductVersionForOverviewDtoPagedResultDto

Response fields

| Field | Type | Required | Description | Notes |

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

| items | array | No | | |

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

Example response

`json

{

"result": {

"totalCount": 0,

"items": [

{

"buildVersion": 0,

"description": "string",

"isEnabled": false

}

]

},

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

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

`

GetInstallProductVersionForEdit

Method: GET

Path: /api/services/app/InstallerVersion/GetInstallProductVersionForEdit

Operation ID: ApiServicesAppInstallerversionGetinstallproductversionforeditGet

Tag: InstallerVersion

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

Response fields

| Field | Type | Required | Description | Notes |

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

| betaVersion | boolean | No | | |

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

| changeLog | string | No | | |

| description | string | No | | |

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

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

| isEnabled | boolean | No | | |

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

| url | string | No | | |

Example response

`json

{

"result": {

"buildVersion": 0,

"description": "string",

"isEnabled": false

},

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

curl -X GET "https://public-api.loadgen.cloud/api/services/app/InstallerVersion/GetInstallProductVersionForEdit?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/InstallerVersion/GetInstallProductVersionForEdit?id=0"

$tenantId = 12345

$accessToken = ""

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

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

`

GetInstallProductVersionForView

Method: GET

Path: /api/services/app/InstallerVersion/GetInstallProductVersionForView

Operation ID: ApiServicesAppInstallerversionGetinstallproductversionforviewGet

Tag: InstallerVersion

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

Response fields

| Field | Type | Required | Description | Notes |

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

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

| changeLog | string | No | | |

| description | string | No | | |

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

| isEnabled | boolean | No | | |

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

| url | string | No | | |

Example response

`json

{

"result": {

"buildVersion": 0,

"description": "string",

"isEnabled": false

},

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

curl -X GET "https://public-api.loadgen.cloud/api/services/app/InstallerVersion/GetInstallProductVersionForView?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/InstallerVersion/GetInstallProductVersionForView?id=0"

$tenantId = 12345

$accessToken = ""

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

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

`

GetLatestInstallProductVersion

Method: GET

Path: /api/services/app/InstallerVersion/GetLatestInstallProductVersion

Operation ID: ApiServicesAppInstallerversionGetlatestinstallproductversionGet

Tag: InstallerVersion

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 |

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

| productName | 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: GetAllInstallProductVersionForOverviewDto

Response fields

| Field | Type | Required | Description | Notes |

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

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

| description | string | No | | |

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

| isEnabled | boolean | No | | |

| references | array | No | | |

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

| url | string | No | | |

Example response

`json

{

"result": {

"buildVersion": 0,

"description": "string",

"isEnabled": false

},

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

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

$tenantId = 12345

$accessToken = ""

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

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

`

GetLatestProductVersionFilePath

Method: GET

Path: /api/services/app/InstallerVersion/GetLatestProductVersionFilePath

Operation ID: ApiServicesAppInstallerversionGetlatestproductversionfilepathGet

Tag: InstallerVersion

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 |

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

| productName | 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: 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/InstallerVersion/GetLatestProductVersionFilePath?productName=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/InstallerVersion/GetLatestProductVersionFilePath?productName=string"

$tenantId = 12345

$accessToken = ""

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

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

`

UploadFiles

Method: POST

Path: /PlugIns/TempFileUpload/UploadFiles

Operation ID: PluginsTempfileuploadUploadfilesPost

Tag: TempFileUpload

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

  • 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/PlugIns/TempFileUpload/UploadFiles" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

`

PowerShell

`powershell

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

$uri = "$baseUrl/PlugIns/TempFileUpload/UploadFiles"

$tenantId = 12345

$accessToken = ""

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

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

`

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