Safe Haskell	None
Language	Haskell2010

Network.PagerDuty.REST.Services

Contents

List Services
Create Service
Get Service
Update Service
Delete Service
Enable Service
Disable Service
Regenerate Key
Types

Description

This API lets you access and manipulate the services across your account.

A service is an endpoint (like Nagios, email, or an API call) that generates events, which Pagerduty normalizes and dedupes, creating incidents.

When a service is shown inlined in other resources, a deleted service will have its html_url attribute set to Nothing.

See: http://developer.pagerduty.com/documentation/rest/services

Synopsis

List Services

data ListServices Source #

Instances

Eq ListServices Source #
Methods (==) :: ListServices -> ListServices -> Bool # (/=) :: ListServices -> ListServices -> Bool #
Show ListServices Source #
Methods showsPrec :: Int -> ListServices -> ShowS # show :: ListServices -> String # showList :: [ListServices] -> ShowS #
ToJSON ListServices Source #
Methods toJSON :: ListServices -> Value # toEncoding :: ListServices -> Encoding # toJSONList :: [ListServices] -> Value # toEncodingList :: [ListServices] -> Encoding #
Generic ListServices Source #
Associated Types type Code ListServices :: [[*]] # Methods from :: ListServices -> Rep ListServices # to :: Rep ListServices -> ListServices #
HasDatatypeInfo ListServices Source #
Methods datatypeInfo :: proxy ListServices -> DatatypeInfo (Code ListServices) #
QueryLike ListServices Source #
Methods toQuery :: ListServices -> Query #
Paginate ListServices Source #
Methods next :: Request ListServices s b -> Maybe Pager -> Maybe (Request ListServices s b)
type Code ListServices Source #
type Code ListServices

listServices :: Request ListServices s [Service] Source #

List existing services.

GET /services

See: http://developer.pagerduty.com/documentation/rest/services/list

lsTimeZone :: Lens' (Request ListServices s r) (Maybe TimeZone) Source #

Time zone in which dates in the result will be rendered.

Default: account default time zone.

Create Service

data CreateService Source #

Instances

Eq CreateService Source #
Methods (==) :: CreateService -> CreateService -> Bool # (/=) :: CreateService -> CreateService -> Bool #
Show CreateService Source #
Methods showsPrec :: Int -> CreateService -> ShowS # show :: CreateService -> String # showList :: [CreateService] -> ShowS #
ToJSON CreateService Source #
Methods toJSON :: CreateService -> Value # toEncoding :: CreateService -> Encoding # toJSONList :: [CreateService] -> Value # toEncodingList :: [CreateService] -> Encoding #
FromJSON CreateService Source #
Methods parseJSON :: Value -> Parser CreateService # parseJSONList :: Value -> Parser [CreateService] #
QueryLike CreateService Source #
Methods toQuery :: CreateService -> Query #

createService :: Text -> EscalationPolicyId -> ServiceType -> Request CreateService s Service Source #

Creates a new service.

POST /services

See: http://developer.pagerduty.com/documentation/rest/services/create

csName :: Lens' (Request CreateService s r) Text Source #

The name of the service.

csDescription :: Lens' (Request CreateService s r) (Maybe Text) Source #

A description for your service. 1024 character maximum.

csType :: Lens' (Request CreateService s r) ServiceType Source #

The type of service to create.

csVendorId :: Lens' (Request CreateService s r) (Maybe VendorId) Source #

PagerDuty's internal vendor identifier for this service. For more information about a specific vendor, please contact PagerDuty Support.

csEscalationPolicyId :: Lens' (Request CreateService s r) EscalationPolicyId Source #

The id of the escalation policy to be used by this service.

csAcknowledgementTimeout :: Lens' (Request CreateService s r) (Maybe Int) Source #

The duration in seconds before an incidents acknowledged in this service become triggered again.

Default: 30 minutes.

csAutoResolveTimeout :: Lens' (Request CreateService s r) (Maybe Int) Source #

The duration in seconds before a triggered incident auto-resolves itself.

Default: 4 hours.

csSeverityFilter :: Lens' (Request CreateService s r) (Maybe SeverityFilter) Source #

Specifies what severity levels will create a new open incident.

Get Service

getService :: ServiceId -> Request Empty s Service Source #

Get details about an existing service.

GET services/:id

See: http://developer.pagerduty.com/documentation/rest/services/show

Update Service

data UpdateService Source #

Instances

