Stability Level Preview
API Stability Preview

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

Syntax

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

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

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

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/graphql',
  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 Datatypes

For the ArchivingFormat given datatype, there are a couple of options. Below is a list of them, along with a description of each.

Table: ArchivingFormat

ParameterTypeRequiredDefaultStabilityDescription
Some arguments may be required, as indicated in the Required column. For some fields, this column indicates that a result will always be returned for this column.
Table last updated: May 8, 2025
NDJSON   PreviewSet to this if the archive format uses the Newline Delimited JSON format.
RAW   PreviewUsed to indicate the archive is raw, unformatted data.

Returned Datatypes

For BooleanResultType, there are several parameters that may be requested. Below is a list of them:

Table: BooleanResultType

ParameterTypeRequiredDefaultStabilityDescription
Some arguments may be required, as indicated in the Required column. For some fields, this column indicates that a result will always be returned for this column.
Table last updated: Sep 24, 2024
resultsbooleanyes Long-TermWhether the mutation was performed.