API Stability Long-Term

The updatePagerDutyAction() GraphQL mutation is used to update a PagerDuty action in LogScale.

For more information on PagerDuty actions, see the Action Type: PagerDuty documentation page. You may also want to look at the Actions page for related information.

Syntax

Below is the syntax for the updatePagerDutyAction() mutation field:

graphql
updatePagerDutyAction(
     input: UpdatePagerDutyAction!
   ): PagerDutyAction!

Below is an example of how this mutation field might be used:

Raw
graphql
mutation {
  updatePagerDutyAction( input:
      { viewName: "humio",
        id: "abc123",
        name: "Your-Turn",
        severity: "Important",
        routingKey: "def456",
        useProxy: false
      }
  )
  { severity }
}
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 {
  updatePagerDutyAction( input:
      { viewName: \"humio\",
        id: \"abc123\",
        name: \"Your-Turn\",
        severity: \"Important\",
        routingKey: \"def456\",
        useProxy: false
      }
  )
  { severity }
}"
}
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 {
  updatePagerDutyAction( input:
      { viewName: \"humio\",
        id: \"abc123\",
        name: \"Your-Turn\",
        severity: \"Important\",
        routingKey: \"def456\",
        useProxy: false
      }
  )
  { severity }
}"
}
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 { ^
  updatePagerDutyAction( input: ^
      { viewName: \"humio\", ^
        id: \"abc123\", ^
        name: \"Your-Turn\", ^
        severity: \"Important\", ^
        routingKey: \"def456\", ^
        useProxy: false ^
      } ^
  ) ^
  { severity } ^
}" ^
} '
Windows Powershell and curl
powershell
curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "mutation {
  updatePagerDutyAction( input:
      { viewName: \"humio\",
        id: \"abc123\",
        name: \"Your-Turn\",
        severity: \"Important\",
        routingKey: \"def456\",
        useProxy: false
      }
  )
  { severity }
}"
}'
    "$YOUR_LOGSCALE_URL/graphql"
Perl
perl
#!/usr/bin/perl

use HTTP::Request;
use LWP;

my $INGEST_TOKEN = "TOKEN";

my $uri = '$YOUR_LOGSCALE_URL/graphql';

my $json = '{"query" : "mutation {
  updatePagerDutyAction( input:
      { viewName: \"humio\",
        id: \"abc123\",
        name: \"Your-Turn\",
        severity: \"Important\",
        routingKey: \"def456\",
        useProxy: false
      }
  )
  { severity }
}"
}';
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 {
  updatePagerDutyAction( input:
      { viewName: \"humio\",
        id: \"abc123\",
        name: \"Your-Turn\",
        severity: \"Important\",
        routingKey: \"def456\",
        useProxy: false
      }
  )
  { severity }
}"
}'''

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 {
  updatePagerDutyAction( input:
      { viewName: \"humio\",
        id: \"abc123\",
        name: \"Your-Turn\",
        severity: \"Important\",
        routingKey: \"def456\",
        useProxy: false
      }
  )
  { severity }
}"
}
);


const options = {
  hostname: '$YOUR_LOGSCALE_URL/graphql',
  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": {
    "updatePagerDutyAction": {
      "severity": "Important"
    }
  }
}

Given Datatypes

For UpdatePagerDutyAction, there are a few parameters. Below is a list of them along with a description of each:

Table: UpdatePagerDutyAction

ParameterTypeRequiredDefaultStabilityDescription
Some arguments may be required, as indicated in the Required column. For some fields, this column indicates that a result will always be returned for this column.
Table last updated: Sep 23, 2024
idstringyes  The unique identifier of the action.
namestringyes  The name of the action.
routingKeystringyes  The routing key to authenticate with PagerDuty.
severitystringyes  The severity level to pass to the message.
useProxybooleanyes  Defines whether the action should use the configured proxy to make web requests.
viewNamestringyes  The name of the view of the action.

Returned Datatypes

The returned datatype PagerDutyAction has several parameters. Below is a list of them along with a description of each:

Table: PagerDutyAction

ParameterTypeRequiredDefaultStabilityDescription
Some arguments may be required, as indicated in the Required column. For some fields, this column indicates that a result will always be returned for this column.
Table last updated: Sep 27, 2024
allowedActionsAssetActionyes  The asset actions allowed. See AssetAction.
displayNamestringyes  The display name of the action.
idstringyes  The unique identifier of the action.
isAllowedToRunbooleanyes  False if this type of action is disabled because of a security policy, true otherwise.
namestringyes  The name of the action.
packagePackageInstallationyes  The package, if any, of which the action is part. See PackageInstallation.
packageIdVersionedPackageSpecifier   The identifier of the package, if any. VersionedPackageSpecifier is a scalar.
routingKeystringyes  Routing key to authenticate with PagerDuty.
requiresOrganizationOwnedQueriesPermissionToEditbooleanyes  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.
severitystringyes  Severity level to give to the message.
useProxybooleanyes  Defines whether the action should use the configured proxy to make web requests.
yamlTemplateyamlyes  A template that can be used to recreate the action.