Eq UpdateService Source #
Methods (==) :: UpdateService -> UpdateService -> Bool # (/=) :: UpdateService -> UpdateService -> Bool #
Show UpdateService Source #
Methods showsPrec :: Int -> UpdateService -> ShowS # show :: UpdateService -> String # showList :: [UpdateService] -> ShowS #
ToJSON UpdateService Source #
Methods toJSON :: UpdateService -> Value # toEncoding :: UpdateService -> Encoding # toJSONList :: [UpdateService] -> Value # toEncodingList :: [UpdateService] -> Encoding #
FromJSON UpdateService Source #
Methods parseJSON :: Value -> Parser UpdateService # parseJSONList :: Value -> Parser [UpdateService] #
QueryLike UpdateService Source #
Methods toQuery :: UpdateService -> Query #

updateService :: ServiceId -> Request UpdateService s Service Source #

Update an existing service.

PUT services/:id

See: http://developer.pagerduty.com/documentation/rest/services/update

usName :: Lens' (Request UpdateService s r) (Maybe Text) Source #

The name of the service.

usEscalationPolicyId :: Lens' (Request UpdateService s r) (Maybe EscalationPolicyId) Source #

The id of the escalation policy to be used by this service.

usDescription :: Lens' (Request UpdateService s r) (Maybe Text) Source #

A description for your service. 1024 character maximum.

usAcknowledgementTimeout :: Lens' (Request UpdateService s r) (Maybe Int) Source #

The duration in seconds before an incidents acknowledged in this service become triggered again.

Default: 30 minutes.

usAutoResolveTimeout :: Lens' (Request UpdateService s r) (Maybe Int) Source #

The duration in seconds before a triggered incident auto-resolves itself.

Default: 4 hours.

usSeverityFilter :: Lens' (Request UpdateService s r) (Maybe SeverityFilter) Source #

Specifies what severity levels will create a new open incident.

Delete Service

deleteService :: ServiceId -> Request Empty s Empty Source #

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

DELETE /services/:id

See: http://developer.pagerduty.com/documentation/rest/services/delete

Enable Service

enableService :: RequesterId -> ServiceId -> Request Empty s Empty Source #

Enable a previously disabled service.

PUT services/:id/enable

See: http://developer.pagerduty.com/documentation/rest/services/enable

Disable Service

disableService :: RequesterId -> ServiceId -> Request Empty s Empty Source #

Disable a service. Once a service is disabled, it will not be able to create incidents until it is enabled again.

PUT services/:id/disable

See: http://developer.pagerduty.com/documentation/rest/services/disable

Regenerate Key

regenerateKey :: ServiceId -> Request Empty s Service Source #

Regenerate a new service key for an existing service.

_Warning! The service's previous key will be invalidated, and existing monitoring integrations will need to be modified to use the new key!_

POST services/:id/regenerate_key

See: http://developer.pagerduty.com/documentation/rest/services/regenerate_key

Types

data EmailFilterMode Source #

Constructors

AllEmail	Accept all incoming email
OrRulesEmail	Accept email only if it matches ONE OR MORE rules below
AndRulesEmail	Accept email only if it matches ALL of the rules below

Instances

Eq EmailFilterMode Source #
Methods (==) :: EmailFilterMode -> EmailFilterMode -> Bool # (/=) :: EmailFilterMode -> EmailFilterMode -> Bool #
Show EmailFilterMode Source #
Methods showsPrec :: Int -> EmailFilterMode -> ShowS # show :: EmailFilterMode -> String # showList :: [EmailFilterMode] -> ShowS #
ToJSON EmailFilterMode Source #
Methods toJSON :: EmailFilterMode -> Value # toEncoding :: EmailFilterMode -> Encoding # toJSONList :: [EmailFilterMode] -> Value # toEncodingList :: [EmailFilterMode] -> Encoding #
FromJSON EmailFilterMode Source #
Methods parseJSON :: Value -> Parser EmailFilterMode # parseJSONList :: Value -> Parser [EmailFilterMode] #

data EmailIncidentCreation Source #

Constructors

OnNewEmail	Open a new incident for each trigger email.
OnNewEmailSubject	Open a new incident for each new trigger email subject.
OnlyIfNoOpenIncidents	Open a new incident only if an open incident does not already exist.

Instances

