Below is the syntax for the
deleteSearchDomainById() mutation
field:
deleteSearchDomainById(
input : DeleteSearchDomainByIdInput!
) : boolean!
Below is an example of how this mutation field might be used:
Show:
Raw Mac OS or Linux (curl) Mac OS or Linux (curl) One-line Windows Cmd and curl Windows Powershell and curl Perl Python Node.js
Raw mutation {
deleteSearchDomainById( input : {
id : "JekdMHiFPEWnbXTtg6IS5lKggn3f" ,
deleteMessage : "Sorry: Had to be deleted."
} )
}
Mac OS or Linux (curl) curl -v -X POST $YOUR_LOGSCALE_URL/graphql \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d @- << EOF
{"query" : "mutation {
deleteSearchDomainById( input: {
id: \"JekdMHiFPEWnbXTtg6IS5lKggn3f\",
deleteMessage: \"Sorry: Had to be deleted.\"
} )
}"
}
EOF
Mac OS or Linux (curl) One-line curl -v -X POST $YOUR_LOGSCALE_URL/graphql \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d @- << EOF
{"query" : "mutation {
deleteSearchDomainById( input: {
id: \"JekdMHiFPEWnbXTtg6IS5lKggn3f\",
deleteMessage: \"Sorry: Had to be deleted.\"
} )
}"
}
EOF
Windows Cmd and curl curl -v -X POST $YOUR_LOGSCALE_URL/graphql ^
-H "Authorization: Bearer $TOKEN" ^
-H "Content-Type: application/json" ^
-d @'{"query" : "mutation { ^
deleteSearchDomainById( input: { ^
id: \"JekdMHiFPEWnbXTtg6IS5lKggn3f\", ^
deleteMessage: \"Sorry: Had to be deleted.\" ^
} ) ^
}" ^
} '
Windows Powershell and curl curl.exe -X POST
-H "Authorization: Bearer $TOKEN "
-H "Content-Type: application/json"
-d '{"query" : "mutation {
deleteSearchDomainById( input: {
id: \"JekdMHiFPEWnbXTtg6IS5lKggn3f\",
deleteMessage: \"Sorry: Had to be deleted.\"
} )
}"
}'
"$YOUR_LOGSCALE_URL /graphql"
Perl
use HTTP::Request;
use LWP;
my $INGEST_TOKEN = "TOKEN" ;
my $uri = '$YOUR_LOGSCALE_URL/graphql' ;
my $json = '{"query" : "mutation {
deleteSearchDomainById( input: {
id: \"JekdMHiFPEWnbXTtg6IS5lKggn3f\",
deleteMessage: \"Sorry: Had to be deleted.\"
} )
}"
}' ;
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
import requests
url = '$YOUR_LOGSCALE_URL/graphql'
mydata = r'''{"query" : "mutation {
deleteSearchDomainById( input: {
id: \"JekdMHiFPEWnbXTtg6IS5lKggn3f\",
deleteMessage: \"Sorry: Had to be deleted.\"
} )
}"
}'''
resp = requests.post(url,
data = mydata,
headers = {
"Authorization" : "Bearer $TOKEN" ,
"Content-Type" : "application/json"
}
)
print (resp.text)
Node.js const https = require ('https' );
const data = JSON .stringify (
{"query" : "mutation {
deleteSearchDomainById( input: {
id: \"JekdMHiFPEWnbXTtg6IS5lKggn3f\",
deleteMessage: \"Sorry: Had to be deleted.\"
} )
}"
}
);
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 Show:
Success (HTTP Response Code 200 OK)
Success (HTTP Response Code 200 OK) {
"data" : {
"deleteSearchDomainById" : true
}
}
For
DeleteSearchDomainByIdInput ,
there are two parameters. Below are descriptions of them:
Table: DeleteSearchDomainByIdInput
Parameter Type Required Default Stability Description 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 18, 2024 deleteMessage
string Optional message to why the search domain was deleted. Will be added to the audit log. id
string yes The unique identifier of the search domain.