runners

Creates, updates, deletes, gets or lists a runners resource.

Overview

Name	runners
Type	Resource
Id	pagerduty.automation_actions.runners

Fields

The following fields are returned by SELECT queries:

get

Runner information

Name	Datatype	Description
id	string
name	string	(example: us-west-2 prod runner)
associated_actions	object	References to at most 3 actions associated with the Runner. Use appropriate endpoints to retrieve the full list of associated actions.
creation_time	string (date-time)
description	string	(example: us-west-2 runner provisioned in the production environment by the SRE team)
html_url	string (url)	a URL at which the entity is uniquely displayed in the Web app
last_seen	string (date-time)
metadata	string	Additional metadata (opaque JSON object)
privileges	object
runbook_base_uri	string	The base URI of the Runbook server to connect to. May only contain alphanumeric characters, periods, underscores and dashes. Specified as the subdomain portion of an RBA host, as in <runbook_base_uri>.runbook.pagerduty.cloud (example: subdomain)
runner_type	string	sidecar -- The runner is backed by an external sidecar that polls for invocations. runbook -- The runner communicates directly with a runbook instance. (sidecar, runbook) (example: runbook)
self	string (url)	the API show URL at which the object is accessible
status	string	Configured -- Runner has connected to the backend at least once NotConfigured -- Runner has never connected to backend (Configured, NotConfigured) (example: Configured)
summary	string	A 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.
teams	array	The list of teams associated with the Runner
type	string	A 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.

list

Runners matching the criteria.

Name	Datatype	Description
id	string
name	string	(example: us-west-2 prod runner)
associated_actions	object	References to at most 3 actions associated with the Runner. Use appropriate endpoints to retrieve the full list of associated actions.
creation_time	string (date-time)
description	string	(example: us-west-2 runner provisioned in the production environment by the SRE team)
html_url	string (url)	a URL at which the entity is uniquely displayed in the Web app
last_seen	string (date-time)
metadata	string	Additional metadata (opaque JSON object)
privileges	object
runbook_base_uri	string	The base URI of the Runbook server to connect to. May only contain alphanumeric characters, periods, underscores and dashes. Specified as the subdomain portion of an RBA host, as in <runbook_base_uri>.runbook.pagerduty.cloud (example: subdomain)
runner_type	string	sidecar -- The runner is backed by an external sidecar that polls for invocations. runbook -- The runner communicates directly with a runbook instance. (sidecar, runbook) (example: runbook)
self	string (url)	the API show URL at which the object is accessible
status	string	Configured -- Runner has connected to the backend at least once NotConfigured -- Runner has never connected to backend (Configured, NotConfigured) (example: Configured)
summary	string	A 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.
teams	array	The list of teams associated with the Runner
type	string	A 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

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	id		Get an Automation Action runner<br />
list	select		limit, cursor, name, include[]	Lists Automation Action runners matching provided query params.<br />The returned records are sorted by runner name in alphabetical order.<br /><br />See [Cursor-based pagination](https:​//developer.pagerduty.com/docs/rest-api-v2/pagination/) for instructions on how to paginate through the result set.<br />
create	insert	runner		Create a Process Automation or a Runbook Automation runner.<br />
update	update	id, runner		Update an Automation Action runner<br />
delete	delete	id		Delete an Automation Action runner<br />

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
id	string	The ID of the resource.
cursor	string	Optional parameter used to request the "next" set of results from an API. The value provided here is most commonly obtained from the next_cursor field of the previous request. When no value is provided, the request starts at the beginning of the result set.
include[]	array	Includes additional data elements into the response
limit	integer	The minimum of the limit parameter used in the request or the maximum request size of the API.
name	string	Filters results to include the ones matching the name (case insensitive substring matching)

SELECT examples

get

Get an Automation Action runner<br />

SELECT
id,
name,
associated_actions,
creation_time,
description,
html_url,
last_seen,
metadata,
privileges,
runbook_base_uri,
runner_type,
self,
status,
summary,
teams,
type
FROM pagerduty.automation_actions.runners
WHERE id = '{{ id }}' -- required
;

list

Lists Automation Action runners matching provided query params.<br />The returned records are sorted by runner name in alphabetical order.<br /><br />See [Cursor-based pagination](https:​//developer.pagerduty.com/docs/rest-api-v2/pagination/) for instructions on how to paginate through the result set.<br />

SELECT
id,
name,
associated_actions,
creation_time,
description,
html_url,
last_seen,
metadata,
privileges,
runbook_base_uri,
runner_type,
self,
status,
summary,
teams,
type
FROM pagerduty.automation_actions.runners
WHERE limit = '{{ limit }}'
AND cursor = '{{ cursor }}'
AND name = '{{ name }}'
AND include[] = '{{ include[] }}'
;

INSERT examples

create

Create a Process Automation or a Runbook Automation runner.<br />

INSERT INTO pagerduty.automation_actions.runners (
runner
)
SELECT 
'{{ runner }}' /* required */
RETURNING
runner
;

Manifest

# Description fields are for documentation purposes
- name: runners
props:
  - name: runner
    value:
      runner_type: "{{ runner_type }}"
      name: "{{ name }}"
      description: "{{ description }}"
      teams:
        - id: "{{ id }}"
          summary: "{{ summary }}"
          type: "{{ type }}"
          self: "{{ self }}"
          html_url: "{{ html_url }}"
      runbook_base_uri: "{{ runbook_base_uri }}"
      runbook_api_key: "{{ runbook_api_key }}"

UPDATE examples

update

Update an Automation Action runner<br />

UPDATE pagerduty.automation_actions.runners
SET 
runner = '{{ runner }}'
WHERE 
id = '{{ id }}' --required
AND runner = '{{ runner }}' --required
RETURNING
runner;

DELETE examples

delete

Delete an Automation Action runner<br />

DELETE FROM pagerduty.automation_actions.runners
WHERE id = '{{ id }}' --required
;