Skip to main content

extensions

Overview

Nameextensions
TypeResource
Idpagerduty.extensions.extensions

Fields

NameDatatypeDescription
idstring
namestringThe name of the extension.
_typestringThe type of object being created.
configobjectThe object that contains extension configuration values depending on the extension schema specification.
endpoint_urlstringThe url of the extension.
extension_objectsarrayThe objects for which the extension applies
extension_schemaobject
html_urlstringa URL at which the entity is uniquely displayed in the Web app
selfstringthe API show URL at which the object is accessible
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.
temporarily_disabledbooleanWhether or not this extension is temporarily disabled; for example, a webhook extension that is repeatedly rejected by the server.
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_extensionSELECTidGet 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_extensionsSELECTList 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_extensionINSERTdata__extensionCreate 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_extensionDELETEidDelete 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
_get_extensionEXECidGet 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_extensionsEXECList 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
enable_extensionEXECidEnable 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
update_extensionEXECid, data__extensionUpdate 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