createPagerDutyAction()

🎯API Stability

Long-TermThis API is stable and will remain supported across versions with minimal breaking changes.

Summary

PagerDuty actions let LogScale push incident notifications to PagerDuty when an alert fires. Each action stores a routing key that identifies the PagerDuty service or escalation policy to receive the event, an event severity that maps to the PagerDuty severity field, and a display name so the action can be reused across multiple alerts without reconfiguring the integration settings each time.

The createPagerDutyAction() mutation creates a new PagerDuty action in a LogScale repository or view. On success, it returns the PagerDutyAction object for the created action, including the generated ID. After creation, attach the action to an alert using createAggregateAlert(), createFilterAlert(), or their update counterparts.

After creating the action, use testPagerDutyAction() to verify it delivers events to the correct PagerDuty service. Use updatePagerDutyAction() to modify an existing action's routing key, severity, or name. Use deleteActionV2() to remove a PagerDuty action. To add organizational labels to the action, use addActionLabels().

Hide Query Example

Show PagerDuty Actions Query

To get a list of PagerDuty actions in a repository, use the repository() query:

graphql

query {
     repository(name: "humio") {
       id
       name
       actions {
         id
         name
         ... on PagerDutyAction { id, name }
       }
     }
   }

Use the action's unique identifier from these results as the id value when calling testPagerDutyAction() or updatePagerDutyAction().

For guidance on PagerDuty integration, see the Action Type: PagerDuty documentation page. For an overview of LogScale actions, see the Actions page.

Syntax

graphql

createPagerDutyAction(
      input: CreatePagerDutyAction!
   ): PagerDutyAction!

The input argument is required and takes a CreatePagerDutyAction object. Provide the repository or view name, a display name for the action, the PagerDuty routing key, and an event severity. The routing key is the integration key from the PagerDuty service or global ruleset that will receive the events. The severity maps directly to the PagerDuty event severity field and accepts the values critical, error, warning, and info. Creating a PagerDuty action requires the CreateActions API permission.

The mutation returns a non-null PagerDutyAction! object. The Returned Values section describes the available fields, including the generated action ID.

Example

Raw

graphql

mutation {
  createPagerDutyAction(input: 
         { viewName: "humio",
           name: "on-duty",
           severity: "high",
           routingKey: "123XYZabc",
           useProxy: false        
         } )
    {id, isAllowedToRun}
}

Mac OS or Linux (curl)

shell

curl -v -X POST $YOUR_LOGSCALE_URL/graphql \
    -H "Authorization: Bearer $TOKEN" \
    -H "Content-Type: application/json" \
    -d @- << EOF
{"query" : "mutation {
  createPagerDutyAction(input: 
         { viewName: \"humio\",
           name: \"on-duty\",
           severity: \"high\",
           routingKey: \"123XYZabc\",
           useProxy: false        
         } )
    {id, isAllowedToRun}
}"
}
EOF

Mac OS or Linux (curl) One-line

shell

curl -v -X POST $YOUR_LOGSCALE_URL/graphql \
    -H "Authorization: Bearer $TOKEN" \
    -H "Content-Type: application/json" \
    -d @- << EOF
{"query" : "mutation {
  createPagerDutyAction(input: 
         { viewName: \"humio\",
           name: \"on-duty\",
           severity: \"high\",
           routingKey: \"123XYZabc\",
           useProxy: false        
         } )
    {id, isAllowedToRun}
}"
}
EOF

Windows Cmd and curl

shell

curl -v -X POST $YOUR_LOGSCALE_URL/graphql ^
    -H "Authorization: Bearer $TOKEN" ^
    -H "Content-Type: application/json" ^
    -d @'{"query" : "mutation { ^
  createPagerDutyAction(input:  ^
         { viewName: \"humio\", ^
           name: \"on-duty\", ^
           severity: \"high\", ^
           routingKey: \"123XYZabc\", ^
           useProxy: false         ^
         } ) ^
    {id, isAllowedToRun} ^
}" ^
} '

Windows Powershell and curl

powershell

curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "mutation {
  createPagerDutyAction(input: 
         { viewName: \"humio\",
           name: \"on-duty\",
           severity: \"high\",
           routingKey: \"123XYZabc\",
           useProxy: false        
         } )
    {id, isAllowedToRun}
}"
}'
    "$YOUR_LOGSCALE_URL/graphql"

Perl

perl

#!/usr/bin/perl

use HTTP::Request;
use LWP;

my $TOKEN = "TOKEN";

my $uri = '$YOUR_LOGSCALE_URL/graphql';

my $query = "mutation {
  createPagerDutyAction(input: 
         { viewName: \"humio\",
           name: \"on-duty\",
           severity: \"high\",
           routingKey: \"123XYZabc\",
           useProxy: false        
         } )
    {id, isAllowedToRun}
}";
$query =~ s/\n/ /g;
my $json = sprintf('{"query" : "%s"}',$query);
my $req = HTTP::Request->new("POST", $uri );