Eq EmailIncidentCreation Source #
Methods (==) :: EmailIncidentCreation -> EmailIncidentCreation -> Bool # (/=) :: EmailIncidentCreation -> EmailIncidentCreation -> Bool #
Show EmailIncidentCreation Source #
Methods showsPrec :: Int -> EmailIncidentCreation -> ShowS # show :: EmailIncidentCreation -> String # showList :: [EmailIncidentCreation] -> ShowS #
ToJSON EmailIncidentCreation Source #
Methods toJSON :: EmailIncidentCreation -> Value # toEncoding :: EmailIncidentCreation -> Encoding # toJSONList :: [EmailIncidentCreation] -> Value # toEncodingList :: [EmailIncidentCreation] -> Encoding #
FromJSON EmailIncidentCreation Source #
Methods parseJSON :: Value -> Parser EmailIncidentCreation # parseJSONList :: Value -> Parser [EmailIncidentCreation] #

data ServiceStatus Source #

Constructors

Active	The service is enabled and has no open incidents.
Warning	The service is enabled and has one or more acknowledged incidents.
Critical	The service is enabled and has one or more triggered incidents.
Maintenance	The service is under maintenance, no new incidents will be triggered during maintenance mode.
Disabled	The service is disabled and will not have any new triggered incidents.

Instances

Eq ServiceStatus Source #
Methods (==) :: ServiceStatus -> ServiceStatus -> Bool # (/=) :: ServiceStatus -> ServiceStatus -> Bool #
Show ServiceStatus Source #
Methods showsPrec :: Int -> ServiceStatus -> ShowS # show :: ServiceStatus -> String # showList :: [ServiceStatus] -> ShowS #
ToJSON ServiceStatus Source #
Methods toJSON :: ServiceStatus -> Value # toEncoding :: ServiceStatus -> Encoding # toJSONList :: [ServiceStatus] -> Value # toEncodingList :: [ServiceStatus] -> Encoding #
FromJSON ServiceStatus Source #
Methods parseJSON :: Value -> Parser ServiceStatus # parseJSONList :: Value -> Parser [ServiceStatus] #

data ServiceType Source #

Constructors

CloudKick
GenericEmail
GenericEventsApi
Keynote
Nagios
Pingdom
ServerDensity
SqlMonitor

Instances

Eq ServiceType Source #
Methods (==) :: ServiceType -> ServiceType -> Bool # (/=) :: ServiceType -> ServiceType -> Bool #
Show ServiceType Source #
Methods showsPrec :: Int -> ServiceType -> ShowS # show :: ServiceType -> String # showList :: [ServiceType] -> ShowS #
ToJSON ServiceType Source #
Methods toJSON :: ServiceType -> Value # toEncoding :: ServiceType -> Encoding # toJSONList :: [ServiceType] -> Value # toEncodingList :: [ServiceType] -> Encoding #
FromJSON ServiceType Source #
Methods parseJSON :: Value -> Parser ServiceType # parseJSONList :: Value -> Parser [ServiceType] #

data SeverityFilter Source #

Constructors

SevCritical	Incidents are created when an alarm enters the Critical state.
SevCriticalOrWarning	Incidents are created when an alarm enters the Critical OR Warning states
SevOnAny	SQL Monitor: Incidents are created for alerts of any severity.
SevOnHigh	SQL Monitor: Incidents are created for alerts with high severity.
SevOnMediumHigh	SQL Monitor: Incidents are created for with high or medium severity

Instances

Eq SeverityFilter Source #
Methods (==) :: SeverityFilter -> SeverityFilter -> Bool # (/=) :: SeverityFilter -> SeverityFilter -> Bool #
Show SeverityFilter Source #
Methods showsPrec :: Int -> SeverityFilter -> ShowS # show :: SeverityFilter -> String # showList :: [SeverityFilter] -> ShowS #
ToJSON SeverityFilter Source #
Methods toJSON :: SeverityFilter -> Value # toEncoding :: SeverityFilter -> Encoding # toJSONList :: [SeverityFilter] -> Value # toEncodingList :: [SeverityFilter] -> Encoding #
FromJSON SeverityFilter Source #
Methods parseJSON :: Value -> Parser SeverityFilter # parseJSONList :: Value -> Parser [SeverityFilter] #

data IncidentCounts Source #

Instances

