Sign in
latestOpenAPI 3.0.32026-08-227451,2751.8 MB

d0fc0114da66

Alert

Patch AlertConfiguration

Patch an AlertConfiguration. Only name, description, and active are mutable. To change a configuration, you must replace it.

patch/alerts/configurations/{alert_configuration_id}

Path parameters

alert_configuration_idstring required

The ID of the AlertConfiguration

Request body

idstring

ID of the AlertConfiguration

parent_namespace'accounts' | 'api_keys' | 'workspaces'

Namespace of the parent to which this AlertConfiguration belongs

parent_idstring

ID of the parent to which this AlertConfiguration belongs

namestring

Name of the AlertConfiguration

descriptionstring

Description of the AlertConfiguration

trigger_type'usage' | 'time_based'

Discriminator for the type of trigger for this AlertConfiguration

triggerobject

Configuration of the trigger for this AlertConfiguration. Type depends on trigger_type (AlertConfigurationUsageTrigger for usage, AlertConfigurationTimeBasedTrigger for time_based)

enabledboolean

Whether or not this configuration is enabled

created_timeinteger

Time at which the AlertConfiguration was created

created_by_idstring

The ID of the user who created this AlertConfiguration

last_updated_timeinteger

Time at which the AlertConfiguration was last updated

last_updated_by_idstring

The ID of the user who last updated this AlertConfiguration

Response

The AlertConfiguration that was updated

idstring

ID of the AlertConfiguration

parent_namespace'accounts' | 'api_keys' | 'workspaces'

Namespace of the parent to which this AlertConfiguration belongs

parent_idstring

ID of the parent to which this AlertConfiguration belongs

namestring

Name of the AlertConfiguration

descriptionstring

Description of the AlertConfiguration

trigger_type'usage' | 'time_based'

Discriminator for the type of trigger for this AlertConfiguration

triggerobject

Configuration of the trigger for this AlertConfiguration. Type depends on trigger_type (AlertConfigurationUsageTrigger for usage, AlertConfigurationTimeBasedTrigger for time_based)

enabledboolean

Whether or not this configuration is enabled

created_timeinteger

Time at which the AlertConfiguration was created

created_by_idstring

The ID of the user who created this AlertConfiguration

last_updated_timeinteger

Time at which the AlertConfiguration was last updated

last_updated_by_idstring

The ID of the user who last updated this AlertConfiguration