API Stability Short-Term

The s3ResetArchiving() GraphQL mutation is used to mark all of the segment files as unarchived.

For more information on S3 storage, see the S3 Archiving documentation page.

Syntax

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

graphql
s3ResetArchiving(
      repositoryName: string!,
      archivalKind: ArchivalKind
   ): BooleanResultType!

Given Datatypes

For ArchivalKind, there are a few choices. Below is a list of them:

Table: ArchivalKind

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
All   Short-TermReset only the cluster wide archiving.
ClusterWideOnly   Short-TermReset all archiving types.
RepoOnly  ✓Short-TermReset only the repository archiving.

Returned Datatypes

The returned datatype BooleanResultType has its own parameters. Below is a list of them along with their datatypes and a description of each:

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.