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

Summary

The updateOpsGenieAction() mutation updates an existing OpsGenie action in a LogScale view. Use it to change the action name, API URL, authentication key, proxy setting, or labels after initial creation. To create a new OpsGenie action, use createOpsGenieAction() instead. All fields in the input are required except labels.

Syntax

graphql
updateOpsGenieAction(
      input: UpdateOpsGenieAction!
   ): OpsGenieAction!

The mutation accepts a single required input argument of type UpdateOpsGenieAction!. The input requires the view name, the action ID, the action name, the OpsGenie API URL, and the authentication key. The mutation returns a non-null OpsGenieAction! object representing the updated action. Use the repository() query to retrieve the action ID before calling this mutation.

Input parameters

Provide the view name and the unique action ID to identify the action to update, along with all required fields you want to set. To find the action ID, use the repository() query. All input fields except labels are required.

Table: UpdateOpsGenieAction Input Datatype

ParameterTypeRequiredDefaultStabilityAvailabilityDescription
apiUrlStringyes Long-Term The OpsGenie webhook URL where to send the request.
genieKeyStringyes Long-Term The key to authenticate with OpsGenie.
idStringyes Long-Term The unique identifier of the action.
labelsStringyes   Labels to categorize the action.
nameStringyes Long-Term The name of the action.
useProxyBooleanyes Long-Term Defines whether the action should use the configured proxy to make web requests.
viewNameStringyes Long-Term The name of the view of the action.

Example

Raw
graphql
mutation {
  updateOpsGenieAction( input:
    { viewName: "humio",
      id: "abc123",
      name: "act-now",
      apiUrl: "https://opsgenie.company.com",
      genieKey: "def456",
      useProxy: false
    }
  )
 { id }
}
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 {
  updateOpsGenieAction( input:
    { viewName: \"humio\",
      id: \"abc123\",
      name: \"act-now\",
      apiUrl: \"https://opsgenie.company.com\",
      genieKey: \"def456\",
      useProxy: false
    }
  )
 { id }
}"
}
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 {
  updateOpsGenieAction( input:
    { viewName: \"humio\",
      id: \"abc123\",
      name: \"act-now\",
      apiUrl: \"https://opsgenie.company.com\",
      genieKey: \"def456\",
      useProxy: false
    }
  )
 { id }
}"
}
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 { ^
  updateOpsGenieAction( input: ^
    { viewName: \"humio\", ^
      id: \"abc123\", ^
      name: \"act-now\", ^
      apiUrl: \"https://opsgenie.company.com\", ^
      genieKey: \"def456\", ^
      useProxy: false ^
    } ^
  ) ^
 { id } ^
}" ^
} '
Windows Powershell and curl
powershell
curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "mutation {
  updateOpsGenieAction( input:
    { viewName: \"humio\",
      id: \"abc123\",
      name: \"act-now\",
      apiUrl: \"https://opsgenie.company.com\",
      genieKey: \"def456\",
      useProxy: false
    }
  )
 { id }
}"
}'
    "$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 {
  updateOpsGenieAction( input:
    { viewName: \"humio\",
      id: \"abc123\",
      name: \"act-now\",
      apiUrl: \"https://opsgenie.company.com\",
      genieKey: \"def456\",
      useProxy: false
    }
  )
 { id }
}";
$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 {
  updateOpsGenieAction( input:
    { viewName: \"humio\",
      id: \"abc123\",
      name: \"act-now\",
      apiUrl: \"https://opsgenie.company.com\",
      genieKey: \"def456\",
      useProxy: false
    }
  )
 { id }
}"
}'''

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 {
  updateOpsGenieAction( input:
    { viewName: \"humio\",
      id: \"abc123\",
      name: \"act-now\",
      apiUrl: \"https://opsgenie.company.com\",
      genieKey: \"def456\",
      useProxy: false
    }
  )
 { id }
}"
}
);


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": {
    "updateOpsGenieAction": {
      "id": "abc123"
    }
  }
}

Returned values

The mutation returns a non-null OpsGenieAction! object. The returned object includes the action ID, name, API URL, proxy setting, labels, and audit fields such as creation and modification timestamps. 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.