pagerduty-cli
PagerDuty Command Line Interface
Usage
See the User Guide!
Commands
pd analytics:incidentpd analytics:incident:rawpd auth:addpd auth:deletepd auth:getpd auth:listpd auth:usepd auth:webpd autocomplete [SHELL]pd commandspd ep:copypd ep:createpd ep:level:addpd ep:level:removepd ep:listpd ep:oncallpd ep:openpd ep:target:addpd ep:target:removepd help [COMMAND]pd incident:ackpd incident:alertspd incident:analyticspd incident:assignpd incident:createpd incident:listpd incident:logpd incident:mergepd incident:notespd incident:openpd incident:prioritypd incident:renamepd incident:resolvepd incident:setpd logpd rest:deletepd rest:fetchpd rest:getpd rest:postpd rest:putpd schedule:copypd schedule:listpd schedule:oncallpd schedule:openpd schedule:override:addpd schedule:override:listpd schedule:renderpd schedule:showpd service:createpd service:disablepd service:enablepd service:listpd service:openpd service:setpd tag:assignpd tag:listpd tag:listobjectspd team:createpd team:ep:addpd team:ep:listpd team:ep:removepd team:listpd team:openpd team:user:addpd team:user:listpd team:user:removepd update [CHANNEL]pd user:contact:addpd user:contact:listpd user:contact:setpd user:createpd user:deletepd user:listpd user:logpd user:oncallpd user:replacepd user:session:listpd user:setpd util:deleteresourcepd util:timestamp [DATE]pd version
pd analytics:incident
Get PagerDuty Incident Analytics
USAGE
$ pd analytics:incident
OPTIONS
-M, --major Include only major incidents
-S, --services=services Service names to include. Specify multiple times for multiple services.
-b, --useauth=useauth Use the saved REST API token with this alias
-d, --delimiter=delimiter [default:
] Delimiter for fields that have more than one value
-g, --aggregate_unit=day|week|month The time unit to aggregate metrics by. If no value is provided, the metrics will
be aggregated for the entire period.
-h, --help Show CLI help.
-j, --json output full details as JSON
-k, --keys=keys Additional fields to display. Specify multiple times for multiple fields.
-t, --teams=teams Team names to include. Specify multiple times for multiple teams.
-u, --urgencies=high|low [default: high,low] Urgencies to include.
-x, --extended show extra columns
--columns=columns only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--debug Print REST API call debug logs
--filter=filter filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=csv|json|yaml output in a more machine friendly format
--since=since [default: 7 days ago] The start of the date range over which you want to search.
--sort=sort property to sort by (prepend '-' for descending)
--token=token Ignore the saved configuration and use this token
--until=until [default: now] The end of the date range over which you want to search.
See code: src/commands/analytics/incident/index.ts
pd analytics:incident:raw
Get PagerDuty Raw Incident Analytics
USAGE
$ pd analytics:incident:raw
OPTIONS
-M, --major Include only major incidents
-S, --services=services Service names to include. Specify multiple times for multiple services.
-b, --useauth=useauth Use the saved REST API token with this alias
-d, --delimiter=delimiter [default:
] Delimiter for fields that have more than one value
-h, --help Show CLI help.
-j, --json output full details as JSON
-k, --keys=keys Additional fields to display. Specify multiple times for multiple fields.
-t, --teams=teams Team names to include. Specify multiple times for multiple teams.
-x, --extended show extra columns
--columns=columns only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--debug Print REST API call debug logs
--filter=filter filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=csv|json|yaml output in a more machine friendly format
--since=since The start of the date range over which you want to search.
--sort=sort property to sort by (prepend '-' for descending)
--token=token Ignore the saved configuration and use this token
--until=until The end of the date range over which you want to search.
See code: src/commands/analytics/incident/raw.ts
pd auth:add
Add an authenticated PagerDuty domain
USAGE
$ pd auth:add
OPTIONS
-a, --alias=alias The alias to use for this token. Defaults to the name of the PD subdomain
-d, --[no-]default Use this token as the default for all PD commands
-h, --help Show CLI help.
-t, --token=token A PagerDuty API token
--debug Print REST API call debug logs
ALIASES
$ pd auth:set
See code: src/commands/auth/add.ts
pd auth:delete
Delete a PagerDuty domain authentication
USAGE
$ pd auth:delete
OPTIONS
-a, --alias=alias (required) The alias of the PD domain authentication to delete
-h, --help Show CLI help.
--debug Print REST API call debug logs
See code: src/commands/auth/delete.ts
pd auth:get
Get the current authenticated PagerDuty domain
USAGE
$ pd auth:get
OPTIONS
-h, --help Show CLI help.
--debug Print REST API call debug logs
See code: src/commands/auth/get.ts
pd auth:list
List authenticated PagerDuty domains
USAGE
$ pd auth:list
OPTIONS
-h, --help Show CLI help.
--debug Print REST API call debug logs
See code: src/commands/auth/list.ts
pd auth:use
Choose a saved authenticated PagerDuty domain to use with all pd commands
USAGE
$ pd auth:use
OPTIONS
-a, --alias=alias (required) The alias of the PD domain to use
-h, --help Show CLI help.
--debug Print REST API call debug logs
See code: src/commands/auth/use.ts
pd auth:web
Authenticate with PagerDuty in the browser
USAGE
$ pd auth:web
OPTIONS
-a, --alias=alias The alias to use for this token. Defaults to the name of the PD subdomain
-d, --[no-]default Use this token as the default for all PD commands
-h, --help Show CLI help.
--debug Print REST API call debug logs
ALIASES
$ pd login
See code: src/commands/auth/web.ts
pd autocomplete [SHELL]
display autocomplete installation instructions
USAGE
$ pd autocomplete [SHELL]
ARGUMENTS
SHELL shell type
OPTIONS
-r, --refresh-cache Refresh cache (ignores displaying instructions)
EXAMPLES
$ pd autocomplete
$ pd autocomplete bash
$ pd autocomplete zsh
$ pd autocomplete --refresh-cache
See code: @oclif/plugin-autocomplete
pd commands
list all the commands
USAGE
$ pd commands
OPTIONS
-h, --help Show CLI help.
-x, --extended show extra columns
--columns=columns only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--filter=filter filter property by partial string matching, ex: name=foo
--hidden show hidden commands
--json Format output as json.
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=csv|json|yaml output in a more machine friendly format
--sort=sort property to sort by (prepend '-' for descending)
See code: @oclif/plugin-commands
pd ep:copy
Make a copy of a PagerDuty Escalation Policy
USAGE
$ pd ep:copy
OPTIONS
-b, --useauth=useauth Use the saved REST API token with this alias
-d, --destination=destination The name for the new escalation policy
-h, --help Show CLI help.
-i, --id=id The ID of the escalation policy to copy.
-n, --name=name The name of the escalation policy to copy.
-o, --open Open the new escalation policy in the browser
-p, --pipe Print the new escalation policy ID only to stdout, for use with pipes.
--debug Print REST API call debug logs
--token=token Ignore the saved configuration and use this token
See code: src/commands/ep/copy.ts
pd ep:create
Create a PagerDuty Escalation Policy with a single level. You can add levels and targets later with ep:level and ep:target
USAGE
$ pd ep:create
OPTIONS
-S, --schedule_names=schedule_names Add a target schedule with this name. Specify multiple times for multiple
targets.
-U, --user_emails=user_emails Add a target user with this email. Specify multiple times for multiple targets.
-b, --useauth=useauth Use the saved REST API token with this alias
-d, --delay=delay [default: 30] Delay in minutes before unacknowledged incidents escalate away from
this level
-h, --help Show CLI help.
-n, --name=name (required) The name of the escalation policy to add.
-o, --open Open the new escalation policy in the browser
-p, --pipe Print the escalation policy ID only to stdout, for use with pipes.
-r, --repeat=repeat [default: 0] Number of times to repeat this level
-s, --schedule_ids=schedule_ids Add a target schedule with this ID. Specify multiple times for multiple targets.
-u, --user_ids=user_ids Add a target user with this ID. Specify multiple times for multiple targets.
--debug Print REST API call debug logs
--description=description The description of the escalation policy
--token=token Ignore the saved configuration and use this token
See code: src/commands/ep/create.ts
pd ep:level:add
Add a level to PagerDuty Escalation Policies
USAGE
$ pd ep:level:add
OPTIONS
-S, --schedule_names=schedule_names Add a target schedule with this name. Specify multiple times for multiple
targets.
-U, --user_emails=user_emails Add a target user with this email. Specify multiple times for multiple targets.
-b, --useauth=useauth Use the saved REST API token with this alias
-d, --delay=delay [default: 30] Delay in minutes before unacknowledged incidents escalate away from
this level
-h, --help Show CLI help.
-i, --ids=ids The IDs of escalation policies to update.
-l, --level=level (required) Escalation policy level to add (the lowest level is 1; any existing
levels at or above the added level will be moved up. To add the top level,
specify any number higher than the existing number of levels (e.g., 99))
-n, --name=name Update escalation policies whose names match this string.
-p, --pipe Read escalation policy ID's from stdin.
-s, --schedule_ids=schedule_ids Add a target schedule with this ID. Specify multiple times for multiple targets.
-u, --user_ids=user_ids Add a target user with this ID. Specify multiple times for multiple targets.
--debug Print REST API call debug logs
--token=token Ignore the saved configuration and use this token
See code: src/commands/ep/level/add.ts
pd ep:level:remove
Remove a level from PagerDuty Escalation Policies
USAGE
$ pd ep:level:remove
OPTIONS
-b, --useauth=useauth Use the saved REST API token with this alias
-h, --help Show CLI help.
-i, --ids=ids The IDs of escalation policies to update.
-l, --level=level (required) Escalation policy level to remove (the lowest level is 1; any existing levels above
the deleted level will be moved down.
-n, --name=name Update escalation policies whose names match this string.
-p, --pipe Read escalation policy ID's from stdin.
--debug Print REST API call debug logs
--token=token Ignore the saved configuration and use this token
See code: src/commands/ep/level/remove.ts
pd ep:list
List PagerDuty Escalation Policies
USAGE
$ pd ep:list
OPTIONS
-b, --useauth=useauth Use the saved REST API token with this alias
-d, --delimiter=delimiter [default:
] Delimiter for fields that have more than one value
-h, --help Show CLI help.
-j, --json output full details as JSON
-k, --keys=keys Additional fields to display. Specify multiple times for multiple fields.
-n, --name=name Select escalation policies whose names contain the given text
-p, --pipe Print escalation policy ID's only to stdout, for use with pipes.
-x, --extended show extra columns
--columns=columns only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--debug Print REST API call debug logs
--filter=filter filter property by partial string matching, ex: name=foo
--limit=limit Return no more than this many entries. This option turns off table filtering options.
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=csv|json|yaml output in a more machine friendly format
--sort=sort property to sort by (prepend '-' for descending)
--token=token Ignore the saved configuration and use this token
See code: src/commands/ep/list.ts
pd ep:oncall
List a PagerDuty Escalation Policy's on call shifts.
USAGE
$ pd ep:oncall
OPTIONS
-b, --useauth=useauth Use the saved REST API token with this alias
-h, --help Show CLI help.
-i, --id=id Show oncalls for the EP with this ID.
-j, --json output full details as JSON
-k, --keys=keys Additional fields to display. Specify multiple times for multiple fields.
-n, --name=name Show oncalls for the EP with this name.
-x, --extended show extra columns
--columns=columns only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--debug Print REST API call debug logs
--filter=filter filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=csv|json|yaml output in a more machine friendly format
--since=since The start of the date range over which you want to search.
--sort=sort property to sort by (prepend '-' for descending)
--token=token Ignore the saved configuration and use this token
--until=until The end of the date range over which you want to search.
See code: src/commands/ep/oncall.ts
pd ep:open
Open PagerDuty Escalation policies in the browser
USAGE
$ pd ep:open
OPTIONS
-b, --useauth=useauth Use the saved REST API token with this alias
-h, --help Show CLI help.
-i, --ids=ids The IDs of escalation policies to open.
-n, --name=name Open escalation policies whose names match this string.
-p, --pipe Read escalation policy ID's from stdin.
--debug Print REST API call debug logs
--token=token Ignore the saved configuration and use this token
See code: src/commands/ep/open.ts
pd ep:target:add
Add targets to PagerDuty Escalation Policies
USAGE
$ pd ep:target:add
OPTIONS
-S, --schedule_names=schedule_names Add a target schedule with this name. Specify multiple times for multiple
targets.
-U, --user_emails=user_emails Add a target user with this email. Specify multiple times for multiple targets.
-b, --useauth=useauth Use the saved REST API token with this alias
-h, --help Show CLI help.
-i, --ids=ids The IDs of escalation policies to update.
-l, --level=level (required) Escalation policy level to add targets to
-n, --name=name Update escalation policies whose names match this string.
-p, --pipe Read escalation policy ID's from stdin.
-s, --schedule_ids=schedule_ids Add a target schedule with this ID. Specify multiple times for multiple targets.
-u, --user_ids=user_ids Add a target user with this ID. Specify multiple times for multiple targets.
--debug Print REST API call debug logs
--token=token Ignore the saved configuration and use this token
See code: src/commands/ep/target/add.ts
pd ep:target:remove
Remove targets from PagerDuty Escalation Policies
USAGE
$ pd ep:target:remove
OPTIONS
-S, --schedule_names=schedule_names Remove a target schedule with this name. Specify multiple times for multiple
targets.
-U, --user_emails=user_emails Remove a target user with this email. Specify multiple times for multiple
targets.
-b, --useauth=useauth Use the saved REST API token with this alias
-h, --help Show CLI help.
-i, --ids=ids The IDs of escalation policies to update.
-l, --level=level (required) Escalation policy level to remove targets from
-n, --name=name Update escalation policies whose names match this string.
-p, --pipe Read escalation policy ID's from stdin.
-s, --schedule_ids=schedule_ids Remove a target schedule with this ID. Specify multiple times for multiple
targets.
-u, --user_ids=user_ids Remove a target user with this ID. Specify multiple times for multiple targets.
--debug Print REST API call debug logs
--token=token Ignore the saved configuration and use this token
See code: src/commands/ep/target/remove.ts
pd help [COMMAND]
Display help for pd.
USAGE
$ pd help [COMMAND]
ARGUMENTS
COMMAND Command to show help for.
OPTIONS
-n, --nested-commands Include all nested commands in the output.
See code: @oclif/plugin-help
pd incident:ack
Acknowledge PagerDuty Incidents
USAGE
$ pd incident:ack
OPTIONS
-F, --from=from Login email of a PD user account for the "From:" header. Use only with legacy API tokens.
-b, --useauth=useauth Use the saved REST API token with this alias
-h, --help Show CLI help.
-i, --ids=ids Incident ID's to acknowledge. Specify multiple times for multiple incidents.
-m, --me Acknowledge all incidents assigned to me
-p, --pipe Read incident ID's from stdin.
-z, --snooze=snooze Also snooze selected incidents for the specified amount of time (5m, '1 hour', default unit is
seconds).
--debug Print REST API call debug logs
--token=token Ignore the saved configuration and use this token
ALIASES
$ pd incident:acknowledge
See code: src/commands/incident/ack.ts
pd incident:alerts
Show Alerts in PagerDuty Incidents
USAGE
$ pd incident:alerts
OPTIONS
-b, --useauth=useauth Use the saved REST API token with this alias
-d, --delimiter=delimiter [default:
] Delimiter for fields that have more than one value
-h, --help Show CLI help.
-i, --ids=ids Show alerts for these Incident ID's. Specify multiple times for multiple incidents.
-j, --json output full details as JSON
-k, --keys=keys Additional fields to display. Specify multiple times for multiple fields.
-m, --me Show alerts for all incidents assigned to me
-p, --pipe Read incident ID's from stdin.
-x, --extended show extra columns
--columns=columns only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--debug Print REST API call debug logs
--filter=filter filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=csv|json|yaml output in a more machine friendly format
--sort=sort property to sort by (prepend '-' for descending)
--token=token Ignore the saved configuration and use this token
See code: src/commands/incident/alerts.ts
pd incident:analytics
Get Incident analytics
USAGE
$ pd incident:analytics
OPTIONS
-b, --useauth=useauth Use the saved REST API token with this alias
-h, --help Show CLI help.
-i, --ids=ids Incident ID's to look at. Specify multiple times for multiple incidents.
-j, --json output full details as JSON
-k, --keys=keys Additional fields to display. Specify multiple times for multiple fields.
-p, --pipe Read incident ID's from stdin.
-x, --extended show extra columns
--columns=columns only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--debug Print REST API call debug logs
--filter=filter filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=csv|json|yaml output in a more machine friendly format
--sort=sort property to sort by (prepend '-' for descending)
--token=token Ignore the saved configuration and use this token
See code: src/commands/incident/analytics.ts
pd incident:assign
Assign/Reassign PagerDuty Incidents
USAGE
$ pd incident:assign
OPTIONS
-E, --assign_to_ep_name=assign_to_ep_name Escalation policy name to assign incidents to.
-F, --from=from Login email of a PD user account for the "From:" header. Use only
with legacy API tokens.
-U, --assign_to_user_emails=assign_to_user_emails User emails to assign incidents to. Specify multiple times for
multiple assignees.
-b, --useauth=useauth Use the saved REST API token with this alias
-e, --assign_to_ep_id=assign_to_ep_id Escalation policy ID to assign incidents to.
-h, --help Show CLI help.
-i, --ids=ids Incident ID's to assign. Specify multiple times for multiple
incidents.
-m, --me Reassign all incidents that are currently assigned to me
-p, --pipe Read incident ID's from stdin.
-u, --assign_to_user_ids=assign_to_user_ids User ID's to assign incidents to. Specify multiple times for
multiple assignees.
--debug Print REST API call debug logs
--token=token Ignore the saved configuration and use this token
ALIASES
$ pd incident:reassign
See code: src/commands/incident/assign.ts
pd incident:create
Create a PagerDuty Incident
USAGE
$ pd incident:create
OPTIONS
-E, --escalation_policy=escalation_policy The name of the escalation policy to assign the incident to
-F, --from=from Login email of a PD user account for the "From:" header. Use only with
legacy API tokens.
-P, --priority=priority Incident priority
-S, --service=service The name of the service to create the incident in
-U, --user=user The email of a user to assign the incident to
-b, --useauth=useauth Use the saved REST API token with this alias
-d, --details=details Incident details
-h, --help Show CLI help.
-k, --key=key Incident key
-o, --open Open the new incident in the browser
-p, --pipe Print the incident ID only to stdout, for use with pipes.
-t, --title=title (required) Incident title
-u, --urgency=high|low Incident urgency
--debug Print REST API call debug logs
--escalation_policy_id=escalation_policy_id The ID of the escalation policy to assign the incident to
--service_id=service_id The ID of the service to create the incident in
--token=token Ignore the saved configuration and use this token
--user_id=user_id The ID of a user to assign the incident to
See code: src/commands/incident/create.ts
pd incident:list
List PagerDuty Incidents
USAGE
$ pd incident:list
OPTIONS
-S, --services=services Service names to include. Specify multiple times for
multiple services.
-b, --useauth=useauth Use the saved REST API token with this alias
-d, --delimiter=delimiter [default:
] Delimiter for fields that have more than one value
-e, --assignees=assignees Return only incidents assigned to this PD login email.
Specify multiple times for multiple assignees.
-h, --help Show CLI help.
-j, --json output full details as JSON
-k, --keys=keys Additional fields to display. Specify multiple times for
multiple fields.
-m, --me Return only incidents assigned to me
-p, --pipe Print incident ID's only to stdout, for use with pipes.
-s, --statuses=open|closed|triggered|acknowledged|resolved [default: open] Return only incidents with the given
statuses. Specify multiple times for multiple statuses.
-t, --teams=teams Team names to include. Specify multiple times for multiple
teams.
-u, --urgencies=high|low [default: high,low] Urgencies to include.
-x, --extended show extra columns
--columns=columns only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--debug Print REST API call debug logs
--filter=filter filter property by partial string matching, ex: name=foo
--limit=limit Return no more than this many entries. This option turns
off table filtering options.
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--notes Also show incident notes (Uses a lot more HTTPS requests!)
--output=csv|json|yaml output in a more machine friendly format
--since=since The start of the date range over which you want to search.
--sort=sort property to sort by (prepend '-' for descending)
--token=token Ignore the saved configuration and use this token
--until=until The end of the date range over which you want to search.
See code: src/commands/incident/list.ts
pd incident:log
Show PagerDuty Incident Log Entries
USAGE
$ pd incident:log
OPTIONS
-O, --overview Get only `overview` log entries
-b, --useauth=useauth Use the saved REST API token with this alias
-d, --delimiter=delimiter [default:
] Delimiter for fields that have more than one value
-h, --help Show CLI help.
-i, --ids=ids Select incidents with the given ID. Specify multiple times for multiple incidents.
-j, --json output full details as JSON
-k, --keys=keys Additional fields to display. Specify multiple times for multiple fields.
-p, --pipe Read incident IDs from stdin, for use with pipes.
-x, --extended show extra columns
--columns=columns only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--debug Print REST API call debug logs
--filter=filter filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=csv|json|yaml output in a more machine friendly format
--sort=sort property to sort by (prepend '-' for descending)
--token=token Ignore the saved configuration and use this token
See code: src/commands/incident/log.ts
pd incident:merge
Merge PagerDuty Incidents
USAGE
$ pd incident:merge
OPTIONS
-F, --from=from Login email of a PD user account for the "From:" header. Use only with legacy API tokens.
-I, --parent_id=parent_id Use this incident ID as the parent ID.
-b, --useauth=useauth Use the saved REST API token with this alias
-h, --help Show CLI help.
-i, --ids=ids Merge incidents with the given ID. Specify multiple times for multiple incidents. If -I is
not given, the first incident in the list will be the parent incident.
-o, --open Open the merged incident in the browser
-p, --pipe Read incident IDs from stdin, for use with pipes. If -I is not given, the first incident ID
from the pipe will be the parent incident.
--debug Print REST API call debug logs
--token=token Ignore the saved configuration and use this token
See code: src/commands/incident/merge.ts
pd incident:notes
See or add notes on PagerDuty Incidents
USAGE
$ pd incident:notes
OPTIONS
-F, --from=from Login email of a PD user account for the "From:" header. Use only with legacy API tokens.
-b, --useauth=useauth Use the saved REST API token with this alias
-h, --help Show CLI help.
-i, --id=id (required) Incident ID.
-n, --note=note Note to add
-x, --extended show extra columns
--columns=columns only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--debug Print REST API call debug logs
--filter=filter filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=csv|json|yaml output in a more machine friendly format
--sort=sort property to sort by (prepend '-' for descending)
--token=token Ignore the saved configuration and use this token
See code: src/commands/incident/notes.ts
pd incident:open
Open PagerDuty Incidents in your browser
USAGE
$ pd incident:open
OPTIONS
-b, --useauth=useauth Use the saved REST API token with this alias
-h, --help Show CLI help.
-i, --ids=ids Incident ID's to open. Specify multiple times for multiple incidents.
-m, --me Open all incidents assigned to me
-p, --pipe Read incident ID's from stdin.
--debug Print REST API call debug logs
--token=token Ignore the saved configuration and use this token
See code: src/commands/incident/open.ts
pd incident:priority
Set priority on PagerDuty Incidents
USAGE
$ pd incident:priority
OPTIONS
-F, --from=from Login email of a PD user account for the "From:" header. Use only with legacy API tokens.
-b, --useauth=useauth Use the saved REST API token with this alias
-h, --help Show CLI help.
-i, --ids=ids Incident ID's to set priority on. Specify multiple times for multiple incidents.
-m, --me Set priority on all incidents assigned to me
-n, --priority=priority (required) The name of the priority to set.
-p, --pipe Read incident ID's from stdin.
--debug Print REST API call debug logs
--token=token Ignore the saved configuration and use this token
See code: src/commands/incident/priority.ts
pd incident:rename
Rename (change the title of) PagerDuty Incidents
USAGE
$ pd incident:rename
OPTIONS
-F, --from=from Login email of a PD user account for the "From:" header. Use only with legacy API tokens.
-b, --useauth=useauth Use the saved REST API token with this alias
-h, --help Show CLI help.
-i, --ids=ids Incident ID's to rename. Specify multiple times for multiple incidents.
-m, --me Rename all incidents that are currently assigned to me
-p, --pipe Read incident ID's from stdin.
-t, --title=title Set the incident title to this string
--debug Print REST API call debug logs
--prefix=prefix Prefix the incident title with this string
--token=token Ignore the saved configuration and use this token
See code: src/commands/incident/rename.ts
pd incident:resolve
Resolve PagerDuty Incidents
USAGE
$ pd incident:resolve
OPTIONS
-F, --from=from Login email of a PD user account for the "From:" header. Use only with legacy API tokens.
-b, --useauth=useauth Use the saved REST API token with this alias
-h, --help Show CLI help.
-i, --ids=ids Incident ID's to resolve. Specify multiple times for multiple incidents.
-m, --me Resolve all incidents assigned to me
-p, --pipe Read incident ID's from stdin.
--debug Print REST API call debug logs
--token=token Ignore the saved configuration and use this token
See code: src/commands/incident/resolve.ts
pd incident:set
Update PagerDuty Incidents
USAGE
$ pd incident:set
OPTIONS
-F, --from=from Login email of a PD user account for the "From:" header. Use only with legacy API tokens.
-b, --useauth=useauth Use the saved REST API token with this alias
-h, --help Show CLI help.
-i, --ids=ids Incident ID's to update. Specify multiple times for multiple incidents.
-k, --key=key (required) Attribute key to set
-m, --me Update all incidents that are currently assigned to me
-p, --pipe Read incident ID's from stdin.
-v, --value=value (required) Attribute value to set
--debug Print REST API call debug logs
--token=token Ignore the saved configuration and use this token
ALIASES
$ pd incident:update
See code: src/commands/incident/set.ts
pd log
Show PagerDuty Domain Log Entries
USAGE
$ pd log
OPTIONS
-O, --overview Get only `overview` log entries
-b, --useauth=useauth Use the saved REST API token with this alias
-d, --delimiter=delimiter [default:
] Delimiter for fields that have more than one value
-h, --help Show CLI help.
-j, --json output full details as JSON
-k, --keys=keys Additional fields to display. Specify multiple times for multiple fields.
-x, --extended show extra columns
--columns=columns only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--debug Print REST API call debug logs
--filter=filter filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=csv|json|yaml output in a more machine friendly format
--since=since [default: 30 days ago] The start of the date range over which you want to search.
--sort=sort property to sort by (prepend '-' for descending)
--token=token Ignore the saved configuration and use this token
--until=until The end of the date range over which you want to search.
See code: src/commands/log.ts
pd rest:delete
Make a DELETE request to PagerDuty
USAGE
$ pd rest:delete
OPTIONS
-H, --headers=headers [default: ] Headers to add, for example, `From=martin@pagerduty.com`. Specify multiple times
for multiple headers.
-P, --params=params [default: ] Parameters to add, for example, `query=martin` or `include[]=teams. Specify
multiple times for multiple params.
-b, --useauth=useauth Use the saved REST API token with this alias
-e, --endpoint=endpoint (required) The path to the endpoint, for example, `/users/PXXXXXX` or `/services`
-h, --help Show CLI help.
--debug Print REST API call debug logs
--token=token Ignore the saved configuration and use this token
See code: src/commands/rest/delete.ts
pd rest:fetch
Fetch objects from PagerDuty
USAGE
$ pd rest:fetch
OPTIONS
-H, --headers=headers [default: ] Headers to add, for example, `From=martin@pagerduty.com`. Specify multiple
times for multiple headers.
-P, --params=params [default: ] Parameters to add, for example, `query=martin` or `include[]=teams. Specify
multiple times for multiple params.
-b, --useauth=useauth Use the saved REST API token with this alias
-d, --delimiter=delimiter [default:
] Delimiter for fields that have more than one value, for use with `--table`.
-e, --endpoint=endpoint (required) The path to the endpoint, for example, `/users/PXXXXXX` or `/services`
-h, --help Show CLI help.
-k, --keys=keys Additional fields to display, for use with `--table`. Specify multiple times for multiple
fields.
-p, --pipe Print object ID's only to stdout, for use with pipes.
-t, --table Output in table format instead of JSON
-x, --extended show extra columns
--columns=columns only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--debug Print REST API call debug logs
--filter=filter filter property by partial string matching, ex: name=foo
--limit=limit Return no more than this many entries. This option turns off table filtering options.
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=csv|json|yaml output in a more machine friendly format
--sort=sort property to sort by (prepend '-' for descending)
--token=token Ignore the saved configuration and use this token
See code: src/commands/rest/fetch.ts
pd rest:get
Make a GET request to PagerDuty
USAGE
$ pd rest:get
OPTIONS
-H, --headers=headers [default: ] Headers to add, for example, `From=martin@pagerduty.com`. Specify multiple times
for multiple headers.
-P, --params=params [default: ] Parameters to add, for example, `query=martin` or `include[]=teams`. Specify
multiple times for multiple params.
-b, --useauth=useauth Use the saved REST API token with this alias
-e, --endpoint=endpoint (required) The path to the endpoint, for example, `/users/PXXXXXX` or `/services`
-h, --help Show CLI help.
--debug Print REST API call debug logs
--token=token Ignore the saved configuration and use this token
See code: src/commands/rest/get.ts
pd rest:post
Make a POST request to PagerDuty
USAGE
$ pd rest:post
OPTIONS
-H, --headers=headers [default: ] Headers to add, for example, `From=martin@pagerduty.com`. Specify multiple times
for multiple headers.
-P, --params=params [default: ] Parameters to add, for example, `query=martin` or `include[]=teams. Specify
multiple times for multiple params.
-b, --useauth=useauth Use the saved REST API token with this alias
-d, --data=data (required) JSON data to send
-e, --endpoint=endpoint (required) The path to the endpoint, for example, `/users/PXXXXXX` or `/services`
-h, --help Show CLI help.
--debug Print REST API call debug logs
--token=token Ignore the saved configuration and use this token
See code: src/commands/rest/post.ts
pd rest:put
Make a PUT request to PagerDuty
USAGE
$ pd rest:put
OPTIONS
-H, --headers=headers [default: ] Headers to add, for example, `From=martin@pagerduty.com`. Specify multiple times
for multiple headers.
-P, --params=params [default: ] Parameters to add, for example, `query=martin` or `include[]=teams. Specify
multiple times for multiple params.
-b, --useauth=useauth Use the saved REST API token with this alias
-d, --data=data (required) JSON data to send
-e, --endpoint=endpoint (required) The path to the endpoint, for example, `/users/PXXXXXX` or `/services`
-h, --help Show CLI help.
--debug Print REST API call debug logs
--token=token Ignore the saved configuration and use this token
See code: src/commands/rest/put.ts
pd schedule:copy
Make a copy of a PagerDuty Schedule
USAGE
$ pd schedule:copy
OPTIONS
-b, --useauth=useauth Use the saved REST API token with this alias
-d, --destination=destination The name for the new schedule
-h, --help Show CLI help.
-i, --id=id The ID of the schedule to copy.
-n, --name=name The name of the schedule to copy.
-o, --open Open the new schedule in the browser
-p, --pipe Print the new schedule ID only to stdout, for use with pipes.
--debug Print REST API call debug logs
--token=token Ignore the saved configuration and use this token
See code: src/commands/schedule/copy.ts
pd schedule:list
List PagerDuty Schedules
USAGE
$ pd schedule:list
OPTIONS
-b, --useauth=useauth Use the saved REST API token with this alias
-d, --delimiter=delimiter [default:
] Delimiter for fields that have more than one value
-h, --help Show CLI help.
-j, --json output full details as JSON
-k, --keys=keys Additional fields to display. Specify multiple times for multiple fields.
-n, --name=name Select schedules whose names contain the given text
-p, --pipe Print schedule ID's only to stdout, for use with pipes.
-x, --extended show extra columns
--columns=columns only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--debug Print REST API call debug logs
--filter=filter filter property by partial string matching, ex: name=foo
--limit=limit Return no more than this many entries. This option turns off table filtering options.
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=csv|json|yaml output in a more machine friendly format
--sort=sort property to sort by (prepend '-' for descending)
--token=token Ignore the saved configuration and use this token
See code: src/commands/schedule/list.ts
pd schedule:oncall
List a PagerDuty Schedule's on call shifts.
USAGE
$ pd schedule:oncall
OPTIONS
-b, --useauth=useauth Use the saved REST API token with this alias
-h, --help Show CLI help.
-i, --id=id Show oncalls for the schedule with this ID.
-j, --json output full details as JSON
-k, --keys=keys Additional fields to display. Specify multiple times for multiple fields.
-n, --name=name Show oncalls for the schedule with this name.
-x, --extended show extra columns
--columns=columns only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--debug Print REST API call debug logs
--filter=filter filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=csv|json|yaml output in a more machine friendly format
--since=since The start of the date range over which you want to search.
--sort=sort property to sort by (prepend '-' for descending)
--token=token Ignore the saved configuration and use this token
--until=until The end of the date range over which you want to search.
See code: src/commands/schedule/oncall.ts
pd schedule:open
Open PagerDuty Schedules in the browser
USAGE
$ pd schedule:open
OPTIONS
-b, --useauth=useauth Use the saved REST API token with this alias
-h, --help Show CLI help.
-i, --ids=ids The IDs of schedules to open.
-n, --name=name Open schedules matching this string.
-p, --pipe Read schedule ID's from stdin.
--debug Print REST API call debug logs
--token=token Ignore the saved configuration and use this token
See code: src/commands/schedule/open.ts
pd schedule:override:add
Add an override to a PagerDuty schedule.
USAGE
$ pd schedule:override:add
OPTIONS
-U, --user_email=user_email The email of the PagerDuty user for the override
-b, --useauth=useauth Use the saved REST API token with this alias
-h, --help Show CLI help.
-i, --id=id Add an override to the schedule with this ID.
-n, --name=name Add an override to the schedule with this name.
-u, --user_id=user_id The ID of the PagerDuty user for the override
--debug Print REST API call debug logs
--end=end [default: in 1 day] The end time for the override.
--start=start [default: now] The start time for the override.
--token=token Ignore the saved configuration and use this token
See code: src/commands/schedule/override/add.ts
pd schedule:override:list
List a PagerDuty Schedule's overrides.
USAGE
$ pd schedule:override:list
OPTIONS
-b, --useauth=useauth Use the saved REST API token with this alias
-d, --delimiter=delimiter [default:
] Delimiter for fields that have more than one value
-h, --help Show CLI help.
-i, --id=id Show overrides for the schedule with this ID.
-j, --json output full details as JSON
-k, --keys=keys Additional fields to display. Specify multiple times for multiple fields.
-n, --name=name Show overrides for the schedule with this name.
-p, --pipe Print override ID's only to stdout, for use with pipes.
-x, --extended show extra columns
--columns=columns only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--debug Print REST API call debug logs
--filter=filter filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=csv|json|yaml output in a more machine friendly format
--since=since [default: now] The start of the date range over which you want to search.
--sort=sort property to sort by (prepend '-' for descending)
--token=token Ignore the saved configuration and use this token
--until=until [default: in 30 days] The end of the date range over which you want to search.
See code: src/commands/schedule/override/list.ts
pd schedule:render
Render a PagerDuty Schedule
USAGE
$ pd schedule:render
OPTIONS
-b, --useauth=useauth Use the saved REST API token with this alias
-d, --delimiter=delimiter [default:
] Delimiter for fields that have more than one value
-h, --help Show CLI help.
-i, --id=id Render the schedule with this ID.
-j, --json output full details as JSON
-k, --keys=keys Additional fields to display. Specify multiple times for multiple fields.
-n, --name=name Render the schedule with this name.
-x, --extended show extra columns
--columns=columns only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--debug Print REST API call debug logs
--filter=filter filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=csv|json|yaml output in a more machine friendly format
--since=since The start of the date range over which you want to search.
--sort=sort property to sort by (prepend '-' for descending)
--token=token Ignore the saved configuration and use this token
--until=until The end of the date range over which you want to search.
See code: src/commands/schedule/render.ts
pd schedule:show
Show a PagerDuty Schedule
USAGE
$ pd schedule:show
OPTIONS
-b, --useauth=useauth Use the saved REST API token with this alias
-h, --help Show CLI help.
-i, --id=id Show the schedule with this ID.
-n, --name=name Show the schedule with this name.
--debug Print REST API call debug logs
--since=since The start of the date range over which you want to search.
--token=token Ignore the saved configuration and use this token
--until=until The end of the date range over which you want to search.
See code: src/commands/schedule/show.ts
pd service:create
Create a PagerDuty Service
USAGE
$ pd service:create
OPTIONS
-E, --escalation_policy_name=escalation_policy_name The name of the service's escalation policy.
-F, --from=from Login email of a PD user account for the "From:" header. Use
only with legacy API tokens.
-b, --useauth=useauth Use the saved REST API token with this alias
-d, --description=description The service's description
-e, --escalation_policy_id=escalation_policy_id The ID of the service's escalation policy.
-h, --help Show CLI help.
-n, --name=name (required) The service's name
-o, --open Open the new service in the browser
-p, --pipe Print the service ID only to stdout, for use with pipes.
-r, --auto_resolve_timeout=auto_resolve_timeout Automatically resolve incidents after this number of minutes
-t, --ack_timeout=ack_timeout Automatically re-trigger incidents after this number of
minutes
-u, --urgency=high|low|use_support_hours|severity_based The urgency of incidents in the service
--Gc=any|all Do content-based alert grouping. Specify the fields to look
at with --Gf and choose 'any' or 'all' fields.
--Gd=Gd Do time based alert grouping for this number of minutes.
--Gf=Gf The fields to look at for content based alert grouping.
Specify multiple times for multiple fields.
--Gi Do intelligent alert grouping
--Sd=Sd A day when support hours are active. Specify multiple times
for multiple days.
--Se=Se The time of day when support hours end
--Ss=Ss The time of day when support hours start
--Uc Change unacknowledged incidents to high urgency when entering
high-urgency support hours
--Ud=high|low|severity_based Incident urgency during support hours.
--Uo=high|low|severity_based Incident urgency outside of support hours.
--create_alerts Turn on alert support in the service (default: true)
--debug Print REST API call debug logs
--token=token Ignore the saved configuration and use this token
See code: src/commands/service/create.ts
pd service:disable
Disable PagerDuty Services
USAGE
$ pd service:disable
OPTIONS
-b, --useauth=useauth Use the saved REST API token with this alias
-h, --help Show CLI help.
-i, --ids=ids Select services with the given ID. Specify multiple times for multiple services.
-n, --name=name Select services whose names contain the given text
-p, --pipe Read service ID's from stdin.
--debug Print REST API call debug logs
--token=token Ignore the saved configuration and use this token
See code: src/commands/service/disable.ts
pd service:enable
Enable PagerDuty Services
USAGE
$ pd service:enable
OPTIONS
-b, --useauth=useauth Use the saved REST API token with this alias
-h, --help Show CLI help.
-i, --ids=ids Select services with the given ID. Specify multiple times for multiple services.
-n, --name=name Select services whose names contain the given text
-p, --pipe Read service ID's from stdin.
--debug Print REST API call debug logs
--token=token Ignore the saved configuration and use this token
See code: src/commands/service/enable.ts
pd service:list
List PagerDuty Services
USAGE
$ pd service:list
OPTIONS
-b, --useauth=useauth Use the saved REST API token with this alias
-d, --delimiter=delimiter [default:
] Delimiter for fields that have more than one value
-h, --help Show CLI help.
-j, --json output full details as JSON
-k, --keys=keys Additional fields to display. Specify multiple times for multiple fields.
-n, --name=name Retrieve only services whose names contain this text
-p, --pipe Print service ID's only to stdin, for use with pipes.
-t, --teams=teams Team names to include. Specify multiple times for multiple teams.
-x, --extended show extra columns
--columns=columns only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--debug Print REST API call debug logs
--filter=filter filter property by partial string matching, ex: name=foo
--limit=limit Return no more than this many entries. This option turns off table filtering options.
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=csv|json|yaml output in a more machine friendly format
--sort=sort property to sort by (prepend '-' for descending)
--token=token Ignore the saved configuration and use this token
See code: src/commands/service/list.ts
pd service:open
Open PagerDuty Services in the browser
USAGE
$ pd service:open
OPTIONS
-b, --useauth=useauth Use the saved REST API token with this alias
-h, --help Show CLI help.
-i, --ids=ids The IDs of services to open.
-n, --name=name Open services matching this string.
-p, --pipe Read service ID's from stdin.
--debug Print REST API call debug logs
--token=token Ignore the saved configuration and use this token
See code: src/commands/service/open.ts
pd service:set
Set PagerDuty Service attributes
USAGE
$ pd service:set
OPTIONS
-b, --useauth=useauth Use the saved REST API token with this alias
-h, --help Show CLI help.
-i, --ids=ids Select services with the given ID. Specify multiple times for multiple services.
-k, --key=key (required) Attribute key to set
-n, --name=name Select services whose names contain the given text
-p, --pipe Read service ID's from stdin.
-v, --value=value (required) Attribute value to set
--debug Print REST API call debug logs
--token=token Ignore the saved configuration and use this token
See code: src/commands/service/set.ts
pd tag:assign
Assign/Remove Tags to/from PagerDuty objects
USAGE
$ pd tag:assign
OPTIONS
-A, --add_names=add_names [default: ] The name of a Tag to add. If no tag with this name exists, a new tag will
be created. Specify multiple times for multiple tags
-R, --remove_names=remove_names [default: ] The name of a Tag to remove. Specify multiple times for multiple tags
-U, --user_emails=user_emails [default: ] The email of a User to assign this tag to. Specify multiple times for
multiple users
-a, --add_ids=add_ids [default: ] The ID of a Tag to add. Specify multiple times for multiple tags
-b, --useauth=useauth Use the saved REST API token with this alias
-e, --ep_ids=ep_ids [default: ] The ID of an Escalation Policy to assign this tag to. Specify multiple
times for multiple users
-h, --help Show CLI help.
-r, --remove_ids=remove_ids [default: ] The ID of a Tag to remove. Specify multiple times for multiple tags
-t, --team_ids=team_ids [default: ] The ID of a Team to assign this tag to. Specify multiple times for
multiple teams
-u, --user_ids=user_ids [default: ] The ID of a User to assign this tag to. Specify multiple times for
multiple users
--debug Print REST API call debug logs
--token=token Ignore the saved configuration and use this token
See code: src/commands/tag/assign.ts
pd tag:list
List PagerDuty Tags
USAGE
$ pd tag:list
OPTIONS
-b, --useauth=useauth Use the saved REST API token with this alias
-d, --delimiter=delimiter [default:
] Delimiter for fields that have more than one value
-h, --help Show CLI help.
-j, --json output full details as JSON
-k, --keys=keys Additional fields to display. Specify multiple times for multiple fields.
-p, --pipe Print tag ID's only to stdout, for use with pipes.
-x, --extended show extra columns
--columns=columns only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--debug Print REST API call debug logs
--filter=filter filter property by partial string matching, ex: name=foo
--limit=limit Return no more than this many entries. This option turns off table filtering options.
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=csv|json|yaml output in a more machine friendly format
--sort=sort property to sort by (prepend '-' for descending)
--token=token Ignore the saved configuration and use this token
See code: src/commands/tag/list.ts
pd tag:listobjects
List Tagged PagerDuty Objects (Connected Entities)
USAGE
$ pd tag:listobjects
OPTIONS
-b, --useauth=useauth Use the saved REST API token with this alias
-h, --help Show CLI help.
-i, --ids=ids [default: ] The ID of a Tag to show. Specify multiple times for multiple
tags
-j, --json output full details as JSON
-n, --names=names [default: ] The name of a Tag to show. Specify multiple times for
multiple tags
-p, --pipe Print object ID's only to stdout, for use with pipes.
-t, --types=users|teams|escalation_policies [default: users,teams,escalation_policies] The types of objects to show.
Specify multiple times for multiple types
-x, --extended show extra columns
--columns=columns only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--debug Print REST API call debug logs
--filter=filter filter property by partial string matching, ex: name=foo
--limit=limit Return no more than this many entries. This option turns off table
filtering options.
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=csv|json|yaml output in a more machine friendly format
--sort=sort property to sort by (prepend '-' for descending)
--token=token Ignore the saved configuration and use this token
See code: src/commands/tag/listobjects.ts
pd team:create
Create an empty PagerDuty Team. You can add escalation policies and users later with team:ep and team:user
USAGE
$ pd team:create
OPTIONS
-A, --parent_name=parent_name The name of the new team's parent team
-a, --parent_id=parent_id The ID of the new team's parent team
-b, --useauth=useauth Use the saved REST API token with this alias
-h, --help Show CLI help.
-n, --name=name (required) The name of the team to add.
-o, --open Open the new team in the browser
-p, --pipe Print the team ID only to stdout, for use with pipes.
--debug Print REST API call debug logs
--description=description The description of the team
--token=token Ignore the saved configuration and use this token
See code: src/commands/team/create.ts
pd team:ep:add
Add PagerDuty escalation policies to Teams.
USAGE
$ pd team:ep:add
OPTIONS
-E, --ep_names=ep_names Add an escalation policy with this name. Specify multiple times for multiple escalation
policies.
-b, --useauth=useauth Use the saved REST API token with this alias
-e, --ep_ids=ep_ids Add an escalation policy with this ID. Specify multiple times for multiple escalation
policies.
-h, --help Show CLI help.
-i, --ids=ids The IDs of teams to add escalation policies to.
-n, --name=name Select teams whose names contain the given text
--debug Print REST API call debug logs
--token=token Ignore the saved configuration and use this token
See code: src/commands/team/ep/add.ts
pd team:ep:list
List PagerDuty Team Members
USAGE
$ pd team:ep:list
OPTIONS
-b, --useauth=useauth Use the saved REST API token with this alias
-d, --delimiter=delimiter [default:
] Delimiter for fields that have more than one value
-h, --help Show CLI help.
-i, --ids=ids The IDs of teams to list escalation policies for.
-j, --json output full details as JSON
-k, --keys=keys Additional fields to display. Specify multiple times for multiple fields.
-n, --name=name Select teams whose names contain the given text
-p, --pipe Print escalation policy ID's only to stdout, for use with pipes.
-x, --extended show extra columns
--columns=columns only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--debug Print REST API call debug logs
--filter=filter filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=csv|json|yaml output in a more machine friendly format
--sort=sort property to sort by (prepend '-' for descending)
--token=token Ignore the saved configuration and use this token
See code: src/commands/team/ep/list.ts
pd team:ep:remove
Remove PagerDuty escalation policies from Teams.
USAGE
$ pd team:ep:remove
OPTIONS
-E, --ep_names=ep_names Remove an escalation policy with this name. Specify multiple times for multiple escalation
policies.
-b, --useauth=useauth Use the saved REST API token with this alias
-e, --ep_ids=ep_ids Remove an escalation policy with this ID. Specify multiple times for multiple escalation
policies.
-h, --help Show CLI help.
-i, --ids=ids The IDs of teams to remove escalation policies from.
-n, --name=name Select teams whose names contain the given text
--debug Print REST API call debug logs
--token=token Ignore the saved configuration and use this token
See code: src/commands/team/ep/remove.ts
pd team:list
List PagerDuty Teams
USAGE
$ pd team:list
OPTIONS
-b, --useauth=useauth Use the saved REST API token with this alias
-d, --delimiter=delimiter [default:
] Delimiter for fields that have more than one value
-h, --help Show CLI help.
-j, --json output full details as JSON
-k, --keys=keys Additional fields to display. Specify multiple times for multiple fields.
-n, --name=name Select teams whose names contain the given text
-p, --pipe Print user ID's only to stdout, for use with pipes.
-x, --extended show extra columns
--columns=columns only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--debug Print REST API call debug logs
--filter=filter filter property by partial string matching, ex: name=foo
--limit=limit Return no more than this many entries. This option turns off table filtering options.
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=csv|json|yaml output in a more machine friendly format
--sort=sort property to sort by (prepend '-' for descending)
--token=token Ignore the saved configuration and use this token
See code: src/commands/team/list.ts
pd team:open
Open PagerDuty Teams in the browser
USAGE
$ pd team:open
OPTIONS
-b, --useauth=useauth Use the saved REST API token with this alias
-h, --help Show CLI help.
-i, --ids=ids The IDs of teams to open.
-n, --name=name Open teams matching this string.
-p, --pipe Read team ID's from stdin.
--debug Print REST API call debug logs
--token=token Ignore the saved configuration and use this token
See code: src/commands/team/open.ts
pd team:user:add
Add PagerDuty users to Teams. If a given user is already a member, this command will set their role on the team.
USAGE
$ pd team:user:add
OPTIONS
-U, --user_emails=user_emails Add a user with this email. Specify multiple times for multiple users.
-b, --useauth=useauth Use the saved REST API token with this alias
-h, --help Show CLI help.
-i, --ids=ids The IDs of teams to add members to.
-n, --name=name Select teams whose names contain the given text
-r, --role=manager|responder|observer [default: manager] The role of the user(s) on the team(s)
-u, --user_ids=user_ids Add a user with this ID. Specify multiple times for multiple users.
--debug Print REST API call debug logs
--token=token Ignore the saved configuration and use this token
See code: src/commands/team/user/add.ts
pd team:user:list
List PagerDuty Team Members
USAGE
$ pd team:user:list
OPTIONS
-b, --useauth=useauth Use the saved REST API token with this alias
-d, --delimiter=delimiter [default:
] Delimiter for fields that have more than one value
-h, --help Show CLI help.
-i, --ids=ids The IDs of teams to list members for.
-j, --json output full details as JSON
-k, --keys=keys Additional fields to display. Specify multiple times for multiple fields.
-n, --name=name Select teams whose names contain the given text
-p, --pipe Print user ID's only to stdout, for use with pipes.
-x, --extended show extra columns
--columns=columns only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--debug Print REST API call debug logs
--filter=filter filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=csv|json|yaml output in a more machine friendly format
--sort=sort property to sort by (prepend '-' for descending)
--token=token Ignore the saved configuration and use this token
See code: src/commands/team/user/list.ts
pd team:user:remove
Remove PagerDuty users from Teams
USAGE
$ pd team:user:remove
OPTIONS
-U, --user_emails=user_emails Remove a user with this email. Specify multiple times for multiple users.
-b, --useauth=useauth Use the saved REST API token with this alias
-h, --help Show CLI help.
-i, --ids=ids The IDs of teams to remove members from.
-n, --name=name Select teams whose names contain the given text
-u, --user_ids=user_ids Remove a user with this ID. Specify multiple times for multiple users.
--debug Print REST API call debug logs
--token=token Ignore the saved configuration and use this token
See code: src/commands/team/user/remove.ts
pd update [CHANNEL]
update the pd CLI
USAGE
$ pd update [CHANNEL]
OPTIONS
-a, --available Install a specific version.
-i, --interactive Interactively select version to install. This is ignored if a channel is provided.
-v, --version=version Install a specific version.
--force Force a re-download of the requested version.
EXAMPLES
[object Object]
[object Object]
[object Object]
[object Object]
See code: @oclif/plugin-update
pd user:contact:add
Add a contact method to a PagerDuty user
USAGE
$ pd user:contact:add
OPTIONS
-T, --type=email|phone|sms (required) The contact method type.
-a, --address=address (required) The contact method address or phone number.
-b, --useauth=useauth Use the saved REST API token with this alias
-e, --email=email Add contact to the user with this login email.
-h, --help Show CLI help.
-i, --id=id Add contact to the user with this ID.
-l, --label=label (required) The contact method label.
--debug Print REST API call debug logs
--token=token Ignore the saved configuration and use this token
See code: src/commands/user/contact/add.ts
pd user:contact:list
List a PagerDuty User's contact methods.
USAGE
$ pd user:contact:list
OPTIONS
-b, --useauth=useauth Use the saved REST API token with this alias
-d, --delimiter=delimiter [default:
] Delimiter for fields that have more than one value
-e, --email=email Show contacts for the user with this login email.
-h, --help Show CLI help.
-i, --id=id Show contacts for the user with this ID.
-j, --json output full details as JSON
-k, --keys=keys Additional fields to display. Specify multiple times for multiple fields.
-p, --pipe Print contact ID's only to stdout, for use with pipes.
-x, --extended show extra columns
--columns=columns only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--debug Print REST API call debug logs
--filter=filter filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=csv|json|yaml output in a more machine friendly format
--sort=sort property to sort by (prepend '-' for descending)
--token=token Ignore the saved configuration and use this token
See code: src/commands/user/contact/list.ts
pd user:contact:set
Update a contact method for a PagerDuty user
USAGE
$ pd user:contact:set
OPTIONS
-a, --address=address The contact method address or phone number to set.
-b, --useauth=useauth Use the saved REST API token with this alias
-c, --contact_id=contact_id (required) Update the contact with this ID.
-e, --email=email Update a contact for the user with this login email.
-h, --help Show CLI help.
-i, --id=id Update a contact for the user with this ID.
-l, --label=label The contact method label to set.
--debug Print REST API call debug logs
--token=token Ignore the saved configuration and use this token
See code: src/commands/user/contact/set.ts
pd user:create
Create a PagerDuty User
USAGE
$ pd user:create
OPTIONS
-F, --from=from
Login email of a PD user account for the "From:" header. Use only with legacy API tokens.
-b, --useauth=useauth
Use the saved REST API token with this alias
-c, --color=color
The user's schedule color
-d, --description=description
The user's job description
-e, --email=email
(required) The user's login email
-h, --help
Show CLI help.
-n, --name=name
(required) The user's name
-o, --open
Open the new user in the browser
-p, --pipe
Print the user ID only to stdout, for use with pipes.
-r, --role=admin|read_only_user|read_only_limited_user|user|limited_user|observer|restricted_access
[default: user] The user's role
-t, --title=title
The user's job title
-w, --password=password
The user's password - if not specified, a random password will be generated
-z, --timezone=timezone
[default: UTC] The user's time zone
--debug
Print REST API call debug logs
--show_password
Show the user's password when creating
--token=token
Ignore the saved configuration and use this token
See code: src/commands/user/create.ts
pd user:delete
Dangerous - Delete PagerDuty Users
USAGE
$ pd user:delete
OPTIONS
-E, --exact_emails=exact_emails Select a user whose login email is this exact text. Specify multiple times for
multiple emails.
-b, --useauth=useauth Use the saved REST API token with this alias
-e, --emails=emails Select users whose emails contain the given text. Specify multiple times for multiple
emails.
-h, --help Show CLI help.
-i, --ids=ids Select users with the given ID. Specify multiple times for multiple users.
-p, --pipe Read user ID's from stdin.
--debug Print REST API call debug logs
--force Extreme danger mode: do not prompt before deleting
--token=token Ignore the saved configuration and use this token
See code: src/commands/user/delete.ts
pd user:list
List PagerDuty Users
USAGE
$ pd user:list
OPTIONS
-E, --exact_email=exact_email Select the user whose login email is this exact text
-b, --useauth=useauth Use the saved REST API token with this alias
-d, --delimiter=delimiter [default:
] Delimiter for fields that have more than one value
-e, --email=email Select users whose login email addresses contain the given text
-h, --help Show CLI help.
-j, --json output full details as JSON
-k, --keys=keys Additional fields to display. Specify multiple times for multiple fields.
-p, --pipe Print user ID's only to stdout, for use with pipes.
-x, --extended show extra columns
--columns=columns only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--debug Print REST API call debug logs
--filter=filter filter property by partial string matching, ex: name=foo
--limit=limit Return no more than this many entries. This option turns off table filtering options.
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=csv|json|yaml output in a more machine friendly format
--sort=sort property to sort by (prepend '-' for descending)
--token=token Ignore the saved configuration and use this token
See code: src/commands/user/list.ts
pd user:log
Show PagerDuty User Log Entries
USAGE
$ pd user:log
OPTIONS
-E, --exact_email=exact_email Select the user whose login email is this exact text
-O, --overview Get only `overview` log entries
-b, --useauth=useauth Use the saved REST API token with this alias
-d, --delimiter=delimiter [default:
] Delimiter for fields that have more than one value
-e, --email=email Select users whose login email addresses contain the given text
-h, --help Show CLI help.
-i, --ids=ids Select users with the given ID. Specify multiple times for multiple users.
-j, --json output full details as JSON
-k, --keys=keys Additional fields to display. Specify multiple times for multiple fields.
-p, --pipe Read user IDs from stdin, for use with pipes.
-x, --extended show extra columns
--columns=columns only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--debug Print REST API call debug logs
--filter=filter filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=csv|json|yaml output in a more machine friendly format
--since=since [default: 30 days ago] The start of the date range over which you want to search.
--sort=sort property to sort by (prepend '-' for descending)
--token=token Ignore the saved configuration and use this token
--until=until The end of the date range over which you want to search.
See code: src/commands/user/log.ts
pd user:oncall
List a PagerDuty User's on call shifts.
USAGE
$ pd user:oncall
OPTIONS
-a, --always Include 'Always on call.'
-b, --useauth=useauth Use the saved REST API token with this alias
-e, --email=email Show oncalls for the user with this login email.
-h, --help Show CLI help.
-i, --id=id Show oncalls for the user with this ID.
-j, --json output full details as JSON
-k, --keys=keys Additional fields to display. Specify multiple times for multiple fields.
-m, --me Show my oncalls.
-x, --extended show extra columns
--columns=columns only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--debug Print REST API call debug logs
--filter=filter filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=csv|json|yaml output in a more machine friendly format
--since=since The start of the date range over which you want to search.
--sort=sort property to sort by (prepend '-' for descending)
--token=token Ignore the saved configuration and use this token
--until=until The end of the date range over which you want to search.
See code: src/commands/user/oncall.ts
pd user:replace
Replace PagerDuty Users in all Schedules and Escalation Policies
USAGE
$ pd user:replace
OPTIONS
-U, --user_email=user_email The email of the replacement user.
-b, --useauth=useauth Use the saved REST API token with this alias
-d, --deleted Replace all deleted users
-h, --help Show CLI help.
-i, --ids=ids Replace users with the given IDs. Specify multiple times for multiple users.
-p, --pipe Read user ID's from stdin.
-u, --user_id=user_id The ID of the replacement user.
--debug Print REST API call debug logs
--force Extreme danger mode: do not prompt before updating
--token=token Ignore the saved configuration and use this token
See code: src/commands/user/replace.ts
pd user:session:list
List a PagerDuty User's sessions.
USAGE
$ pd user:session:list
OPTIONS
-b, --useauth=useauth Use the saved REST API token with this alias
-e, --email=email Show sessions for the user with this login email.
-h, --help Show CLI help.
-i, --id=id Show sessions for the user with this ID.
-j, --json output full details as JSON
-k, --keys=keys Additional fields to display. Specify multiple times for multiple fields.
-p, --pipe Print session ID's only to stdout, for use with pipes.
-q, --query=query Query the API output
-x, --extended show extra columns
--columns=columns only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--debug Print REST API call debug logs
--filter=filter filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=csv|json|yaml output in a more machine friendly format
--since=since The start of the date range over which you want to search.
--sort=sort property to sort by (prepend '-' for descending)
--token=token Ignore the saved configuration and use this token
--until=until The end of the date range over which you want to search.
See code: src/commands/user/session/list.ts
pd user:set
Set PagerDuty User attributes
USAGE
$ pd user:set
OPTIONS
-E, --exact_emails=exact_emails Select a user whose login email is this exact text. Specify multiple times for
multiple emails.
-b, --useauth=useauth Use the saved REST API token with this alias
-e, --emails=emails Select users whose emails contain the given text. Specify multiple times for multiple
emails.
-h, --help Show CLI help.
-i, --ids=ids Select users with the given ID. Specify multiple times for multiple users.
-k, --key=key (required) Attribute key to set
-p, --pipe Read user ID's from stdin.
-v, --value=value (required) Attribute value to set
--debug Print REST API call debug logs
--token=token Ignore the saved configuration and use this token
See code: src/commands/user/set.ts
pd util:deleteresource
Dangerous - Delete PagerDuty Resources
USAGE
$ pd util:deleteresource
OPTIONS
-b, --useauth=useauth
Use the saved REST API token with this alias
-h, --help
Show CLI help.
-i, --ids=ids
Select resources with the given ID. Specify multiple times for multiple resources.
-p, --pipe
Read resource ID's from stdin.
-t, --resource-type=business_service|escalation_policy|extension|response_play|ruleset|schedule|service|tag|team|user|
webhook_subscription
(required) The type of PagerDuty resource to delete. You have to provide either -i or -p to specify IDs of objects
to delete.
--debug
Print REST API call debug logs
--force
Extreme danger mode: do not prompt before deleting
--token=token
Ignore the saved configuration and use this token
See code: src/commands/util/deleteresource.ts
pd util:timestamp [DATE]
Make ISO8601 timestamps
USAGE
$ pd util:timestamp [DATE]
ARGUMENTS
DATE A human-style date/time, like "4pm 1/1/2021" or "Dec 2 1pm", etc. Default: now
OPTIONS
-b, --useauth=useauth Use the saved REST API token with this alias
-h, --help Show CLI help.
--debug Print REST API call debug logs
--token=token Ignore the saved configuration and use this token
See code: src/commands/util/timestamp.ts
pd version
USAGE
$ pd version
See code: @oclif/plugin-version