„GET /service/{serviceid}/provisioning/status“ ändern

GET-%2Fservice%2F%7Bserviceid%7D%2Fprovisioning%2Fstatus.md

@@ -0,0 +1,89 @@
+## **GET /service/{serviceid}/provisioning/status**
+
+
+## **Inhalt**
+---
+- Parameter
+- Optionale Parameter
+- Beispiel Anfrage
+- Beispiel Antwort
+- Mögliche Fehlermeldungen
+---
+
+### Parameter
+
+|URL Parameter | Typ | Beschreibung|
+|----------|-----|-------------|
+|serviceid | integer| Beschreibt die ID des Services
+
+---
+
+### Optionale Parameter
+
+|Query-String Parameter | Typ | Beschreibung|
+|----------|-----|-------------|
+|-| -| -
+
+
+
+
+---
+
+### Beispiel Anfrage
+
+##### PHP
+```php
+<?php
+
+$curl = curl_init();
+
+curl_setopt_array($curl, array(
+  CURLOPT_URL => 'control.local/api/v2/service/12345/provisioning/status',
+  CURLOPT_CUSTOMREQUEST => 'GET',
+  CURLOPT_HTTPHEADER => array(
+    'X-TOKEN: test-token',
+    'Content-Type: application/json'
+  ),
+));
+
+$response = curl_exec($curl);
+
+curl_close($curl);
+echo $response;
+```
+
+##### cURL
+```bash
+curl --location --request GET control.local/api/v2/service/449050/provisioning/status' \
+--header 'X-TOKEN: test-token' \
+--header 'Content-Type: application/json' 
+```
+
+---
+
+### Beispiel Antwort
+
+```json
+{
+    "status": "OK",
+    "templateid": 1,
+    "template": "AlmaLinux 8",
+    "statusmsg": "Retrieved file /BaseOS/x86_64/kickstart/images/pxeboot/initrd.img"
+}
+```
+
+```json
+{
+    "status": "OK",
+    "queued": false
+}
+```
+
+
+### Mögliche Fehlermeldungen
+
+> :warning: Status Code **403** - Permission denied
+
+> :warning: Status Code **400** - Server is not Provisioning. No installation queued
+
+> :warning: Status Code **500** - This action is not available for this service!