Skip to main content
PUT
Update an outbound config

Authorizations

Authorization
string
header
required

An sre_ak_* API key holding the api:admin scope (or api:config_read, which every write refuses with read_only_key).

Path Parameters

id
string
required

The resource's id.

Body

application/json
api_key
string<password>
write-only

The bearer token for a webhook or a Grafana target. Write-only: it is never answered by any tool here, an omitted one keeps the stored token, and an empty one is refused rather than read as a way to remove it. To remove it, delete the target.

base_url
string | null

Where to send the calls: the endpoint for a webhook target, the Grafana instance for a Grafana one. PagerDuty does not use it. null clears it.

default_severity_mapping
object | null

What each of this platform's severities is called at the provider, for PagerDuty. A severity this does not name uses the built-in mapping, and null means every one of them does.

enabled
boolean

Whether this target may be escalated to at all. A disabled row keeps its tokens and its rules and is skipped.

name
string

What this target is called here, unique within the organization. It is a label for the people reading the list, not anything the provider sees.

oncall_schedule_id
string | null

The schedule (by its uuid, as list_oncall_schedules answers it) an oncall_schedule target pages. It must belong to this organization. Required while provider_type is oncall_schedule and refused for every other provider, on the same terms as slack_channel: who is paged is resolved fresh from this schedule's roster and overrides at the moment of each page (Slack DM when the person on call has a linked account, email otherwise), never cached, and a schedule with nobody currently on call is a failed page rather than a silent one.

priority
integer

The order this organization's targets are tried in, lowest first. At least 1.

provider_type
enum<string>

Which system this target reaches: pagerduty, grafana, webhook, slack, oncall_schedule.

Available options:
pagerduty,
grafana,
webhook,
slack,
oncall_schedule
routing_key
string<password>
write-only

The PagerDuty Events integration key. Write-only on the same terms as api_key, which PagerDuty falls back to when this is not set.

slack_channel
string | null

The channel a Slack target's pages open in, like #oncall. Required while provider_type is slack and refused for every other provider, so the channel cannot be removed on a Slack target: converting the target to another provider_type is what clears it, and the stored channel goes with that conversion. The target pages in this organization's own connected workspace: no token is stored here, and an acknowledged or resolved alert rewrites the page it already posted rather than adding a message.

Response

Updated.