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:

Raw
graphql
mutation {
  addIngestTokenV3(input: {repositoryName: "humio", name: "tokener1"} )
      { name, token, parser { id, name, displayName} }
}
Mac OS or Linux (curl)
shell
curl -v -X POST $YOUR_LOGSCALE_URL/graphql \
    -H "Authorization: Bearer $TOKEN" \
    -H "Content-Type: application/json" \
    -d @- << EOF
{"query" : "mutation {
  addIngestTokenV3(input: {repositoryName: \"humio\", name: \"tokener1\"} )
      { name, token, parser { id, name, displayName} }
}"
}
EOF
Mac OS or Linux (curl) One-line
shell
curl -v -X POST $YOUR_LOGSCALE_URL/graphql \
    -H "Authorization: Bearer $TOKEN" \
    -H "Content-Type: application/json" \
    -d @- << EOF
{"query" : "mutation {
  addIngestTokenV3(input: {repositoryName: \"humio\", name: \"tokener1\"} )
      { name, token, parser { id, name, displayName} }
}"
}
EOF
Windows Cmd and curl
shell
curl -v -X POST $YOUR_LOGSCALE_URL/graphql ^
    -H "Authorization: Bearer $TOKEN" ^
    -H "Content-Type: application/json" ^
    -d @'{"query" : "mutation { ^
  addIngestTokenV3(input: {repositoryName: \"humio\", name: \"tokener1\"} ) ^
      { name, token, parser { id, name, displayName} } ^
}" ^
} '
Windows Powershell and curl
powershell
curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "mutation {
  addIngestTokenV3(input: {repositoryName: \"humio\", name: \"tokener1\"} )
      { name, token, parser { id, name, displayName} }
}"
}'
"$YOUR_LOGSCALE_URL/graphql"
Perl
perl
#!/usr/bin/perl

use HTTP::Request;
use LWP;

my $INGEST_TOKEN = "TOKEN";

my $uri = '$YOUR_LOGSCALE_URL/graphql';

my $json = '{"query" : "mutation {
  addIngestTokenV3(input: {repositoryName: \"humio\", name: \"tokener1\"} )
      { name, token, parser { id, name, displayName} }
}"
}';
my $req = HTTP::Request->new("POST", $uri );

$req->header("Authorization" => "Bearer $TOKEN");
$req->header("Content-Type" => "application/json");

$req->content( $json );

my $lwp = LWP::UserAgent->new;

my $result = $lwp->request( $req );

print $result->{"_content"},"\n";
Python
python
#! /usr/local/bin/python3

import requests

url = '$YOUR_LOGSCALE_URL/graphql'
mydata = r'''{"query" : "mutation {
  addIngestTokenV3(input: {repositoryName: \"humio\", name: \"tokener1\"} )
      { name, token, parser { id, name, displayName} }
}"
}'''

resp = requests.post(url,
                     data = mydata,
                     headers = {
   "Authorization" : "Bearer $TOKEN",
   "Content-Type" : "application/json"
}
)

print(resp.text)
Node.js
javascript
const https = require('https');

const data = JSON.stringify(
    {"query" : "mutation {
  addIngestTokenV3(input: {repositoryName: \"humio\", name: \"tokener1\"} )
      { name, token, parser { id, name, displayName} }
}"
}
);


const options = {
  hostname: '$YOUR_LOGSCALE_URL/graphql',
  path: '/graphql',
  port: 443,
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'Content-Length': data.length,
    Authorization: 'BEARER ' + process.env.TOKEN,
    'User-Agent': 'Node',
  },
};

const req = https.request(options, (res) => {
  let data = '';
  console.log(`statusCode: ${res.statusCode}`);

  res.on('data', (d) => {
    data += d;
  });
  res.on('end', () => {
    console.log(JSON.parse(data).data);
  });
});

req.on('error', (error) => {
  console.error(error);
});

req.write(data);
req.end();

Given Datatypes

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

Table: AddIngestTokenV3Input

ParameterTypeRequiredDefaultDescription
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  The custom token string. This requires special permissions and root privileges.
namestringyes The name of the ingest token to create.
Parserstring  The 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 The name of the repository.

Returned Datatypes

As indicated by the syntax above, this mutation will return data using the datatype, IngestToken. Below is a list of the parameters of that datatype:

Table: IngestToken

ParameterTypeRequiredDefaultDescription
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 The name of ingest token.
ParserParseryes The parser with which the token is associated. See Parser.
tokenstringyes The token.