$req->header("Authorization" => "Bearer $TOKEN");
$req->header("Content-Type" => "application/json");

$req->content( $json );

my $lwp = LWP::UserAgent->new;

my $result = $lwp->request( $req );

print $result->{"_content"},"\n";

Python

python

#! /usr/local/bin/python3

import requests

url = '$YOUR_LOGSCALE_URL/graphql'
mydata = r'''{"query" : "mutation {
  createPagerDutyAction(input: 
         { viewName: \"humio\",
           name: \"on-duty\",
           severity: \"high\",
           routingKey: \"123XYZabc\",
           useProxy: false        
         } )
    {id, isAllowedToRun}
}"
}'''

resp = requests.post(url,
                     data = mydata,
                     headers = {
   "Authorization" : "Bearer $TOKEN",
   "Content-Type" : "application/json"
}
)

print(resp.text)

Node.js

javascript

const https = require('https');

const data = JSON.stringify(
    {"query" : "mutation {
  createPagerDutyAction(input: 
         { viewName: \"humio\",
           name: \"on-duty\",
           severity: \"high\",
           routingKey: \"123XYZabc\",
           useProxy: false        
         } )
    {id, isAllowedToRun}
}"
}
);


const options = {
  hostname: '$YOUR_LOGSCALE_URL',
  path: 'graphql',
  port: 443,
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'Content-Length': data.length,
    Authorization: 'BEARER ' + process.env.TOKEN,
    'User-Agent': 'Node',
  },
};

const req = https.request(options, (res) => {
  let data = '';
  console.log(`statusCode: ${res.statusCode}`);

  res.on('data', (d) => {
    data += d;
  });
  res.on('end', () => {
    console.log(JSON.parse(data).data);
  });
});

req.on('error', (error) => {
  console.error(error);
});

req.write(data);
req.end();

Example Responses

Success (HTTP Response Code 200 OK)

json

{
  "data": {
    "createPagerDutyAction": {
      "id": "abc123",
      "isAllowedToRun": true
    }
  }
}

Input Parameters

The input argument takes a CreatePagerDutyAction object. Provide the repository or view name, a display name for the action, the PagerDuty routing key, and the event severity. The routing key is the integration key from the PagerDuty service or global ruleset that will receive the events; copy it from the PagerDuty service's Integrations page. The following table describes each available field.

Table: CreatePagerDutyAction Input Datatype

Parameter	Type	Required	Stability	Description
labels	String	yes		Labels for the action. There can be at most 10 labels with a max length of 60 characters per label.
name	String	yes	`Long-Term`	Name of the action.
routingKey	String	yes	`Long-Term`	Key to authenticate with OpsGenie.
severity	String	yes	`Long-Term`	The routing key to authenticate with PagerDuty.
useProxy	Boolean	yes	`Long-Term`	Defines whether the action should use the configured proxy to make web requests.
viewName	String	yes	`Long-Term`	Name of the view of the action.

Returned Values

The mutation returns the created PagerDutyAction object. Include id in the return fields to capture the generated action identifier, which you need when attaching the action to alerts or calling testPagerDutyAction(). Include isAllowedToRun to confirm the caller has permission to execute the action.

Table: PagerDutyAction Datatype

Parameter	Type	Required	Stability	Description
allowedActions	[AssetAction]	yes	`Short-Term`	The asset actions allowed. See AssetAction .
createdInfo	AssetCommitMetadata		`Long-Term`	Metadata related to the creation of the action. See AssetCommitMetadata.
displayName	string	yes	`Long-Term`	The display name of the action.
id	string	yes	`Long-Term`	The unique identifier of the action.
isAllowedToRun	boolean	yes	`Long-Term`	False if this type of action is disabled because of a security policy, true otherwise.
labels	[string]		`Preview`	Any labels associated with the action.
modifiedInfo	AssetCommitMetadata		`Long-Term`	Metadata related to the latest modification of the action. See AssetCommitMetadata.
name	string	yes	`Long-Term`	The name of the action.
package	PackageInstallation	yes	`Long-Term`	The package, if any, of which the action is part. See PackageInstallation.
packageId	VersionedPackageSpecifier		`Long-Term`	The identifier of the package, if any. VersionedPackageSpecifier is a scalar.
requiresOrganizationOwnedQueriesPermissionToEdit	boolean	yes	`Long-Term`	True if this action is used by triggers, where the query is run by the organization. If true, then the OrganizationOwnedQueries permission is required to edit the action.
resource	string	yes	`Short-Term`	The resource identifier for the action.
routingKey	string	yes	`Long-Term`	Routing key to authenticate with PagerDuty.
severity	string	yes	`Long-Term`	Severity level to give to the message.
useProxy	boolean	yes	`Long-Term`	Defines whether the action should use the configured proxy to make web requests.
yamlTemplate	YAML	yes	`Long-Term`	A template that can be used to recreate the action. YAML is a scalar.

Versions of this Page

GraphQL Mutations

GraphQL API

GraphQL Queries

GraphQL Datatypes