API Reference

App Logs

Check app.capabilities for feature support and app.access plus host permissions for authorization. Examples use synthetic values; replace paths, IDs, inputs and filters before calling.

Type Definitions

graphql
type Mutation {
  clearAppLogs: Boolean!
  exportAppLogs: String
}

type Query {
  appLogFilesSize: Long!
  appLogPath: String!
  appLogs(query: String!, offset: Int!, limit: Int!): [String!]!
}

scalar Long

Operations

mutation

clearAppLogs

Clear application log files; remote calls require Developer Mode.

graphql
mutation clearAppLogs {
  clearAppLogs
}
mutation

exportAppLogs

Export application logs to an archive and return its path when available; remote calls require Developer Mode.

graphql
mutation exportAppLogs {
  exportAppLogs
}
query

appLogFilesSize

Read the total size of application log files in bytes; remote calls require Developer Mode.

graphql
query appLogFilesSize {
  appLogFilesSize
}
query

appLogPath

Read the current application log path; remote calls require Developer Mode.

graphql
query appLogPath {
  appLogPath
}
query

appLogs

Read or search application log lines, newest first, with pagination; remote calls require Developer Mode.

graphql
# Log lines, newest first. A blank `query` pages the buffer directly;
# a non-blank one filters the whole buffer and then pages, so a
# search cannot be cut short by the page size.
query appLogs($query: String!, $offset: Int!, $limit: Int!) {
  appLogs(query: $query, offset: $offset, limit: $limit)
}