Read sandbox file

sandboxFile(sandboxId: ID!, path: String!): SandboxFile!

Requires project.sandboxes.manage.

Arguments

ArgumentTypeRequired
sandboxIdID!Yes
pathString!Yes

Response

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

FieldTypeDescription
pathString!
contentString!UTF-8 file content.
encodingString!Content encoding: utf-8.

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

Example

graphql
query SandboxFile($sandboxId: ID!, $path: String!) {
  sandboxFile(sandboxId: $sandboxId, path: $path) {
    content
    encoding
    path
  }
}
json
{
  "sandboxId": "00000000-0000-4000-8000-000000000001",
  "path": "example"
}