createLogCollectorConfiguration()

The createLogCollectorConfiguration() GraphQL mutation field is used to creates a log collector configuration. It's a preview and subject to change.

Syntax

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

graphql
createLogCollectorConfiguration(
       name: string!, draft: string
    ): LogCollectorConfiguration!

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

Raw
graphql
mutation {
  createLogCollectorConfiguration(
         name: "my-lc-config" )
  { id, name }
}
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 {
  createLogCollectorConfiguration(
         name: \"my-lc-config\" )
  { id, name }
}"
}
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 {
  createLogCollectorConfiguration(
         name: \"my-lc-config\" )
  { id, name }
}"
}
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 { ^
  createLogCollectorConfiguration( ^
         name: \"my-lc-config\" ) ^
  { id, name } ^
}" ^
} '
Windows Powershell and curl
powershell
curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "mutation {
  createLogCollectorConfiguration(
         name: \"my-lc-config\" )
  { id, name }
}"
}'
    "$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 {
  createLogCollectorConfiguration(
         name: \"my-lc-config\" )
  { id, name }
}"
}';
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 {
  createLogCollectorConfiguration(
         name: \"my-lc-config\" )
  { id, name }
}"
}'''

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 {
  createLogCollectorConfiguration(
         name: \"my-lc-config\" )
  { id, name }
}"
}
);


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();
Example Responses
Success (HTTP Response Code 200 OK)
json
{
  "data": {
    "createLogCollectorConfiguration": {
      "id": "IkJ0r6zoS64rgGxHAUyz6zhKLrY0JpXN",
      "name": "my-lc-config"
    }
  }
}

Returned Datatypes

As indicated by the syntax above, this mutation will return data using the datatype, LogCollectorConfiguration. Below is the parameter of that datatype:

Table: LogCollectorConfiguration

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 26, 2024
descriptionstring   A description of the Log Collector configuration.
draftstring   The configuration draft.
draftModifiedAtdatetimeyes  The date and time of the last draft of the configuration.
idstringyes  The unique identifier for the log collector configuration.
instancesintegeryes  The number of instances.
isTestRunningbooleanyes  Whether a test is running.
modifiedAtdatetimeyes  The date and time of the current configuration.
modifiedBystringyes  Who last modified the configuration.
namestringyes  The name assigned to the log collector configuration.
versionintegeryes  The version used.
yamlstring   Configuration in YAML format.
yamlCharactersCountintegeryes  The YAML character count.