Get an analysis of the error of an app installation

GET/v2/app-installations/{appInstallationId}/error-analysis/

API version

v2

Request method

GET

Operation ID

app-get-appinstallation-error-analysis

---

Analyzes the last error of the AppInstallation. Only available while the AppInstallation has an error; returns a failed precondition otherwise.

Request

• appInstallationIdstring

  required

Responses

Format

application/json

Description

The analysis of the AppInstallation error.

Schema documentation

• recommendationstring
• summarystring

  required

Example

Content-Type: application/json

{
  "recommendation": "Update the PHP version of the app installation to a version supported by the app and make sure all required extensions are enabled.",
  "summary": "The app installation failed because a required PHP extension is not available in the installed PHP version."
}

JSON Schema

{
  "properties": {
    "recommendation": {
      "example": "Update the PHP version of the app installation to a version supported by the app and make sure all required extensions are enabled.",
      "type": "string"
    },
    "summary": {
      "example": "The app installation failed because a required PHP extension is not available in the installed PHP version.",
      "type": "string"
    }
  },
  "required": [
    "summary"
  ],
  "type": "object"
}

Usage examples

cURL

$ curl \
    --fail \
    --location \
    -H "Authorization: Bearer $MITTWALD_API_TOKEN" \
    https://api.mittwald.de/v2/app-installations/string/error-analysis

JavaScript SDK

import { MittwaldAPIV2Client } from "@mittwald/api-client";
import { assertStatus } from "@mittwald/api-client-commons";
  
const client = MittwaldAPIClient.newWithToken(process.env.MITTWALD_API_TOKEN);
const response = await client.app.getAppinstallationErrorAnalysis({
  "appInstallationId": "string"
});

assertStatus(response, 200);
  

PHP SDK

use \Mittwald\ApiClient\Generated\V2\Clients\App\GetAppinstallationErrorAnalysis\GetAppinstallationErrorAnalysisRequest;
  
$client = MittwaldAPIClient::newWithToken(getenv('MITTWALD_API_TOKEN'));

$request = (new GetAppinstallationErrorAnalysisRequest(
  appInstallationId: "string"
));
$response = $client->app()->getAppinstallationErrorAnalysis($request);

var_dump($response->getBody();