assignParserToIngestTokenV2()

API Stability Long-Term

The assignParserToIngestTokenV2() GraphQL mutation is used to assign an ingest token to be associated with a parser.

Syntax

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

graphql
assignParserToIngestTokenV2(
       input: AssignParserToIngestTokenInputV2!
    ): IngestToken!

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

Show:
graphql
mutation {
	assignParserToIngestTokenV2( input:
	  { repositoryName: "humio",
      tokenName: "my-token",
      parser: "kv"
    } )
  { name }
}
Example Responses
Show:
json
{
  "data": {
    "assignParserToIngestTokenV2": {
      "name": "my-token"
    }
  }
}

Given Datatypes

For AssignParserToIngestTokenInputV2, there are a few parameters. Below is a list of them along with a description of each:

Table: AssignParserToIngestTokenInputV2

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
parserstringyes 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.
tokenNamestringyes Long-TermThe name of the ingest token.

Returned Data Types

IngestToken returns a few parameters and sub-parameters. They're 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.