PagerDuty

this connector integrates pagerduty's rest api with swimlane turbine prerequisites the pagerduty asset requires an api key only account administrators have the ability to generate api tokens information on generating api tokens can be found https //support pagerduty com/docs/using the api#section generating an api key capabilities the pagerduty connector has the following capabilities create an incident list teams list on calls list services list users list escalation policies notes for more information on pagerduty is found at https //www pagerduty com/ for more information on pagerduty's developer site is found at https //developer pagerduty com/ api documentation link https //developer pagerduty com/api reference/e65c5833eeb07 pager duty api configurations api key authentication authenticates using an api key configuration parameters parameter description type required url a url to the target host string required apikey api key in the authorization header of all requests that are sent to api gateway string required verify ssl verify ssl certificate boolean optional http proxy a proxy to route requests through string optional actions create an incident create an incident synchronously without a corresponding event from a monitoring service endpoint url /incidents method post input argument name type required description headers object required http headers for the request headers accept string required http headers for the request headers content type string required http headers for the request headers from string required http headers for the request incident object optional unique identifier incident type string required unique identifier incident title string required unique identifier incident service object required unique identifier incident service id string optional unique identifier incident service type string optional unique identifier incident priority object optional unique identifier incident priority id string optional unique identifier incident priority type string optional unique identifier incident urgency string optional unique identifier incident body object optional request body data incident body type string optional request body data incident body details string optional request body data incident incident key string optional unique identifier incident assignments array optional unique identifier incident assignments assignee object optional unique identifier incident assignments assignee type string optional unique identifier incident escalation policy object optional unique identifier incident escalation policy id string optional unique identifier incident escalation policy type string optional unique identifier incident conference bridge object optional unique identifier input example {"json body" {"incident" {"type" "incident","title" "the server is on fire ","service" {"id" "pwixjzs","type" "service reference"},"priority" {"id" "p53zzh5","type" "priority reference"},"urgency" "high","body" {"type" "incident body","details" "a disk is getting full on this machine you should investigate what is causing the disk to fill, and ensure that there is an automated process in place for ensuring data is rotated (eg logs should have logrotate around them) if data is expected to stay on this disk forever, you should start planning to scale up to a larger disk "},"incident key" "baf7cf21b1da41b4b0221008339ff357","assignments" \[{"assignee" {"type" "service reference"}},{"assignee" {"type" "priority reference"}}],"escalation policy" {"id" "pt20ypa","type" "escalation policy reference"},"conference bridge" {"conference number" "+1 415 555 1212","conference url" "https //subdomain pagerduty com"}}},"headers" {"accept" "application/vnd pagerduty+json;version=2","content type" "application/json","from" "mail id"}} output parameter type description status code number http status code of the response reason string response reason phrase incident object unique identifier incident id string unique identifier incident type string unique identifier incident title string unique identifier incident summary string unique identifier incident self string unique identifier incident html url string url endpoint for the request incident incident number number unique identifier incident created at string unique identifier incident updated at string unique identifier incident status string unique identifier incident incident key string unique identifier incident service object unique identifier incident service id string unique identifier incident service type string unique identifier incident service summary string unique identifier incident service self string unique identifier incident service html url string url endpoint for the request incident priority object unique identifier incident priority id string unique identifier incident priority type string unique identifier incident priority summary string unique identifier incident priority self string unique identifier output example {"status code" 200,"response headers" {},"reason" "ok","json body" {"incident" {"id" "pt4khlk","type" "incident","title" "the server is on fire ","summary" "\[#1234] the server is on fire ","self" "https //api pagerduty com/incidents/pt4khlk","html url" "https //subdomain pagerduty com/incidents/pt4khlk","incident number" 1234,"created at" "2015 10 06t21 30 42z","updated at" "2015 10 06t21 40 23z","status" "triggered","incident key" "baf7cf21b1da41b4b0221008339ff357","service" {},"priority" {},"a list escalation policies list all of the existing escalation policies endpoint url /escalation policies method get input argument name type required description parameters limit number optional parameters for the list escalation policies action parameters offset number optional parameters for the list escalation policies action parameters total boolean optional parameters for the list escalation policies action parameters query string optional parameters for the list escalation policies action parameters include\[] string optional parameters for the list escalation policies action parameters sort by string optional parameters for the list escalation policies action parameters team ids\[] array optional parameters for the list escalation policies action parameters user ids\[] array optional parameters for the list escalation policies action headers object required http headers for the request headers accept string required http headers for the request headers content type string required http headers for the request input example {"parameters" {"limit" 25,"offset" 0,"total"\ false,"query" "","include\[]" "teams","sort by" "name","team ids\[]" \["pq9k7i8"],"user ids\[]" \["pi7dh85"]},"headers" {"accept" "application/vnd pagerduty+json;version=2","content type" "application/json"}} output parameter type description status code number http status code of the response reason string response reason phrase escalation policies array output field escalation policies escalation policies id string unique identifier escalation policies type string type of the resource escalation policies summary string output field escalation policies summary escalation policies self string output field escalation policies self escalation policies html url string url endpoint for the request escalation policies name string name of the resource escalation policies escalation rules array output field escalation policies escalation rules escalation policies escalation rules id string unique identifier escalation policies escalation rules escalation delay in minutes number output field escalation policies escalation rules escalation delay in minutes escalation policies escalation rules targets array output field escalation policies escalation rules targets escalation policies escalation rules targets id string unique identifier escalation policies escalation rules targets type string type of the resource escalation policies escalation rules targets summary string output field escalation policies escalation rules targets summary escalation policies escalation rules targets self string output field escalation policies escalation rules targets self escalation policies escalation rules targets html url string url endpoint for the request escalation policies services array output field escalation policies services escalation policies services id string unique identifier escalation policies services type string type of the resource escalation policies services summary string output field escalation policies services summary escalation policies services self string output field escalation policies services self escalation policies services html url string url endpoint for the request escalation policies num loops number output field escalation policies num loops output example {"status code" 200,"response headers" {"server" "nginx","date" "fri, 10 nov 2023 07 39 08 gmt","content type" "application/json","transfer encoding" "chunked","connection" "keep alive","vary" "accept encoding, accept","access control allow origin" " ","x frame options" "sameorigin","x xss protection" "1; mode=block, 1; mode=block","x content type options" "nosniff, nosniff","x download options" "noopen","x permitted cross domain policies" "none","referrer policy" "strict origin when cross origin list all of the on calls list the on call entries during a given time range endpoint url /oncalls method get input argument name type required description parameters limit number optional parameters for the list all of the on calls action parameters offset number optional parameters for the list all of the on calls action parameters total boolean optional parameters for the list all of the on calls action parameters earliest boolean optional parameters for the list all of the on calls action parameters escalation policy ids\[] array optional parameters for the list all of the on calls action parameters include\[] string optional parameters for the list all of the on calls action parameters schedule ids\[] array optional parameters for the list all of the on calls action parameters since string optional parameters for the list all of the on calls action parameters time zone string optional parameters for the list all of the on calls action parameters until string optional parameters for the list all of the on calls action parameters user ids\[] array optional parameters for the list all of the on calls action headers object required http headers for the request headers accept string required http headers for the request headers content type string required http headers for the request input example {"parameters" {"limit" 25,"offset" 0,"total"\ false,"earliest"\ false,"escalation policy ids\[]" \["pt20ypa"],"include\[]" "users","schedule ids\[]" \["pi7dh85"],"since" "2015 03 06t15 28 51 05 00","time zone" "asia/hong kong","until" "2015 03 06t15 28 51 05 00","user ids\[]" \["pi7dh85"]},"headers" {"accept" "application/vnd pagerduty+json;version=2","content type" "application/json"}} output parameter type description status code number http status code of the response reason string response reason phrase oncalls array output field oncalls oncalls escalation policy object output field oncalls escalation policy oncalls escalation policy id string unique identifier oncalls escalation policy type string type of the resource oncalls escalation policy summary string output field oncalls escalation policy summary oncalls escalation policy self string output field oncalls escalation policy self oncalls escalation policy html url string url endpoint for the request oncalls escalation level number output field oncalls escalation level oncalls schedule object output field oncalls schedule oncalls user object output field oncalls user oncalls user id string unique identifier oncalls user type string type of the resource oncalls user summary string output field oncalls user summary oncalls user self string output field oncalls user self oncalls user html url string url endpoint for the request oncalls start object output field oncalls start oncalls end object output field oncalls end limit number output field limit offset number output field offset more boolean output field more total object output field total output example {"status code" 200,"response headers" {"server" "nginx","date" "fri, 10 nov 2023 07 19 22 gmt","content type" "application/json","transfer encoding" "chunked","connection" "keep alive","vary" "accept encoding, accept","access control allow origin" " ","x frame options" "sameorigin","x xss protection" "1; mode=block, 1; mode=block","x content type options" "nosniff, nosniff","x download options" "noopen","x permitted cross domain policies" "none","referrer policy" "strict origin when cross origin list services list existing services endpoint url /services method get input argument name type required description parameters limit number optional parameters for the list services action parameters offset number optional parameters for the list services action parameters total boolean optional parameters for the list services action parameters query string optional parameters for the list services action parameters include\[] string optional parameters for the list services action parameters sort by string optional parameters for the list services action parameters team ids\[] array optional parameters for the list services action parameters time zone string optional parameters for the list services action headers object required http headers for the request headers accept string required http headers for the request headers content type string required http headers for the request input example {"parameters" {"limit" 25,"offset" 0,"total"\ false,"query" "","include\[]" "teams","sort by" "name","team ids\[]" \["pq9k7i8"],"time zone" "asia/hong kong"},"headers" {"accept" "application/vnd pagerduty+json;version=2","content type" "application/json"}} output parameter type description status code number http status code of the response reason string response reason phrase services array output field services services id string unique identifier services name string name of the resource services description string output field services description services created at string output field services created at services updated at string output field services updated at services status string status value services teams array output field services teams services teams id string unique identifier services teams type string type of the resource services teams summary string output field services teams summary services teams self string output field services teams self services teams html url string url endpoint for the request services alert creation string output field services alert creation services addons array output field services addons services addons file name string name of the resource services addons file string output field services addons file services scheduled actions array output field services scheduled actions services scheduled actions file name string name of the resource services scheduled actions file string output field services scheduled actions file services support hours object output field services support hours services last incident timestamp object unique identifier services escalation policy object output field services escalation policy output example {"status code" 200,"response headers" {"server" "nginx","date" "fri, 10 nov 2023 07 28 11 gmt","content type" "application/json","transfer encoding" "chunked","connection" "keep alive","vary" "accept encoding, accept","access control allow origin" " ","x frame options" "sameorigin","x xss protection" "1; mode=block, 1; mode=block","x content type options" "nosniff, nosniff","x download options" "noopen","x permitted cross domain policies" "none","referrer policy" "strict origin when cross origin list teams list teams of your pagerduty account, optionally filtered by a search query endpoint url /teams method get input argument name type required description parameters limit number optional parameters for the list teams action parameters offset number optional parameters for the list teams action parameters query string optional parameters for the list teams action parameters total boolean optional parameters for the list teams action headers object required http headers for the request headers accept string required http headers for the request headers content type string required http headers for the request input example {"parameters" {"limit" 25,"offset" 0,"query" "","total"\ false},"headers" {"accept" "application/vnd pagerduty+json;version=2","content type" "application/json"}} output parameter type description status code number http status code of the response reason string response reason phrase teams array output field teams teams id string unique identifier teams name string name of the resource teams description object output field teams description teams type string type of the resource teams summary string output field teams summary teams self string output field teams self teams html url string url endpoint for the request teams default role string output field teams default role teams parent object output field teams parent limit number output field limit offset number output field offset total object output field total more boolean output field more output example {"status code" 200,"response headers" {"server" "nginx","date" "fri, 10 nov 2023 07 14 02 gmt","content type" "application/json","content length" "603","connection" "keep alive","access control allow origin" " ","x frame options" "sameorigin","x xss protection" "1; mode=block, 1; mode=block","x content type options" "nosniff, nosniff","x download options" "noopen","x permitted cross domain policies" "none","referrer policy" "strict origin when cross origin, strict origin when cross origin","acce list users list users of your pagerduty account, optionally filtered by a search query endpoint url /users method get input argument name type required description parameters limit number optional parameters for the list users action parameters offset number optional parameters for the list users action parameters total boolean optional parameters for the list users action parameters query string optional parameters for the list users action parameters include\[] string optional parameters for the list users action parameters team ids\[] array optional parameters for the list users action headers object required http headers for the request headers accept string required http headers for the request headers content type string required http headers for the request input example {"parameters" {"limit" 25,"offset" 0,"total"\ false,"query" "","include\[]" "teams","team ids\[]" \["pq9k7i8"]},"headers" {"accept" "application/vnd pagerduty+json;version=2","content type" "application/json"}} output parameter type description status code number http status code of the response reason string response reason phrase users array output field users users name string name of the resource users email string output field users email users time zone string output field users time zone users color string output field users color users avatar url string url endpoint for the request users billed boolean output field users billed users role string output field users role users description object output field users description users invitation sent boolean output field users invitation sent users job title object output field users job title users teams array output field users teams users teams id string unique identifier users teams type string type of the resource users teams summary string output field users teams summary users teams self string output field users teams self users teams html url string url endpoint for the request users contact methods array http method to use users contact methods id string http method to use users contact methods type string http method to use users contact methods summary string http method to use users contact methods self string http method to use users contact methods html url object url endpoint for the request output example {"status code" 200,"response headers" {"server" "nginx","date" "fri, 10 nov 2023 07 30 38 gmt","content type" "application/json","transfer encoding" "chunked","connection" "keep alive","vary" "accept encoding, accept","access control allow origin" " ","x frame options" "sameorigin","x xss protection" "1; mode=block, 1; mode=block","x content type options" "nosniff, nosniff","x download options" "noopen","x permitted cross domain policies" "none","referrer policy" "strict origin when cross origin response headers header description example access control allow headers http response header access control allow headers authorization, content type, authorizationoauth, x early access access control allow methods http response header access control allow methods get, post, put, delete, options access control allow origin http response header access control allow origin access control expose headers http response header access control expose headers access control max age http response header access control max age 1728000 cache control directives for caching mechanisms max age=0, private, must revalidate connection http response header connection keep alive content encoding http response header content encoding gzip content length the length of the response body in bytes 603 content type the media type of the resource application/json date the date and time at which the message was originated fri, 10 nov 2023 07 39 08 gmt etag an identifier for a specific version of a resource w/"42bc513c488f8a1265dde64c8abd264c" feature policy http response header feature policy accelerometer 'none'; camera 'none'; geolocation 'none'; gyroscope 'none'; magnetometer 'none'; microphone 'none'; payment 'none'; usb 'none' ratelimit limit http response header ratelimit limit 960 ratelimit remaining http response header ratelimit remaining 956 ratelimit reset http response header ratelimit reset 39 referrer policy http response header referrer policy strict origin when cross origin, strict origin when cross origin server information about the software used by the origin server nginx strict transport security http response header strict transport security max age=31536000; includesubdomains transfer encoding http response header transfer encoding chunked vary http response header vary accept x content type options http response header x content type options nosniff, nosniff x download options http response header x download options noopen x frame options http response header x frame options sameorigin x permitted cross domain policies http response header x permitted cross domain policies none x request id a unique identifier for the request 8bbbb95c0b830102a33f0fd7c9b485c6 x xss protection http response header x xss protection 1; mode=block, 1; mode=block