STstatusstack

Update a custom source

Renames a custom source the API key's team owns, or changes its website URL. Shared vendor sources cannot be edited. Needs the write permission. The response carries tag names but not components.

put/v1/sources/{source_id}

Request

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

Request body

namestring
urlstring uri

Stored as the source's url (its website).

Response

Source updated

idstring uuid
keystring

Stable URL-safe identifier of the service.

namestring
descriptionstring nullable
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.

urlstring uri nullable

The service's own website (service_url), which is nullable — a source registered by status page alone has no service URL.

status_page_urlstring uri nullable

The provider's public status page.

logo_urlstring uri nullable
tagsstring[]

Tag names. Present on the /v1/sources endpoints.

last_checked_atstring date-time nullable

When StatusStack last fetched the service's status. On the /v1/sources index this can lag by up to 10 minutes: a fetch that changes nothing but the check time does not evict the cached list. /v1/sources/{source_id} is always current.

created_atstring date-time
updated_atstring date-time

Changes

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