Skip to main content

List app installations that a user has access to

GET/app-installations/
v2
GET
app-list-appinstallations-for-user

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.

application/json

Object containing the list of AppInstallations.

  • Array[
  • *object

    An AppInstallation is a concrete manifestation of an App in a specific AppVersion.

    • appIdstring (uuid)
      required
    • appVersionobject
      required

      VersionStatus describes the current and desired version of something like the AppVersion of an AppInstallation. If diverging, an internal process is going to assert, the current value will be aligned.

      • currentstring
      • desiredstring
        required
    • customDocumentRootstring
    • descriptionstring
      required
    • disabledboolean
      required
    • idstring (uuid)
      required
    • installationPathstring
      required
    • linkedDatabasesarray of object
      • Array[
      • *object

        LinkedDatabase is a reference to a concrete Database and DatabaseUsers.

        • databaseIdstring (uuid)
          required
        • databaseUserIdsobject
          • *string
        • kindstring (one of: mysql, redis)
          required
        • purposestring (one of: primary, cache, custom)
          required
        • ]
  • processesarray of string (uuid)
    • Array[
    • *string (uuid)
      • ]
  • projectIdstring (uuid)
  • screenshotIdstring (uuid)
  • screenshotRefstring
  • shortIdstring
    required
  • systemSoftwarearray of object
    • Array[
    • *object

      InstalledSystemSoftware describes the currently configured and installed SystemSoftwareVersion of a SystemSoftware besides the desired SystemSoftwareUpdatePolicy inside an AppInstallation.

      • systemSoftwareIdstring (uuid)
        required
      • systemSoftwareVersionobject
        required

        VersionStatus describes the current and desired version of something like the AppVersion of an AppInstallation. If diverging, an internal process is going to assert, the current value will be aligned.

        • currentstring
        • desiredstring
          required
      • updatePolicystring (one of: none, inheritedFromApp, patchLevel, all)
        required

        SystemSoftwareUpdatePolicy describes which updates should be applied automatically by our systems.

      • ]
  • updatePolicystring (one of: none, patchLevel, all)

    AppUpdatePolicy describes which updates should be applied automatically by our systems.

  • userInputsarray of object
    • Array[
    • *object

      A SavedUserInput is an entered value for a desired UserInput of an AppVersion or SystemSoftwareVersion.

      • namestring
        required
      • valuestring
        required
      • ]
    • ]

    Usage examples​

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