The s3ResetArchiving() GraphQL mutation is used to mark all of the segment files as unarchived.

To configure S3 archiving for a respository, use the s3ConfigureArchiving() mutation. To enable and disable S3 archiving, use the s3EnableArchiving() and s3DisableArchiving() mutations.

Hide Query Example

Show S3 Archiving Query

For more information on S3 storage, see the S3 Archiving documentation page.

API Stability Short-Term

Syntax

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

You'll have to give the name of the repository, and choose which archiving type to reset. See the Given Datatype section for the choices.

For the results, you'll receive confirmation if successful through a simple parameter. See the Returned Datatype section.

Example

Raw
graphql
mutation {
  s3ResetArchiving(
     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 {
  s3ResetArchiving(
     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 {
  s3ResetArchiving(
     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 { ^
  s3ResetArchiving( ^
     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 {
  s3ResetArchiving(
     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 {
  s3ResetArchiving(
     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 {
  s3ResetArchiving(
     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 {
  s3ResetArchiving(
     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": {
    "s3ResetArchiving": {
      "result": true
    }
  }
}

Given Datatype

For the input, you'll have to choose which archiving type to reset (see second table below), and the name of the related repository.

Table: Input Using Standard Datatypes

Parameter Type Required Default Description
repositoryName string yes   The name of the repository.

For this input datatype, you'll have to choose which archiving type to reset.

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
resultbooleanyes Long-TermWhether the mutation was performed successfully.