List Container Templates

GET/v2/container-templates/

API version

v2

Request method

GET

Operation ID

container-list-templates

---

Request

Responses

Response headers

• X-Pagination-Limitinteger

  The limit used to select the resources for the response

• X-Pagination-Skipinteger

  The number of skipped items

• X-Pagination-Pagenumber

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

• X-Pagination-TotalCountinteger

  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

OK

Schema documentation

• Array[
  • *object
    • categoriesarray of string

      required
      • Array[
        • *string
        ]
    • descriptionobject

      required
      • destring

        required
      • enstring

        required
    • developerstring

      required
    • domainsarray of object
      • Array[
        • *object
          • portstring

            required
          • servicestring

            required
          • userInputstring

            required
        ]
    • iconstring

      required
    • idstring

      required
    • licensestring
    • manifestVersionstring

      required

      Version of the manifest for this template, e.g. '1.0'

    • namestring

      required
    • repositorystring
    • taglineobject

      required
      • destring

        required
      • enstring

        required
    • userInputsarray of object
      • Array[
        • *object
          • dataSourcestring
          • defaultValuestring
          • namestring

            required
          • requiredboolean

            required
          • validationSchemastring
        ]
    • versionstring

      required

      Version of the application described by this template, e.g. 'latest'

    • websitestring
  ]

Example

Content-Type: application/json

[
  {
    "categories": [
      "string"
    ],
    "description": {
      "de": "string",
      "en": "string"
    },
    "developer": "string",
    "domains": [
      {
        "port": "string",
        "service": "string",
        "userInput": "string"
      }
    ],
    "icon": "string",
    "id": "string",
    "license": "string",
    "manifestVersion": "string",
    "name": "string",
    "repository": "string",
    "tagline": {
      "de": "string",
      "en": "string"
    },
    "userInputs": [
      {
        "dataSource": "string",
        "defaultValue": "string",
        "name": "string",
        "required": true,
        "validationSchema": "string"
      }
    ],
    "version": "string",
    "website": "string"
  }
]

JSON Schema

{
  "items": {
    "properties": {
      "categories": {
        "items": {
          "type": "string"
        },
        "type": "array"
      },
      "description": {
        "properties": {
          "de": {
            "type": "string"
          },
          "en": {
            "type": "string"
          }
        },
        "required": [
          "de",
          "en"
        ],
        "type": "object"
      },
      "developer": {
        "type": "string"
      },
      "domains": {
        "items": {
          "properties": {
            "port": {
              "type": "string"
            },
            "service": {
              "type": "string"
            },
            "userInput": {
              "type": "string"
            }
          },
          "required": [
            "userInput",
            "service",
            "port"
          ],
          "type": "object"
        },
        "type": "array"
      },
      "icon": {
        "type": "string"
      },
      "id": {
        "type": "string"
      },
      "license": {
        "type": "string"
      },
      "manifestVersion": {
        "description": "Version of the manifest for this template, e.g. '1.0'",
        "type": "string"
      },
      "name": {
        "type": "string"
      },
      "repository": {
        "type": "string"
      },
      "tagline": {
        "properties": {
          "de": {
            "type": "string"
          },
          "en": {
            "type": "string"
          }
        },
        "required": [
          "de",
          "en"
        ],
        "type": "object"
      },
      "userInputs": {
        "items": {
          "properties": {
            "dataSource": {
              "type": "string"
            },
            "defaultValue": {
              "type": "string"
            },
            "name": {
              "type": "string"
            },
            "required": {
              "type": "boolean"
            },
            "validationSchema": {
              "type": "string"
            }
          },
          "required": [
            "name",
            "required"
          ],
          "type": "object"
        },
        "type": "array"
      },
      "version": {
        "description": "Version of the application described by this template, e.g. 'latest'",
        "type": "string"
      },
      "website": {
        "type": "string"
      }
    },
    "required": [
      "id",
      "manifestVersion",
      "version",
      "name",
      "categories",
      "tagline",
      "description",
      "developer",
      "icon"
    ],
    "type": "object"
  },
  "type": "array"
}

Usage examples

cURL

$ curl \
    --fail \
    --location \
    -H "Authorization: Bearer $MITTWALD_API_TOKEN" \
    https://api.mittwald.de/v2/container-templates?category=string&searchTerm=string&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.container.listTemplates({
  "queryParameters": {
    "category": "string",
    "searchTerm": "string",
    "limit": 50,
    "page": 1
  }
});

assertStatus(response, 200);
  

PHP SDK

use \Mittwald\ApiClient\Generated\V2\Clients\Container\ListTemplates\ListTemplatesRequest;
  
$client = MittwaldAPIClient::newWithToken(getenv('MITTWALD_API_TOKEN'));

$request = (new ListTemplatesRequest())
  ->withCategory("string")
  ->withSearchTerm("string")
  ->withLimit(50)
  ->withPage(1);
$response = $client->container()->listTemplates($request);

var_dump($response->getBody();