API Stability Long-Term

The newFile() GraphQL mutation may be used to create a new file.

For information on loading and using files, see the Lookup Files documentation page.

Syntax

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

graphql
newFile(
     fileName: string!, 
     name: string!
   ): UploadedFileSnapshot!

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

Show:
graphql
mutation {
  newFile( 
     fileName: "somefile.csv",
     name: "humio",
  ) 
  { nameAndPath {path} }
}
Example Responses
Show:
json
{
  "data": {
    "newFile": {
      "nameAndPath": {
        "path": null
      }
    }
  }
}

Returned Datatypes

The returned datatype UploadedFileSnapshot has several parameters. Below is a list of them along with a description of each:

Table: UploadedFileSnapshot

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: Mar 27, 2025
filterStringstring  Long-TermAny string on which to filter the data.
headers[string]yes Long-TermThe headers for the uploaded snapshot file.
limitintegeryes Long-TermThe file upload limit.
lines[string]yes Long-TermThe contents of the file in the form of a list of lines, with each line being itself a list of column values. When the file is empty or nothing matches filterString, then [] is returned.
nameAndPathFileNameAndPathyes Long-TermThe name and path of the uploaded snapshot file. See FileNameAndPath.
offsetintegeryes Long-TermThis is the offset supplied to a file query. For a new or updated file, this is always 0.
resourcestring  Short-TermThe resource identifier for the file.
totalLinesCountlongyes Long-TermThe total number of lines in the uploaded snapshot file.