API Stability Long-Term

The updateRetention() GraphQL mutation is used to update the retention policy of a repository in LogScale.

For information on data retention in repositories, see the Data Retention documentation page.

Syntax

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

graphql
updateRetention(
      repositoryName: string!,
      ingestSizeBasedRetention: float,
      storageSizeBasedRetention: float,
      timeBasedBackupRetention: float,
      timeBasedRetention: float
   ): UpdateRetentionMutation!

There are no special input datatypes for this mutation field. Below is an example of how it might be used:

Raw
graphql
mutation {
  updateRetention(
       repositoryName: "Testeroo",
       storageSizeBasedRetention: 50
  )
  { repository { id } }
}
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 {
  updateRetention(
       repositoryName: \"Testeroo\",
       storageSizeBasedRetention: 50
  )
  { repository { id } }
}"
}
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 {
  updateRetention(
       repositoryName: \"Testeroo\",
       storageSizeBasedRetention: 50
  )
  { repository { id } }
}"
}
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 { ^
  updateRetention( ^
       repositoryName: \"Testeroo\", ^
       storageSizeBasedRetention: 50 ^
  ) ^
  { repository { id } } ^
}" ^
} '
Windows Powershell and curl
powershell
curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "mutation {
  updateRetention(
       repositoryName: \"Testeroo\",
       storageSizeBasedRetention: 50
  )
  { repository { id } }
}"
}'
    "$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 {
  updateRetention(
       repositoryName: \"Testeroo\",
       storageSizeBasedRetention: 50
  )
  { repository { id } }
}";
$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 {
  updateRetention(
       repositoryName: \"Testeroo\",
       storageSizeBasedRetention: 50
  )
  { repository { id } }
}"
}'''

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 {
  updateRetention(
       repositoryName: \"Testeroo\",
       storageSizeBasedRetention: 50
  )
  { repository { id } }
}"
}
);


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": {
    "updateRetention": {
      "repository": {
        "id": "cfeQriTyDwPerwIPCGw505lp"
      }
    }
  }
}

Returned Datatypes

The returned datatype UpdateRetentionMutation has one parameter and several sub-parameters. Click on the link below to see a table containing the sub-parameters:

Table: UpdateRetentionMutation

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: Oct 4, 2024
repositorySearchDomainyes Long-TermThe repository for which to update retention. See SearchDomain.