API Stability Short-Term

The restartArchiving() GraphQL mutation may be used to mark all segment files as unarchived.

Related to this mutation there is the disableArchiving() mutation to disable archiving, and the enableArchiving() to enable archiving.

Hide Query Example

Show Repository Archiving Settings Query

Syntax

graphql
restartArchiving(
      repositoryName: string!, 
      archivalKind: ArchivalKind
   ): BooleanResultType!

Example

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

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

Given Datatype

For this input datatype, you'll have to choose which archiving type to reset. Below is a list of choices along with descriptions of each:

Table: ArchivalKind

ParameterTypeRequiredDefaultStabilityDescription
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: May 8, 2025
All   Short-TermReset only the cluster wide archiving.
ClusterWideOnly   Short-TermReset all archiving types.
RepoOnly  ✓Short-TermReset only the repository archiving.

Returned Datatype

For this datatype, the only result is whether the mutation was successful or not. The table below describes this:

Table: BooleanResultType

ParameterTypeRequiredDefaultStabilityDescription
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 24, 2024
resultsbooleanyes Long-TermWhether the mutation was performed.