Deutsch English

Komponente aktualisieren

PUT /api/v1/components/{component}

Partiell: Weggelassene Felder behalten ihren Wert, eine weggelassene Sprache ihre Übersetzung.

Erforderliche Berechtigung

components.manage Komponenten verwalten

URL Variablen

Name Beschreibung
component

Body Parameter (application/json)

Name Format Beschreibung Optional
name Mehrsprachiger Text als Objekt je Sprache, z. B. {"de": "…", "en": "…"}. Ein einfacher String wird in der Hauptsprache der Statusseite gespeichert. Bei PATCH partiell: eine weggelassene Sprache bleibt unverändert, ein ausdrückliches null löscht sie. —
description Mehrsprachiger Text als Objekt je Sprache, z. B. {"de": "…", "en": "…"}. Ein einfacher String wird in der Hauptsprache der Statusseite gespeichert. Bei PATCH partiell: eine weggelassene Sprache bleibt unverändert, ein ausdrückliches null löscht sie.
group_id Integer
is_public Boolean
subscribable Boolean
position Integer
webhook_enabled Boolean
host_system_id Integer

Beispiel-Request (application/json) 

{
  "name": {
    "de": "API-Gateway",
    "en": "API gateway"
  },
  "description": {
    "de": "Die öffentliche Schnittstelle",
    "en": "The public interface"
  },
  "group_id": 1,
  "is_public": true,
  "subscribable": true,
  "position": 0,
  "webhook_enabled": true,
  "host_system_id": 0
}

Werte sind Beispiele — Pflichtfelder stehen in der Tabelle. Der Body wird als JSON gesendet.

Response (application/json) 

{1 Eigenschaft
  "data": {13 Eigenschaften
    "id": 3,
    "name": {2 Eigenschaften
      "de": "API-Gateway",
      "en": "API gateway"
    },
    "description": {2 Eigenschaften
      "de": "Die öffentliche Schnittstelle",
      "en": null
    },
    "slug": "api-gateway",
    "group_id": 1,
    "position": 0,
    "is_public": true,
    "subscribable": true,
    "status": "degraded",
    "uptime_90d": 0.9982,
    "remote_trigger": {5 Eigenschaften
      "webhook_enabled": true,
      "webhook_url": "https://status.example.com/remote/2f9c1d7ab3e54c08a1b6",
      "webhook_status": "degraded",
      "webhook_status_at": "2026-07-27T13:58:00Z",
      "host_system": null
    },
    "created_at": "2026-05-04T08:00:00Z",
    "updated_at": "2026-07-27T13:58:00Z"
  }
}
{2 Eigenschaften
  "message": "Component not found.",
  "documentation_url": "https://docs.firestatus.de"
}
{2 Eigenschaften
  "message": "This API accepts JSON only. Send the request body as application/json (received application/x-www-form-urlencoded).",
  "documentation_url": "https://docs.firestatus.de"
}
{3 Eigenschaften
  "message": "The name must remain filled in at least one language.",
  "errors": {1 Eigenschaft
    "name": [1 Element
      "The name must remain filled in at least one language."
    ]
  },
  "documentation_url": "https://docs.firestatus.de"
}

cURL

curl -X PUT 'https://status.example.com/api/v1/components/{component}' \
  -H 'Authorization: Bearer fs_YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{"name":{"de":"API-Gateway","en":"API gateway"},"description":{"de":"Die öffentliche Schnittstelle","en":"The public interface"},"group_id":1,"is_public":true,"subscribable":true,"position":0,"webhook_enabled":true,"host_system_id":0}'