Get a Container Template by ID

GET/v2/container-templates/{templateId}/

API version

v2

Request method

GET

Operation ID

container-get-template

---

Request

• templateIdstring

  required

  ID of the Template to be retrieved.

Responses

Format

application/json

Beschreibung

OK

Schema-Dokumentation

• categoriesarray of string

  required
  • Array[
    • *string
    ]
• descriptionobject

  required
  • destring

    required
  • enstring

    required
• developerstring

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

        required
      • purposestring
      • servicestring

        required
      • userInputstring

        required
    ]
• helpobject
  • alertsarray of object
    • Array[
      • *object
        • contentobject

          required
          • destring

            required
          • enstring

            required
        • headingobject

          required
          • destring

            required
          • enstring

            required
        • linkobject
          • destring

            required
          • enstring

            required
        • linkTextobject
          • destring

            required
          • enstring

            required
        • statusstring

          required
      ]
  • technicalDetailsarray of object
    • Array[
      • *object
        • keyobject

          required
          • destring

            required
          • enstring

            required
        • valuestring

          required
      ]
• iconUrlstring

  required
• idstring

  required
• licenseobject
  • linkstring
  • namestring

    required
• manifestVersionstring

  required

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

• nameobject

  required
  • destring

    required
  • enstring

    required
• repositorystring
• screenshotsarray of object
  • Array[
    • *object
      • bgstring

        required
      • screenshotstring

        required
      • textobject

        required
        • destring

          required
        • enstring

          required
    ]
• supportLinkstring
• taglineobject

  required
  • destring

    required
  • enstring

    required
• typestring (one of: component, standalone)

  required
• userInputsarray of object
  • Array[
    • *object
      • dataSourcestring
      • defaultValuestring
      • labelobject
        • destring

          required
        • enstring

          required
      • namestring

        required
      • requiredboolean

        required
      • validationSchemastring
    ]
• versionstring

  required

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

• websitestring

Beispiel

Content-Type: application/json

{
  "categories": [
    "string"
  ],
  "description": {
    "de": "string",
    "en": "string"
  },
  "developer": "string",
  "domains": [
    {
      "port": "string",
      "purpose": "string",
      "service": "string",
      "userInput": "string"
    }
  ],
  "help": {
    "alerts": [
      {
        "content": {
          "de": "string",
          "en": "string"
        },
        "heading": {
          "de": "string",
          "en": "string"
        },
        "link": {
          "de": "string",
          "en": "string"
        },
        "linkText": {
          "de": "string",
          "en": "string"
        },
        "status": "string"
      }
    ],
    "technicalDetails": [
      {
        "key": {
          "de": "string",
          "en": "string"
        },
        "value": "string"
      }
    ]
  },
  "iconUrl": "string",
  "id": "string",
  "license": {
    "link": "string",
    "name": "string"
  },
  "manifestVersion": "string",
  "name": {
    "de": "string",
    "en": "string"
  },
  "repository": "string",
  "screenshots": [
    {
      "bg": "string",
      "screenshot": "string",
      "text": {
        "de": "string",
        "en": "string"
      }
    }
  ],
  "supportLink": "string",
  "tagline": {
    "de": "string",
    "en": "string"
  },
  "type": "component",
  "userInputs": [
    {
      "dataSource": "string",
      "defaultValue": "string",
      "label": {
        "de": "string",
        "en": "string"
      },
      "name": "string",
      "required": true,
      "validationSchema": "string"
    }
  ],
  "version": "string",
  "website": "string"
}

JSON Schema

{
  "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"
          },
          "purpose": {
            "type": "string"
          },
          "service": {
            "type": "string"
          },
          "userInput": {
            "type": "string"
          }
        },
        "required": [
          "userInput",
          "service",
          "port"
        ],
        "type": "object"
      },
      "type": "array"
    },
    "help": {
      "properties": {
        "alerts": {
          "items": {
            "properties": {
              "content": {
                "properties": {
                  "de": {
                    "type": "string"
                  },
                  "en": {
                    "type": "string"
                  }
                },
                "required": [
                  "de",
                  "en"
                ],
                "type": "object"
              },
              "heading": {
                "properties": {
                  "de": {
                    "type": "string"
                  },
                  "en": {
                    "type": "string"
                  }
                },
                "required": [
                  "de",
                  "en"
                ],
                "type": "object"
              },
              "link": {
                "properties": {
                  "de": {
                    "type": "string"
                  },
                  "en": {
                    "type": "string"
                  }
                },
                "required": [
                  "de",
                  "en"
                ],
                "type": "object"
              },
              "linkText": {
                "properties": {
                  "de": {
                    "type": "string"
                  },
                  "en": {
                    "type": "string"
                  }
                },
                "required": [
                  "de",
                  "en"
                ],
                "type": "object"
              },
              "status": {
                "type": "string"
              }
            },
            "required": [
              "status",
              "heading",
              "content"
            ],
            "type": "object"
          },
          "type": "array"
        },
        "technicalDetails": {
          "items": {
            "properties": {
              "key": {
                "properties": {
                  "de": {
                    "type": "string"
                  },
                  "en": {
                    "type": "string"
                  }
                },
                "required": [
                  "de",
                  "en"
                ],
                "type": "object"
              },
              "value": {
                "type": "string"
              }
            },
            "required": [
              "key",
              "value"
            ],
            "type": "object"
          },
          "type": "array"
        }
      },
      "type": "object"
    },
    "iconUrl": {
      "type": "string"
    },
    "id": {
      "type": "string"
    },
    "license": {
      "properties": {
        "link": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      },
      "required": [
        "name"
      ],
      "type": "object"
    },
    "manifestVersion": {
      "description": "Version of the manifest for this template, e.g. '1.0'",
      "type": "string"
    },
    "name": {
      "properties": {
        "de": {
          "type": "string"
        },
        "en": {
          "type": "string"
        }
      },
      "required": [
        "de",
        "en"
      ],
      "type": "object"
    },
    "repository": {
      "type": "string"
    },
    "screenshots": {
      "items": {
        "properties": {
          "bg": {
            "type": "string"
          },
          "screenshot": {
            "type": "string"
          },
          "text": {
            "properties": {
              "de": {
                "type": "string"
              },
              "en": {
                "type": "string"
              }
            },
            "required": [
              "de",
              "en"
            ],
            "type": "object"
          }
        },
        "required": [
          "bg",
          "screenshot",
          "text"
        ],
        "type": "object"
      },
      "type": "array"
    },
    "supportLink": {
      "type": "string"
    },
    "tagline": {
      "properties": {
        "de": {
          "type": "string"
        },
        "en": {
          "type": "string"
        }
      },
      "required": [
        "de",
        "en"
      ],
      "type": "object"
    },
    "type": {
      "enum": [
        "component",
        "standalone"
      ],
      "type": "string"
    },
    "userInputs": {
      "items": {
        "properties": {
          "dataSource": {
            "type": "string"
          },
          "defaultValue": {
            "type": "string"
          },
          "label": {
            "properties": {
              "de": {
                "type": "string"
              },
              "en": {
                "type": "string"
              }
            },
            "required": [
              "de",
              "en"
            ],
            "type": "object"
          },
          "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",
    "type",
    "manifestVersion",
    "version",
    "name",
    "categories",
    "tagline",
    "description",
    "developer",
    "iconUrl"
  ],
  "type": "object"
}

Usage examples

cURL

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

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

assertStatus(response, 200);
  

PHP SDK

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

$request = (new GetTemplateRequest(
  templateId: "string"
));
$response = $client->container()->getTemplate($request);

var_dump($response->getBody();