testVictorOpsAction()

Security Requirements and Controls

CreateActions API permission

API Stability Long-Term

The testVictorOpsAction() GraphQL mutation is used to test a VictorOps action.

To create a VictorOps action, use the createVictorOpsAction() mutation. You can use the updateVictorOpsAction() to update one and the deleteActionV2() to delete an action.

Hide Query Example

Show VictorOps Actions Query

To get a list of VictorOps actions, you could use the repository() query like so:

graphql

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

For more information on VictorOps actions, see the Action Type: VictorOps (Splunk On-Call) documentation page. You may also want to look at the Actions page for related information.

Syntax

graphql

testVictorOpsAction(
      input: TestVictorOpsAction!
   ): TestResult!

For the input, you'll have to provide several parameters and values for the action you want to test. See the Given Datatype for more details.

Example

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

Raw

graphql

mutation {
  testVictorOpsAction( input: 
    { viewName: "humio",
      name: "act-up",
      messageType: "warning",
      notifyUrl: "https://victorops.company.com",
      useProxy: false,
      triggerName: "wake-up",
      eventData: "[{\"#type\":\"kv\"}]",
      } )
  { success }
}

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 {
  testVictorOpsAction( input: 
    { viewName: \"humio\",
      name: \"act-up\",
      messageType: \"warning\",
      notifyUrl: \"https://victorops.company.com\",
      useProxy: false,
      triggerName: \"wake-up\",
      eventData: \"[{\\"#type\\":\\"kv\\"}]\",
      } )
  { success }
}"
}
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 {
  testVictorOpsAction( input: 
    { viewName: \"humio\",
      name: \"act-up\",
      messageType: \"warning\",
      notifyUrl: \"https://victorops.company.com\",
      useProxy: false,
      triggerName: \"wake-up\",
      eventData: \"[{\\"#type\\":\\"kv\\"}]\",
      } )
  { success }
}"
}
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 { ^
  testVictorOpsAction( input:  ^
    { viewName: \"humio\", ^
      name: \"act-up\", ^
      messageType: \"warning\", ^
      notifyUrl: \"https://victorops.company.com\", ^
      useProxy: false, ^
      triggerName: \"wake-up\", ^
      eventData: \"[{\\"#type\\":\\"kv\\"}]\", ^
      } ) ^
  { success } ^
}" ^
} '

Windows Powershell and curl

powershell

curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "mutation {
  testVictorOpsAction( input: 
    { viewName: \"humio\",
      name: \"act-up\",
      messageType: \"warning\",
      notifyUrl: \"https://victorops.company.com\",
      useProxy: false,
      triggerName: \"wake-up\",
      eventData: \"[{\\"#type\\":\\"kv\\"}]\",
      } )
  { success }
}"
}'
    "$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 {
  testVictorOpsAction( input: 
    { viewName: \"humio\",
      name: \"act-up\",
      messageType: \"warning\",
      notifyUrl: \"https://victorops.company.com\",
      useProxy: false,
      triggerName: \"wake-up\",
      eventData: \"[{\\"#type\\":\\"kv\\"}]\",
      } )
  { success }
}";
$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 {
  testVictorOpsAction( input: 
    { viewName: \"humio\",
      name: \"act-up\",
      messageType: \"warning\",
      notifyUrl: \"https://victorops.company.com\",
      useProxy: false,
      triggerName: \"wake-up\",
      eventData: \"[{\\"#type\\":\\"kv\\"}]\",
      } )
  { success }
}"
}'''

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 {
  testVictorOpsAction( input: 
    { viewName: \"humio\",
      name: \"act-up\",
      messageType: \"warning\",
      notifyUrl: \"https://victorops.company.com\",
      useProxy: false,
      triggerName: \"wake-up\",
      eventData: \"[{\\"#type\\":\\"kv\\"}]\",
      } )
  { success }
}"
}
);


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": {
    "testVictorOpsAction": {
      "success": false
    }
  }
}

Given Datatype

For this input datatype, you would provide the name of the view associated with the action to test, a trigger name — which can be a mock value for testing — the URL where to send requests, and some other parameters. These are listed and explained in the table below:

Table: TestVictorOpsAction

Parameter	Type	Required	Stability	Description
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 20, 2024
eventData	string	yes	`Long-Term`	JSON data representing one or more events. One event can be supplied as a JSON object. Multiple events must be supplied as a list of JSON objects.
messageType	string	yes	`Long-Term`	The type of the VictorOps message to make.
name	string	yes	`Long-Term`	The name of the action.
notifyUrl	string	yes	`Long-Term`	The VictorOps webhook URL where to send the request.
triggerName	string	yes	`Long-Term`	The name of the action. This is a mock value; the trigger doesn't have to exist.
useProxy	boolean	yes	`Long-Term`	Defines whether the action should use the configured proxy to make web requests.
viewName	string	yes	`Long-Term`	The name of the view of the action.

Returned Datatype

The returned datatype will tell you if the test was succesful and it will provide a message explaining results. This is described in the table below:

Table: TestResult

Parameter	Type	Required	Stability	Description
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: Oct 3, 2024
message	string	yes	`Long-Term`	A message explaining the test result.
success	boolean	yes	`Long-Term`	True if the test was a success, false otherwise.

Versions of this Page

GraphQL Mutations

GraphQL API Stability

GraphQL Queries

GraphQL Datatypes