Skip to content

pagerduty update-services

Update existing services.

Description

Update existing services.

Synopsis

pagerduty update-services
    --site <site>
    --id <id>
    [--name <name>]
    [--description <description>]
    [--auto_resolve_timeout <auto_resolve_timeout>]
    [--acknowledgement_timeout <acknowledgement_timeout>]
    [--alert_creation <alert_creation>]
    [--status <status>]
    --escalation_policy <escalation_policy>
    [--active]

Arguments

site - (string)

     Site where this command will be executed
     Example: --site "site-1"
     Default: input.site      Attributes: required

id - (string)

     ID of the service.
     Example: --id "id-1"
     Default: _None_      Attributes: required

name - (string)

     The name of the service.
     Example: --name "name-1"
     Default: _None_      Attributes: optional

description - (string)

     description of webhook subscription
     Example: --description "description-1"
     Default: _None_      Attributes: optional

auto_resolve_timeout - (int)

     Time in seconds, incident is automatically resolved if left open for that long.
     Example: --auto_resolve_timeout 1
     Default: 14400      Attributes: optional

acknowledgement_timeout - (int)

     Time in seconds that an incident changes to the Triggered State after being Acknowledged.
     Example: --acknowledgement_timeout 1
     Default: 1800      Attributes: optional

alert_creation - (string)

     Whether a service creates only incidents, or both alerts and incidents.
     Example: --alert_creation "alert_creation-1"
     Default: _None_      Attributes: optional

     Validation:
         allowed values: create_incidents, create_alerts_and_incidents

status - (string)

     The current state of the Service.
     Example: --status "status-1"
     Default: active      Attributes: optional

     Validation:
         allowed values: active, warning, critical, maintenance, disabled

escalation_policy - (string)

     The Escalation Policy id
     Example: --escalation_policy "escalation_policy-1"
     Default: _None_      Attributes: required

active - (bool)

     If true, a webhook will be sent.
     Example: --active
     Default: true      Attributes: optional

Examples

pagerduty update-services --id "id-1" --name "name-1" --description "description-1" --alert_creation "alert_creation-1" --escalation_policy "escalation_policy-1"

Access Control

To use this command, you need access to the following:

Field Value
Action "update"
Service Type "pagerduty"
Service Instance
Namespace
Object Type "service"
Object ID id

Please see Access Control for details.