Summary

The deleteLogCollectorConfiguration() GraphQL mutation may be used to delete a Log Collector configuration.

API Stability Long-Term

Syntax

graphql
deleteLogCollectorConfiguration(
      configId: string!, 
      versionId: integer!
   ): boolean

For the input, you'll have to provide the unique identifier of the LogCollector configuration and the version number to delete. You can get the identifier by using the logCollectorConfiguration() query. See the Input Parameters section. For the results, you'll receive confirmation if successful.

Example

Raw
graphql
mutation {
  deleteLogCollectorConfiguration( 
         configId: "abc123",
         versionId: 24
  )
}
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 {
  deleteLogCollectorConfiguration( 
         configId: \"abc123\",
         versionId: 24
  )
}"
}
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 {
  deleteLogCollectorConfiguration( 
         configId: \"abc123\",
         versionId: 24
  )
}"
}
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 { ^
  deleteLogCollectorConfiguration(  ^
         configId: \"abc123\", ^
         versionId: 24 ^
  ) ^
}" ^
} '
Windows Powershell and curl
powershell
curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "mutation {
  deleteLogCollectorConfiguration( 
         configId: \"abc123\",
         versionId: 24
  )
}"
}'
    "$YOUR_LOGSCALE_URL/graphql"
Perl
perl
#!/usr/bin/perl

use HTTP::Request;
use LWP;

my $TOKEN = "TOKEN";

my $uri = '$YOUR_LOGSCALE_URL/graphql';

my $query = "mutation {
  deleteLogCollectorConfiguration( 
         configId: \"abc123\",
         versionId: 24
  )
}";
$query =~ s/\n/ /g;
my $json = sprintf('{"query" : "%s"}',$query);
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 {
  deleteLogCollectorConfiguration( 
         configId: \"abc123\",
         versionId: 24
  )
}"
}'''

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 {
  deleteLogCollectorConfiguration( 
         configId: \"abc123\",
         versionId: 24
  )
}"
}
);


const options = {
  hostname: '$YOUR_LOGSCALE_URL',
  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": {
    "deleteLogCollectorConfiguration": true
  }
}

Input Parameters

For the input, you'll have to give the unique identifier of the LogCollector configuration to delete. You'll also have to give the version number. The table below lists and describes these parameters:

Table: Input Parameters & Datatypes

Parameter Type Required Default Description
This table contains all input parameters for this mutation.
configId string yes   The unique identifier of the LogCollector configuration.
versionId integer yes   The identifier of the version.