API Stability Short-Term

The restartArchiving() GraphQL mutation may be used to mark all segment files as unarchived.

Syntax

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

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

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

Show:
graphql
mutation {
  restartArchiving(
      repositoryName: "humio",
      archivalKind: RepoOnly
     )
  { result }
}
Example Responses
Show:
json
{
  "data": {
    "restartArchiving": {
      "result": true
    }
  }
}

Given Datatypes

ArchivalKind is an enumerated list of archival types from which you may choose. Below is a list of them along with descriptions of each:

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: Mar 28, 2025
Allboolean  Short-TermReset only the cluster wide archiving.
ClusterWideOnlyboolean  Short-TermReset all archiving types.
RepoOnlyboolean Short-TermReset only the repository archiving. This is the default.

Returned Datatypes

BooleanResultType has one parameter. It's describe in the table here:

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.