Get an app

GET /v2/apps/{appId}/

API version

v2

Request method

GET

Operation ID

app-get-app

---

Request

• appIdstring (uuid)

  required

Responses

Format

application/json

Description

The app object.

Schema documentation

• actionCapabilitiesarray of string (one of: start, stop, restart)
  • Array[
  • *string (one of: start, stop, restart)

    An Action is a string that describes a runtime concerning action which can be executed on an AppInstallation or an App can be capable of.

  ]

idstring

required

namestring

required

tagsarray of string

required

• Array[
• *string
]

Example

{
  "actionCapabilities": [
    "start"
  ],
  "id": "string",
  "name": "string",
  "tags": [
    "string"
  ]
}

JSON Schema

{
  "description": "An App is to be understood as a manifest for AppInstallations. E.g. 'WordPress' only exists inside our ecosystem, because there is an  App -Manifest for it.",
  "properties": {
    "actionCapabilities": {
      "items": {
        "description": "An Action is a string that describes a runtime concerning action which can be executed on an AppInstallation or an  App  can be capable of.",
        "enum": [
          "start",
          "stop",
          "restart"
        ],
        "type": "string"
      },
      "type": "array"
    },
    "id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "tags": {
      "items": {
        "type": "string"
      },
      "type": "array"
    }
  },
  "required": [
    "id",
    "name",
    "tags"
  ],
  "type": "object"
}

Usage examples

cURL

$ curl \
    --fail \
    --location \
    -H "Authorization: Bearer $MITTWALD_API_TOKEN" \
    https://api.mittwald.de/v2/apps/f0f86186-0a5a-45b2-aa33-502777496347

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.getApp({
  "appId": "f0f86186-0a5a-45b2-aa33-502777496347"
});

assertStatus(response, 200);
  

PHP SDK

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

$request = (new GetAppRequest(
  appId: "f0f86186-0a5a-45b2-aa33-502777496347"
));
$response = $client->app()->getApp($request);

var_dump($response->getBody();