Deutsch English

Komponenten auflisten

GET /api/v1/components

Enthält auch interne Komponenten, die auf den öffentlichen Flächen verborgen sind.

Erforderliche Berechtigung

components.view Komponenten lesen

Body Parameter (application/json)

Name Format Beschreibung Optional
page integer
per_page integer Wird auf die maximale Seitengröße begrenzt statt abgewiesen.
group_id integer Nach Gruppe filtern. Ein leerer Wert liefert Komponenten ohne Gruppe.
is_public boolean
subscribable boolean

Response (application/json) 

{3 Eigenschaften
  "links": {4 Eigenschaften
    "first": "https://status.example.com/api/v1/components?page=1",
    "last": "https://status.example.com/api/v1/components?page=1",
    "prev": null,
    "next": null
  },
  "meta": {4 Eigenschaften
    "current_page": 1,
    "per_page": 25,
    "total": 1,
    "last_page": 1
  },
  "data": [1 Element
    {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": "Invalid API key."
}

cURL

curl -X GET 'https://status.example.com/api/v1/components' \
  -H 'Authorization: Bearer fs_YOUR_API_KEY'