disableScheduledReport()

🎯API Stability

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

Summary

The disableScheduledReport() mutation disables an existing scheduled report in a LogScale view or repository, stopping future report delivery without deleting the report configuration. To resume delivery after disabling, use enableScheduledReport().

To re-enable a scheduled report, use enableScheduledReport(). To create a new scheduled report, use createScheduledReport(). To modify an existing scheduled report, use updateScheduledReport(). To permanently remove a scheduled report, use deleteScheduledReport().

Use the scheduledReport() query to retrieve information about a scheduled report, including its unique identifier. The following example shows how to retrieve report IDs from a repository.

Hide Query Example

Show Scheduled Reports Query

To get a list of scheduled reports for a specific repository, use the repository() query as shown here:

graphql

query {
     repository(name: "humio") {
       scheduledReports {
         id
         name
         schedule {
           startDate
           endDate
         }
       }
     }
   }

Syntax

graphql

disableScheduledReport(
      input: DisableScheduledReportInput!
   ): Boolean!

The mutation accepts a single required input argument of type DisableScheduledReportInput!, which contains the view or repository name and the scheduled report ID. The mutation returns a non-null Boolean! confirming whether the operation succeeded.

Example

Raw

graphql

mutation {
  disableScheduledReport( input:
    { viewName: "humio",
      id: "abc123"
    } )
}

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 {
  disableScheduledReport( input:
    { viewName: \"humio\",
      id: \"abc123\"
    } )
}"
}
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 {
  disableScheduledReport( input:
    { viewName: \"humio\",
      id: \"abc123\"
    } )
}"
}
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 { ^
  disableScheduledReport( input: ^
    { viewName: \"humio\", ^
      id: \"abc123\" ^
    } ) ^
}" ^
} '

Windows Powershell and curl

powershell

curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "mutation {
  disableScheduledReport( input:
    { viewName: \"humio\",
      id: \"abc123\"
    } )
}"
}'
    "$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 {
  disableScheduledReport( input:
    { viewName: \"humio\",
      id: \"abc123\"
    } )
}";
$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 {
  disableScheduledReport( input:
    { viewName: \"humio\",
      id: \"abc123\"
    } )
}"
}'''

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 {
  disableScheduledReport( input:
    { viewName: \"humio\",
      id: \"abc123\"
    } )
}"
}
);


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": {
    "disableScheduledReport": true
  }
}

Input Parameters

The DisableScheduledReportInput type requires two fields: the name of the view or repository that owns the scheduled report, and the unique ID of the scheduled report to disable. Use the scheduledReport() query or the repository() query shown in the preceding Related section to retrieve the report ID.

Table: DisableScheduledReportInput Input Datatype

Parameter	Type	Required	Default	Stability	Availability	Description
id	String	yes		`Long-Term`		The unique identifier of the scheduled report.
viewName	String	yes		`Long-Term`		The name of the view of the scheduled report.

Versions of this Page

GraphQL Mutations

GraphQL API

GraphQL Queries

GraphQL Datatypes