🔒Security Requirements and Controls
🎯API Stability
Long-TermThis API is stable and will remain supported across versions with minimal breaking changes.

Summary

The createOpsGenieAction() mutation creates a new OpsGenie action in a LogScale view. OpsGenie actions can send notifications to your OpsGenie incident management system when alert conditions are met. Define the action once using this mutation, then attach it to aggregate or filter alerts in that view.

Syntax

graphql
createOpsGenieAction(
      input: CreateOpsGenieAction!
   ): OpsGenieAction!

The input argument is required and takes a CreateOpsGenieAction object. Provide the view name, a display name for the action, the OpsGenie webhook URL, an OpsGenie API key, and whether to route requests through your configured HTTP proxy. An optional labels field accepts up to 10 labels for organizing actions. The mutation returns a non-null OpsGenieAction! object representing the newly created action.

Example

Raw
graphql
mutation {
  createOpsGenieAction(input:
    { viewName: "humio",
      name: "genie-act",
      genieKey: "abc123-def456-ghi789",
      apiUrl: "https://genie.company.com",
      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 {
  createOpsGenieAction(input:
    { viewName: \"humio\",
      name: \"genie-act\",
      genieKey: \"abc123-def456-ghi789\",
      apiUrl: \"https://genie.company.com\",
      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 {
  createOpsGenieAction(input:
    { viewName: \"humio\",
      name: \"genie-act\",
      genieKey: \"abc123-def456-ghi789\",
      apiUrl: \"https://genie.company.com\",
      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 { ^
  createOpsGenieAction(input: ^
    { viewName: \"humio\", ^
      name: \"genie-act\", ^
      genieKey: \"abc123-def456-ghi789\", ^
      apiUrl: \"https://genie.company.com\", ^
      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 {
  createOpsGenieAction(input:
    { viewName: \"humio\",
      name: \"genie-act\",
      genieKey: \"abc123-def456-ghi789\",
      apiUrl: \"https://genie.company.com\",
      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 {
  createOpsGenieAction(input:
    { viewName: \"humio\",
      name: \"genie-act\",
      genieKey: \"abc123-def456-ghi789\",
      apiUrl: \"https://genie.company.com\",
      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 {
  createOpsGenieAction(input:
    { viewName: \"humio\",
      name: \"genie-act\",
      genieKey: \"abc123-def456-ghi789\",
      apiUrl: \"https://genie.company.com\",
      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 {
  createOpsGenieAction(input:
    { viewName: \"humio\",
      name: \"genie-act\",
      genieKey: \"abc123-def456-ghi789\",
      apiUrl: \"https://genie.company.com\",
      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": {
    "createOpsGenieAction": {
      "id": "abc123",
      "isAllowedToRun": true
    }
  }
}

Input Parameters

The CreateOpsGenieAction input type requires the view name, a display name for the action, the OpsGenie webhook URL, and an OpsGenie API key. You must also specify whether to route requests through your configured HTTP proxy. An optional labels field accepts up to 10 labels for organizing actions. The following table lists all input parameters:

Table: CreateOpsGenieAction Input Datatype

ParameterTypeRequiredDefaultStabilityAvailabilityDescription
apiUrlStringyes Long-Term OpsGenie webhook URL to where the request is to be sent.
genieKeyStringyes Long-Term Key to authenticate with OpsGenie.
labelsStringyes   Labels for the action. There can be at most 10 labels with a max length of 60 characters per label.
nameStringyes Long-Term Name of the action.
useProxyBooleanyes Long-Term Defines whether the action should use the configured proxy to make web requests.
viewNameStringyes Long-Term Name of the view of the action.

Returned Values

The mutation returns an OpsGenieAction! object. The returned object includes the action ID, name, API URL, proxy setting, labels, and audit metadata such as creation time and last modification details. Use the returned ID to reference this action when attaching it to alerts. The following table lists all available fields:

Table: OpsGenieAction Datatype

ParameterTypeRequiredDefaultStabilityAvailabilityDescription
allowedActions[AssetAction]yes Short-Term The allowed asset actions. See AssetAction . This is a preview and subject to change.
apiUrlstringyes Long-Term OpsGenie webhook url to send the request to.
createdInfoAssetCommitMetadata  Long-Term Metadata related to the creation of the action. See AssetCommitMetadata.
displayNamestringyes Long-Term The display name of the action.
genieKeystringyes Long-Term Key to authenticate with OpsGenie.
idstringyes Long-Term The unique identifier of the action.
isAllowedToRunbooleanyes Long-Term Whether the action is enabled.
labels[string]  Preview Any labels associated with the action.
modifiedInfoAssetCommitMetadata  Long-Term Metadata related to the latest modification of the action. See AssetCommitMetadata.
namestringyes Long-Term The name of the action.
packagePackageInstallation  Long-Term The package, if any, of which the action is part. See PackageInstallation.
requiresOrganizationOwnedQueriesPermissionToEditbooleanyes Long-Term True if this action is used by triggers, where the query is run by the organization. The OrganizationOwnedQueries permission is required to edit the action.
resourcestringyes Short-Term The resource identifier for the action.
useProxybooleanyes Long-Term Defines whether the action should use the configured proxy to make web requests.
yamlTemplateYAMLyes Long-Term A template that can be used to recreate the action. YAML is a scalar.