---
title: "Update a custom source"
method: PUT
path: "/v1/sources/{source_id}"
---

# Update a custom source

`PUT /v1/sources/{source_id}`

## Request

- Base URL: `https://statusstack.com/api`
- URL: `https://statusstack.com/api/v1/sources/{source_id}`
- Auth: HTTP bearer

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.

## Request body

- object
  - `name` string
  - `url` string, uri: Stored as the source's `url` (its website).

## Response `200`

Source updated

- Source: A monitored service (a vendor's status page, or a custom source the team owns).
  - `id` string, uuid
  - `key` string: Stable URL-safe identifier of the service.
  - `name` string
  - `description` string, 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.
  - `url` string, 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_url` string, uri, nullable: The provider's public status page.
  - `logo_url` string, uri, nullable
  - `tags` string[]: Tag names. Present on the `/v1/sources` endpoints.
  - `last_checked_at` string, 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.
  - `components` Component[]: Enabled components, without the synthetic catch-all component that stands in for the service as a whole. Present when the endpoint loads them.
    - `id` string, uuid
    - `name` string
    - `description` string, nullable
    - `source_id` string, 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_name` string, 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_at` string, date-time
    - `updated_at` string, date-time
  - `created_at` string, date-time
  - `updated_at` string, date-time

## Other responses

- `401`: No bearer credentials, or credentials that do not resolve to an API key or Sanctum token. Produced by `ApiAuthentication` ahead of the route, so every operation in the v1 group can return it.
- `403`: The API key lacks the required permission, or a policy denied the action. The two come from different layers and return different bodies, so this is a union rather than one shape.
- `404`: No such source
- `422`: The request body failed validation, or the write would exceed the organization's quota — `CheckQuota` also answers 422, with its own body.
- `429`: The `v1-api` rate limit (120 requests per minute) was exceeded. Applies to every operation in the v1 group.

---

[API](https://skmtc.dev/statusstack/apis/statusstack-api.md) - [All operations](https://skmtc.dev/statusstack/apis/statusstack-api/llms.txt) - [OpenAPI document](https://skmtc.dev/statusstack/apis/statusstack-api/revisions/a5fabf6ac5e4?raw)