🎯API Stability
Short-TermThis API may change in future versions. Use with caution in production environments.

Summary

The disableArchiving() mutation disables the archiving job for a named repository. It stops LogScale from writing new data to the configured archiving provider without removing the archiving configuration or affecting previously archived data. To re-enable archiving, use enableArchiving(). To reset and restart a failed or stalled archiving job, use restartArchiving().

Syntax

graphql
disableArchiving(
      repositoryName: String!
   ): BooleanResultType!

The mutation accepts one required argument, repositoryName, identifying the target repository. It returns a non-null BooleanResultType indicating whether the operation succeeded.

Example

Raw
graphql
mutation {
  disableArchiving(
      repositoryName: "humio"
     )
  { result }
}
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 {
  disableArchiving(
      repositoryName: \"humio\"
     )
  { result }
}"
}
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 {
  disableArchiving(
      repositoryName: \"humio\"
     )
  { result }
}"
}
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 { ^
  disableArchiving( ^
      repositoryName: \"humio\" ^
     ) ^
  { result } ^
}" ^
} '
Windows Powershell and curl
powershell
curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "mutation {
  disableArchiving(
      repositoryName: \"humio\"
     )
  { result }
}"
}'
    "$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 {
  disableArchiving(
      repositoryName: \"humio\"
     )
  { result }
}";
$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 {
  disableArchiving(
      repositoryName: \"humio\"
     )
  { result }
}"
}'''

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 {
  disableArchiving(
      repositoryName: \"humio\"
     )
  { result }
}"
}
);


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

Input Parameters

This mutation requires one input parameter: the name of the repository on which to disable archiving.

Table: Input Parameters & Datatypes

Parameter Type Required Default Description
This table contains all input parameters for this mutation.
repositoryName string yes   The name of the repository for which to disable archiving. This must match the exact repository name in LogScale.

Returned Values

The mutation returns a non-null BooleanResultType indicating whether the archiving job was successfully disabled. A true result means LogScale has stopped scheduling new archiving work for the repository. The archiving configuration is preserved, and existing archived data is unaffected. The following table describes the fields of this type.

Table: BooleanResultType Datatype

ParameterTypeRequiredDefaultStabilityAvailabilityDescription
resultBooleanyes Long-Term Whether the mutation was performed successfully.