Eq IncidentCounts Source #
Methods (==) :: IncidentCounts -> IncidentCounts -> Bool # (/=) :: IncidentCounts -> IncidentCounts -> Bool #
Show IncidentCounts Source #
Methods showsPrec :: Int -> IncidentCounts -> ShowS # show :: IncidentCounts -> String # showList :: [IncidentCounts] -> ShowS #
ToJSON IncidentCounts Source #
Methods toJSON :: IncidentCounts -> Value # toEncoding :: IncidentCounts -> Encoding # toJSONList :: [IncidentCounts] -> Value # toEncodingList :: [IncidentCounts] -> Encoding #
FromJSON IncidentCounts Source #
Methods parseJSON :: Value -> Parser IncidentCounts # parseJSONList :: Value -> Parser [IncidentCounts] #

cntTriggered :: Lens' IncidentCounts Int Source #

cntAcknowledged :: Lens' IncidentCounts Int Source #

cntResolved :: Lens' IncidentCounts Int Source #

cntTotal :: Lens' IncidentCounts Int Source #

data PolicyInfo Source #

Instances

Eq PolicyInfo Source #
Methods (==) :: PolicyInfo -> PolicyInfo -> Bool # (/=) :: PolicyInfo -> PolicyInfo -> Bool #
Show PolicyInfo Source #
Methods showsPrec :: Int -> PolicyInfo -> ShowS # show :: PolicyInfo -> String # showList :: [PolicyInfo] -> ShowS #
ToJSON PolicyInfo Source #
Methods toJSON :: PolicyInfo -> Value # toEncoding :: PolicyInfo -> Encoding # toJSONList :: [PolicyInfo] -> Value # toEncodingList :: [PolicyInfo] -> Encoding #
FromJSON PolicyInfo Source #
Methods parseJSON :: Value -> Parser PolicyInfo # parseJSONList :: Value -> Parser [PolicyInfo] #

pinfoId :: Lens' PolicyInfo EscalationPolicyId Source #

pinfoName :: Lens' PolicyInfo Text Source #

data Service Source #

Instances

Eq Service Source #
Methods (==) :: Service -> Service -> Bool # (/=) :: Service -> Service -> Bool #
Show Service Source #
Methods showsPrec :: Int -> Service -> ShowS # show :: Service -> String # showList :: [Service] -> ShowS #
ToJSON Service Source #
Methods toJSON :: Service -> Value # toEncoding :: Service -> Encoding # toJSONList :: [Service] -> Value # toEncodingList :: [Service] -> Encoding #
FromJSON Service Source #
Methods parseJSON :: Value -> Parser Service # parseJSONList :: Value -> Parser [Service] #

svcId :: Lens' Service ServiceId Source #

A unique identifier for this service.

svcName :: Lens' Service Text Source #

The name of the service.

svcDescription :: Lens' Service Text Source #

The description of the service

svcServiceUrl :: Lens' Service Text Source #

Relative URL that corresponds to this service.

svcServiceKey :: Lens' Service ServiceKey Source #

For Email services, the serviceKey is the associated email address for the service. For all other service types, this is the unique key used for API calls.

svcAutoResolveTimeout :: Lens' Service (Maybe Int) Source #

Time in seconds that an incident changes to the Triggered State after being Acknowledged. Value is Nothing if the feature is disabled.

svcAcknowledgementTimeout :: Lens' Service (Maybe Int) Source #

Time in seconds that an incident is automatically resolved if left open for that long. Value is Nothing is the feature is disabled.

svcCreatedAt :: Lens' Service UTCTime Source #

The date/time when this service was created.

svcStatus :: Lens' Service ServiceStatus Source #

The current state of the Service.

svcLastIncidentTimestamp :: Lens' Service (Maybe UTCTime) Source #

The date/time when the most recent incident was created for this service.

svcEmailIncidentCreation :: Lens' Service (Maybe EmailIncidentCreation) Source #

If the service is a Generic Email service, this describes what kind of emails create an incident.

svcIncidentCounts :: Lens' Service IncidentCounts Source #

An object with the number of incidents corresponding to these states.

svcEmailFilterMode :: Lens' Service EmailFilterMode Source #

If the service is a Generic Email service, this describes which types of email will generate an incident.

svcType :: Lens' Service ServiceType Source #

The service type.

svcEscalationPolicy :: Lens' Service (Maybe PolicyInfo) Source #

An object containing the ID and name of the escalation policy used by this service.

svcEmailFilters :: Lens' Service (Maybe [EmailFilterInfo]) Source #

An object containing inline Email Filters. Note that only genericEmail services have filters.

svcSeverityFilter :: Lens' Service (Maybe SeverityFilter) Source #

Specifies what severity levels will create a new open incident.