API Stability Long-Term

The createOpsGenieAction() GraphQL mutation may be used to create an OpsGenie action.

For more information on creating an OpsGenie action, see the Action Type: OpsGenie documentation page. You may also want to look at the Actions page for related information.

Syntax

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

graphql
createOpsGenieAction(
      input: CreateOpsGenieAction!
   ): OpsGenieAction!

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

Raw
graphql
mutation {
  createOpsGenieAction(input:
    { viewName: "humio",
      name: "genie-act",
      genieKey: "PB2pWsFK2V6k9I2xCtI3Xres8xQPx9F5~oc0UaoltdtXTSIKDBQkot65Ml7ncsJb9Bhc9Opr8b6aJ",
      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: \"PB2pWsFK2V6k9I2xCtI3Xres8xQPx9F5~oc0UaoltdtXTSIKDBQkot65Ml7ncsJb9Bhc9Opr8b6aJ\",
      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: \"PB2pWsFK2V6k9I2xCtI3Xres8xQPx9F5~oc0UaoltdtXTSIKDBQkot65Ml7ncsJb9Bhc9Opr8b6aJ\",
      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: \"PB2pWsFK2V6k9I2xCtI3Xres8xQPx9F5~oc0UaoltdtXTSIKDBQkot65Ml7ncsJb9Bhc9Opr8b6aJ\", ^
      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: \"PB2pWsFK2V6k9I2xCtI3Xres8xQPx9F5~oc0UaoltdtXTSIKDBQkot65Ml7ncsJb9Bhc9Opr8b6aJ\",
      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: \"PB2pWsFK2V6k9I2xCtI3Xres8xQPx9F5~oc0UaoltdtXTSIKDBQkot65Ml7ncsJb9Bhc9Opr8b6aJ\",
      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: \"PB2pWsFK2V6k9I2xCtI3Xres8xQPx9F5~oc0UaoltdtXTSIKDBQkot65Ml7ncsJb9Bhc9Opr8b6aJ\",
      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: \"PB2pWsFK2V6k9I2xCtI3Xres8xQPx9F5~oc0UaoltdtXTSIKDBQkot65Ml7ncsJb9Bhc9Opr8b6aJ\",
      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": "bdN6ikgTdoRJHigZjvfoTThtGGBjRP4r",
      "isAllowedToRun": true
    }
  }
}

Given Datatypes

For CreateOpsGenieAction, there are a few parameters that may be given. Below is a list of them along with descriptions of each:

Table: CreateOpsGenieAction

ParameterTypeRequiredDefaultStabilityDescription
Some arguments may be required, as indicated in the Required column. For return datatypes, this indicates that you must specify which fields you want returned in the results.
Table last updated: Sep 17, 2024
apiUrlstringyes Long-TermOpsGenie webhook URL to where the request is to be sent.
genieKeystringyes Long-TermKey to authenticate with OpsGenie.
namestringyes Long-TermName of the action.
useProxybooleanyes Long-TermDefines whether the action should use the configured proxy to make web requests.
viewNamestringyes Long-TermName of the view of the action.

Returned Datatypes

OpsGenieAction has a few parameters. Below is a list of them:

Table: OpsGenieAction

ParameterTypeRequiredDefaultStabilityDescription
Some arguments may be required, as indicated in the Required column. For return datatypes, this indicates that you must specify which fields you want returned in the results.
Table last updated: Sep 30, 2025
allowedActions[AssetAction]yes Short-TermThe allowed asset actions. See AssetAction . This is a preview and subject to change.
apiUrlstringyes Long-TermOpsGenie webhook url to send the request to.
createdInfoAssetCommitMetadata  Long-TermMetadata related to the creation of the action. See AssetCommitMetadata.
displayNamestringyes Long-TermThe display name of the action.
genieKeystringyes Long-TermKey to authenticate with OpsGenie.
idstringyes Long-TermThe unique identifier of the action.
isAllowedToRunbooleanyes Long-TermWhether the action is enabled.
labels[string]  PreviewAny labels associated with the action.
modifiedInfoAssetCommitMetadata  Long-TermMetadata related to the latest modification of the action. See AssetCommitMetadata.
namestringyes Long-TermThe name of the action.
packagePackageInstallation  Long-TermThe package, if any, of which the action is part. See PackageInstallation.
requiresOrganizationOwnedQueriesPermissionToEditbooleanyes Long-TermTrue 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-TermThe resource identifier for the action.
useProxybooleanyes Long-TermDefines whether the action should use the configured proxy to make web requests.
yamlTemplateYAMLyes Long-TermA template that can be used to recreate the action. YAML is a scalar.