GET /api/v2/ping GET /api/v2/usage-downloads

pre-check

Post pre-check/licenses

API endpoint for installation pre-check.

This endpoint is part of Cloud-specific endpoints.

POST /api/v2/pre-check/licenses

Parameters

Parameter	Type	Example	Description
`Authorization` (required)	header		JWT from Qt Login for an authenticated user as bearer token

Request body

The request body can have one of the following formats:

Request 1 Request 2

Properties

Property	Type	Description
`operation` (required)	`string`	Operation of installation license list payload

Example request body

{
  "operation": "list"
}

Properties

Property	Type	Description
`operation` (required)	`string`	Operation of installation license check payload
`consumers` (required)	`array`	List of consumers that need installation check from offline installer

Example request body

{
  "operation": "check",
  "consumers": [
    {
      "consumer_id": "qtcreator",
      "consumer_version": "6.0.1",
      "consumer_installation_schema": "commercial | opensource",
      "consumer_supported_features": "host_platform, target_platform",
      "consumer_build_timestamp": "2024-12-12",
      "component_id": "9876"
    }
  ]
}

Responses

Code	Description
`200`	Server response object indicating success
`400`	Bad request
`500`	Internal server error

Example responses

200 400 500

{
  "status": true,
  "message": "Fetched available licenses for user.",
  "licenses": [
    {
      "licensee": {
        "name": "John Doe",
        "description": "Software engineer",
        "contact": "Software engineer"
      },
      "contacts": {
        "sales": "https://www.qt.io/contact-us",
        "support": "mailto:support@qt.io",
        "admin": "https://account.qt.io/s/manage-licenses"
      },
      "license_info": {
        "license_id": "10612076",
        "model": "floating | site | name",
        "priority": 100,
        "type": "subscription | perpetual",
        "schema": "commercial | education | evaluation | opensource",
        "hosting": "qt | on-prem",
        "valid_from": "2023-09-28",
        "valid_to": "2024-09-28"
      },
      "consumers": [
        {
          "consumer_id": "squish_tester",
          "consumer_version": "8.0.0",
          "consumer_features": {
            "feature_key": "android, qt, ios, java, mac, tk, vnc, web, windows"
          }
        }
      ],
      "pool_info": {
        "concurrent_consumers": 20,
        "lease_time_unit": "seconds | minutes | hours",
        "lease_time": 100,
        "reservation_type": "user | process"
      },
      "version": "1.0.0",
      "cs_s": "0987654321ruoppyr7890876resdfyu90",
      "cs_p": "kojsd8ubj__OIUhjhjHJG9879uhjsdhkjsdhf=)=0sdkj"
    }
  ]
}

{
  "status": true,
  "message": "Checked consumers available for installation",
  "data": [
    {
      "component_id": "1231",
      "consumer_id": "qtcreator",
      "installtion_allowed": true
    }
  ]
}

{
  "status": false,
  "message": "Invalid data"
}

{
  "status": false,
  "code": "1234",
  "message": "Bad request"
}

{
  "status": false,
  "code": "1234"
}

GET /api/v2/ping GET /api/v2/usage-downloads

© 2024 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.