runInconsistencyCheck()

API Stability	`Preview`

The runInconsistencyCheck() GraphQL mutation is used to manually start the organization inconsistency job. This job will check for inconsistencies like orphaned entities, references to non-existent entities. The job can be run in a dry-run mode to log only what would have happened.

Syntax

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

graphql

runInconsistencyCheck(
       input: RunInconsistencyCheckInput!
    ): string!

If dryRun is set to true, any inconsistencies found will be logged with no further action taken. If set to false, any inconsistencies will be patched automatically.

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

Show:

graphql

mutation {
  runInconsistencyCheck(input:
     { dryRun: false }
  )
}

shell

curl -v -X POST $YOUR_LOGSCALE_URL/graphql \
    -H "Authorization: Bearer $TOKEN" \
    -H "Content-Type: application/json" \
    -d @- << EOF
{"query" : "mutation {
  runInconsistencyCheck(input:
     { dryRun: false }
  )
}"
}
EOF

shell

curl -v -X POST $YOUR_LOGSCALE_URL/graphql \
    -H "Authorization: Bearer $TOKEN" \
    -H "Content-Type: application/json" \
    -d @- << EOF
{"query" : "mutation {
  runInconsistencyCheck(input:
     { dryRun: false }
  )
}"
}
EOF

shell

curl -v -X POST $YOUR_LOGSCALE_URL/graphql ^
    -H "Authorization: Bearer $TOKEN" ^
    -H "Content-Type: application/json" ^
    -d @'{"query" : "mutation { ^
  runInconsistencyCheck(input: ^
     { dryRun: false } ^
  ) ^
}" ^
} '

powershell

curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "mutation {
  runInconsistencyCheck(input:
     { dryRun: false }
  )
}"
}'
    "$YOUR_LOGSCALE_URL/graphql"

perl

#!/usr/bin/perl

use HTTP::Request;
use LWP;

my $INGEST_TOKEN = "TOKEN";

my $uri = '$YOUR_LOGSCALE_URL/graphql';

my $json = '{"query" : "mutation {
  runInconsistencyCheck(input:
     { dryRun: false }
  )
}"
}';
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

#! /usr/local/bin/python3

import requests

url = '$YOUR_LOGSCALE_URL/graphql'
mydata = r'''{"query" : "mutation {
  runInconsistencyCheck(input:
     { dryRun: false }
  )
}"
}'''

resp = requests.post(url,
                     data = mydata,
                     headers = {
   "Authorization" : "Bearer $TOKEN",
   "Content-Type" : "application/json"
}
)

print(resp.text)

javascript

const https = require('https');

const data = JSON.stringify(
    {"query" : "mutation {
  runInconsistencyCheck(input:
     { dryRun: false }
  )
}"
}
);


const options = {
  hostname: '$YOUR_LOGSCALE_URL/graphql',
  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

Show:

json

{
  "data": {
    "runInconsistencyCheck": "jobId=cpjeqm63"
  }
}

Given Data Types

For RunInconsistencyCheckInput, there is one parameter that may be given. However, that one parameter has several parameters of its own. A link to that table is in the description field here.

Table: RunInconsistencyCheckInput

Parameter	Type	Required	Description
Some arguments may be required, as indicated in the Required column. For some fields, this column indicates that a result will always be returned for this column.
Table last updated: Sep 19, 2024
`dryRun`	string	yes	If set to true, any inconsistencies found will be logged and no further action taken. If false, inconsistencies will be patched automatically.

GraphQL Mutations

GraphQL API Stability

GraphQL Queries

GraphQL Datatypes