createUploadFileAction()

API Stability	`Long-Term`

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:

Show:

graphql

mutation {
  createUploadFileAction(input:
       { name: "my-search-link", 
         viewName: "humio",
         fileName: "somefile.csv"
      } )
  { id }
}

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

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

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 } ^
}" ^
} '

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

#!/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

#! /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)

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

Show:

json

{
  "data": {
    "createUploadFileAction": {
      "id": "B352ihOlsFo2WU5VqItzPUjVVPH9bmZE"
    }
  }
}

Given Datatypes

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

Table: CreateUploadFileAction

Parameter	Type	Required	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 17, 2024
`fileName`	string	yes	The file name to use for the uploaded file.
`name`	string	yes	The name of the action.
`viewName`	string	yes	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

Parameter	Type	Required	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: Mar 27, 2025
`allowedActions`	[`AssetAction`]	yes	`Preview`	A list of allowed asset actions. See `AssetAction`. This is a preview and subject to change.
`displayName`	string	yes	`Long-Term`	The display name of the action.
`fileName`	string	yes	`Long-Term`	The name of the uploaded file.
`id`	string	yes	`Long-Term`	The unique identifier of the action.
`isAllowedToRun`	boolean	yes	`Long-Term`	False if disabled because of a security policy.
`name`	string	yes	`Long-Term`	The name of the action.
`package`	`PackageInstallation`	yes	`Long-Term`	The package, if any, of which the action is part. See `PackageInstallation`.
`packageId`	`VersionedPackageSpecifier`		`Long-Term`	The unique identifier of the package. VersionedPackageSpecifier is a scalar.
`requiresOrganizationOwnedQueriesPermissionToEdit`	boolean	yes	`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.
`resource`	string	yes	`Short-Term`	The resource identifier for this action.
`yamlTemplate`	`yaml`	yes	`Long-Term`	A template that can be used to recreate the action.

GraphQL Mutations

GraphQL API Stability

GraphQL Queries

GraphQL Datatypes