STstatusstack

List components for a source

The service's enabled components by name, without the synthetic catch-all component that stands in for the service as a whole. A bare JSON array; never paginated.

get/v1/sources/{source_id}/components

Request

  • Base URL
    https://statusstack.com/api
  • Auth
    HTTP bearer

Response

List of components

idstring uuid
namestring
descriptionstring nullable
source_idstring uuid
status'operational' | 'degraded' | 'degraded_performance' | 'partial_outage' | 'major_outage' | 'maintenance' | 'unknown'

The status vocabulary every v1 component surface speaks (App\Support\ComponentWireStatus), not the stored value. degraded_performance is echoed back in its stored spelling; every other degraded state maps to degraded. A status the alias table cannot place, or a component never checked, is unknown rather than being reported as healthy.

group_namestring nullable

Name of the component group this component sits in, or null for an ungrouped component. Present when the endpoint loads groups (the /v1/sources endpoints do; affected_components on incidents does not).

created_atstring date-time
updated_atstring date-time

Changes

No recorded changes to this operation across all 1 revision of this API.