Summary

The updateUploadFileAction() mutation updates an upload file action in LogScale. Upload file actions attach a lookup file to alert or scheduled search triggers.

This mutation is deprecated. It does not support the fields required for different update modes. Use updateUploadFileActionV2() instead. LogScale will remove this mutation at the earliest in version 1.219.

Syntax

graphql
updateUploadFileAction(
      input: UpdateUploadFileAction!
   ): UploadFileAction!

The mutation requires an input argument of type UpdateUploadFileAction, which is non-null. Provide the view name, the action identifier, and any fields to update. For the full field list, see Input parameters.

The mutation returns a non-null UploadFileAction object. For the available fields, see Returned values.

Input parameters

The input argument accepts an UpdateUploadFileAction object. Provide the view name and the unique identifier of the action, along with the fields to update. Use the repository() query to retrieve the action identifier.

Table: UpdateUploadFileAction Input Datatype

ParameterTypeRequiredDefaultStabilityAvailabilityDescription
fileNameStringyes Long-Term The file name for the uploaded file.
idStringyes Long-Term The unique identifier of the action.
labelsStringyes Long-Term Labels, if any, associated with the action.
nameStringyes Long-Term The name of the action.
viewNameStringyes Long-Term The name of the view of the action.

Example

Raw
graphql
mutation {
  updateUploadFileAction( input:
    { viewName: "humio",
      id: "abc123",
      name: "file-act",
      fileName: "my-file.csv"
    } )
  { fileName }
}
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 {
  updateUploadFileAction( input:
    { viewName: \"humio\",
      id: \"abc123\",
      name: \"file-act\",
      fileName: \"my-file.csv\"
    } )
  { fileName }
}"
}
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 {
  updateUploadFileAction( input:
    { viewName: \"humio\",
      id: \"abc123\",
      name: \"file-act\",
      fileName: \"my-file.csv\"
    } )
  { fileName }
}"
}
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 { ^
  updateUploadFileAction( input: ^
    { viewName: \"humio\", ^
      id: \"abc123\", ^
      name: \"file-act\", ^
      fileName: \"my-file.csv\" ^
    } ) ^
  { fileName } ^
}" ^
} '
Windows Powershell and curl
powershell
curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "mutation {
  updateUploadFileAction( input:
    { viewName: \"humio\",
      id: \"abc123\",
      name: \"file-act\",
      fileName: \"my-file.csv\"
    } )
  { fileName }
}"
}'
    "$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 {
  updateUploadFileAction( input:
    { viewName: \"humio\",
      id: \"abc123\",
      name: \"file-act\",
      fileName: \"my-file.csv\"
    } )
  { fileName }
}";
$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 {
  updateUploadFileAction( input:
    { viewName: \"humio\",
      id: \"abc123\",
      name: \"file-act\",
      fileName: \"my-file.csv\"
    } )
  { fileName }
}"
}'''

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 {
  updateUploadFileAction( input:
    { viewName: \"humio\",
      id: \"abc123\",
      name: \"file-act\",
      fileName: \"my-file.csv\"
    } )
  { fileName }
}"
}
);


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": {
    "updateUploadFileAction": {
      "fileName": "my-file.csv"
    }
  }
}

Returned values

The mutation returns an UploadFileAction object. The object contains the updated action configuration, file details, and timestamps. It also includes the identities of users who created and last modified the action.

Table: UploadFileAction Datatype

ParameterTypeRequiredDefaultStabilityAvailabilityDescription
allowedActions[AssetAction]yes Short-Term A list of allowed asset actions. See AssetAction . This is a preview and subject to change.
createdInfoAssetCommitMetadata  Long-Term Metadata related to the creation of the action. See AssetCommitMetadata.
displayNamestringyes Long-Term The display name of the action.
fileNamestringyes Long-Term The name of the uploaded file.
idstringyes Long-Term The unique identifier of the action.
isAllowedToRunbooleanyes Long-Term False if disabled because of a security policy.
labels[string]  Preview Labels attached to the action.
modifiedInfoAssetCommitMetadata  Long-Term Metadata related to the latest modification of the action. See AssetCommitMetadata.
namestringyes Long-Term The name of the action.
packagePackageInstallation  Long-Term The package, if any, of which the action is part. See PackageInstallation.
packageIdVersionedPackageSpecifier  Long-Term The unique identifier of the package. VersionedPackageSpecifier is a scalar.
requiresOrganizationOwnedQueriesPermissionToEditbooleanyes Long-Term True if this action is used by triggers, where the query is run by the organization. If true, the OrganizationOwnedQueries permission is required to edit.
resourcestringyes Short-Term The resource identifier for this action.
yamlTemplateYAMLyes Long-Term A template that can be used to recreate the action. YAML is a scalar.