The configureAzureArchiving() GraphQL mutation is used to configure Azure archiving for a repository, such as a bucket.

Related to this mutation are a few other mutation fields for archiving: disableArchiving() and enableArchiving() to disable and enable archiving in general; and the restartArchiving() mutation for restarting archiving.

Hide Query Example

Show Archiving Settings Query

Stability Level Preview

Syntax

graphql
configureAzureArchiving(
       repositoryName: string!, 
       bucket: string!, 
       tagOrderInName: [string], 
       startFromDateTime: datetime,
       endAtDateTime: datetime,
       format: ArchivingFormat!
    ): BooleanResultType!

For the input, you'll have to give the repository's name, the storage bucket to use, the start and end times, and the format used. See the Given Datatype section for details.

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

Example

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

Given Datatype

For the input, you'll have to give the name of the repository, and the Azure storage bucket to use. You can also give the start and end times for archiving. These parameters use typical datatypes and are listed in the table here. Regarding the format used to store archived segments in AWS S3, see the next table.

Table: Input Using Standard Datatypes

Parameter Type Required Default Description
bucket string yes   The Azure archive bucket used.
endAtDateTime datetime     The date and time archiving will end.
repositoryName string yes   The name of the repository to archive.
startFromDateTime datetime     The date and time archiving will start.
tagOrderInName [string]     Any names of tag fields to use — in that order.

With this special input datatype, you would specify the format used to store archived segments in AWS S3. The table below lists the choices:

Table: ArchivingFormat

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
NDJSON   Short-TermSet to this if the archive format uses the Newline Delimited JSON format.
RAW   Short-TermUsed to indicate the archive is raw, unformatted data.

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.