API Stability Long-Term

The addIngestTokenV3() GraphQL mutation is used to create a new Ingest API Token.

For more information on ingest tokens, see the Ingest Tokens documentation page.

Syntax

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

graphql
addIngestTokenV3(
      input: AddIngestTokenV3Input!
    ): IngestToken!

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

Show:
graphql
mutation {
  addIngestTokenV3(input: {repositoryName: "humio", name: "tokener1"} )
      { name, token, parser { id, name, displayName} }
}

Given Datatypes

For AddIngestTokenV3Input(), there are several parameters that may be given. Below is a list of them along with a description of each:

Table: AddIngestTokenV3Input

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 17, 2024
customTokenstring  Long-TermThe custom token string. This requires special permissions and root privileges.
namestringyes Long-TermThe name of the ingest token to create.
parserstring  Long-TermThe unique identifier or name of the parser to assign to the ingest token. Parsers in packages can be referred to as packagescope/packagename:parsername.
repositoryNamestringyes Long-TermThe name of the repository.

Returned Datatypes

IngestToken has a few parameters. They're listed and described below:

Table: IngestToken

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 25, 2024
namestringyes Long-TermThe name of ingest token.
parserParseryes Long-TermThe parser with which the token is associated. See Parser.
tokenstringyes Long-TermThe token.