List apps

GET /v2/apps/

API version

v2

Request method

GET

Operation ID

app-list-apps

---

Request

Responses

Response headers

• X-Pagination-Limitnumber

  The limit used to select the resources for the response

• X-Pagination-Skipnumber

  The number of skipped items

• X-Pagination-Pagenumber

  The calculate page of the list response. Refer to parameters to learn more.

• X-Pagination-TotalCountnumber

  The total amount of items available in the remote ressource. Use this value in combination with the limit to calculate the available pages.

Format

application/json

Description

Object containing the list of Apps.

Schema documentation

• Array[
• *object

  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.

  • 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

{
  "items": {
    "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"
  },
  "type": "array"
}

Usage examples

cURL

$ curl \
    --fail \
    --location \
    -H "Authorization: Bearer $MITTWALD_API_TOKEN" \
    https://api.mittwald.de/v2/apps?limit=50&page=1

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.listApps({
  "queryParameters": {
    "limit": 50,
    "page": 1
  }
});

assertStatus(response, 200);
  

PHP SDK

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

$request = (new ListAppsRequest())
  ->withLimit(50)
  ->withPage(1);
$response = $client->app()->listApps($request);

var_dump($response->getBody();