gcsConfigureArchiving()

API Stability	`Preview`

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

Syntax

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

graphql

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

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

Show:

graphql

mutation {
  gcsConfigureArchiving( 
      repositoryName: "humio",
      bucket: "pale-1",
      format: NDJSON,
      tagOrderInName: ["admin", "other"],
  )
  { result }
}

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

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

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 } ^
}" ^
} '

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

#!/usr/bin/perl

use HTTP::Request;
use LWP;

my $INGEST_TOKEN = "TOKEN";

my $uri = '$YOUR_LOGSCALE_URL/graphql';

my $json = '{"query" : "mutation {
  gcsConfigureArchiving( 
      repositoryName: \"humio\",
      bucket: \"pale-1\",
      format: NDJSON,
      tagOrderInName: [\"admin\", \"other\"],
  )
  { result }
}"
}';
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

#! /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)

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/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

Show:

json

{
  "data": {
    "gcsConfigureArchiving": {
      "result": true
    }
  }
}

Given Datatypes

ArchivingFormat is an enumerated list of formats from which to choose. Below is a list of them along with descriptions of each:

Table: ArchivingFormat

Parameter	Type	Stability	Description
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: Mar 12, 2025
`NDJSON`	boolean	`Preview`	Whether the archive format uses the Newline Delimited JSON format.
`RAW`	boolean	`Preview`	Whether the archive is in raw data, unformatted.

Returned Datatypes

BooleanResultType has one parameter. It's described here:

Table: BooleanResultType

Parameter	Type	Required	Stability	Description
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
`results`	boolean	yes	`Long-Term`	Whether the mutation was performed.

GraphQL Mutations

GraphQL API Stability

GraphQL Queries

GraphQL Datatypes