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

Hide Query Example

Show Retention Settings Query

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

API Stability Long-Term
Security Requirement & Control ManageCluster API permission
  ManageOrganizations API permission

Syntax

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

You'll have to give the name of the repository, and the retention settings you want to change. See the Given Datatype section for details.

For the results, you can get the search domain's identifier, a list packages installed, etc. See the Returned Datatype section for more.

Example

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": "abc123"
      }
    }
  }
}

Given Datatype

For the input, you would provide the name of the repository, and the retention settings you want to change. The table below lists your choices. Click on the Show Query above the Syntax section for an example of how to see the current retention settings.

Table: Input Using Standard Datatypes

Parameter Type Required Default Description
ingestSizeBasedRetention float     Sets retention in gigabytes based on the size of data when it arrives to LogScale, that is before parsing and compression. LogScale will keep at most this amount.
repositoryName string yes   The name of the repository.
storageSizeBasedRetention float     Sets retention in gigabytes based on the size of data when it is stored in LogScale, that is after parsing and compression. LogScale will keep at most this amount.
timeBasedBackupRetention float     The maximum days to keep data. Older data will be deleted.
timeBasedRetention float     Sets days to keep backups before they are deleted.

Returned Datatype

With this returned datatype, through sub-parameters, you can get the unique identifier of the search domain, a list packages installed, and other information about the search domain. The table below contains a link to another table with 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.