Create file

createFile(input: CreateFileInput!): CreateFilePayload!

Requires project.files.write.

Arguments

ArgumentTypeRequired
inputCreateFileInput!Yes

Input fields

input

CreateFileInput

FieldTypeRequiredDescription
filePathString!YesFile path to create in main or the selected branch. Atomically fails if the path already exists, including concurrent creation; it does not overwrite.
contentString!Yes
refStringNoCanonical content selector: main, branch:<name-or-id>, release:<version> or env:<name>. An unresolvable reference is rejected; it never falls back to main. A release or environment is read-only, so a write addressed to one is refused rather than applied elsewhere.
branchIdStringNoLegacy alias for ref=branch:<value>. Supplying both is accepted when they name the same content and rejected when they do not.

Response

Returns CreateFilePayload!. Open the type for its fields and nested types.

FieldTypeDescription
idString!
pathString!
successBoolean!
errorString
versionIdStringVersion ID the write produced; null when the mutation failed.
typeStringFile kind: page, function, component or file; null when the mutation failed.
contentStringContent of the file after the mutation; null when the mutation failed.
sizeBytesIntSize of the content encoded as UTF-8, in bytes; null when the mutation failed.

All fields of CreateFilePayload.

Types marked with ! cannot be null. Lists use [Type] notation. The type index lists all published input and response types.

Example

graphql
mutation CreateFile($input: CreateFileInput!) {
  createFile(input: $input) {
    id
    updatedAt
    checksum
    content
    error
  }
}
json
{
  "input": {
    "filePath": "example",
    "content": "example"
  }
}