createUploadFileAction()

API StabilityLongTerm

The createUploadFileAction() GraphQL mutation field is used to create an upload file action.

Syntax

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

graphql
createUploadFileAction(
       input: CreateUploadFileAction!
    ): UploadFileAction!

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

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

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 {
  createUploadFileAction(input:
       { name: \"my-search-link\", 
         viewName: \"humio\",
         fileName: \"somefile.csv\"
      } )
  { id }
}"
}
);


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": {
    "createUploadFileAction": {
      "id": "B352ihOlsFo2WU5VqItzPUjVVPH9bmZE"
    }
  }
}

Given Datatypes

For CreateUploadFileAction, there are a few parameters. Below is a list of them:

Table: CreateUploadFileAction

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 17, 2024
fileNamestringyes  The file name to use for the uploaded file.
namestringyes  The name of the action.
viewNamestringyes  The name of the view of the action.

Returned Datatypes

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

Table: UploadFileAction

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: Oct 4, 2024
allowedActions[AssetAction]yes  A list of allowed asset actions. See AssetAction. This is a preview and subject to change.
displayNamestringyes  The display name of the action.
fileNamestringyes  The name of the uploaded file.
idstringyes  The unique identifier of the action.
isAllowedToRunbooleanyes  False if disabled because of a security policy.
namestringyes  The name of the action.
packagePackageInstallationyes  The package, if any, of which the action is part. See PackageInstallation.
packageIdVersionedPackageSpecifier   The unique identifier of the package. VersionedPackageSpecifier is a scalar.
requiresOrganizationOwnedQueriesPermissionToEditbooleanyes  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.
yamlTemplateyamlyes  A template that can be used to recreate the action.