Get runtime status belonging to an app installation

GET/app-installations/{appInstallationId}/status/

API version

v2

Request method

GET

Operation ID

app-retrieve-status

---

Request

• appInstallationIdstring

  required

Responses

Format

application/json

Description

The appInstallation status.

Schema documentation

• lastExitCodenumber
• logFileLocationstring

  required
• statestring (one of: running, stopped, exited)

  required
• uptimeSecondsnumber

Example

{
  "lastExitCode": 123,
  "logFileLocation": "string",
  "state": "running",
  "uptimeSeconds": 123
}

JSON Schema

{
  "description": "AppInstallationStatus describes the overall runtime status of an AppInstallation.",
  "properties": {
    "lastExitCode": {
      "type": "number"
    },
    "logFileLocation": {
      "type": "string"
    },
    "state": {
      "enum": [
        "running",
        "stopped",
        "exited"
      ],
      "type": "string"
    },
    "uptimeSeconds": {
      "type": "number"
    }
  },
  "required": [
    "state",
    "logFileLocation"
  ],
  "type": "object"
}

Usage examples

cURL

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

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.retrieveStatus({
  "appInstallationId": "string"
});

assertStatus(response, 200);
  

PHP SDK

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

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

var_dump($response->getBody();