Skip to main content

runners

Overview

Namerunners
TypeResource
Idpagerduty.automation_actions.runners

Fields

NameDatatypeDescription
idstring
namestring
descriptionstring
associated_actionsobjectReferences to at most 3 actions associated with the Runner. Use appropriate endpoints to retrieve the full list of associated actions.
creation_timestring
html_urlstringa URL at which the entity is uniquely displayed in the Web app
last_seenstring
metadataobjectAdditional metadata
privilegesobject
runbook_base_uristringThe base URI of the Runbook server to connect to. May only contain alphanumeric characters, periods, underscores and dashes.
runner_typestringsidecar -- The runner is backed by an external sidecar that polls for invocations.
runbook -- The runner communicates directly with a runbook instance.
selfstringthe API show URL at which the object is accessible
statusstringConfigured -- Runner has connected to the backend at least once
NotConfigured -- Runner has never connected to backend
summarystringA short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to name, though it is not intended to be an identifier.
teamsarrayThe list of teams associated with the Runner
typestringA string that determines the schema of the object. This must be the standard name for the entity, suffixed by _reference if the object is a reference.

Methods

NameAccessible byRequired ParamsDescription
get_automation_actions_runnerSELECTidGet an Automation Action runner
get_automation_actions_runnersSELECTLists Automation Action runners matching provided query params.
The returned records are sorted by runner name in alphabetical order.

See Cursor-based pagination for instructions on how to paginate through the result set.
create_automation_actions_runnerINSERTdata__runnerCreate a Process Automation or a Runbook Automation runner.
delete_automation_actions_runnerDELETEidDelete an Automation Action runner
_get_automation_actions_runnerEXECidGet an Automation Action runner
_get_automation_actions_runnersEXECLists Automation Action runners matching provided query params.
The returned records are sorted by runner name in alphabetical order.

See Cursor-based pagination for instructions on how to paginate through the result set.
update_automation_actions_runnerEXECid, data__runnerUpdate an Automation Action runner