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
list

The extension that was requested.

Name	Datatype	Description
`id`	`string`
`name`	`string`	The name of the extension.
`config`	`string`	The object that contains extension configuration values depending on the extension schema specification. (opaque JSON object)
`endpoint_url`	`string (url)`	The url of the extension.
`extension_objects`	`array`	The objects for which the extension applies
`extension_schema`	`object`	(opaque JSON 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`	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.

A paginated array of extensions.

Name	Datatype	Description
`id`	`string`
`name`	`string`	The name of the extension.
`config`	`string`	The object that contains extension configuration values depending on the extension schema specification. (opaque JSON object)
`endpoint_url`	`string (url)`	The url of the extension.
`extension_objects`	`array`	The objects for which the extension applies
`extension_schema`	`object`	(opaque JSON 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`	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`	`include[]`	Get details about an existing extension.<br /><br />Extensions are representations of Extension Schema objects that are attached to Services.<br /><br />For more information see the [API Concepts Document](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#extensions)<br /><br />Scoped OAuth requires: `extensions.read`<br />
`list`	`select`		`limit`, `offset`, `total`, `query`, `extension_object_id`, `extension_schema_id`, `include[]`	List existing extensions.<br /><br />Extensions are representations of Extension Schema objects that are attached to Services.<br /><br />For more information see the [API Concepts Document](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#extensions)<br /><br />Scoped OAuth requires: `extensions.read`<br />
`create`	`insert`	`extension`		Create a new Extension.<br /><br />Extensions are representations of Extension Schema objects that are attached to Services.<br /><br />For more information see the [API Concepts Document](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#extensions)<br /><br />Scoped OAuth requires: `extensions.write`<br />
`update`	`update`	`id`, `extension`		Update an existing extension.<br /><br />Extensions are representations of Extension Schema objects that are attached to Services.<br /><br />For more information see the [API Concepts Document](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#extensions)<br /><br />Scoped OAuth requires: `extensions.write`<br />
`delete`	`delete`	`id`		Delete an existing extension.<br /><br />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.<br /><br />Extensions are representations of Extension Schema objects that are attached to Services.<br /><br />For more information see the [API Concepts Document](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#extensions)<br /><br />Scoped OAuth requires: `extensions.write`<br />
`enable`	`exec`	`id`		Enable an extension that is temporarily disabled. (This API does not require a request body.)<br /><br />Extensions are representations of Extension Schema objects that are attached to Services.<br /><br />For more information see the [API Concepts Document](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#extensions)<br /><br />Scoped OAuth requires: `extensions.write`<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.
`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](https://developer.pagerduty.com/docs/rest-api-v2/pagination/) for more information.

`SELECT` examples

get
list

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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#extensions) 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 include[] = '{{ include[] }}'
;

List existing extensions. Extensions are representations of Extension Schema objects that are attached to Services. For more information see the [API Concepts Document](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#extensions) 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 query = '{{ query }}'
AND extension_object_id = '{{ extension_object_id }}'
AND extension_schema_id = '{{ extension_schema_id }}'
AND include[] = '{{ include[] }}'
;

`INSERT` examples

create
Manifest

Create a new Extension. Extensions are representations of Extension Schema objects that are attached to Services. For more information see the [API Concepts Document](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#extensions) Scoped OAuth requires: extensions.write

INSERT INTO pagerduty.extensions.extensions (
extension
)
SELECT 
'{{ extension }}' /* required */
RETURNING
extension
;

# Description fields are for documentation purposes
- name: extensions
props:
  - name: extension
    value:
      id: "{{ id }}"
      summary: "{{ summary }}"
      type: "{{ type }}"
      self: "{{ self }}"
      html_url: "{{ html_url }}"
      name: "{{ name }}"
      endpoint_url: "{{ endpoint_url }}"
      extension_objects:
        - id: "{{ id }}"
          summary: "{{ summary }}"
          type: "{{ type }}"
          self: "{{ self }}"
          html_url: "{{ html_url }}"
      extension_schema:
        id: "{{ id }}"
        summary: "{{ summary }}"
        type: "{{ type }}"
        self: "{{ self }}"
        html_url: "{{ html_url }}"
      temporarily_disabled: {{ temporarily_disabled }}
      config: "{{ config }}"

`UPDATE` examples

update

Update an existing extension. Extensions are representations of Extension Schema objects that are attached to Services. For more information see the [API Concepts Document](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#extensions) Scoped OAuth requires: extensions.write

UPDATE pagerduty.extensions.extensions
SET 
extension = '{{ extension }}'
WHERE 
id = '{{ id }}' --required
AND extension = '{{ extension }}' --required
RETURNING
extension;

`DELETE` examples

delete

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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#extensions) Scoped OAuth requires: extensions.write

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

Lifecycle Methods

enable

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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#extensions) Scoped OAuth requires: extensions.write

EXEC pagerduty.extensions.extensions.enable 
@id='{{ id }}' --required
;

Overview​

Fields​

Methods​

Parameters​

SELECT examples​

INSERT examples​

UPDATE examples​

DELETE examples​

Lifecycle Methods​