Skip to main content
PUT
Update a Provider Integration Resource

Authorizations

X-BRONTO-API-KEY
string
header
required

Path Parameters

provider_id
string
required

The unique identifier of the provider integration to update

Body

application/json
url
string
required

The provider URL to send alerts to. Must use https.

Required string length: 10 - 2048
Example:

"https://provider.ie/webhook/generic/abc-123"

auth_type
enum<string>
required

How requests to the provider are authenticated. hmac signs each request with the secret, which is never sent. api_key sends the secret with each request in the form the provider expects. Not every provider supports both.

Available options:
hmac,
api_key
Example:

"hmac"

name
string

The integration name. Defaults to the provider's name.

Maximum string length: 255
Example:

"AWS DevOps Agent"

secret
string

A new secret for the provider. Omit or leave empty to keep the stored one.

Maximum string length: 4096
Example:

"xxxxx"

Response

Provider integration successfully updated

id
string
required

A unique identifier for the integration resource

Example:

"550e8400-e29b-41d4-a716-446655440000"

name
string
required

The integration name

Example:

"AWS DevOps Agent"

provider
enum<string>
required

The provider the integration sends alerts to

Available options:
aws-devops-agent,
pagerduty,
jsm,
rootly
Example:

"aws-devops-agent"

url
string
required

The provider webhook URL

Example:

"https://provider.ie/webhook/generic/abc-123"

has_secret
boolean
required

Whether a secret is stored. The secret itself is never returned.

Example:

true

auth_type
enum<string>
required

How requests to the provider are authenticated. hmac signs each request with the secret, which is never sent. api_key sends the secret with each request in the form the provider expects. Not every provider supports both.

Available options:
hmac,
api_key
Example:

"hmac"

tags
object

A map of key value pairs associated with the resource

Example: