Summary

The gcsConfigureArchiving() GraphQL mutation may be used to configure GCS archiving for a repository (e.g., bucket).

API Stability Preview

Syntax

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

You'll have to give the repository name, and the storage bucket. You can also specify the start and end date and times, and tags for ordering. See the Input Parameters section for details.

For the results, you'll receive confirmation if successful. See the Returned Values section.

Example

Raw
graphql
mutation {
  gcsConfigureArchiving( 
      repositoryName: "humio",
      bucket: "pale-1",
      format: NDJSON,
      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 {
  gcsConfigureArchiving( 
      repositoryName: \"humio\",
      bucket: \"pale-1\",
      format: NDJSON,
      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 {
  gcsConfigureArchiving( 
      repositoryName: \"humio\",
      bucket: \"pale-1\",
      format: NDJSON,
      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 { ^
  gcsConfigureArchiving(  ^
      repositoryName: \"humio\", ^
      bucket: \"pale-1\", ^
      format: NDJSON, ^
      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 {
  gcsConfigureArchiving( 
      repositoryName: \"humio\",
      bucket: \"pale-1\",
      format: NDJSON,
      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 {
  gcsConfigureArchiving( 
      repositoryName: \"humio\",
      bucket: \"pale-1\",
      format: NDJSON,
      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 {
  gcsConfigureArchiving( 
      repositoryName: \"humio\",
      bucket: \"pale-1\",
      format: NDJSON,
      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 {
  gcsConfigureArchiving( 
      repositoryName: \"humio\",
      bucket: \"pale-1\",
      format: NDJSON,
      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": {
    "gcsConfigureArchiving": {
      "result": true
    }
  }
}

Input Parameters

For the input, you need to give the repository name, and the storage bucket. You can also specify the start and end date and times, and tags for ordering (see the second table below).

Table: Input Parameters & Datatypes

Parameter Type Required Default Description
This table contains all input parameters for this mutation. Since one of the parameters uses a special datatype, an additional table is included below with its parameters.
bucket string yes   The bucket for archiving.
endAtDateTime datetime     The date and time at which to end archiving.
format ArchivingFormat     The format to store archived segments. See table below.
repositoryName string yes   The name of the repository.
startFromDateTime datetime     The date and time at which to start archiving.
tagOrderInName string yes   Names of tag fields to use in that order in the output file names.

For archiving, you'll have to choose the format to use. Below is a list of them along with descriptions of each:

Table: ArchivingFormat Enum Datatype

ParameterTypeRequiredDefaultStabilityDescription
Some input parameters may be required, as indicated in the Required column. For return values, this indicates that you are assured a value if the field is requested for 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 Values

For the results, the only value indicates whether the mutation was successful or not. The table below describes this:

Table: BooleanResultType Datatype

ParameterTypeRequiredDefaultStabilityDescription
Some input parameters may be required, as indicated in the Required column. For return values, this indicates that you are assured a value if the field is requested for the results.
Table last updated: Sep 24, 2024
resultbooleanyes Long-TermWhether the mutation was performed successfully.