extensions

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

Overview

Name	extensions
Type	Resource
Id	pagerduty.extensions.extensions

Fields

The following fields are returned by SELECT queries:

get_extension

The extension that was requested.

Name	Datatype	Description
id	string
name	string	The name of the extension.
config	object	The object that contains extension configuration values depending on the extension schema specification.
endpoint_url	string (url)	The url of the extension.
extension_objects	array	The objects for which the extension applies
extension_schema	object
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
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.
temporarily_disabled	boolean	Whether or not this extension is temporarily disabled; for example, a webhook extension that is repeatedly rejected by the server.
type	string	The type of object being created. (default: extension)

list_extensions

A paginated array of extensions.

Name	Datatype	Description
id	string
name	string	The name of the extension.
config	object	The object that contains extension configuration values depending on the extension schema specification.
endpoint_url	string (url)	The url of the extension.
extension_objects	array	The objects for which the extension applies
extension_schema	object
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
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.
temporarily_disabled	boolean	Whether or not this extension is temporarily disabled; for example, a webhook extension that is repeatedly rejected by the server.
type	string	The type of object being created. (default: extension)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_extension	select	id	Accept, Content-Type, include[]	Get details about an existing extension. Extensions are representations of Extension Schema objects that are attached to Services. For more information see the API Concepts Document Scoped OAuth requires: extensions.read
list_extensions	select		limit, offset, total, Accept, Content-Type, query, extension_object_id, extension_schema_id, include[]	List existing extensions. Extensions are representations of Extension Schema objects that are attached to Services. For more information see the API Concepts Document Scoped OAuth requires: extensions.read
create_extension	insert	data__extension	Accept, Content-Type	Create a new Extension. Extensions are representations of Extension Schema objects that are attached to Services. For more information see the API Concepts Document Scoped OAuth requires: extensions.write
delete_extension	delete	id	Accept, Content-Type	Delete an existing extension. Once the extension is deleted, it will not be accessible from the web UI and new incidents won't be able to be created for this extension. Extensions are representations of Extension Schema objects that are attached to Services. For more information see the API Concepts Document Scoped OAuth requires: extensions.write
_list_extensions	exec		limit, offset, total, Accept, Content-Type, query, extension_object_id, extension_schema_id, include[]	List existing extensions. Extensions are representations of Extension Schema objects that are attached to Services. For more information see the API Concepts Document Scoped OAuth requires: extensions.read
_get_extension	exec	id	Accept, Content-Type, include[]	Get details about an existing extension. Extensions are representations of Extension Schema objects that are attached to Services. For more information see the API Concepts Document Scoped OAuth requires: extensions.read
update_extension	exec	id, extension	Accept, Content-Type	Update an existing extension. Extensions are representations of Extension Schema objects that are attached to Services. For more information see the API Concepts Document Scoped OAuth requires: extensions.write
enable_extension	exec	id	Accept, Content-Type	Enable an extension that is temporarily disabled. (This API does not require a request body.) Extensions are representations of Extension Schema objects that are attached to Services. For more information see the API Concepts Document Scoped OAuth requires: extensions.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
extension_object_id	string	The id of the extension object you want to filter by.
extension_schema_id	string	Filter the extensions by extension vendor id.
include[]	string	Array of additional details to include.
limit	integer	The number of results per page.
offset	integer	Offset to start pagination search results.
query	string	Filters the result, showing only the records whose name matches the query.
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_extension

Get details about an existing extension.

Extensions are representations of Extension Schema objects that are attached to Services.

For more information see the API Concepts Document

Scoped OAuth requires: extensions.read

SELECT
id,
name,
config,
endpoint_url,
extension_objects,
extension_schema,
html_url,
self,
summary,
temporarily_disabled,
type
FROM pagerduty.extensions.extensions
WHERE id = '{{ id }}' -- required
AND Accept = '{{ Accept }}'
AND Content-Type = '{{ Content-Type }}'
AND include[] = '{{ include[] }}'
;

list_extensions

List existing extensions.

Extensions are representations of Extension Schema objects that are attached to Services.

For more information see the API Concepts Document

Scoped OAuth requires: extensions.read

SELECT
id,
name,
config,
endpoint_url,
extension_objects,
extension_schema,
html_url,
self,
summary,
temporarily_disabled,
type
FROM pagerduty.extensions.extensions
WHERE limit = '{{ limit }}'
AND offset = '{{ offset }}'
AND total = '{{ total }}'
AND Accept = '{{ Accept }}'
AND Content-Type = '{{ Content-Type }}'
AND query = '{{ query }}'
AND extension_object_id = '{{ extension_object_id }}'
AND extension_schema_id = '{{ extension_schema_id }}'
AND include[] = '{{ include[] }}'
;

INSERT examples

create_extension

Create a new Extension.

Extensions are representations of Extension Schema objects that are attached to Services.

For more information see the API Concepts Document

Scoped OAuth requires: extensions.write

INSERT INTO pagerduty.extensions.extensions (
data__extension,
Accept,
Content-Type
)
SELECT 
'{{ extension }}' /* required */,
'{{ Accept }}',
'{{ Content-Type }}'
RETURNING
extension
;

Manifest

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

DELETE examples

delete_extension

Delete an existing extension.

Once the extension is deleted, it will not be accessible from the web UI and new incidents won't be able to be created for this extension.

Extensions are representations of Extension Schema objects that are attached to Services.

For more information see the API Concepts Document

Scoped OAuth requires: extensions.write

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

Lifecycle Methods

_list_extensions

List existing extensions.

Extensions are representations of Extension Schema objects that are attached to Services.

For more information see the API Concepts Document

Scoped OAuth requires: extensions.read

EXEC pagerduty.extensions.extensions._list_extensions 
@limit='{{ limit }}', 
@offset='{{ offset }}', 
@total={{ total }}, 
@Accept='{{ Accept }}', 
@Content-Type='{{ Content-Type }}', 
@query='{{ query }}', 
@extension_object_id='{{ extension_object_id }}', 
@extension_schema_id='{{ extension_schema_id }}', 
@include[]='{{ include[] }}'
;

_get_extension

Get details about an existing extension.

Extensions are representations of Extension Schema objects that are attached to Services.

For more information see the API Concepts Document

Scoped OAuth requires: extensions.read

EXEC pagerduty.extensions.extensions._get_extension 
@id='{{ id }}' --required, 
@Accept='{{ Accept }}', 
@Content-Type='{{ Content-Type }}', 
@include[]='{{ include[] }}'
;

update_extension

Update an existing extension.

Extensions are representations of Extension Schema objects that are attached to Services.

For more information see the API Concepts Document

Scoped OAuth requires: extensions.write

EXEC pagerduty.extensions.extensions.update_extension 
@id='{{ id }}' --required, 
@Accept='{{ Accept }}', 
@Content-Type='{{ Content-Type }}' 
@@json=
'{
"extension": "{{ extension }}"
}'
;

enable_extension

Enable an extension that is temporarily disabled. (This API does not require a request body.)

Extensions are representations of Extension Schema objects that are attached to Services.

For more information see the API Concepts Document

Scoped OAuth requires: extensions.write

EXEC pagerduty.extensions.extensions.enable_extension 
@id='{{ id }}' --required, 
@Accept='{{ Accept }}', 
@Content-Type='{{ Content-Type }}'
;