Deutsch English

Komponente aktualisieren

PATCH /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 string Locale-Objekt, z. B. {"de": "API-Gateway", "en": "API gateway"}. —
description string Locale-Objekt wie bei name.
group_id integer
is_public boolean
subscribable boolean
position integer
webhook_enabled boolean
host_system_id integer

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"
  }
}
{1 Eigenschaft
  "message": "Component not found."
}
{2 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."
    ]
  }
}

cURL

curl -X PATCH 'https://status.example.com/api/v1/components/:component' \
  -H 'Authorization: Bearer fs_YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{"name":"VALUE","description":"VALUE","group_id":"VALUE","is_public":"VALUE","subscribable":"VALUE","position":"VALUE","webhook_enabled":"VALUE","host_system_id":"VALUE"}'