API Stability Short-Term

The s3ConfigureArchiving() GraphQL mutation is used to configure S3 archiving for a repository (e.g., bucket and region).

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

Syntax

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

graphql
s3ConfigureArchiving(
     repositoryName: string!,
     bucket: string!,
     region: string!,
     format: S3ArchivingFormat!,
     tagOrderInName: [string],
     startFromDateTime: datetime, 
     roleArn: string
   ): BooleanResultType!

Example

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

Raw
graphql
mutation {
  s3ConfigureArchiving(
    repositoryName: "humio",
    bucket: "pale-1",
    region: "us-west-1",
    format: RAW,
    tagOrderInName: ["admin", "other"]
  )
  { 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 {
  s3ConfigureArchiving(
    repositoryName: \"humio\",
    bucket: \"pale-1\",
    region: \"us-west-1\",
    format: RAW,
    tagOrderInName: [\"admin\", \"other\"]
  )
  { 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 {
  s3ConfigureArchiving(
    repositoryName: \"humio\",
    bucket: \"pale-1\",
    region: \"us-west-1\",
    format: RAW,
    tagOrderInName: [\"admin\", \"other\"]
  )
  { 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 { ^
  s3ConfigureArchiving( ^
    repositoryName: \"humio\", ^
    bucket: \"pale-1\", ^
    region: \"us-west-1\", ^
    format: RAW, ^
    tagOrderInName: [\"admin\", \"other\"] ^
  ) ^
  { result } ^
}" ^
} '
Windows Powershell and curl
powershell
curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "mutation {
  s3ConfigureArchiving(
    repositoryName: \"humio\",
    bucket: \"pale-1\",
    region: \"us-west-1\",
    format: RAW,
    tagOrderInName: [\"admin\", \"other\"]
  )
  { 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 {
  s3ConfigureArchiving(
    repositoryName: \"humio\",
    bucket: \"pale-1\",
    region: \"us-west-1\",
    format: RAW,
    tagOrderInName: [\"admin\", \"other\"]
  )
  { 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 {
  s3ConfigureArchiving(
    repositoryName: \"humio\",
    bucket: \"pale-1\",
    region: \"us-west-1\",
    format: RAW,
    tagOrderInName: [\"admin\", \"other\"]
  )
  { 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 {
  s3ConfigureArchiving(
    repositoryName: \"humio\",
    bucket: \"pale-1\",
    region: \"us-west-1\",
    format: RAW,
    tagOrderInName: [\"admin\", \"other\"]
  )
  { 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": {
    "s3ConfigureArchiving": {
      "result": true
    }
  }
}

Given Datatypes

The given datatype S3ArchivingFormat is an enumerated list. Its values are listed here:

Table: S3ArchivingFormat

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 9, 2025
NDJSON   Short-TermThe format for archival storage in AWS S3 is newline delimited JSON.
RAW   Short-TermThe format for archival storage of segments in AWS S3 is raw.

Returned Datatypes

The returned datatype BooleanResultType has its one parameter. It's described below:

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.