Befehlsvorlagen über die API abrufen

Nach der Aktivierung des Run Command-Service müssen Sie die verfügbaren Befehlsvorlagen abrufen, um Skripte auszuführen. Diese Anleitung erläutert, wie Sie die aktuell unterstützten Vorlagen für die Verwendung in API-Anfragen oder im STACKIT Portal abrufen.

Eine vollständige Liste der unterstützten Vorlagen finden Sie in der Tabelle Befehlsvorlagen.

Voraussetzungen

• Swagger-API-Definition für die STACKIT Run Commands Service-API.
• Sie haben den Server Agent installiert.
• Der Run Command-Service wurde aktiviert.

Alle Befehlsvorlagen auflisten

Um eine JSON-Liste aller verfügbaren Remote Command-Vorlagen zu erhalten, verwenden Sie die folgende GET-Anfrage:

GET https://run-command.api.eu01.stackit.cloud/v1/command-templates

Sobald Sie eine Vorlage aus dieser Liste identifiziert haben, können Sie diese per Fernzugriff auf Ihrer Maschine ausführen. Anleitungen dazu finden Sie unter Einen Befehl über die API ausführen. API-Referenz: GetCommandTemplates.

Informationen zu einer bestimmten Befehlsvorlage abrufen

Geben Sie die folgenden Informationen in Ihren API-Anfragen an:

• projectId
• serverId
• commandTemplateName

Verwenden Sie diese GET-Anfrage, um weitere Informationen zu einer Befehlsvorlage zu erhalten:

GET https://run-command.api.eu01.stackit.cloud/v1/projects/{projectId}/servers/{serverId}/command-templates/{commandTemplateName}

Swagger-API-Definition für die STACKIT Run Commands Service-API: GetCommandTemplate.