API Stability Short-Term

The enableArchiving() GraphQL mutation may be used to enable an archiving job for a repository.

Syntax

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

graphql
enableArchiving(
      repositoryName: string!
   ): BooleanResultType!

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

Show:
graphql
mutation {
  enableArchiving(
      repositoryName: "humio"
     )
  { result }
}
Example Responses
Show:
json
{
  "data": {
    "enableArchiving": {
      "result": true
    }
  }
}

Returned Datatypes

BooleanResultType has one parameter. It's described 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.