addons

Creates, updates, deletes, gets or lists an addons resource.

Overview

Name	addons
Type	Resource
Id	pagerduty.add_ons.addons

Fields

The following fields are returned by SELECT queries:

get_addon

The requested Add-on.

Name	Datatype	Description
id	string
name	string	The name of the Add-on.
html_url	string (url)	a URL at which the entity is uniquely displayed in the Web app
self	string (url)	the API show URL at which the object is accessible
src	string (url)	The source URL to display in a frame in the PagerDuty UI. HTTPS is required.
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.
type	string	The type of Add-on.

list_addon

A paginated array of installed Add-ons.

Name	Datatype	Description

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_addon	select	id	Accept, Content-Type	Get details about an existing Add-on. Addon's are pieces of functionality that developers can write to insert new functionality into PagerDuty's UI. For more information see the API Concepts Document Scoped OAuth requires: addons.read
list_addon	select		limit, offset, total, Accept, Content-Type, include[], service_ids[], filter	List all of the Add-ons installed on your account. Addon's are pieces of functionality that developers can write to insert new functionality into PagerDuty's UI. For more information see the API Concepts Document Scoped OAuth requires: addons.read
create_addon	insert	data__addon	Accept, Content-Type	Install an Add-on for your account. Addon's are pieces of functionality that developers can write to insert new functionality into PagerDuty's UI. Given a configuration containing a src parameter, that URL will be embedded in an iframe on a page that's available to users from a drop-down menu. For more information see the API Concepts Document Scoped OAuth requires: addons.write
delete_addon	delete	id	Accept, Content-Type	Remove an existing Add-on. Addon's are pieces of functionality that developers can write to insert new functionality into PagerDuty's UI. For more information see the API Concepts Document Scoped OAuth requires: addons.write
_list_addon	exec		limit, offset, total, Accept, Content-Type, include[], service_ids[], filter	List all of the Add-ons installed on your account. Addon's are pieces of functionality that developers can write to insert new functionality into PagerDuty's UI. For more information see the API Concepts Document Scoped OAuth requires: addons.read
_get_addon	exec	id	Accept, Content-Type	Get details about an existing Add-on. Addon's are pieces of functionality that developers can write to insert new functionality into PagerDuty's UI. For more information see the API Concepts Document Scoped OAuth requires: addons.read
update_addon	exec	id, addon	Accept, Content-Type	Update an existing Add-on. Addon's are pieces of functionality that developers can write to insert new functionality into PagerDuty's UI. Given a configuration containing a src parameter, that URL will be embedded in an iframe on a page that's available to users from a drop-down menu. For more information see the API Concepts Document Scoped OAuth requires: addons.write

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.
Accept	string	The Accept header is used as a versioning header.
Content-Type	string
filter	string	Filters the results, showing only Add-ons of the given type
include[]	string	Array of additional Models to include in response.
limit	integer	The number of results per page.
offset	integer	Offset to start pagination search results.
service_ids[]	array	Filters the results, showing only Add-ons for the given services
total	boolean	By default the total field in pagination responses is set to null to provide the fastest possible response times. Set total to true for this field to be populated. See our Pagination Docs for more information.

SELECT examples

get_addon

Get details about an existing Add-on.

Addon's are pieces of functionality that developers can write to insert new functionality into PagerDuty's UI.

For more information see the API Concepts Document

Scoped OAuth requires: addons.read

SELECT
id,
name,
html_url,
self,
src,
summary,
type
FROM pagerduty.add_ons.addons
WHERE id = '{{ id }}' -- required
AND Accept = '{{ Accept }}'
AND Content-Type = '{{ Content-Type }}'
;

list_addon

List all of the Add-ons installed on your account.

Addon's are pieces of functionality that developers can write to insert new functionality into PagerDuty's UI.

For more information see the API Concepts Document

Scoped OAuth requires: addons.read

SELECT
*
FROM pagerduty.add_ons.addons
WHERE limit = '{{ limit }}'
AND offset = '{{ offset }}'
AND total = '{{ total }}'
AND Accept = '{{ Accept }}'
AND Content-Type = '{{ Content-Type }}'
AND include[] = '{{ include[] }}'
AND service_ids[] = '{{ service_ids[] }}'
AND filter = '{{ filter }}'
;

INSERT examples

create_addon

Install an Add-on for your account.

Addon's are pieces of functionality that developers can write to insert new functionality into PagerDuty's UI.

Given a configuration containing a src parameter, that URL will be embedded in an iframe on a page that's available to users from a drop-down menu.

For more information see the API Concepts Document

Scoped OAuth requires: addons.write

INSERT INTO pagerduty.add_ons.addons (
data__addon,
Accept,
Content-Type
)
SELECT 
'{{ addon }}' /* required */,
'{{ Accept }}',
'{{ Content-Type }}'
RETURNING
addon
;

Manifest

# Description fields are for documentation purposes
- name: addons
  props:
    - name: addon
      value: object
    - name: Accept
      value: string
      description: The `Accept` header is used as a versioning header.
    - name: Content-Type
      value: string

DELETE examples

delete_addon

Remove an existing Add-on.

Addon's are pieces of functionality that developers can write to insert new functionality into PagerDuty's UI.

For more information see the API Concepts Document

Scoped OAuth requires: addons.write

DELETE FROM pagerduty.add_ons.addons
WHERE id = '{{ id }}' --required
AND Accept = '{{ Accept }}'
AND Content-Type = '{{ Content-Type }}'
;

Lifecycle Methods

_list_addon

List all of the Add-ons installed on your account.

Addon's are pieces of functionality that developers can write to insert new functionality into PagerDuty's UI.

For more information see the API Concepts Document

Scoped OAuth requires: addons.read

EXEC pagerduty.add_ons.addons._list_addon 
@limit='{{ limit }}', 
@offset='{{ offset }}', 
@total={{ total }}, 
@Accept='{{ Accept }}', 
@Content-Type='{{ Content-Type }}', 
@include[]='{{ include[] }}', 
@service_ids[]='{{ service_ids[] }}', 
@filter='{{ filter }}'
;

_get_addon

Get details about an existing Add-on.

Addon's are pieces of functionality that developers can write to insert new functionality into PagerDuty's UI.

For more information see the API Concepts Document

Scoped OAuth requires: addons.read

EXEC pagerduty.add_ons.addons._get_addon 
@id='{{ id }}' --required, 
@Accept='{{ Accept }}', 
@Content-Type='{{ Content-Type }}'
;

update_addon

Update an existing Add-on.

Addon's are pieces of functionality that developers can write to insert new functionality into PagerDuty's UI.

Given a configuration containing a src parameter, that URL will be embedded in an iframe on a page that's available to users from a drop-down menu.

For more information see the API Concepts Document

Scoped OAuth requires: addons.write

EXEC pagerduty.add_ons.addons.update_addon 
@id='{{ id }}' --required, 
@Accept='{{ Accept }}', 
@Content-Type='{{ Content-Type }}' 
@@json=
'{
"addon": "{{ addon }}"
}'
;